hammer_cli_foreman 0.4.0 → 0.5.0

data/test/unit/apipie_resource_mock.rb

@@ -20,7 +20,8 @@ module ResourceMocks
   end
 
   def self.smart_class_parameters_index
-    ResourceMocks.mock_action_call(:smart_class_parameters, :index, [ { 'parameter' => 'config', 'id' => '1'} ])
+    ResourceMocks.mock_action_call(:smart_class_parameters, :index,
+      { "results" => [ { 'parameter' => 'config', 'id' => '1'} ] })
   end
 
   def self.smart_class_parameters_show
@@ -28,7 +29,8 @@ module ResourceMocks
   end
 
   def self.smart_variables_index
-    ResourceMocks.mock_action_call(:smart_variables, :index, [ { 'variable' => 'var', 'id' => '1'} ])
+    ResourceMocks.mock_action_call(:smart_variables, :index,
+      { "results" => [ { 'variable' => 'var', 'id' => '1'} ] })
   end
 
   def self.smart_variables_show
@@ -41,7 +43,15 @@ module ResourceMocks
 
 
   def self.organizations_index
-    ResourceMocks.mock_action_call(:organizations, :index, [ { } ])
+    ResourceMocks.mock_action_call(:organizations, :index, {
+     "results" => [
+        {
+                 "label" => "Default_Organization",
+                    "id" => 1,
+                  "name" => "Default_Organization",
+                 "title" => "Default_Organization"
+        }
+      ]})
   end
 
   def self.organizations_show
@@ -52,7 +62,17 @@ module ResourceMocks
   end
 
   def self.locations_index
-    ResourceMocks.mock_action_call(:locations, :index, [ { } ])
+    ResourceMocks.mock_action_call(:locations, :index, {
+      "results" => [
+        {
+              "ancestry" => nil,
+            "created_at" => "2014-07-17T17:21:49+02:00",
+            "updated_at" => "2015-06-17T13:18:10+02:00",
+                    "id" => 2,
+                  "name" => "Default_Location",
+                 "title" => "Default_Location"
+        }
+      ]})
   end
 
   def self.locations_show
@@ -65,7 +85,6 @@ module ResourceMocks
   def self.operatingsystems
     ResourceMocks.mock_action_calls(
       [:parameters, :index, []],
-      [:operatingsystems, :index, [ {} ]],
       [:operatingsystems, :show, {}]
       )
   end
@@ -95,5 +114,4 @@ module ResourceMocks
       }]
     })
   end
-
 end

data/test/unit/architecture_test.rb

@@ -17,7 +17,7 @@ describe HammerCLIForeman::Architecture do
     end
 
     context "output" do
-      let(:expected_record_count) { cmd.resource.call(:index).length }
+      let(:expected_record_count) { count_records(cmd.resource.call(:index)) }
 
       it_should_print_n_records
       it_should_print_column "Name"

data/test/unit/auth_source_ldap_test.rb

@@ -18,9 +18,7 @@ describe HammerCLIForeman::AuthSourceLdap do
     end
 
     context "output" do
-      let(:expected_record_count) do
-        cmd.resource.call(:index).length
-      end
+      let(:expected_record_count) { count_records(cmd.resource.call(:index)) }
 
       it_should_print_n_records 1
       it_should_print_column "Name"

data/test/unit/common_parameter_test.rb

@@ -17,7 +17,7 @@ describe HammerCLIForeman::CommonParameter do
     end
 
     context "output" do
-      let(:expected_record_count) { cmd.resource.call(:index).length }
+      let(:expected_record_count) { count_records(cmd.resource.call(:index)) }
 
       it_should_print_n_records
       it_should_print_columns  ["Name", "Value"]

data/test/unit/compute_resource_test.rb

@@ -18,7 +18,7 @@ describe HammerCLIForeman::ComputeResource do
     end
 
     context "output" do
-      let(:expected_record_count) { cmd.resource.call(:index).length }
+      let(:expected_record_count) { count_records(cmd.resource.call(:index)) }
 
       it_should_print_n_records
       it_should_print_columns ["Name", "Id", "Provider"]

data/test/unit/data/1.10/foreman_api.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":{"hostgroups":{"doc_url":"../apidoc/v2/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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"location_id","full_name":"location_id","description":"\n\u003Cp\u003EScope by locations\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"organization_id","full_name":"organization_id","description":"\n\u003Cp\u003EScope by organizations\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"search","full_name":"search","description":"\n\u003Cp\u003Efilter results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003Cp\u003Esort results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003Cp\u003Epaginate results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003Cp\u003Enumber of entries per request\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/hostgroups\n200\n{\n  \"total\": 5,\n  \"subtotal\": 5,\n  \"page\": 1,\n  \"per_page\": 20,\n  \"search\": null,\n  \"sort\": {\n    \"by\": null,\n    \"order\": null\n  },\n  \"results\": [\n    {\n      \"subnet_id\": null,\n      \"subnet_name\": null,\n      \"operatingsystem_id\": 309172073,\n      \"operatingsystem_name\": \"centos 5.3\",\n      \"domain_id\": 22495316,\n      \"domain_name\": \"mydomain.net\",\n      \"environment_id\": 334344675,\n      \"environment_name\": \"production\",\n      \"compute_profile_id\": 980190962,\n      \"compute_profile_name\": \"1-Small\",\n      \"ancestry\": null,\n      \"puppet_proxy_id\": 182953976,\n      \"puppet_ca_proxy_id\": null,\n      \"ptable_id\": null,\n      \"ptable_name\": null,\n      \"medium_id\": 980190962,\n      \"medium_name\": \"CentOS 5.4\",\n      \"architecture_id\": 501905019,\n      \"architecture_name\": \"x86_64\",\n      \"realm_id\": null,\n      \"realm_name\": null,\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"id\": 636252244,\n      \"name\": \"Common\",\n      \"title\": \"Common\"\n    },\n    {\n      \"subnet_id\": 113629430,\n      \"subnet_name\": \"three\",\n      \"operatingsystem_id\": 309172073,\n      \"operatingsystem_name\": \"centos 5.3\",\n      \"domain_id\": 22495316,\n      \"domain_name\": \"mydomain.net\",\n      \"environment_id\": 153855663,\n      \"environment_name\": \"global_puppetmaster\",\n      \"compute_profile_id\": 980190962,\n      \"compute_profile_name\": \"1-Small\",\n      \"ancestry\": null,\n      \"puppet_proxy_id\": 182953976,\n      \"puppet_ca_proxy_id\": 182953976,\n      \"ptable_id\": null,\n      \"ptable_name\": null,\n      \"medium_id\": 980190962,\n      \"medium_name\": \"CentOS 5.4\",\n      \"architecture_id\": 501905019,\n      \"architecture_name\": \"x86_64\",\n      \"realm_id\": null,\n      \"realm_name\": null,\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"id\": 1,\n      \"name\": \"Parent\",\n      \"title\": \"Parent\"\n    },\n    {\n      \"subnet_id\": null,\n      \"subnet_name\": null,\n      \"operatingsystem_id\": null,\n      \"operatingsystem_name\": null,\n      \"domain_id\": null,\n      \"domain_name\": null,\n      \"environment_id\": 334344675,\n      \"environment_name\": \"production\",\n      \"compute_profile_id\": null,\n      \"compute_profile_name\": null,\n      \"ancestry\": \"1\",\n      \"puppet_proxy_id\": null,\n      \"puppet_ca_proxy_id\": null,\n      \"ptable_id\": null,\n      \"ptable_name\": null,\n      \"medium_id\": null,\n      \"medium_name\": null,\n      \"architecture_id\": null,\n      \"architecture_name\": null,\n      \"realm_id\": null,\n      \"realm_name\": null,\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"id\": 928644285,\n      \"name\": \"inherited\",\n      \"title\": \"Parent/inherited\"\n    },\n    {\n      \"subnet_id\": null,\n      \"subnet_name\": null,\n      \"operatingsystem_id\": null,\n      \"operatingsystem_name\": null,\n      \"domain_id\": null,\n      \"domain_name\": null,\n      \"environment_id\": null,\n      \"environment_name\": null,\n      \"compute_profile_id\": null,\n      \"compute_profile_name\": null,\n      \"ancestry\": null,\n      \"puppet_proxy_id\": 182953976,\n      \"puppet_ca_proxy_id\": null,\n      \"ptable_id\": null,\n      \"ptable_name\": null,\n      \"medium_id\": null,\n      \"medium_name\": null,\n      \"architecture_id\": null,\n      \"architecture_name\": null,\n      \"realm_id\": null,\n      \"realm_name\": null,\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"id\": 866317115,\n      \"name\": \"Unusual\",\n      \"title\": \"Unusual\"\n    },\n    {\n      \"subnet_id\": null,\n      \"subnet_name\": null,\n      \"operatingsystem_id\": 309172073,\n      \"operatingsystem_name\": \"centos 5.3\",\n      \"domain_id\": null,\n      \"domain_name\": null,\n      \"environment_id\": 334344675,\n      \"environment_name\": \"production\",\n      \"compute_profile_id\": null,\n      \"compute_profile_name\": null,\n      \"ancestry\": null,\n      \"puppet_proxy_id\": 182953976,\n      \"puppet_ca_proxy_id\": null,\n      \"ptable_id\": null,\n      \"ptable_name\": null,\n      \"medium_id\": 980190962,\n      \"medium_name\": \"CentOS 5.4\",\n      \"architecture_id\": 501905019,\n      \"architecture_name\": \"x86_64\",\n      \"realm_id\": null,\n      \"realm_name\": null,\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"id\": 603241515,\n      \"name\": \"db\",\n      \"title\": \"db\"\n    }\n  ]\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/hostgroups/636252244-Common\n200\n{\n  \"subnet_id\": null,\n  \"subnet_name\": null,\n  \"operatingsystem_id\": 309172073,\n  \"operatingsystem_name\": \"centos 5.3\",\n  \"domain_id\": 22495316,\n  \"domain_name\": \"mydomain.net\",\n  \"environment_id\": 334344675,\n  \"environment_name\": \"production\",\n  \"compute_profile_id\": 980190962,\n  \"compute_profile_name\": \"1-Small\",\n  \"ancestry\": null,\n  \"puppet_proxy_id\": 182953976,\n  \"puppet_ca_proxy_id\": null,\n  \"ptable_id\": null,\n  \"ptable_name\": null,\n  \"medium_id\": 980190962,\n  \"medium_name\": \"CentOS 5.4\",\n  \"architecture_id\": 501905019,\n  \"architecture_name\": \"x86_64\",\n  \"realm_id\": null,\n  \"realm_name\": null,\n  \"created_at\": \"2015-12-01T02:40:02Z\",\n  \"updated_at\": \"2015-12-01T02:40:02Z\",\n  \"id\": 636252244,\n  \"name\": \"Common\",\n  \"title\": \"Common\",\n  \"parameters\": [\n    {\n      \"id\": 767575238,\n      \"name\": \"group1\",\n      \"value\": \"group1\"\n    }\n  ],\n  \"template_combinations\": [\n    {\n      \"id\": 281110143,\n      \"provisioning_template_id\": 269958254,\n      \"provisioning_template_name\": \"MyString2\",\n      \"hostgroup_id\": 636252244,\n      \"hostgroup_name\": \"Common\",\n      \"environment_id\": 334344675,\n      \"environment_name\": \"production\",\n      \"config_template_id\": 269958254,\n      \"config_template_name\": \"MyString2\"\n    },\n    {\n      \"id\": 980190962,\n      \"provisioning_template_id\": 943779058,\n      \"provisioning_template_name\": \"MyString\",\n      \"hostgroup_id\": 636252244,\n      \"hostgroup_name\": \"Common\",\n      \"environment_id\": 334344675,\n      \"environment_name\": \"production\",\n      \"config_template_id\": 943779058,\n      \"config_template_name\": \"MyString\"\n    }\n  ],\n  \"puppetclasses\": [\n    {\n      \"id\": 980190962,\n      \"name\": \"base\",\n      \"module_name\": \"base\"\n    }\n  ],\n  \"config_groups\": [\n    {\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"id\": 980190962,\n      \"name\": \"Monitoring\",\n      \"puppetclasses\": [\n        {\n          \"id\": 51848956,\n          \"name\": \"chkmk\",\n          \"module_name\": \"chkmk\"\n        },\n        {\n          \"id\": 1018350795,\n          \"name\": \"nagios\",\n          \"module_name\": \"nagios\"\n        }\n      ]\n    },\n    {\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"id\": 113629430,\n      \"name\": \"Tools\",\n      \"puppetclasses\": [\n        {\n          \"id\": 113629430,\n          \"name\": \"git\",\n          \"module_name\": \"git\"\n        },\n        {\n          \"id\": 281110143,\n          \"name\": \"vim\",\n          \"module_name\": \"vim\"\n        }\n      ]\n    }\n  ],\n  \"all_puppetclasses\": [\n    {\n      \"id\": 980190962,\n      \"name\": \"base\",\n      \"module_name\": \"base\"\n    },\n    {\n      \"id\": 51848956,\n      \"name\": \"chkmk\",\n      \"module_name\": \"chkmk\"\n    },\n    {\n      \"id\": 1018350795,\n      \"name\": \"nagios\",\n      \"module_name\": \"nagios\"\n    },\n    {\n      \"id\": 281110143,\n      \"name\": \"vim\",\n      \"module_name\": \"vim\"\n    }\n  ],\n  \"locations\": [],\n  \"organizations\": []\n}"],"metadata":null,"see":[]},{"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":"hostgroup","full_name":"hostgroup","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"hostgroup[name]","description":"\n\u003Cp\u003EName of the host group\u003C/p\u003E\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"environment_id","full_name":"hostgroup[environment_id]","description":"\n\u003Cp\u003EEnvironment ID\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"operatingsystem_id","full_name":"hostgroup[operatingsystem_id]","description":"\n\u003Cp\u003EOperating system ID\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"architecture_id","full_name":"hostgroup[architecture_id]","description":"\n\u003Cp\u003EArchitecture ID\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"medium_id","full_name":"hostgroup[medium_id]","description":"\n\u003Cp\u003EMedia ID\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"ptable_id","full_name":"hostgroup[ptable_id]","description":"\n\u003Cp\u003EPartition table ID\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"subnet_id","full_name":"hostgroup[subnet_id]","description":"\n\u003Cp\u003ESubnet ID\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"domain_id","full_name":"hostgroup[domain_id]","description":"\n\u003Cp\u003EDomain ID\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"realm_id","full_name":"hostgroup[realm_id]","description":"\n\u003Cp\u003ERealm ID\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"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,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":["POST /api/hostgroups\n{\n  \"hostgroup\": {\n    \"name\": \"TestHostgroup\"\n  }\n}\n500\n{\n  \"error\": {\n    \"message\": \"SQLite3::SQLException: table hostgroups has no column named hosts_count: INSERT INTO \\\"hostgroups\\\" (\\\"ancestry\\\", \\\"architecture_id\\\", \\\"compute_profile_id\\\", \\\"created_at\\\", \\\"domain_id\\\", \\\"environment_id\\\", \\\"grub_pass\\\", \\\"hosts_count\\\", \\\"image_file\\\", \\\"lookup_value_matcher\\\", \\\"medium_id\\\", \\\"name\\\", \\\"operatingsystem_id\\\", \\\"ptable_id\\\", \\\"puppet_ca_proxy_id\\\", \\\"puppet_proxy_id\\\", \\\"realm_id\\\", \\\"root_pass\\\", \\\"subnet_id\\\", \\\"title\\\", \\\"updated_at\\\", \\\"use_image\\\", \\\"vm_defaults\\\") VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)\"\n  }\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true},{"name":"hostgroup","full_name":"hostgroup","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"hostgroup[name]","description":"\n\u003Cp\u003EName of the host group\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"environment_id","full_name":"hostgroup[environment_id]","description":"\n\u003Cp\u003EEnvironment ID\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"operatingsystem_id","full_name":"hostgroup[operatingsystem_id]","description":"\n\u003Cp\u003EOperating system ID\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"architecture_id","full_name":"hostgroup[architecture_id]","description":"\n\u003Cp\u003EArchitecture ID\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"medium_id","full_name":"hostgroup[medium_id]","description":"\n\u003Cp\u003EMedia ID\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"ptable_id","full_name":"hostgroup[ptable_id]","description":"\n\u003Cp\u003EPartition table ID\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"subnet_id","full_name":"hostgroup[subnet_id]","description":"\n\u003Cp\u003ESubnet ID\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"domain_id","full_name":"hostgroup[domain_id]","description":"\n\u003Cp\u003EDomain ID\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"realm_id","full_name":"hostgroup[realm_id]","description":"\n\u003Cp\u003ERealm ID\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"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,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":["PUT /api/hostgroups/636252244-Common\n{\n  \"hostgroup\": {\n    \"name\": \"TestHostgroup\"\n  }\n}\n200\n{\n  \"subnet_id\": null,\n  \"subnet_name\": null,\n  \"operatingsystem_id\": 309172073,\n  \"operatingsystem_name\": \"centos 5.3\",\n  \"domain_id\": 22495316,\n  \"domain_name\": \"mydomain.net\",\n  \"environment_id\": 334344675,\n  \"environment_name\": \"production\",\n  \"compute_profile_id\": 980190962,\n  \"compute_profile_name\": \"1-Small\",\n  \"ancestry\": null,\n  \"puppet_proxy_id\": 182953976,\n  \"puppet_ca_proxy_id\": 182953976,\n  \"ptable_id\": null,\n  \"ptable_name\": null,\n  \"medium_id\": 980190962,\n  \"medium_name\": \"CentOS 5.4\",\n  \"architecture_id\": 501905019,\n  \"architecture_name\": \"x86_64\",\n  \"realm_id\": null,\n  \"realm_name\": null,\n  \"created_at\": \"2015-12-01T02:40:02Z\",\n  \"updated_at\": \"2015-12-01T02:40:39Z\",\n  \"id\": 636252244,\n  \"name\": \"TestHostgroup\",\n  \"title\": \"TestHostgroup\",\n  \"parameters\": [\n    {\n      \"id\": 767575238,\n      \"name\": \"group1\",\n      \"value\": \"group1\"\n    }\n  ],\n  \"template_combinations\": [\n    {\n      \"id\": 281110143,\n      \"provisioning_template_id\": 269958254,\n      \"provisioning_template_name\": \"MyString2\",\n      \"hostgroup_id\": 636252244,\n      \"hostgroup_name\": \"TestHostgroup\",\n      \"environment_id\": 334344675,\n      \"environment_name\": \"production\",\n      \"config_template_id\": 269958254,\n      \"config_template_name\": \"MyString2\"\n    },\n    {\n      \"id\": 980190962,\n      \"provisioning_template_id\": 943779058,\n      \"provisioning_template_name\": \"MyString\",\n      \"hostgroup_id\": 636252244,\n      \"hostgroup_name\": \"TestHostgroup\",\n      \"environment_id\": 334344675,\n      \"environment_name\": \"production\",\n      \"config_template_id\": 943779058,\n      \"config_template_name\": \"MyString\"\n    }\n  ],\n  \"puppetclasses\": [\n    {\n      \"id\": 980190962,\n      \"name\": \"base\",\n      \"module_name\": \"base\"\n    }\n  ],\n  \"config_groups\": [\n    {\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"id\": 980190962,\n      \"name\": \"Monitoring\",\n      \"puppetclasses\": [\n        {\n          \"id\": 51848956,\n          \"name\": \"chkmk\",\n          \"module_name\": \"chkmk\"\n        },\n        {\n          \"id\": 1018350795,\n          \"name\": \"nagios\",\n          \"module_name\": \"nagios\"\n        }\n      ]\n    },\n    {\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"id\": 113629430,\n      \"name\": \"Tools\",\n      \"puppetclasses\": [\n        {\n          \"id\": 113629430,\n          \"name\": \"git\",\n          \"module_name\": \"git\"\n        },\n        {\n          \"id\": 281110143,\n          \"name\": \"vim\",\n          \"module_name\": \"vim\"\n        }\n      ]\n    }\n  ],\n  \"all_puppetclasses\": [\n    {\n      \"id\": 980190962,\n      \"name\": \"base\",\n      \"module_name\": \"base\"\n    },\n    {\n      \"id\": 51848956,\n      \"name\": \"chkmk\",\n      \"module_name\": \"chkmk\"\n    },\n    {\n      \"id\": 1018350795,\n      \"name\": \"nagios\",\n      \"module_name\": \"nagios\"\n    },\n    {\n      \"id\": 281110143,\n      \"name\": \"vim\",\n      \"module_name\": \"vim\"\n    }\n  ],\n  \"locations\": [],\n  \"organizations\": []\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true}],"examples":["DELETE /api/hostgroups/866317115-Unusual\n200\n{\n  \"ancestry\": null,\n  \"architecture_id\": null,\n  \"compute_profile_id\": null,\n  \"created_at\": \"2015-12-01T02:40:02Z\",\n  \"domain_id\": null,\n  \"environment_id\": null,\n  \"grub_pass\": \"\",\n  \"id\": 866317115,\n  \"image_file\": \"\",\n  \"lookup_value_matcher\": \"hostgroup=Unusual\",\n  \"medium_id\": null,\n  \"name\": \"Unusual\",\n  \"operatingsystem_id\": null,\n  \"ptable_id\": null,\n  \"puppet_ca_proxy_id\": null,\n  \"puppet_proxy_id\": 182953976,\n  \"realm_id\": null,\n  \"root_pass\": null,\n  \"subnet_id\": null,\n  \"title\": \"Unusual\",\n  \"updated_at\": \"2015-12-01T02:40:02Z\",\n  \"use_image\": null,\n  \"vm_defaults\": null\n}"],"metadata":null,"see":[]},{"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":"name","full_name":"name","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["POST /api/hostgroups/636252244-Common/clone\n{\n  \"name\": \"2015-12-01 02:40:39 +0000\",\n  \"hostgroup\": {\n    \"name\": \"2015-12-01 02:40:39 +0000\"\n  }\n}\n500\n{\n  \"error\": {\n    \"message\": \"missing attribute: hosts_count\"\n  }\n}"],"metadata":null,"see":[]}]},"bookmarks":{"doc_url":"../apidoc/v2/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":"page","full_name":"page","description":"\n\u003Cp\u003Epaginate results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003Cp\u003Enumber of entries per request\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/bookmarks\n200\n{\n  \"total\": 2,\n  \"subtotal\": 2,\n  \"page\": 1,\n  \"per_page\": 20,\n  \"search\": null,\n  \"sort\": {\n    \"by\": null,\n    \"order\": null\n  },\n  \"results\": [\n    {\n      \"name\": \"bar\",\n      \"controller\": \"hosts\",\n      \"query\": \"bar=car\",\n      \"public\": false,\n      \"id\": 298486374,\n      \"owner_id\": null,\n      \"owner_type\": null\n    },\n    {\n      \"name\": \"foo\",\n      \"controller\": \"hosts\",\n      \"query\": \"foo=boo\",\n      \"public\": true,\n      \"id\": 980190962,\n      \"owner_id\": null,\n      \"owner_type\": null\n    }\n  ]\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/bookmarks/980190962-foo\n200\n{\n  \"name\": \"foo\",\n  \"controller\": \"hosts\",\n  \"query\": \"foo=boo\",\n  \"public\": true,\n  \"id\": 980190962,\n  \"owner_id\": null,\n  \"owner_type\": null\n}"],"metadata":null,"see":[]},{"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":"bookmark","full_name":"bookmark","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"bookmark[name]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"controller","full_name":"bookmark[controller]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"query","full_name":"bookmark[query]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"public","full_name":"bookmark[public]","description":"","required":false,"allow_nil":true,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true}]}],"examples":["POST /api/bookmarks\n{\n  \"bookmark\": {\n    \"public\": false,\n    \"controller\": \"hosts\",\n    \"name\": \"foo-bar\",\n    \"query\": \"bar\"\n  }\n}\n201\n{\n  \"name\": \"foo-bar\",\n  \"controller\": \"hosts\",\n  \"query\": \"bar\",\n  \"public\": false,\n  \"id\": 980190963,\n  \"owner_id\": 886836129,\n  \"owner_type\": \"User\"\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true},{"name":"bookmark","full_name":"bookmark","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"bookmark[name]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"controller","full_name":"bookmark[controller]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"query","full_name":"bookmark[query]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"public","full_name":"bookmark[public]","description":"","required":false,"allow_nil":true,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true}]}],"examples":["PUT /api/bookmarks/980190962-foo\n{\n  \"bookmark\": {\n    \"public\": false,\n    \"controller\": \"hosts\",\n    \"name\": \"facts.architecture\",\n    \"query\": \"facts.architecture = x86_64\"\n  }\n}\n200\n{\n  \"name\": \"facts.architecture\",\n  \"controller\": \"hosts\",\n  \"query\": \"facts.architecture = x86_64\",\n  \"public\": false,\n  \"id\": 980190962,\n  \"owner_id\": 886836129,\n  \"owner_type\": \"User\"\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true}],"examples":["DELETE /api/bookmarks/980190962-foo\n200\n{\n  \"controller\": \"hosts\",\n  \"id\": 980190962,\n  \"name\": \"foo\",\n  \"owner_id\": null,\n  \"owner_type\": null,\n  \"public\": true,\n  \"query\": \"foo=boo\"\n}"],"metadata":null,"see":[]}]},"hosts":{"doc_url":"../apidoc/v2/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":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003Cp\u003EID of host group\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"location_id","full_name":"location_id","description":"\n\u003Cp\u003EID of location\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"organization_id","full_name":"organization_id","description":"\n\u003Cp\u003EID of organization\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"environment_id","full_name":"environment_id","description":"\n\u003Cp\u003EID of environment\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"search","full_name":"search","description":"\n\u003Cp\u003Efilter results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003Cp\u003Esort results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003Cp\u003Epaginate results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003Cp\u003Enumber of entries per request\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/hosts\n200\n{\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\": [\n    {\n      \"ip\": null,\n      \"environment_id\": null,\n      \"environment_name\": null,\n      \"last_report\": null,\n      \"mac\": null,\n      \"realm_id\": null,\n      \"realm_name\": null,\n      \"sp_mac\": null,\n      \"sp_ip\": null,\n      \"sp_name\": null,\n      \"domain_id\": null,\n      \"domain_name\": null,\n      \"architecture_id\": null,\n      \"architecture_name\": null,\n      \"operatingsystem_id\": null,\n      \"operatingsystem_name\": null,\n      \"subnet_id\": null,\n      \"subnet_name\": null,\n      \"sp_subnet_id\": null,\n      \"ptable_id\": null,\n      \"ptable_name\": null,\n      \"medium_id\": null,\n      \"medium_name\": null,\n      \"build\": false,\n      \"comment\": null,\n      \"disk\": null,\n      \"installed_at\": null,\n      \"model_id\": null,\n      \"model_name\": null,\n      \"hostgroup_id\": null,\n      \"hostgroup_name\": null,\n      \"owner_id\": null,\n      \"owner_type\": null,\n      \"enabled\": true,\n      \"puppet_ca_proxy_id\": null,\n      \"managed\": false,\n      \"use_image\": null,\n      \"image_file\": \"\",\n      \"uuid\": null,\n      \"compute_resource_id\": null,\n      \"compute_resource_name\": null,\n      \"compute_profile_id\": null,\n      \"compute_profile_name\": null,\n      \"capabilities\": [\n        \"build\"\n      ],\n      \"provision_method\": \"build\",\n      \"puppet_proxy_id\": null,\n      \"certname\": \"host49\",\n      \"image_id\": null,\n      \"image_name\": null,\n      \"created_at\": \"2015-12-01T02:40:39Z\",\n      \"updated_at\": \"2015-12-01T02:40:39Z\",\n      \"last_compile\": null,\n      \"global_status\": 0,\n      \"global_status_label\": \"OK\",\n      \"organization_id\": null,\n      \"organization_name\": null,\n      \"location_id\": null,\n      \"location_name\": null,\n      \"puppet_status\": 0,\n      \"name\": \"host49\",\n      \"id\": 1\n    }\n  ]\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":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}],"examples":["GET /api/hosts/host50\n200\n{\n  \"ip\": null,\n  \"environment_id\": null,\n  \"environment_name\": null,\n  \"last_report\": null,\n  \"mac\": null,\n  \"realm_id\": null,\n  \"realm_name\": null,\n  \"sp_mac\": null,\n  \"sp_ip\": null,\n  \"sp_name\": null,\n  \"domain_id\": null,\n  \"domain_name\": null,\n  \"architecture_id\": null,\n  \"architecture_name\": null,\n  \"operatingsystem_id\": null,\n  \"operatingsystem_name\": null,\n  \"subnet_id\": null,\n  \"subnet_name\": null,\n  \"sp_subnet_id\": null,\n  \"ptable_id\": null,\n  \"ptable_name\": null,\n  \"medium_id\": null,\n  \"medium_name\": null,\n  \"build\": false,\n  \"comment\": null,\n  \"disk\": null,\n  \"installed_at\": null,\n  \"model_id\": null,\n  \"model_name\": null,\n  \"hostgroup_id\": null,\n  \"hostgroup_name\": null,\n  \"owner_id\": null,\n  \"owner_type\": null,\n  \"enabled\": true,\n  \"puppet_ca_proxy_id\": null,\n  \"managed\": false,\n  \"use_image\": null,\n  \"image_file\": \"\",\n  \"uuid\": null,\n  \"compute_resource_id\": null,\n  \"compute_resource_name\": null,\n  \"compute_profile_id\": null,\n  \"compute_profile_name\": null,\n  \"capabilities\": [\n    \"build\"\n  ],\n  \"provision_method\": \"build\",\n  \"puppet_proxy_id\": null,\n  \"certname\": \"host50\",\n  \"image_id\": null,\n  \"image_name\": null,\n  \"created_at\": \"2015-12-01T02:40:40Z\",\n  \"updated_at\": \"2015-12-01T02:40:40Z\",\n  \"last_compile\": null,\n  \"global_status\": 0,\n  \"global_status_label\": \"OK\",\n  \"organization_id\": null,\n  \"organization_name\": null,\n  \"location_id\": null,\n  \"location_name\": null,\n  \"puppet_status\": 0,\n  \"name\": \"host50\",\n  \"id\": 1,\n  \"parameters\": [],\n  \"interfaces\": [\n    {\n      \"id\": 1,\n      \"name\": \"host50\",\n      \"ip\": null,\n      \"mac\": null,\n      \"identifier\": null,\n      \"primary\": true,\n      \"provision\": true,\n      \"type\": \"interface\"\n    }\n  ],\n  \"puppetclasses\": [],\n  \"config_groups\": [],\n  \"all_parameters\": [\n    {\n      \"id\": 636252244,\n      \"name\": \"test\",\n      \"value\": \"myvalue\"\n    }\n  ],\n  \"all_puppetclasses\": []\n}"],"metadata":null,"see":[]},{"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":"host","full_name":"host","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"host[name]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"location_id","full_name":"host[location_id]","description":"\n\u003Cp\u003Erequired if locations are enabled\u003C/p\u003E\n","required":true,"allow_nil":false,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"organization_id","full_name":"host[organization_id]","description":"\n\u003Cp\u003Erequired if organizations are enabled\u003C/p\u003E\n","required":true,"allow_nil":false,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"mac","full_name":"host[mac]","description":"\n\u003Cp\u003Erequired for managed host that is bare metal, not required if it\u2019s a virtual machine\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"realm_id","full_name":"host[realm_id]","description":"","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"puppet_proxy_id","full_name":"host[puppet_proxy_id]","description":"","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"puppet_class_ids","full_name":"host[puppet_class_ids]","description":"","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"medium_id","full_name":"host[medium_id]","description":"\n\u003Cp\u003Erequired if not imaged based provisioning and host is managed and value is not inherited from host group\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"root_pass","full_name":"host[root_pass]","description":"\n\u003Cp\u003Erequired if host is managed and value is not inherited from host group or default password in settings\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"model_id","full_name":"host[model_id]","description":"","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"hostgroup_id","full_name":"host[hostgroup_id]","description":"","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"owner_id","full_name":"host[owner_id]","description":"","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"owner_type","full_name":"host[owner_type]","description":"\n\u003Cp\u003EHost\u2019s owner type\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be one of: User, Usergroup.","expected_type":"string","metadata":null,"show":true},{"name":"puppet_ca_proxy_id","full_name":"host[puppet_ca_proxy_id]","description":"","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"image_id","full_name":"host[image_id]","description":"","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"host_parameters_attributes","full_name":"host[host_parameters_attributes]","description":"","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"build","full_name":"host[build]","description":"","required":false,"allow_nil":true,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true},{"name":"enabled","full_name":"host[enabled]","description":"","required":false,"allow_nil":true,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true},{"name":"provision_method","full_name":"host[provision_method]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"managed","full_name":"host[managed]","description":"\n\u003Cp\u003ETrue/False flag whether a host is managed or unmanaged. Note: this value also determines whether several parameters are required or not\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true},{"name":"progress_report_id","full_name":"host[progress_report_id]","description":"\n\u003Cp\u003EUUID to track orchestration tasks status, GET /api/orchestration/:UUID/tasks\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"comment","full_name":"host[comment]","description":"\n\u003Cp\u003EAdditional information about this host\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"capabilities","full_name":"host[capabilities]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"compute_profile_id","full_name":"host[compute_profile_id]","description":"","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"interfaces_attributes","full_name":"host[interfaces_attributes]","description":"\n\u003Cp\u003EHost\u2019s network interfaces.\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be an Array of nested elements","expected_type":"string","metadata":null,"show":true,"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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"ip","full_name":"host[interfaces_attributes][ip]","description":"\n\u003Cp\u003EIP address of interface\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be one of: interface, bmc, bond.","expected_type":"string","metadata":null,"show":true},{"name":"name","full_name":"host[interfaces_attributes][name]","description":"\n\u003Cp\u003EInterface\u2019s DNS name\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"subnet_id","full_name":"host[interfaces_attributes][subnet_id]","description":"\n\u003Cp\u003EForeman subnet ID of interface\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be Fixnum","expected_type":"numeric","metadata":null,"show":true},{"name":"domain_id","full_name":"host[interfaces_attributes][domain_id]","description":"\n\u003Cp\u003EForeman domain ID of interface. Required for primary interfaces on managed hosts.\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be Fixnum","expected_type":"numeric","metadata":null,"show":true},{"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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"managed","full_name":"host[interfaces_attributes][managed]","description":"\n\u003Cp\u003EShould this interface be managed via DHCP and DNS smart proxy and should it be configured during provisioning?\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true},{"name":"primary","full_name":"host[interfaces_attributes][primary]","description":"\n\u003Cp\u003EShould this interface be used for constructing the FQDN of the host? Each managed hosts needs to have one primary interface.\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true},{"name":"provision","full_name":"host[interfaces_attributes][provision]","description":"\n\u003Cp\u003EShould this interface be used for TFTP of PXELinux (or SSH for image-based hosts)? Each managed hosts needs to have one provision interface.\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true},{"name":"username","full_name":"host[interfaces_attributes][username]","description":"\n\u003Cp\u003EOnly for BMC interfaces.\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"password","full_name":"host[interfaces_attributes][password]","description":"\n\u003Cp\u003EOnly for BMC interfaces.\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be one of: IPMI.","expected_type":"string","metadata":null,"show":true},{"name":"virtual","full_name":"host[interfaces_attributes][virtual]","description":"\n\u003Cp\u003EAlias or VLAN device\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true},{"name":"tag","full_name":"host[interfaces_attributes][tag]","description":"\n\u003Cp\u003EVLAN tag, this attribute has precedence over the subnet VLAN ID. Only for virtual interfaces.\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"attached_to","full_name":"host[interfaces_attributes][attached_to]","description":"\n\u003Cp\u003EIdentifier of the interface to which this interface belongs, e.g. eth1. Only for virtual interfaces.\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be one of: balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb.","expected_type":"string","metadata":null,"show":true},{"name":"attached_devices","full_name":"host[interfaces_attributes][attached_devices]","description":"\n\u003Cp\u003EIdentifiers of slave interfaces, e.g. \u003Ccode\u003E[\u0026#39;eth1\u0026#39;, \u0026#39;eth2\u0026#39;]\u003C/code\u003E. Only for bond interfaces.\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be Hash","expected_type":"hash","metadata":null,"show":true}]},{"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,"validator":"Must be Hash","expected_type":"hash","metadata":null,"show":true}]}],"examples":["POST /api/hosts\n{\n  \"host\": {\n    \"name\": \"testhost11\",\n    \"environment_id\": \"334344675\",\n    \"domain_id\": \"22495316\",\n    \"ptable_id\": \"1007981702\",\n    \"medium_id\": \"980190962\",\n    \"architecture_id\": \"501905019\",\n    \"operatingsystem_id\": \"1073012828\",\n    \"puppet_proxy_id\": \"980190962\",\n    \"compute_resource_id\": \"980190962\",\n    \"root_pass\": \"xybxa6JUkz63w\",\n    \"location_id\": \"255093256\",\n    \"organization_id\": \"447626438\",\n    \"ip\": \"10.0.0.20\",\n    \"mac\": \"52:53:00:1e:85:93\"\n  }\n}\n201\n{\n  \"ip\": \"10.0.0.20\",\n  \"environment_id\": 334344675,\n  \"environment_name\": \"production\",\n  \"last_report\": null,\n  \"mac\": \"52:53:00:1e:85:93\",\n  \"realm_id\": null,\n  \"realm_name\": null,\n  \"sp_mac\": null,\n  \"sp_ip\": null,\n  \"sp_name\": null,\n  \"domain_id\": 22495316,\n  \"domain_name\": \"mydomain.net\",\n  \"architecture_id\": 501905019,\n  \"architecture_name\": \"x86_64\",\n  \"operatingsystem_id\": 1073012828,\n  \"operatingsystem_name\": \"RHEL 6.1\",\n  \"subnet_id\": null,\n  \"subnet_name\": null,\n  \"sp_subnet_id\": null,\n  \"ptable_id\": 1007981702,\n  \"ptable_name\": \"ptable28\",\n  \"medium_id\": 980190962,\n  \"medium_name\": \"CentOS 5.4\",\n  \"build\": false,\n  \"comment\": null,\n  \"disk\": null,\n  \"installed_at\": null,\n  \"model_id\": null,\n  \"model_name\": null,\n  \"hostgroup_id\": null,\n  \"hostgroup_name\": null,\n  \"owner_id\": 886836129,\n  \"owner_type\": \"User\",\n  \"enabled\": true,\n  \"puppet_ca_proxy_id\": null,\n  \"managed\": true,\n  \"use_image\": null,\n  \"image_file\": \"\",\n  \"uuid\": null,\n  \"compute_resource_id\": 980190962,\n  \"compute_resource_name\": \"bigcompute\",\n  \"compute_profile_id\": null,\n  \"compute_profile_name\": null,\n  \"capabilities\": [\n    \"build\",\n    \"image\"\n  ],\n  \"provision_method\": \"build\",\n  \"puppet_proxy_id\": 980190962,\n  \"certname\": \"testhost11.mydomain.net\",\n  \"image_id\": null,\n  \"image_name\": null,\n  \"created_at\": \"2015-12-01T02:40:40Z\",\n  \"updated_at\": \"2015-12-01T02:40:40Z\",\n  \"last_compile\": null,\n  \"global_status\": 0,\n  \"global_status_label\": \"Warning\",\n  \"organization_id\": 447626438,\n  \"organization_name\": \"Organization 1\",\n  \"location_id\": 255093256,\n  \"location_name\": \"Location 1\",\n  \"puppet_status\": 0,\n  \"configuration_status\": 0,\n  \"configuration_status_label\": \"No reports\",\n  \"build_status\": 0,\n  \"build_status_label\": \"Installed\",\n  \"name\": \"testhost11.mydomain.net\",\n  \"id\": 2,\n  \"parameters\": [],\n  \"interfaces\": [\n    {\n      \"id\": 2,\n      \"name\": \"testhost11.mydomain.net\",\n      \"ip\": \"10.0.0.20\",\n      \"mac\": \"52:53:00:1e:85:93\",\n      \"identifier\": null,\n      \"primary\": true,\n      \"provision\": true,\n      \"type\": \"interface\"\n    }\n  ],\n  \"puppetclasses\": [],\n  \"config_groups\": [],\n  \"all_parameters\": [\n    {\n      \"id\": 716195090,\n      \"name\": \"os1\",\n      \"value\": \"os1\"\n    },\n    {\n      \"id\": 665394701,\n      \"name\": \"parameter\",\n      \"value\": \"value1\"\n    },\n    {\n      \"id\": 513706444,\n      \"name\": \"loc_param\",\n      \"value\": \"abc\"\n    },\n    {\n      \"id\": 840284801,\n      \"name\": \"org_param\",\n      \"value\": \"xyz\"\n    },\n    {\n      \"id\": 636252244,\n      \"name\": \"test\",\n      \"value\": \"myvalue\"\n    }\n  ],\n  \"all_puppetclasses\": []\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true},{"name":"host","full_name":"host","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"host[name]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"location_id","full_name":"host[location_id]","description":"\n\u003Cp\u003Erequired if locations are enabled\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"organization_id","full_name":"host[organization_id]","description":"\n\u003Cp\u003Erequired if organizations are enabled\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"mac","full_name":"host[mac]","description":"\n\u003Cp\u003Erequired for managed host that is bare metal, not required if it\u2019s a virtual machine\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"realm_id","full_name":"host[realm_id]","description":"","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"puppet_proxy_id","full_name":"host[puppet_proxy_id]","description":"","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"puppet_class_ids","full_name":"host[puppet_class_ids]","description":"","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"medium_id","full_name":"host[medium_id]","description":"\n\u003Cp\u003Erequired if not imaged based provisioning and host is managed and value is not inherited from host group\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"root_pass","full_name":"host[root_pass]","description":"\n\u003Cp\u003Erequired if host is managed and value is not inherited from host group or default password in settings\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"model_id","full_name":"host[model_id]","description":"","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"hostgroup_id","full_name":"host[hostgroup_id]","description":"","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"owner_id","full_name":"host[owner_id]","description":"","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"owner_type","full_name":"host[owner_type]","description":"\n\u003Cp\u003EHost\u2019s owner type\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be one of: User, Usergroup.","expected_type":"string","metadata":null,"show":true},{"name":"puppet_ca_proxy_id","full_name":"host[puppet_ca_proxy_id]","description":"","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"image_id","full_name":"host[image_id]","description":"","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"host_parameters_attributes","full_name":"host[host_parameters_attributes]","description":"","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"build","full_name":"host[build]","description":"","required":false,"allow_nil":true,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true},{"name":"enabled","full_name":"host[enabled]","description":"","required":false,"allow_nil":true,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true},{"name":"provision_method","full_name":"host[provision_method]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"managed","full_name":"host[managed]","description":"\n\u003Cp\u003ETrue/False flag whether a host is managed or unmanaged. Note: this value also determines whether several parameters are required or not\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true},{"name":"progress_report_id","full_name":"host[progress_report_id]","description":"\n\u003Cp\u003EUUID to track orchestration tasks status, GET /api/orchestration/:UUID/tasks\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"comment","full_name":"host[comment]","description":"\n\u003Cp\u003EAdditional information about this host\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"capabilities","full_name":"host[capabilities]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"compute_profile_id","full_name":"host[compute_profile_id]","description":"","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"interfaces_attributes","full_name":"host[interfaces_attributes]","description":"\n\u003Cp\u003EHost\u2019s network interfaces.\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be an Array of nested elements","expected_type":"string","metadata":null,"show":true,"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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"ip","full_name":"host[interfaces_attributes][ip]","description":"\n\u003Cp\u003EIP address of interface\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be one of: interface, bmc, bond.","expected_type":"string","metadata":null,"show":true},{"name":"name","full_name":"host[interfaces_attributes][name]","description":"\n\u003Cp\u003EInterface\u2019s DNS name\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"subnet_id","full_name":"host[interfaces_attributes][subnet_id]","description":"\n\u003Cp\u003EForeman subnet ID of interface\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be Fixnum","expected_type":"numeric","metadata":null,"show":true},{"name":"domain_id","full_name":"host[interfaces_attributes][domain_id]","description":"\n\u003Cp\u003EForeman domain ID of interface. Required for primary interfaces on managed hosts.\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be Fixnum","expected_type":"numeric","metadata":null,"show":true},{"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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"managed","full_name":"host[interfaces_attributes][managed]","description":"\n\u003Cp\u003EShould this interface be managed via DHCP and DNS smart proxy and should it be configured during provisioning?\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true},{"name":"primary","full_name":"host[interfaces_attributes][primary]","description":"\n\u003Cp\u003EShould this interface be used for constructing the FQDN of the host? Each managed hosts needs to have one primary interface.\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true},{"name":"provision","full_name":"host[interfaces_attributes][provision]","description":"\n\u003Cp\u003EShould this interface be used for TFTP of PXELinux (or SSH for image-based hosts)? Each managed hosts needs to have one provision interface.\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true},{"name":"username","full_name":"host[interfaces_attributes][username]","description":"\n\u003Cp\u003EOnly for BMC interfaces.\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"password","full_name":"host[interfaces_attributes][password]","description":"\n\u003Cp\u003EOnly for BMC interfaces.\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be one of: IPMI.","expected_type":"string","metadata":null,"show":true},{"name":"virtual","full_name":"host[interfaces_attributes][virtual]","description":"\n\u003Cp\u003EAlias or VLAN device\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true},{"name":"tag","full_name":"host[interfaces_attributes][tag]","description":"\n\u003Cp\u003EVLAN tag, this attribute has precedence over the subnet VLAN ID. Only for virtual interfaces.\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"attached_to","full_name":"host[interfaces_attributes][attached_to]","description":"\n\u003Cp\u003EIdentifier of the interface to which this interface belongs, e.g. eth1. Only for virtual interfaces.\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be one of: balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb.","expected_type":"string","metadata":null,"show":true},{"name":"attached_devices","full_name":"host[interfaces_attributes][attached_devices]","description":"\n\u003Cp\u003EIdentifiers of slave interfaces, e.g. \u003Ccode\u003E[\u0026#39;eth1\u0026#39;, \u0026#39;eth2\u0026#39;]\u003C/code\u003E. Only for bond interfaces.\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be Hash","expected_type":"hash","metadata":null,"show":true}]},{"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,"validator":"Must be Hash","expected_type":"hash","metadata":null,"show":true}]}],"examples":["PUT /api/hosts/host57\n{\n  \"host\": {\n    \"name\": \"testhost11\",\n    \"environment_id\": \"334344675\",\n    \"domain_id\": \"22495316\",\n    \"ptable_id\": \"1007981702\",\n    \"medium_id\": \"980190962\",\n    \"architecture_id\": \"501905019\",\n    \"operatingsystem_id\": \"1073012828\",\n    \"puppet_proxy_id\": \"980190962\",\n    \"compute_resource_id\": \"980190962\",\n    \"root_pass\": \"xybxa6JUkz63w\",\n    \"location_id\": \"255093256\",\n    \"organization_id\": \"447626438\",\n    \"ip\": \"10.0.0.20\",\n    \"mac\": \"52:53:00:1e:85:93\"\n  }\n}\n200\n{\n  \"ip\": \"10.0.0.20\",\n  \"environment_id\": 334344675,\n  \"environment_name\": \"production\",\n  \"last_report\": null,\n  \"mac\": \"52:53:00:1e:85:93\",\n  \"realm_id\": null,\n  \"realm_name\": null,\n  \"sp_mac\": null,\n  \"sp_ip\": null,\n  \"sp_name\": null,\n  \"domain_id\": 22495316,\n  \"domain_name\": \"mydomain.net\",\n  \"architecture_id\": 501905019,\n  \"architecture_name\": \"x86_64\",\n  \"operatingsystem_id\": 1073012828,\n  \"operatingsystem_name\": \"RHEL 6.1\",\n  \"subnet_id\": null,\n  \"subnet_name\": null,\n  \"sp_subnet_id\": null,\n  \"ptable_id\": 1007981702,\n  \"ptable_name\": \"ptable34\",\n  \"medium_id\": 980190962,\n  \"medium_name\": \"CentOS 5.4\",\n  \"build\": false,\n  \"comment\": null,\n  \"disk\": null,\n  \"installed_at\": null,\n  \"model_id\": null,\n  \"model_name\": null,\n  \"hostgroup_id\": null,\n  \"hostgroup_name\": null,\n  \"owner_id\": 886836129,\n  \"owner_type\": \"User\",\n  \"enabled\": true,\n  \"puppet_ca_proxy_id\": null,\n  \"managed\": false,\n  \"use_image\": null,\n  \"image_file\": \"\",\n  \"uuid\": null,\n  \"compute_resource_id\": 980190962,\n  \"compute_resource_name\": \"bigcompute\",\n  \"compute_profile_id\": null,\n  \"compute_profile_name\": null,\n  \"capabilities\": [\n    \"build\",\n    \"image\"\n  ],\n  \"provision_method\": \"build\",\n  \"puppet_proxy_id\": 980190962,\n  \"certname\": \"testhost11.mydomain.net\",\n  \"image_id\": null,\n  \"image_name\": null,\n  \"created_at\": \"2015-12-01T02:40:41Z\",\n  \"updated_at\": \"2015-12-01T02:40:42Z\",\n  \"last_compile\": null,\n  \"global_status\": 0,\n  \"global_status_label\": \"Warning\",\n  \"organization_id\": 447626438,\n  \"organization_name\": \"Organization 1\",\n  \"location_id\": 255093256,\n  \"location_name\": \"Location 1\",\n  \"puppet_status\": 0,\n  \"configuration_status\": 0,\n  \"configuration_status_label\": \"No reports\",\n  \"name\": \"testhost11.mydomain.net\",\n  \"id\": 1,\n  \"parameters\": [],\n  \"interfaces\": [\n    {\n      \"id\": 1,\n      \"name\": \"testhost11.mydomain.net\",\n      \"ip\": \"10.0.0.20\",\n      \"mac\": \"52:53:00:1e:85:93\",\n      \"identifier\": null,\n      \"primary\": true,\n      \"provision\": true,\n      \"type\": \"interface\"\n    }\n  ],\n  \"puppetclasses\": [],\n  \"config_groups\": [],\n  \"all_parameters\": [\n    {\n      \"id\": 716195090,\n      \"name\": \"os1\",\n      \"value\": \"os1\"\n    },\n    {\n      \"id\": 665394701,\n      \"name\": \"parameter\",\n      \"value\": \"value1\"\n    },\n    {\n      \"id\": 513706444,\n      \"name\": \"loc_param\",\n      \"value\": \"abc\"\n    },\n    {\n      \"id\": 840284801,\n      \"name\": \"org_param\",\n      \"value\": \"xyz\"\n    },\n    {\n      \"id\": 636252244,\n      \"name\": \"test\",\n      \"value\": \"myvalue\"\n    }\n  ],\n  \"all_puppetclasses\": []\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true}],"examples":["DELETE /api/hosts/host60\n200\n{\n  \"architecture_id\": null,\n  \"build\": false,\n  \"certname\": \"host60\",\n  \"comment\": null,\n  \"compute_profile_id\": null,\n  \"compute_resource_id\": null,\n  \"created_at\": \"2015-12-01T02:40:42Z\",\n  \"disk\": null,\n  \"enabled\": true,\n  \"environment_id\": null,\n  \"global_status\": 0,\n  \"grub_pass\": \"$1$K/k7e7j0$SjmPcoyHORqCPEB7mfW8a.\",\n  \"hostgroup_id\": null,\n  \"id\": 1,\n  \"image_file\": \"\",\n  \"image_id\": null,\n  \"installed_at\": null,\n  \"last_compile\": null,\n  \"last_report\": null,\n  \"location_id\": null,\n  \"lookup_value_matcher\": \"fqdn=host60\",\n  \"managed\": false,\n  \"medium_id\": null,\n  \"model_id\": null,\n  \"name\": \"host60\",\n  \"operatingsystem_id\": null,\n  \"organization_id\": null,\n  \"otp\": null,\n  \"owner_id\": null,\n  \"owner_type\": null,\n  \"provision_method\": \"build\",\n  \"ptable_id\": null,\n  \"puppet_ca_proxy_id\": null,\n  \"puppet_proxy_id\": null,\n  \"realm_id\": null,\n  \"root_pass\": \"$5$yg2R9HTW$B8lMyxNwtldSsqLkeRSwJ27EARrKEXvL7gicfVwHpc/\",\n  \"updated_at\": \"2015-12-01T02:40:42Z\",\n  \"use_image\": null,\n  \"uuid\": null\n}"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/hosts/status","name":"status","apis":[{"api_url":"/api/hosts/:id/status","http_method":"GET","short_description":"Get configuration status of host","deprecated":null}],"formats":null,"full_description":"\n\u003Cp\u003EReturn value may either be one of the following:\u003C/p\u003E\n\n\u003Cul\u003E\n\u003Cli\u003Emissing\u003C/li\u003E\n\n\u003Cli\u003Efailed\u003C/li\u003E\n\n\u003Cli\u003Epending\u003C/li\u003E\n\n\u003Cli\u003Echanged\u003C/li\u003E\n\n\u003Cli\u003Eunchanged\u003C/li\u003E\n\n\u003Cli\u003Eunreported\u003C/li\u003E\n\u003C/ul\u003E\n","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":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}],"examples":["GET /api/hosts/host61/status\n200\n{\n  \"status\": \"No reports\"\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":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},{"name":"type","full_name":"type","description":"\n\u003Cp\u003Estatus type, can be one of\u003C/p\u003E\n\n\u003Cul\u003E\n\u003Cli\u003Eglobal\u003C/li\u003E\n\n\u003Cli\u003Econfiguration\u003C/li\u003E\n\n\u003Cli\u003Ebuild\u003C/li\u003E\n\u003C/ul\u003E\n","required":true,"allow_nil":false,"validator":"Must be one of: HostStatus::Global, configuration, build.","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/hosts/host62/status/global\n200\n{\n  \"status_label\": \"OK\",\n  \"status\": 0\n}"],"metadata":null,"see":[]},{"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\u2019s compute attributes that can be used to create a clone of this VM\u003C/p\u003E\n","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":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}],"examples":["GET /api/hosts/host79/vm_compute_attributes\n200\n{\n  \"cpus\": 4,\n  \"memory\": null\n}"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/hosts/puppetrun","name":"puppetrun","apis":[{"api_url":"/api/hosts/:id/puppetrun","http_method":"PUT","short_description":"Force a Puppet agent run on the host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":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}],"examples":["PUT /api/hosts/host84/puppetrun\n{\n  \"host\": {}\n}\n200\n{\n  \"architecture_id\": null,\n  \"build\": false,\n  \"certname\": \"host84\",\n  \"comment\": null,\n  \"compute_profile_id\": null,\n  \"compute_resource_id\": null,\n  \"created_at\": \"2015-12-01T02:40:45Z\",\n  \"disk\": null,\n  \"enabled\": true,\n  \"environment_id\": 687036938,\n  \"global_status\": 0,\n  \"grub_pass\": \"$1$J07NTgte$vSYxBg1Cw147VvW67s4by0\",\n  \"hostgroup_id\": null,\n  \"id\": 2,\n  \"image_file\": \"\",\n  \"image_id\": null,\n  \"installed_at\": null,\n  \"last_compile\": null,\n  \"last_report\": null,\n  \"location_id\": null,\n  \"lookup_value_matcher\": \"fqdn=host84\",\n  \"managed\": false,\n  \"medium_id\": null,\n  \"model_id\": null,\n  \"name\": \"host84\",\n  \"operatingsystem_id\": null,\n  \"organization_id\": null,\n  \"otp\": null,\n  \"owner_id\": 135138680,\n  \"owner_type\": \"User\",\n  \"provision_method\": \"build\",\n  \"ptable_id\": null,\n  \"puppet_ca_proxy_id\": null,\n  \"puppet_proxy_id\": 982965214,\n  \"realm_id\": null,\n  \"root_pass\": \"$5$7HU/Zmg+$YW9ZeNVmcULEANtAc38k174srffheYFB9F8KuKUi.c6\",\n  \"updated_at\": \"2015-12-01T02:40:45Z\",\n  \"use_image\": null,\n  \"uuid\": null\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":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}],"examples":["PUT /api/hosts/host82/disassociate\n{\n  \"host\": {}\n}\n200\n{\n  \"ip\": null,\n  \"environment_id\": null,\n  \"environment_name\": null,\n  \"last_report\": null,\n  \"mac\": null,\n  \"realm_id\": null,\n  \"realm_name\": null,\n  \"sp_mac\": null,\n  \"sp_ip\": null,\n  \"sp_name\": null,\n  \"domain_id\": null,\n  \"domain_name\": null,\n  \"architecture_id\": null,\n  \"architecture_name\": null,\n  \"operatingsystem_id\": null,\n  \"operatingsystem_name\": null,\n  \"subnet_id\": null,\n  \"subnet_name\": null,\n  \"sp_subnet_id\": null,\n  \"ptable_id\": null,\n  \"ptable_name\": null,\n  \"medium_id\": null,\n  \"medium_name\": null,\n  \"build\": false,\n  \"comment\": null,\n  \"disk\": null,\n  \"installed_at\": null,\n  \"model_id\": null,\n  \"model_name\": null,\n  \"hostgroup_id\": null,\n  \"hostgroup_name\": null,\n  \"owner_id\": null,\n  \"owner_type\": null,\n  \"enabled\": true,\n  \"puppet_ca_proxy_id\": null,\n  \"managed\": false,\n  \"use_image\": null,\n  \"image_file\": \"\",\n  \"uuid\": null,\n  \"compute_resource_id\": null,\n  \"compute_resource_name\": null,\n  \"compute_profile_id\": null,\n  \"compute_profile_name\": null,\n  \"capabilities\": [\n    \"build\"\n  ],\n  \"provision_method\": \"build\",\n  \"puppet_proxy_id\": null,\n  \"certname\": \"host82\",\n  \"image_id\": null,\n  \"image_name\": null,\n  \"created_at\": \"2015-12-01T02:40:45Z\",\n  \"updated_at\": \"2015-12-01T02:40:45Z\",\n  \"last_compile\": null,\n  \"global_status\": 0,\n  \"global_status_label\": \"OK\",\n  \"organization_id\": null,\n  \"organization_name\": null,\n  \"location_id\": null,\n  \"location_name\": null,\n  \"puppet_status\": 0,\n  \"name\": \"host82\",\n  \"id\": 2,\n  \"parameters\": [],\n  \"interfaces\": [\n    {\n      \"id\": 2,\n      \"name\": \"host82\",\n      \"ip\": null,\n      \"mac\": null,\n      \"identifier\": null,\n      \"primary\": true,\n      \"provision\": true,\n      \"type\": \"interface\"\n    }\n  ],\n  \"puppetclasses\": [],\n  \"config_groups\": [],\n  \"all_parameters\": [\n    {\n      \"id\": 636252244,\n      \"name\": \"test\",\n      \"value\": \"myvalue\"\n    }\n  ],\n  \"all_puppetclasses\": []\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":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},{"name":"power_action","full_name":"power_action","description":"\n\u003Cp\u003Epower action, valid actions are (on/start), (off/stop), (soft/reboot), (cycle/reset), (state/status)\u003C/p\u003E\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["PUT /api/hosts/host104.example9.com/power\n{\n  \"power_action\": \"status\",\n  \"host\": {}\n}\n200\n{\n  \"power\": \"on\"\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":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},{"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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["PUT /api/hosts/host116.example12.com/boot\n{\n  \"device\": \"bios\",\n  \"host\": {}\n}\n200\n{\n  \"boot\": \"{\\\"action\\\":\\\"bios\\\",\\\"result\\\":true}\"\n}"],"metadata":null,"see":[]},{"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":"name","full_name":"name","description":"\n\u003Cp\u003Ehostname of the host\u003C/p\u003E\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"facts","full_name":"facts","description":"\n\u003Cp\u003Ehash containing the facts for the host\u003C/p\u003E\n","required":true,"allow_nil":false,"validator":"Must be Hash","expected_type":"hash","metadata":null,"show":true},{"name":"certname","full_name":"certname","description":"\n\u003Cp\u003Eoptional: certname of the host\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["POST /api/hosts/facts\n{\n  \"name\": \"brslc022.brs.infineon.com\",\n  \"facts\": {\n    \"is_virtual\": \"true\",\n    \"processorcount\": \"2\",\n    \"serialnumber\": \"VMware-56 4d 15 06 72 86 a9 d3-8a 09 fc 27 5a cf 00 45\",\n    \"kernel\": \"Linux\",\n    \"virtual\": \"vmware\",\n    \"_timestamp\": \"2010-02-16 12:52:38.163833 +01:00\",\n    \"network_eth0\": \"172.29.205.0\",\n    \"operatingsystemrelease\": \"4\",\n    \"uniqueid\": \"1dac16cd\",\n    \"hardwaremodel\": \"i686\",\n    \"rubysitedir\": \"/usr/lib/site_ruby/1.8\",\n    \"platform\": \"Linux_2.6_i386_all\",\n    \"uptime_seconds\": \"3756\",\n    \"lsbrelease\": \":core-3.0-ia32:core-3.0-noarch:graphics-3.0-ia32:graphics-3.0-noarch\",\n    \"memorysize\": \"1.45 GB\",\n    \"gi\": \"4\",\n    \"netmask_eth0\": \"255.255.255.128\",\n    \"ipaddress\": \"172.29.205.22\",\n    \"physicalprocessorcount\": \"0\",\n    \"swapfree\": \"1.95 GB\",\n    \"vmware\": \"virtual\",\n    \"netmask\": \"255.255.255.128\",\n    \"clientversion\": \"0.24.8\",\n    \"fqdn\": \"brslc022.brs.infineon.com\",\n    \"timezone\": \"GMT\",\n    \"ps\": \"ps -ef\",\n    \"kernelrelease\": \"2.6.9-89.0.16.ELsmp\",\n    \"hardwareisa\": \"i686\",\n    \"domain\": \"brs.infineon.com\",\n    \"type\": \"Other\",\n    \"kernelversion\": \"2.6.9\",\n    \"id\": \"root\",\n    \"lsbdistdescription\": \"Red Hat Enterprise Linux AS release 4 (Nahant Update 8)\",\n    \"uptime_hours\": \"1\",\n    \"lsbdistrelease\": \"4\",\n    \"macaddress_eth0\": \"00:0C:29:CF:00:45\",\n    \"manufacturer\": \"VMware, Inc.\",\n    \"memoryfree\": \"1.39 GB\",\n    \"selinux\": \"false\",\n    \"gateway_if\": \"eth0\",\n    \"lsbdistcodename\": \"NahantUpdate8\",\n    \"sshrsakey\": \"AAAAB3NzaC1yc2EAAAABIwAAAIEAyj0XAKzx4WlNE8Vzj0ABBEHxqHr2H4AZZnabnQkYTOfz5kObXL+BvYqPONg2EqeUYCTNaFtQQPpJ4H+TM+GCJDNvFEKJTRd+cFoOuramf9LunWN/+ETreQ5V8KhKvdYTNw5blPBKiQz/XxSxcm7beo5QiBVr/lOM0u8YhGTLawk=\",\n    \"uptime_days\": \"0\",\n    \"interfaces\": \"eth0\",\n    \"hostname\": \"brslc022\",\n    \"graphcard\": \"VMware\",\n    \"uptime\": \"1:02 hours\",\n    \"processor0\": \"Intel(R) Xeon(R) CPU           X5460  @ 3.16GHz\",\n    \"puppetversion\": \"0.24.8\",\n    \"productname\": \"VMware Virtual Platform\",\n    \"architecture\": \"i386\",\n    \"gateway\": \"172.29.205.1\",\n    \"rubyversion\": \"1.8.1\",\n    \"environment\": \"brs_test\",\n    \"path\": \"/usr/bin:/sbin:/bin:/usr/sbin:/opt/csw/bin\",\n    \"swapsize\": \"1.95 GB\",\n    \"ipaddress_eth0\": \"172.29.205.22\",\n    \"facterversion\": \"1.5.7\",\n    \"kernelmajversion\": \"2.6\",\n    \"operatingsystem\": \"RedHat\",\n    \"macaddress\": \"00:0C:29:CF:00:45\",\n    \"processor1\": \"Intel(R) Xeon(R) CPU           X5460  @ 3.16GHz\",\n    \"lsbmajdistrelease\": \"4\",\n    \"sshdsakey\": \"AAAAB3NzaC1kc3MAAACBAIUasO2eEvlRHfcO8wMPfbo98YfgVsJj0qhUDSSoSa6xmYI8QWBDMoxf1h8INiDfrNQ5e4VreLQjt4/2Ex7OXoeB7C9Cg18/TlfZU+RTNMdsL85W5hQrrKoBm+ksMnxidkDC66ROq+pmxBTGDwwxg3ugF8eZnVSzCZ1FE605AsStAAAAFQCrr3s1cLQFRc6oZJAx3EZDxDraCQAAAIBqIqIvY7KtRsI+8y8E5MSZXpRRZxf0zqbraDxASwzImUr6ysEmpJsHbHyi6UePnF55tG/iZNM4bSNg/3qExK8So040byV71qN4HNT48nIh3cCS0z8oKLqvlCRJ+dOY1QMkE8ZLfOyF4A6ZOTuE8TTsGpvUIR0HyXkpoiIR9XcgzgAAAIA4nkedBQi+VA01NvWx27GGz5P3TTQ36yDODZdLmXoepQM1rPfKWvPFFd5MxgJumSU5BKhYUiQTOImcRlQcY5DA3dGbog1dOAKlWyeJn4WRHbYr+VNgR/HwBzHLMW4TXLt38ThmPv9TiLS1RvTdHuDm2oRTadNZOrmQz619kZejmw==\",\n    \"lsbdistid\": \"RedHatEnterpriseAS\"\n  },\n  \"host\": {\n    \"name\": \"brslc022.brs.infineon.com\"\n  }\n}\n500\n{\n  \"error\": {\n    \"message\": \"SQLite3::SQLException: table domains has no column named total_hosts: INSERT INTO \\\"domains\\\" (\\\"created_at\\\", \\\"dns_id\\\", \\\"fullname\\\", \\\"hostgroups_count\\\", \\\"name\\\", \\\"total_hosts\\\", \\\"updated_at\\\") VALUES (?, ?, ?, ?, ?, ?, ?)\"\n  }\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":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}],"examples":["POST /api/hosts/host101/rebuild_config\n{\n  \"host\": {}\n}\n200\n{\n  \"message\": \"Configuration successfully rebuilt.\"\n}"],"metadata":null,"see":[]}]},"interfaces":{"doc_url":"../apidoc/v2/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":"host_id","full_name":"host_id","description":"\n\u003Cp\u003EID or name of host\u003C/p\u003E\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"domain_id","full_name":"domain_id","description":"\n\u003Cp\u003EID or name of domain\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003Cp\u003EID or name of subnet\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003Cp\u003Epaginate results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003Cp\u003Enumber of entries per request\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/hosts/host109/interfaces\n200\n{\n  \"total\": 2,\n  \"subtotal\": 2,\n  \"page\": 1,\n  \"per_page\": 20,\n  \"search\": null,\n  \"sort\": {\n    \"by\": null,\n    \"order\": null\n  },\n  \"results\": [\n    {\n      \"subnet_id\": null,\n      \"subnet_name\": null,\n      \"domain_id\": null,\n      \"domain_name\": null,\n      \"created_at\": \"2015-12-01T02:40:51Z\",\n      \"updated_at\": \"2015-12-01T02:40:51Z\",\n      \"managed\": true,\n      \"identifier\": null,\n      \"id\": 1,\n      \"name\": \"host109\",\n      \"ip\": null,\n      \"mac\": null,\n      \"primary\": true,\n      \"provision\": true,\n      \"type\": \"interface\",\n      \"virtual\": false\n    },\n    {\n      \"subnet_id\": null,\n      \"subnet_name\": null,\n      \"domain_id\": null,\n      \"domain_name\": null,\n      \"created_at\": \"2015-12-01T02:40:51Z\",\n      \"updated_at\": \"2015-12-01T02:40:51Z\",\n      \"managed\": true,\n      \"identifier\": \"eth1\",\n      \"id\": 2,\n      \"name\": null,\n      \"ip\": \"0.0.0.1\",\n      \"mac\": \"01:23:45:ab:00:01\",\n      \"primary\": false,\n      \"provision\": false,\n      \"type\": \"interface\",\n      \"virtual\": false\n    }\n  ]\n}"],"metadata":null,"see":[]},{"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":"host_id","full_name":"host_id","description":"\n\u003Cp\u003EID or name of host\u003C/p\u003E\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"id","full_name":"id","description":"\n\u003Cp\u003EID or name of interface\u003C/p\u003E\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/hosts/host110/interfaces/2\n200\n{\n  \"subnet_id\": null,\n  \"subnet_name\": null,\n  \"domain_id\": null,\n  \"domain_name\": null,\n  \"created_at\": \"2015-12-01T02:40:52Z\",\n  \"updated_at\": \"2015-12-01T02:40:52Z\",\n  \"managed\": true,\n  \"identifier\": \"eth2\",\n  \"id\": 2,\n  \"name\": null,\n  \"ip\": \"0.0.0.2\",\n  \"mac\": \"01:23:45:ab:00:02\",\n  \"primary\": false,\n  \"provision\": false,\n  \"type\": \"interface\",\n  \"virtual\": false\n}"],"metadata":null,"see":[]},{"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":"host_id","full_name":"host_id","description":"\n\u003Cp\u003EID or name of host\u003C/p\u003E\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"interface","full_name":"interface","description":"\n\u003Cp\u003Einterface information\u003C/p\u003E\n","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"ip","full_name":"interface[ip]","description":"\n\u003Cp\u003EIP address of interface\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be one of: interface, bmc, bond.","expected_type":"string","metadata":null,"show":true},{"name":"name","full_name":"interface[name]","description":"\n\u003Cp\u003EInterface\u2019s DNS name\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"subnet_id","full_name":"interface[subnet_id]","description":"\n\u003Cp\u003EForeman subnet ID of interface\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be Fixnum","expected_type":"numeric","metadata":null,"show":true},{"name":"domain_id","full_name":"interface[domain_id]","description":"\n\u003Cp\u003EForeman domain ID of interface. Required for primary interfaces on managed hosts.\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be Fixnum","expected_type":"numeric","metadata":null,"show":true},{"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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"managed","full_name":"interface[managed]","description":"\n\u003Cp\u003EShould this interface be managed via DHCP and DNS smart proxy and should it be configured during provisioning?\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true},{"name":"primary","full_name":"interface[primary]","description":"\n\u003Cp\u003EShould this interface be used for constructing the FQDN of the host? Each managed hosts needs to have one primary interface.\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true},{"name":"provision","full_name":"interface[provision]","description":"\n\u003Cp\u003EShould this interface be used for TFTP of PXELinux (or SSH for image-based hosts)? Each managed hosts needs to have one provision interface.\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true},{"name":"username","full_name":"interface[username]","description":"\n\u003Cp\u003EOnly for BMC interfaces.\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"password","full_name":"interface[password]","description":"\n\u003Cp\u003EOnly for BMC interfaces.\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be one of: IPMI.","expected_type":"string","metadata":null,"show":true},{"name":"virtual","full_name":"interface[virtual]","description":"\n\u003Cp\u003EAlias or VLAN device\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true},{"name":"tag","full_name":"interface[tag]","description":"\n\u003Cp\u003EVLAN tag, this attribute has precedence over the subnet VLAN ID. Only for virtual interfaces.\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"attached_to","full_name":"interface[attached_to]","description":"\n\u003Cp\u003EIdentifier of the interface to which this interface belongs, e.g. eth1. Only for virtual interfaces.\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be one of: balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb.","expected_type":"string","metadata":null,"show":true},{"name":"attached_devices","full_name":"interface[attached_devices]","description":"\n\u003Cp\u003EIdentifiers of slave interfaces, e.g. \u003Ccode\u003E[\u0026#39;eth1\u0026#39;, \u0026#39;eth2\u0026#39;]\u003C/code\u003E. Only for bond interfaces.\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be Hash","expected_type":"hash","metadata":null,"show":true}]}],"examples":["POST /api/hosts/host111/interfaces\n{\n  \"interface\": {\n    \"name\": \"test.foreman.com\",\n    \"ip\": \"10.0.1.1\",\n    \"mac\": \"AA:AA:AA:AA:AA:AA\",\n    \"username\": \"foo\",\n    \"password\": \"bar\",\n    \"provider\": \"IPMI\",\n    \"type\": \"Nic::BMC\"\n  }\n}\n201\n{\n  \"subnet_id\": null,\n  \"subnet_name\": null,\n  \"domain_id\": null,\n  \"domain_name\": null,\n  \"created_at\": \"2015-12-01T02:40:52Z\",\n  \"updated_at\": \"2015-12-01T02:40:52Z\",\n  \"managed\": true,\n  \"identifier\": null,\n  \"id\": 3,\n  \"name\": \"test.foreman.com\",\n  \"ip\": \"10.0.1.1\",\n  \"mac\": \"aa:aa:aa:aa:aa:aa\",\n  \"primary\": false,\n  \"provision\": false,\n  \"type\": \"bmc\",\n  \"username\": \"foo\",\n  \"password\": \"bar\",\n  \"provider\": \"IPMI\",\n  \"virtual\": false\n}"],"metadata":null,"see":[]},{"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":"host_id","full_name":"host_id","description":"\n\u003Cp\u003EID or name of host\u003C/p\u003E\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"id","full_name":"id","description":"\n\u003Cp\u003EID of interface\u003C/p\u003E\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true},{"name":"interface","full_name":"interface","description":"\n\u003Cp\u003Einterface information\u003C/p\u003E\n","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"ip","full_name":"interface[ip]","description":"\n\u003Cp\u003EIP address of interface\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be one of: interface, bmc, bond.","expected_type":"string","metadata":null,"show":true},{"name":"name","full_name":"interface[name]","description":"\n\u003Cp\u003EInterface\u2019s DNS name\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"subnet_id","full_name":"interface[subnet_id]","description":"\n\u003Cp\u003EForeman subnet ID of interface\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be Fixnum","expected_type":"numeric","metadata":null,"show":true},{"name":"domain_id","full_name":"interface[domain_id]","description":"\n\u003Cp\u003EForeman domain ID of interface. Required for primary interfaces on managed hosts.\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be Fixnum","expected_type":"numeric","metadata":null,"show":true},{"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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"managed","full_name":"interface[managed]","description":"\n\u003Cp\u003EShould this interface be managed via DHCP and DNS smart proxy and should it be configured during provisioning?\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true},{"name":"primary","full_name":"interface[primary]","description":"\n\u003Cp\u003EShould this interface be used for constructing the FQDN of the host? Each managed hosts needs to have one primary interface.\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true},{"name":"provision","full_name":"interface[provision]","description":"\n\u003Cp\u003EShould this interface be used for TFTP of PXELinux (or SSH for image-based hosts)? Each managed hosts needs to have one provision interface.\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true},{"name":"username","full_name":"interface[username]","description":"\n\u003Cp\u003EOnly for BMC interfaces.\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"password","full_name":"interface[password]","description":"\n\u003Cp\u003EOnly for BMC interfaces.\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be one of: IPMI.","expected_type":"string","metadata":null,"show":true},{"name":"virtual","full_name":"interface[virtual]","description":"\n\u003Cp\u003EAlias or VLAN device\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true},{"name":"tag","full_name":"interface[tag]","description":"\n\u003Cp\u003EVLAN tag, this attribute has precedence over the subnet VLAN ID. Only for virtual interfaces.\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"attached_to","full_name":"interface[attached_to]","description":"\n\u003Cp\u003EIdentifier of the interface to which this interface belongs, e.g. eth1. Only for virtual interfaces.\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be one of: balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb.","expected_type":"string","metadata":null,"show":true},{"name":"attached_devices","full_name":"interface[attached_devices]","description":"\n\u003Cp\u003EIdentifiers of slave interfaces, e.g. \u003Ccode\u003E[\u0026#39;eth1\u0026#39;, \u0026#39;eth2\u0026#39;]\u003C/code\u003E. Only for bond interfaces.\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be Hash","expected_type":"hash","metadata":null,"show":true}]}],"examples":["PUT /api/hosts/host115/interfaces/2\n{\n  \"interface\": {\n    \"name\": \"test.foreman.com\",\n    \"ip\": \"10.0.1.1\",\n    \"mac\": \"AA:AA:AA:AA:AA:AA\",\n    \"username\": \"foo\",\n    \"password\": \"bar\",\n    \"provider\": \"IPMI\",\n    \"type\": \"Nic::BMC\",\n    \"host_id\": \"1\"\n  }\n}\n200\n{\n  \"subnet_id\": null,\n  \"subnet_name\": null,\n  \"domain_id\": null,\n  \"domain_name\": null,\n  \"created_at\": \"2015-12-01T02:40:52Z\",\n  \"updated_at\": \"2015-12-01T02:40:52Z\",\n  \"managed\": true,\n  \"identifier\": \"eth7\",\n  \"id\": 2,\n  \"name\": \"test.foreman.com\",\n  \"ip\": \"10.0.1.1\",\n  \"mac\": \"aa:aa:aa:aa:aa:aa\",\n  \"primary\": false,\n  \"provision\": false,\n  \"type\": \"interface\",\n  \"username\": \"foo\",\n  \"password\": \"bar\",\n  \"provider\": \"IPMI\",\n  \"virtual\": false\n}"],"metadata":null,"see":[]},{"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":"host_id","full_name":"host_id","description":"\n\u003Cp\u003EID or name of host\u003C/p\u003E\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"id","full_name":"id","description":"\n\u003Cp\u003EID of interface\u003C/p\u003E\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["DELETE /api/hosts/host116/interfaces/2\n200\n{\n  \"attached_devices\": \"\",\n  \"attached_to\": \"\",\n  \"attrs\": {},\n  \"bond_options\": \"\",\n  \"compute_attributes\": {},\n  \"created_at\": \"2015-12-01T02:40:52Z\",\n  \"domain_id\": null,\n  \"host_id\": 1,\n  \"id\": 2,\n  \"identifier\": \"eth8\",\n  \"ip\": \"0.0.0.8\",\n  \"link\": true,\n  \"mac\": \"01:23:45:ab:00:08\",\n  \"managed\": true,\n  \"mode\": \"balance-rr\",\n  \"name\": null,\n  \"password\": null,\n  \"primary\": false,\n  \"provider\": null,\n  \"provision\": false,\n  \"subnet_id\": null,\n  \"tag\": \"\",\n  \"updated_at\": \"2015-12-01T02:40:52Z\",\n  \"username\": null,\n  \"virtual\": false\n}"],"metadata":null,"see":[]}]},"roles":{"doc_url":"../apidoc/v2/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":"search","full_name":"search","description":"\n\u003Cp\u003Efilter results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003Cp\u003Esort results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003Cp\u003Epaginate results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003Cp\u003Enumber of entries per request\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/roles\n200\n{\n  \"total\": 12,\n  \"subtotal\": 12,\n  \"page\": 1,\n  \"per_page\": 20,\n  \"search\": null,\n  \"sort\": {\n    \"by\": null,\n    \"order\": null\n  },\n  \"results\": [\n    {\n      \"builtin\": 0,\n      \"name\": \"Manager\",\n      \"id\": 1\n    },\n    {\n      \"builtin\": 0,\n      \"name\": \"Edit partition tables\",\n      \"id\": 2\n    },\n    {\n      \"builtin\": 0,\n      \"name\": \"View hosts\",\n      \"id\": 3\n    },\n    {\n      \"builtin\": 0,\n      \"name\": \"Edit hosts\",\n      \"id\": 4\n    },\n    {\n      \"builtin\": 0,\n      \"name\": \"Viewer\",\n      \"id\": 5\n    },\n    {\n      \"builtin\": 1,\n      \"name\": \"Default user\",\n      \"id\": 6\n    },\n    {\n      \"builtin\": 2,\n      \"name\": \"Anonymous\",\n      \"id\": 7\n    },\n    {\n      \"builtin\": 0,\n      \"name\": \"Destroy hosts\",\n      \"id\": 8\n    },\n    {\n      \"builtin\": 0,\n      \"name\": \"Create hosts\",\n      \"id\": 9\n    },\n    {\n      \"builtin\": 0,\n      \"name\": \"No rights\",\n      \"id\": 10\n    },\n    {\n      \"builtin\": 0,\n      \"name\": \"View compute resources\",\n      \"id\": 11\n    },\n    {\n      \"builtin\": 0,\n      \"name\": \"CRUD hosts\",\n      \"id\": 12\n    }\n  ]\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/roles/1-Manager\n200\n{\n  \"builtin\": 0,\n  \"name\": \"Manager\",\n  \"id\": 1,\n  \"filters\": [\n    {\n      \"id\": 139728896\n    },\n    {\n      \"id\": 170801529\n    },\n    {\n      \"id\": 222559602\n    },\n    {\n      \"id\": 225912082\n    },\n    {\n      \"id\": 255448041\n    },\n    {\n      \"id\": 291325508\n    },\n    {\n      \"id\": 321349837\n    },\n    {\n      \"id\": 340438230\n    },\n    {\n      \"id\": 343831726\n    },\n    {\n      \"id\": 372277853\n    },\n    {\n      \"id\": 503111935\n    },\n    {\n      \"id\": 528928374\n    },\n    {\n      \"id\": 557298380\n    },\n    {\n      \"id\": 592288835\n    },\n    {\n      \"id\": 595149887\n    },\n    {\n      \"id\": 643462867\n    },\n    {\n      \"id\": 679608033\n    },\n    {\n      \"id\": 721145960\n    },\n    {\n      \"id\": 943645556\n    },\n    {\n      \"id\": 977587707\n    },\n    {\n      \"id\": 980424071\n    },\n    {\n      \"id\": 1026099682\n    },\n    {\n      \"id\": 1062414187\n    }\n  ]\n}"],"metadata":null,"see":[]},{"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":"role","full_name":"role","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"role[name]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}]}],"examples":["POST /api/roles\n{\n  \"role\": {\n    \"name\": \"staff\"\n  }\n}\n201\n{\n  \"builtin\": 0,\n  \"name\": \"staff\",\n  \"id\": 13,\n  \"filters\": []\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"role","full_name":"role","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"role[name]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}]}],"examples":["PUT /api/roles/1-Manager\n{\n  \"role\": {\n    \"name\": \"staff\"\n  }\n}\n200\n{\n  \"builtin\": 0,\n  \"name\": \"staff\",\n  \"id\": 1,\n  \"filters\": [\n    {\n      \"id\": 139728896\n    },\n    {\n      \"id\": 170801529\n    },\n    {\n      \"id\": 222559602\n    },\n    {\n      \"id\": 225912082\n    },\n    {\n      \"id\": 255448041\n    },\n    {\n      \"id\": 291325508\n    },\n    {\n      \"id\": 321349837\n    },\n    {\n      \"id\": 340438230\n    },\n    {\n      \"id\": 343831726\n    },\n    {\n      \"id\": 372277853\n    },\n    {\n      \"id\": 503111935\n    },\n    {\n      \"id\": 528928374\n    },\n    {\n      \"id\": 557298380\n    },\n    {\n      \"id\": 592288835\n    },\n    {\n      \"id\": 595149887\n    },\n    {\n      \"id\": 643462867\n    },\n    {\n      \"id\": 679608033\n    },\n    {\n      \"id\": 721145960\n    },\n    {\n      \"id\": 943645556\n    },\n    {\n      \"id\": 977587707\n    },\n    {\n      \"id\": 980424071\n    },\n    {\n      \"id\": 1026099682\n    },\n    {\n      \"id\": 1062414187\n    }\n  ]\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["DELETE /api/roles/1-Manager\n200\n{\n  \"builtin\": 0,\n  \"id\": 1,\n  \"name\": \"Manager\",\n  \"permissions\": []\n}"],"metadata":null,"see":[]}]},"architectures":{"doc_url":"../apidoc/v2/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":"search","full_name":"search","description":"\n\u003Cp\u003Efilter results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003Cp\u003Esort results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003Cp\u003Epaginate results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003Cp\u003Enumber of entries per request\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003Cp\u003EID of operating system\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/architectures\n200\n{\n  \"total\": 3,\n  \"subtotal\": 3,\n  \"page\": 1,\n  \"per_page\": 20,\n  \"search\": null,\n  \"sort\": {\n    \"by\": null,\n    \"order\": null\n  },\n  \"results\": [\n    {\n      \"created_at\": \"2015-12-01T02:40:01Z\",\n      \"updated_at\": \"2015-12-01T02:40:01Z\",\n      \"name\": \"sparc\",\n      \"id\": 331892513\n    },\n    {\n      \"created_at\": \"2015-12-01T02:40:01Z\",\n      \"updated_at\": \"2015-12-01T02:40:01Z\",\n      \"name\": \"s390\",\n      \"id\": 381564594\n    },\n    {\n      \"created_at\": \"2015-12-01T02:40:01Z\",\n      \"updated_at\": \"2015-12-01T02:40:01Z\",\n      \"name\": \"x86_64\",\n      \"id\": 501905019\n    }\n  ]\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/architectures/501905019-x86_64\n200\n{\n  \"created_at\": \"2015-12-01T02:40:01Z\",\n  \"updated_at\": \"2015-12-01T02:40:01Z\",\n  \"name\": \"x86_64\",\n  \"id\": 501905019,\n  \"operatingsystems\": [\n    {\n      \"id\": 1073012828,\n      \"name\": \"Redhat\",\n      \"title\": \"RHEL 6.1\"\n    },\n    {\n      \"id\": 331303656,\n      \"name\": \"Ubuntu\",\n      \"title\": \"Ubuntu 10.10\"\n    },\n    {\n      \"id\": 309172073,\n      \"name\": \"centos\",\n      \"title\": \"centos 5.3\"\n    }\n  ],\n  \"images\": [\n    {\n      \"id\": 298486374,\n      \"name\": \"centos-2\"\n    },\n    {\n      \"id\": 980190962,\n      \"name\": \"centos-1\"\n    }\n  ]\n}"],"metadata":null,"see":[]},{"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":"architecture","full_name":"architecture","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"architecture[name]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"operatingsystem_ids","full_name":"architecture[operatingsystem_ids]","description":"\n\u003Cp\u003EOperating system IDs\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":["POST /api/architectures\n{\n  \"architecture\": {\n    \"name\": \"i386\"\n  }\n}\n201\n{\n  \"created_at\": \"2015-12-01T02:40:28Z\",\n  \"updated_at\": \"2015-12-01T02:40:28Z\",\n  \"name\": \"i386\",\n  \"id\": 501905020,\n  \"operatingsystems\": [],\n  \"images\": []\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true},{"name":"architecture","full_name":"architecture","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"architecture[name]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"operatingsystem_ids","full_name":"architecture[operatingsystem_ids]","description":"\n\u003Cp\u003EOperating system IDs\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":["PUT /api/architectures/501905019-x86_64\n{\n  \"architecture\": {\n    \"name\": \"newx86_64\"\n  }\n}\n200\n{\n  \"created_at\": \"2015-12-01T02:40:01Z\",\n  \"updated_at\": \"2015-12-01T02:40:28Z\",\n  \"name\": \"newx86_64\",\n  \"id\": 501905019,\n  \"operatingsystems\": [\n    {\n      \"id\": 1073012828,\n      \"name\": \"Redhat\",\n      \"title\": \"RHEL 6.1\"\n    },\n    {\n      \"id\": 331303656,\n      \"name\": \"Ubuntu\",\n      \"title\": \"Ubuntu 10.10\"\n    },\n    {\n      \"id\": 309172073,\n      \"name\": \"centos\",\n      \"title\": \"centos 5.3\"\n    }\n  ],\n  \"images\": [\n    {\n      \"id\": 298486374,\n      \"name\": \"centos-2\"\n    },\n    {\n      \"id\": 980190962,\n      \"name\": \"centos-1\"\n    }\n  ]\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true}],"examples":["DELETE /api/architectures/381564594-s390\n200\n{\n  \"created_at\": \"2015-12-01T02:40:01Z\",\n  \"hostgroups_count\": 0,\n  \"hosts_count\": 0,\n  \"id\": 381564594,\n  \"name\": \"s390\",\n  \"updated_at\": \"2015-12-01T02:40:01Z\"\n}"],"metadata":null,"see":[]}]},"autosign":{"doc_url":"../apidoc/v2/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":[],"examples":["GET /api/smart_proxies/182953976/autosign\n200\n{\n  \"results\": [\n    \"a5809524-82fe-a8a4f3d6ebf4\",\n    \"5eed0cb7-9aa-00b7b9780f20\"\n  ]\n}"],"metadata":null,"see":[]}]},"common_parameters":{"doc_url":"../apidoc/v2/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":"search","full_name":"search","description":"\n\u003Cp\u003Efilter results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003Cp\u003Esort results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003Cp\u003Epaginate results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003Cp\u003Enumber of entries per request\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/common_parameters\n200\n{\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\": [\n    {\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"hidden_value\": \"*****\",\n      \"id\": 636252244,\n      \"name\": \"test\",\n      \"value\": \"myvalue\"\n    }\n  ]\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/common_parameters/636252244-test\n200\n{\n  \"created_at\": \"2015-12-01T02:40:02Z\",\n  \"updated_at\": \"2015-12-01T02:40:02Z\",\n  \"hidden_value\": \"*****\",\n  \"id\": 636252244,\n  \"name\": \"test\",\n  \"value\": \"myvalue\"\n}"],"metadata":null,"see":[]},{"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":"common_parameter","full_name":"common_parameter","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"common_parameter[name]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"value","full_name":"common_parameter[value]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"hidden_value","full_name":"common_parameter[hidden_value]","description":"","required":false,"allow_nil":true,"validator":"Must be one of: true, false.","expected_type":"string","metadata":null,"show":true}]}],"examples":["POST /api/common_parameters\n{\n  \"common_parameter\": {\n    \"name\": \"special_key\",\n    \"value\": \"123\"\n  }\n}\n201\n{\n  \"created_at\": \"2015-12-01T02:40:30Z\",\n  \"updated_at\": \"2015-12-01T02:40:30Z\",\n  \"hidden_value\": \"*****\",\n  \"id\": 840284802,\n  \"name\": \"special_key\",\n  \"value\": \"123\"\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true},{"name":"common_parameter","full_name":"common_parameter","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"common_parameter[name]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"value","full_name":"common_parameter[value]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"hidden_value","full_name":"common_parameter[hidden_value]","description":"","required":false,"allow_nil":true,"validator":"Must be one of: true, false.","expected_type":"string","metadata":null,"show":true}]}],"examples":["PUT /api/common_parameters/636252244-test\n{\n  \"common_parameter\": {\n    \"name\": \"special_key\",\n    \"value\": \"123\"\n  }\n}\n200\n{\n  \"created_at\": \"2015-12-01T02:40:02Z\",\n  \"updated_at\": \"2015-12-01T02:40:30Z\",\n  \"hidden_value\": \"*****\",\n  \"id\": 636252244,\n  \"name\": \"special_key\",\n  \"value\": \"123\"\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true}],"examples":["DELETE /api/common_parameters/636252244-test\n200\n{\n  \"created_at\": \"2015-12-01T02:40:02Z\",\n  \"hidden_value\": \"*****\",\n  \"id\": 636252244,\n  \"name\": \"test\",\n  \"priority\": 0,\n  \"reference_id\": null,\n  \"updated_at\": \"2015-12-01T02:40:02Z\",\n  \"value\": \"myvalue\"\n}"],"metadata":null,"see":[]}]},"compute_attributes":{"doc_url":"../apidoc/v2/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/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":"compute_profile_id","full_name":"compute_profile_id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true},{"name":"compute_attribute","full_name":"compute_attribute","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"vm_attrs","full_name":"compute_attribute[vm_attrs]","description":"","required":true,"allow_nil":false,"validator":"Must be Hash","expected_type":"hash","metadata":null,"show":true}]}],"examples":["POST /api/compute_profiles/113629430/compute_resources/980190962/compute_attributes\n{\n  \"compute_attribute\": {\n    \"vm_attrs\": {\n      \"cpus\": \"2\",\n      \"memory\": \"2147483648\"\n    },\n    \"compute_profile_id\": \"113629430\",\n    \"compute_resource_id\": \"980190962\"\n  }\n}\n201\n{\n  \"created_at\": \"2015-12-01T02:40:30Z\",\n  \"updated_at\": \"2015-12-01T02:40:30Z\",\n  \"id\": 980190963,\n  \"name\": null,\n  \"compute_resource_id\": 980190962,\n  \"compute_resource_name\": \"bigcompute\",\n  \"compute_profile_id\": 113629430,\n  \"compute_profile_name\": \"3-Large\",\n  \"vm_attrs\": {\n    \"cpus\": \"2\",\n    \"memory\": \"2147483648\"\n  }\n}"],"metadata":null,"see":[]},{"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":"compute_profile_id","full_name":"compute_profile_id","description":"","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"compute_attribute","full_name":"compute_attribute","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"vm_attrs","full_name":"compute_attribute[vm_attrs]","description":"","required":false,"allow_nil":false,"validator":"Must be Hash","expected_type":"hash","metadata":null,"show":true}]}],"examples":["PUT /api/compute_profiles/980190962/compute_resources/980190962/compute_attributes/298486374\n{\n  \"compute_attribute\": {\n    \"vm_attrs\": {\n      \"cpus\": \"4\"\n    }\n  }\n}\n200\n{\n  \"created_at\": \"2015-12-01T02:40:01Z\",\n  \"updated_at\": \"2015-12-01T02:40:30Z\",\n  \"id\": 298486374,\n  \"name\": null,\n  \"compute_resource_id\": 980190962,\n  \"compute_resource_name\": \"bigcompute\",\n  \"compute_profile_id\": 980190962,\n  \"compute_profile_name\": \"1-Small\",\n  \"vm_attrs\": {\n    \"cpus\": \"4\"\n  }\n}"],"metadata":null,"see":[]}]},"compute_profiles":{"doc_url":"../apidoc/v2/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":"search","full_name":"search","description":"\n\u003Cp\u003Efilter results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003Cp\u003Esort results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003Cp\u003Epaginate results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003Cp\u003Enumber of entries per request\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/compute_profiles\n200\n{\n  \"total\": 4,\n  \"subtotal\": 4,\n  \"page\": 1,\n  \"per_page\": 20,\n  \"search\": null,\n  \"sort\": {\n    \"by\": null,\n    \"order\": null\n  },\n  \"results\": [\n    {\n      \"created_at\": \"2015-12-01T02:40:01Z\",\n      \"updated_at\": \"2015-12-01T02:40:01Z\",\n      \"id\": 980190962,\n      \"name\": \"1-Small\"\n    },\n    {\n      \"created_at\": \"2015-12-01T02:40:01Z\",\n      \"updated_at\": \"2015-12-01T02:40:01Z\",\n      \"id\": 298486374,\n      \"name\": \"2-Medium\"\n    },\n    {\n      \"created_at\": \"2015-12-01T02:40:01Z\",\n      \"updated_at\": \"2015-12-01T02:40:01Z\",\n      \"id\": 113629430,\n      \"name\": \"3-Large\"\n    },\n    {\n      \"created_at\": \"2015-12-01T02:40:01Z\",\n      \"updated_at\": \"2015-12-01T02:40:01Z\",\n      \"id\": 281110143,\n      \"name\": \"4-Networking\"\n    }\n  ]\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/compute_profiles/980190962-1-Small\n200\n{\n  \"created_at\": \"2015-12-01T02:40:01Z\",\n  \"updated_at\": \"2015-12-01T02:40:01Z\",\n  \"id\": 980190962,\n  \"name\": \"1-Small\",\n  \"compute_attributes\": [\n    {\n      \"id\": 298486374,\n      \"name\": null,\n      \"compute_resource_id\": 980190962,\n      \"compute_resource_name\": \"bigcompute\",\n      \"compute_profile_id\": 980190962,\n      \"compute_profile_name\": \"1-Small\",\n      \"vm_attrs\": {\n        \"cpus\": 2,\n        \"memory\": 536870912\n      }\n    },\n    {\n      \"id\": 980190962,\n      \"name\": null,\n      \"compute_resource_id\": 928692541,\n      \"compute_resource_name\": \"amazon123\",\n      \"compute_profile_id\": 980190962,\n      \"compute_profile_name\": \"1-Small\",\n      \"vm_attrs\": {\n        \"flavor_id\": \"m1.small\",\n        \"availability_zone\": \"eu-west-1a\"\n      }\n    }\n  ]\n}"],"metadata":null,"see":[]},{"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":"compute_profile","full_name":"compute_profile","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"compute_profile[name]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}]}],"examples":["POST /api/compute_profiles\n{\n  \"compute_profile\": {\n    \"name\": \"4-Xlarge\"\n  }\n}\n201\n{\n  \"created_at\": \"2015-12-01T02:40:30Z\",\n  \"updated_at\": \"2015-12-01T02:40:30Z\",\n  \"id\": 980190963,\n  \"name\": \"4-Xlarge\",\n  \"compute_attributes\": []\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"compute_profile","full_name":"compute_profile","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"compute_profile[name]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}]}],"examples":["PUT /api/compute_profiles/980190962-1-Small\n{\n  \"compute_profile\": {\n    \"name\": \"new name\"\n  }\n}\n200\n{\n  \"created_at\": \"2015-12-01T02:40:01Z\",\n  \"updated_at\": \"2015-12-01T02:40:30Z\",\n  \"id\": 980190962,\n  \"name\": \"new name\",\n  \"compute_attributes\": [\n    {\n      \"id\": 298486374,\n      \"name\": null,\n      \"compute_resource_id\": 980190962,\n      \"compute_resource_name\": \"bigcompute\",\n      \"compute_profile_id\": 980190962,\n      \"compute_profile_name\": \"new name\",\n      \"vm_attrs\": {\n        \"cpus\": 2,\n        \"memory\": 536870912\n      }\n    },\n    {\n      \"id\": 980190962,\n      \"name\": null,\n      \"compute_resource_id\": 928692541,\n      \"compute_resource_name\": \"amazon123\",\n      \"compute_profile_id\": 980190962,\n      \"compute_profile_name\": \"new name\",\n      \"vm_attrs\": {\n        \"flavor_id\": \"m1.small\",\n        \"availability_zone\": \"eu-west-1a\"\n      }\n    }\n  ]\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["DELETE /api/compute_profiles/113629430-3-Large\n200\n{\n  \"created_at\": \"2015-12-01T02:40:01Z\",\n  \"id\": 113629430,\n  \"name\": \"3-Large\",\n  \"updated_at\": \"2015-12-01T02:40:01Z\"\n}"],"metadata":null,"see":[]}]},"compute_resources":{"doc_url":"../apidoc/v2/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,"validator":"Must be Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"organization_id","full_name":"organization_id","description":"\n\u003Cp\u003EScope by organizations\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"search","full_name":"search","description":"\n\u003Cp\u003Efilter results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003Cp\u003Esort results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003Cp\u003Epaginate results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003Cp\u003Enumber of entries per request\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/compute_resources\n200\n{\n  \"total\": 9,\n  \"subtotal\": 9,\n  \"page\": 1,\n  \"per_page\": 20,\n  \"search\": null,\n  \"sort\": {\n    \"by\": null,\n    \"order\": null\n  },\n  \"results\": [\n    {\n      \"description\": \"ovirt resource\",\n      \"url\": \"https://myovirt/api\",\n      \"created_at\": \"2015-12-01T02:40:01Z\",\n      \"updated_at\": \"2015-12-01T02:40:01Z\",\n      \"id\": 510899777,\n      \"name\": \"Ovirt\",\n      \"provider\": \"Ovirt\",\n      \"provider_friendly_name\": \"oVirt\",\n      \"user\": \"MyString\",\n      \"datacenter\": \"1234567891011\"\n    },\n    {\n      \"description\": \"vmware resource\",\n      \"url\": \"https://myvmware/api\",\n      \"created_at\": \"2015-12-01T02:40:01Z\",\n      \"updated_at\": \"2015-12-01T02:40:01Z\",\n      \"id\": 305613588,\n      \"name\": \"Vmware\",\n      \"provider\": \"Vmware\",\n      \"provider_friendly_name\": \"VMware\",\n      \"user\": \"MyString\",\n      \"datacenter\": \"1234567891011\",\n      \"server\": \"https://myvmware/api\",\n      \"set_console_password\": true\n    },\n    {\n      \"description\": \"yourcompute\",\n      \"url\": \"eu-west-1\",\n      \"created_at\": \"2015-12-01T02:40:01Z\",\n      \"updated_at\": \"2015-12-01T02:40:01Z\",\n      \"id\": 928692541,\n      \"name\": \"amazon123\",\n      \"provider\": \"EC2\",\n      \"provider_friendly_name\": \"EC2\",\n      \"access_key\": \"MyString\",\n      \"region\": \"eu-west-1\"\n    },\n    {\n      \"description\": \"yourcompute\",\n      \"url\": \"eu-west-1\",\n      \"created_at\": \"2015-12-01T02:40:01Z\",\n      \"updated_at\": \"2015-12-01T02:40:01Z\",\n      \"id\": 304431216,\n      \"name\": \"another-ec2\",\n      \"provider\": \"EC2\",\n      \"provider_friendly_name\": \"EC2\",\n      \"access_key\": \"MyString\",\n      \"region\": \"eu-west-1\"\n    },\n    {\n      \"description\": \"MyString\",\n      \"url\": \"qemu://stam/system\",\n      \"created_at\": \"2015-12-01T02:40:01Z\",\n      \"updated_at\": \"2015-12-01T02:40:01Z\",\n      \"id\": 980190962,\n      \"name\": \"bigcompute\",\n      \"provider\": \"Libvirt\",\n      \"provider_friendly_name\": \"Libvirt\",\n      \"display_type\": \"vnc\",\n      \"set_console_password\": true\n    },\n    {\n      \"description\": \"yourcompute\",\n      \"url\": \"us-central1-a\",\n      \"created_at\": \"2015-12-01T02:40:01Z\",\n      \"updated_at\": \"2015-12-01T02:40:01Z\",\n      \"id\": 30517511,\n      \"name\": \"gce123\",\n      \"provider\": \"GCE\",\n      \"provider_friendly_name\": \"Google\",\n      \"email\": null,\n      \"zone\": \"us-central1-a\",\n      \"project\": null,\n      \"key_path\": null\n    },\n    {\n      \"description\": \"mycompute\",\n      \"url\": \"test:///default\",\n      \"created_at\": \"2015-12-01T02:40:01Z\",\n      \"updated_at\": \"2015-12-01T02:40:01Z\",\n      \"id\": 367690737,\n      \"name\": \"mycompute\",\n      \"provider\": \"Libvirt\",\n      \"provider_friendly_name\": \"Libvirt\",\n      \"display_type\": \"vnc\",\n      \"set_console_password\": true\n    },\n    {\n      \"description\": \"computeresource\",\n      \"url\": \"test:///default\",\n      \"created_at\": \"2015-12-01T02:40:01Z\",\n      \"updated_at\": \"2015-12-01T02:40:01Z\",\n      \"id\": 628705878,\n      \"name\": \"openstackcr\",\n      \"provider\": \"Openstack\",\n      \"provider_friendly_name\": \"OpenStack\",\n      \"user\": \"MyString\",\n      \"tenant\": null\n    },\n    {\n      \"description\": \"yourcompute\",\n      \"url\": \"test:///default\",\n      \"created_at\": \"2015-12-01T02:40:01Z\",\n      \"updated_at\": \"2015-12-01T02:40:01Z\",\n      \"id\": 932571420,\n      \"name\": \"yourcompute\",\n      \"provider\": \"Libvirt\",\n      \"provider_friendly_name\": \"Libvirt\",\n      \"display_type\": \"vnc\",\n      \"set_console_password\": true\n    }\n  ]\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/compute_resources/980190962-bigcompute\n200\n{\n  \"description\": \"MyString\",\n  \"url\": \"qemu://stam/system\",\n  \"created_at\": \"2015-12-01T02:40:01Z\",\n  \"updated_at\": \"2015-12-01T02:40:01Z\",\n  \"id\": 980190962,\n  \"name\": \"bigcompute\",\n  \"provider\": \"Libvirt\",\n  \"provider_friendly_name\": \"Libvirt\",\n  \"display_type\": \"vnc\",\n  \"set_console_password\": true,\n  \"images\": [\n    {\n      \"id\": 298486374,\n      \"name\": \"centos-2\"\n    },\n    {\n      \"id\": 980190962,\n      \"name\": \"centos-1\"\n    }\n  ],\n  \"compute_attributes\": [\n    {\n      \"id\": 281110143,\n      \"name\": null,\n      \"compute_resource_id\": 980190962,\n      \"compute_resource_name\": \"bigcompute\",\n      \"compute_profile_id\": 298486374,\n      \"compute_profile_name\": \"2-Medium\",\n      \"vm_attrs\": {\n        \"cpus\": 4,\n        \"memory\": 4294967296\n      }\n    },\n    {\n      \"id\": 298486374,\n      \"name\": null,\n      \"compute_resource_id\": 980190962,\n      \"compute_resource_name\": \"bigcompute\",\n      \"compute_profile_id\": 980190962,\n      \"compute_profile_name\": \"1-Small\",\n      \"vm_attrs\": {\n        \"cpus\": 2,\n        \"memory\": 536870912\n      }\n    },\n    {\n      \"id\": 394428105,\n      \"name\": null,\n      \"compute_resource_id\": 980190962,\n      \"compute_resource_name\": \"bigcompute\",\n      \"compute_profile_id\": 281110143,\n      \"compute_profile_name\": \"4-Networking\",\n      \"vm_attrs\": {\n        \"nics_attributes\": {\n          \"1\": {\n            \"attr\": 1\n          },\n          \"2\": {\n            \"attr\": 2\n          }\n        }\n      }\n    }\n  ],\n  \"locations\": [\n    {\n      \"id\": 255093256,\n      \"name\": \"Location 1\",\n      \"title\": \"Location 1\",\n      \"description\": null\n    }\n  ],\n  \"organizations\": [\n    {\n      \"id\": 447626438,\n      \"name\": \"Organization 1\",\n      \"title\": \"Organization 1\",\n      \"description\": null\n    }\n  ]\n}"],"metadata":null,"see":[]},{"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":"compute_resource","full_name":"compute_resource","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"compute_resource[name]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"provider","full_name":"compute_resource[provider]","description":"\n\u003Cp\u003EProviders include Libvirt, Ovirt, EC2, Vmware, Openstack, Rackspace, GCE\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"description","full_name":"compute_resource[description]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"uuid","full_name":"compute_resource[uuid]","description":"\n\u003Cp\u003Efor oVirt, VMware Datacenter\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"region","full_name":"compute_resource[region]","description":"\n\u003Cp\u003Efor EC2 only\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"tenant","full_name":"compute_resource[tenant]","description":"\n\u003Cp\u003Efor OpenStack only\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"server","full_name":"compute_resource[server]","description":"\n\u003Cp\u003Efor VMware\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"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,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":["POST /api/compute_resources\n{\n  \"compute_resource\": {\n    \"name\": \"special_compute\",\n    \"region\": \"eu-west-1\",\n    \"user\": \"user@example.com\",\n    \"password\": \"secret\"\n  }\n}\n201\n{\n  \"description\": null,\n  \"url\": \"eu-west-1\",\n  \"created_at\": \"2015-12-01T02:40:31Z\",\n  \"updated_at\": \"2015-12-01T02:40:31Z\",\n  \"id\": 980190963,\n  \"name\": \"special_compute\",\n  \"provider\": \"EC2\",\n  \"provider_friendly_name\": \"EC2\",\n  \"access_key\": \"user@example.com\",\n  \"region\": \"eu-west-1\",\n  \"images\": [],\n  \"compute_attributes\": [],\n  \"locations\": [],\n  \"organizations\": []\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"compute_resource","full_name":"compute_resource","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"compute_resource[name]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"provider","full_name":"compute_resource[provider]","description":"\n\u003Cp\u003EProviders include Libvirt, Ovirt, EC2, Vmware, Openstack, Rackspace, GCE\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"description","full_name":"compute_resource[description]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"uuid","full_name":"compute_resource[uuid]","description":"\n\u003Cp\u003Efor oVirt, VMware Datacenter\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"region","full_name":"compute_resource[region]","description":"\n\u003Cp\u003Efor EC2 only\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"tenant","full_name":"compute_resource[tenant]","description":"\n\u003Cp\u003Efor OpenStack only\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"server","full_name":"compute_resource[server]","description":"\n\u003Cp\u003Efor VMware\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"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,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":["PUT /api/compute_resources/367690737-mycompute\n{\n  \"compute_resource\": {\n    \"description\": \"new_description\"\n  }\n}\n200\n{\n  \"description\": \"new_description\",\n  \"url\": \"test:///default\",\n  \"created_at\": \"2015-12-01T02:40:01Z\",\n  \"updated_at\": \"2015-12-01T02:40:31Z\",\n  \"id\": 367690737,\n  \"name\": \"mycompute\",\n  \"provider\": \"Libvirt\",\n  \"provider_friendly_name\": \"Libvirt\",\n  \"display_type\": \"vnc\",\n  \"set_console_password\": true,\n  \"images\": [],\n  \"compute_attributes\": [],\n  \"locations\": [],\n  \"organizations\": []\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true}],"examples":["DELETE /api/compute_resources/932571420\n200\n{\n  \"attrs\": {},\n  \"created_at\": \"2015-12-01T02:40:01Z\",\n  \"description\": \"yourcompute\",\n  \"id\": 932571420,\n  \"name\": \"yourcompute\",\n  \"password\": \"1234567\",\n  \"updated_at\": \"2015-12-01T02:40:01Z\",\n  \"url\": \"test:///default\",\n  \"user\": \"MyString\",\n  \"uuid\": \"yourcompute\"\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/compute_resources/928692541-amazon123/available_images\n200\n[\n  {\n    \"name\": \"some_image\",\n    \"uuid\": \"123\"\n  }\n]"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/compute_resources/510899777-Ovirt/available_clusters\n200\n{\n  \"total\": 9,\n  \"subtotal\": 9,\n  \"page\": 1,\n  \"per_page\": 20,\n  \"search\": null,\n  \"sort\": {\n    \"by\": null,\n    \"order\": null\n  },\n  \"results\": [\n    {\n      \"name\": \"test_cluster\",\n      \"id\": \"my11-test35-uuid99\"\n    }\n  ]\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/compute_resources/928692541-amazon123/available_flavors\n200\n{\n  \"total\": 9,\n  \"subtotal\": 9,\n  \"page\": 1,\n  \"per_page\": 20,\n  \"search\": null,\n  \"sort\": {\n    \"by\": null,\n    \"order\": null\n  },\n  \"results\": [\n    {\n      \"name\": \"test_ec2_object\",\n      \"id\": \"123\"\n    }\n  ]\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/compute_resources/305613588-Vmware/available_folders?cluster_id=123-456-789\n200\n{\n  \"total\": 9,\n  \"subtotal\": 9,\n  \"page\": 1,\n  \"per_page\": 20,\n  \"search\": null,\n  \"sort\": {\n    \"by\": null,\n    \"order\": null\n  },\n  \"results\": [\n    {\n      \"name\": \"test_vmware_object\",\n      \"id\": \"my11-test35-uuid99\"\n    }\n  ]\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/compute_resources/928692541-amazon123/available_zones\n200\n{\n  \"total\": 9,\n  \"subtotal\": 9,\n  \"page\": 1,\n  \"per_page\": 20,\n  \"search\": null,\n  \"sort\": {\n    \"by\": null,\n    \"order\": null\n  },\n  \"results\": [\n    {\n      \"name\": \"test_ec2_object\"\n    }\n  ]\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true},{"name":"cluster_id","full_name":"cluster_id","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/compute_resources/510899777-Ovirt/available_clusters/123-456-789/available_networks\n200\n{\n  \"total\": 9,\n  \"subtotal\": 9,\n  \"page\": 1,\n  \"per_page\": 20,\n  \"search\": null,\n  \"sort\": {\n    \"by\": null,\n    \"order\": null\n  },\n  \"results\": [\n    {\n      \"name\": \"test_network\",\n      \"id\": \"my11-test35-uuid99\"\n    }\n  ]\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true},{"name":"cluster_id","full_name":"cluster_id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/compute_resources/305613588-Vmware/available_clusters/123-456-789/available_resource_pools\n200\n{\n  \"total\": 9,\n  \"subtotal\": 9,\n  \"page\": 1,\n  \"per_page\": 20,\n  \"search\": null,\n  \"sort\": {\n    \"by\": null,\n    \"order\": null\n  },\n  \"results\": [\n    {\n      \"name\": \"test_vmware_object\",\n      \"id\": \"my11-test35-uuid99\"\n    }\n  ]\n}"],"metadata":null,"see":[]},{"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","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}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true},{"name":"storage_domain","full_name":"storage_domain","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/compute_resources/510899777-Ovirt/available_storage_domains\n200\n{\n  \"total\": 9,\n  \"subtotal\": 9,\n  \"page\": 1,\n  \"per_page\": 20,\n  \"search\": null,\n  \"sort\": {\n    \"by\": null,\n    \"order\": null\n  },\n  \"results\": [\n    {\n      \"name\": \"test_cluster\",\n      \"id\": \"my11-test35-uuid99\"\n    }\n  ]\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/compute_resources/928692541-amazon123/available_security_groups\n200\n{\n  \"total\": 9,\n  \"subtotal\": 9,\n  \"page\": 1,\n  \"per_page\": 20,\n  \"search\": null,\n  \"sort\": {\n    \"by\": null,\n    \"order\": null\n  },\n  \"results\": [\n    {\n      \"name\": \"test_ec2_object\",\n      \"group_id\": \"123\"\n    }\n  ]\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true}],"examples":["PUT /api/compute_resources/980190963-compute_resource1/associate\n{\n  \"compute_resource\": {}\n}\n200\n{\n  \"total\": 10,\n  \"subtotal\": 10,\n  \"page\": 1,\n  \"per_page\": 20,\n  \"search\": null,\n  \"sort\": {\n    \"by\": null,\n    \"order\": null\n  },\n  \"results\": [\n    {\n      \"ip\": null,\n      \"environment_id\": null,\n      \"environment_name\": null,\n      \"last_report\": null,\n      \"mac\": null,\n      \"realm_id\": null,\n      \"realm_name\": null,\n      \"sp_mac\": null,\n      \"sp_ip\": null,\n      \"sp_name\": null,\n      \"domain_id\": null,\n      \"domain_name\": null,\n      \"architecture_id\": null,\n      \"architecture_name\": null,\n      \"operatingsystem_id\": null,\n      \"operatingsystem_name\": null,\n      \"subnet_id\": null,\n      \"subnet_name\": null,\n      \"sp_subnet_id\": null,\n      \"ptable_id\": null,\n      \"ptable_name\": null,\n      \"medium_id\": null,\n      \"medium_name\": null,\n      \"build\": false,\n      \"comment\": null,\n      \"disk\": null,\n      \"installed_at\": null,\n      \"model_id\": null,\n      \"model_name\": null,\n      \"hostgroup_id\": null,\n      \"hostgroup_name\": null,\n      \"owner_id\": null,\n      \"owner_type\": null,\n      \"enabled\": true,\n      \"puppet_ca_proxy_id\": null,\n      \"managed\": false,\n      \"use_image\": null,\n      \"image_file\": \"\",\n      \"uuid\": \"a74eee56-721e-4021-9583-0db3c3fe697b\",\n      \"compute_resource_id\": 980190963,\n      \"compute_resource_name\": \"compute_resource1\",\n      \"compute_profile_id\": null,\n      \"compute_profile_name\": null,\n      \"capabilities\": [\n        \"image\"\n      ],\n      \"provision_method\": \"image\",\n      \"puppet_proxy_id\": null,\n      \"certname\": \"host41\",\n      \"image_id\": null,\n      \"image_name\": null,\n      \"created_at\": \"2015-12-01T02:40:32Z\",\n      \"updated_at\": \"2015-12-01T02:40:32Z\",\n      \"last_compile\": null,\n      \"global_status\": 0,\n      \"global_status_label\": \"OK\",\n      \"organization_id\": null,\n      \"organization_name\": null,\n      \"location_id\": null,\n      \"location_name\": null,\n      \"puppet_status\": 0,\n      \"name\": \"host41\",\n      \"id\": 2\n    }\n  ]\n}"],"metadata":null,"see":[]}]},"config_groups":{"doc_url":"../apidoc/v2/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":"search","full_name":"search","description":"\n\u003Cp\u003Efilter results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003Cp\u003Esort results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003Cp\u003Epaginate results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003Cp\u003Enumber of entries per request\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[]},{"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":"config_group","full_name":"config_group","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"config_group[name]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"config_group","full_name":"config_group","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"config_group[name]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[]}]},"dashboard":{"doc_url":"../apidoc/v2/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":"search","full_name":"search","description":"\n\u003Cp\u003Efilter results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/dashboard\n200\n{\n  \"total_hosts\": 0,\n  \"bad_hosts\": 0,\n  \"bad_hosts_enabled\": 0,\n  \"active_hosts\": 0,\n  \"active_hosts_ok\": 0,\n  \"active_hosts_ok_enabled\": 0,\n  \"ok_hosts\": 0,\n  \"ok_hosts_enabled\": 0,\n  \"out_of_sync_hosts\": 0,\n  \"out_of_sync_hosts_enabled\": 0,\n  \"disabled_hosts\": 0,\n  \"pending_hosts\": 0,\n  \"pending_hosts_enabled\": 0,\n  \"good_hosts\": 0,\n  \"good_hosts_enabled\": 0,\n  \"percentage\": 0,\n  \"reports_missing\": 0\n}"],"metadata":null,"see":[]}]},"domains":{"doc_url":"../apidoc/v2/domains","api_url":"/api","name":"Domains","short_description":null,"full_description":"\n\u003Cp\u003EForeman considers a domain and a DNS zone as the same thing. That is, if you are planning to manage a site where all the machines are or the form \u003Ci\u003Ehostname\u003C/i\u003E.\u003Cb\u003Esomewhere.com\u003C/b\u003E then the domain is \u003Cb\u003Esomewhere.com\u003C/b\u003E. This allows Foreman to associate a puppet variable with a domain/site and automatically append this variable to all external node requests made by machines at that site.\u003C/p\u003E\n","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/domains/index","name":"index","apis":[{"api_url":"/api/domains","http_method":"GET","short_description":"List of domains","deprecated":null},{"api_url":"/api/subnets/:subnet_id/domains","http_method":"GET","short_description":"List of domains per subnet","deprecated":null},{"api_url":"/api/locations/:location_id/domains","http_method":"GET","short_description":"List of domains per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/domains","http_method":"GET","short_description":"List of domains per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003Cp\u003EID of subnet\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"location_id","full_name":"location_id","description":"\n\u003Cp\u003EScope by locations\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"organization_id","full_name":"organization_id","description":"\n\u003Cp\u003EScope by organizations\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"search","full_name":"search","description":"\n\u003Cp\u003Efilter results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003Cp\u003Esort results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003Cp\u003Epaginate results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003Cp\u003Enumber of entries per request\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/domains\n200\n{\n  \"total\": 4,\n  \"subtotal\": 4,\n  \"page\": 1,\n  \"per_page\": 20,\n  \"search\": null,\n  \"sort\": {\n    \"by\": null,\n    \"order\": null\n  },\n  \"results\": [\n    {\n      \"fullname\": null,\n      \"dns_id\": 113629430,\n      \"created_at\": \"2015-12-01T02:40:01Z\",\n      \"updated_at\": \"2015-12-01T02:40:01Z\",\n      \"id\": 22495316,\n      \"name\": \"mydomain.net\"\n    },\n    {\n      \"fullname\": \"somewhare that is never used\",\n      \"dns_id\": 113629430,\n      \"created_at\": \"2015-12-01T02:40:01Z\",\n      \"updated_at\": \"2015-12-01T02:40:01Z\",\n      \"id\": 759776763,\n      \"name\": \"unused.net\"\n    },\n    {\n      \"fullname\": null,\n      \"dns_id\": null,\n      \"created_at\": \"2015-12-01T02:40:01Z\",\n      \"updated_at\": \"2015-12-01T02:40:01Z\",\n      \"id\": 229305443,\n      \"name\": \"useless.net\"\n    },\n    {\n      \"fullname\": \"somewhere in yourdomain\",\n      \"dns_id\": 113629430,\n      \"created_at\": \"2015-12-01T02:40:01Z\",\n      \"updated_at\": \"2015-12-01T02:40:01Z\",\n      \"id\": 589326610,\n      \"name\": \"yourdomain.net\"\n    }\n  ]\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"\n\u003Cp\u003ENumerical ID or domain name\u003C/p\u003E\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/domains/22495316-mydomain-net\n200\n{\n  \"fullname\": null,\n  \"dns_id\": 113629430,\n  \"created_at\": \"2015-12-01T02:40:01Z\",\n  \"updated_at\": \"2015-12-01T02:40:01Z\",\n  \"id\": 22495316,\n  \"name\": \"mydomain.net\",\n  \"subnets\": [\n    {\n      \"id\": 980190962,\n      \"name\": \"one\",\n      \"network_address\": \"2.3.4.0/24\"\n    }\n  ],\n  \"parameters\": [\n    {\n      \"id\": 665394701,\n      \"name\": \"parameter\",\n      \"value\": \"value1\"\n    }\n  ],\n  \"interfaces\": [],\n  \"locations\": [\n    {\n      \"id\": 255093256,\n      \"name\": \"Location 1\",\n      \"title\": \"Location 1\",\n      \"description\": null\n    }\n  ],\n  \"organizations\": [\n    {\n      \"id\": 447626438,\n      \"name\": \"Organization 1\",\n      \"title\": \"Organization 1\",\n      \"description\": null\n    }\n  ]\n}"],"metadata":null,"see":[]},{"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 \u003Cb\u003Efullname\u003C/b\u003E field is used for human readability in reports and other pages that refer to domains, and also available as an external node parameter\u003C/p\u003E\n","errors":[],"params":[{"name":"domain","full_name":"domain","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"domain[name]","description":"\n\u003Cp\u003EThe full DNS domain name\u003C/p\u003E\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"fullname","full_name":"domain[fullname]","description":"\n\u003Cp\u003EDescription of the domain\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"dns_id","full_name":"domain[dns_id]","description":"\n\u003Cp\u003EDNS proxy to use within this domain\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"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,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"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,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":["POST /api/domains\n{\n  \"domain\": {\n    \"name\": \"domain.net\"\n  }\n}\n500\n{\n  \"error\": {\n    \"message\": \"SQLite3::SQLException: table domains has no column named total_hosts: INSERT INTO \\\"domains\\\" (\\\"created_at\\\", \\\"dns_id\\\", \\\"fullname\\\", \\\"hostgroups_count\\\", \\\"name\\\", \\\"total_hosts\\\", \\\"updated_at\\\") VALUES (?, ?, ?, ?, ?, ?, ?)\"\n  }\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true},{"name":"domain","full_name":"domain","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"domain[name]","description":"\n\u003Cp\u003EThe full DNS domain name\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"fullname","full_name":"domain[fullname]","description":"\n\u003Cp\u003EDescription of the domain\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"dns_id","full_name":"domain[dns_id]","description":"\n\u003Cp\u003EDNS proxy to use within this domain\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"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,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"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,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":["PUT /api/domains/22495316-mydomain-net\n{\n  \"domain\": {\n    \"name\": \"domain.new\"\n  }\n}\n200\n{\n  \"fullname\": null,\n  \"dns_id\": 113629430,\n  \"created_at\": \"2015-12-01T02:40:01Z\",\n  \"updated_at\": \"2015-12-01T02:40:35Z\",\n  \"id\": 22495316,\n  \"name\": \"domain.new\",\n  \"subnets\": [\n    {\n      \"id\": 980190962,\n      \"name\": \"one\",\n      \"network_address\": \"2.3.4.0/24\"\n    }\n  ],\n  \"parameters\": [\n    {\n      \"id\": 665394701,\n      \"name\": \"parameter\",\n      \"value\": \"value1\"\n    }\n  ],\n  \"interfaces\": [],\n  \"locations\": [\n    {\n      \"id\": 255093256,\n      \"name\": \"Location 1\",\n      \"title\": \"Location 1\",\n      \"description\": null\n    }\n  ],\n  \"organizations\": [\n    {\n      \"id\": 447626438,\n      \"name\": \"Organization 1\",\n      \"title\": \"Organization 1\",\n      \"description\": null\n    }\n  ]\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true}],"examples":["DELETE /api/domains/22495316-mydomain-net\n200\n{\n  \"created_at\": \"2015-12-01T02:40:01Z\",\n  \"dns_id\": 113629430,\n  \"fullname\": null,\n  \"hostgroups_count\": -2,\n  \"hosts_count\": 0,\n  \"id\": 22495316,\n  \"name\": \"mydomain.net\",\n  \"updated_at\": \"2015-12-01T02:40:01Z\"\n}"],"metadata":null,"see":[]}]},"environments":{"doc_url":"../apidoc/v2/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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true},{"name":"smart_proxy_id","full_name":"smart_proxy_id","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"environment_id","full_name":"environment_id","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"dryrun","full_name":"dryrun","description":"","required":false,"allow_nil":false,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true},{"name":"except","full_name":"except","description":"\n\u003Cp\u003EOptional comma-delimited string containing either \u2018new\u2019, \u2018updated\u2019, or \u2018obsolete\u2019 that is used to limit the imported Puppet classes\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[]},{"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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"location_id","full_name":"location_id","description":"\n\u003Cp\u003EScope by locations\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"organization_id","full_name":"organization_id","description":"\n\u003Cp\u003EScope by organizations\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"search","full_name":"search","description":"\n\u003Cp\u003Efilter results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003Cp\u003Esort results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003Cp\u003Epaginate results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003Cp\u003Enumber of entries per request\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/environments\n200\n{\n  \"total\": 3,\n  \"subtotal\": 3,\n  \"page\": 1,\n  \"per_page\": 20,\n  \"search\": null,\n  \"sort\": {\n    \"by\": null,\n    \"order\": null\n  },\n  \"results\": [\n    {\n      \"created_at\": \"2015-12-01T02:40:01Z\",\n      \"updated_at\": \"2015-12-01T02:40:01Z\",\n      \"name\": \"global_puppetmaster\",\n      \"id\": 153855663\n    },\n    {\n      \"created_at\": \"2015-12-01T02:40:01Z\",\n      \"updated_at\": \"2015-12-01T02:40:01Z\",\n      \"name\": \"production\",\n      \"id\": 334344675\n    },\n    {\n      \"created_at\": \"2015-12-01T02:40:01Z\",\n      \"updated_at\": \"2015-12-01T02:40:01Z\",\n      \"name\": \"testing\",\n      \"id\": 687036937\n    }\n  ]\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/environments/production\n200\n{\n  \"created_at\": \"2015-12-01T02:40:01Z\",\n  \"updated_at\": \"2015-12-01T02:40:01Z\",\n  \"name\": \"production\",\n  \"id\": 334344675,\n  \"template_combinations\": [\n    {\n      \"id\": 113629430,\n      \"provisioning_template_id\": 104314179,\n      \"provisioning_template_name\": \"MyFinish\",\n      \"hostgroup_id\": null,\n      \"hostgroup_name\": null,\n      \"environment_id\": 334344675,\n      \"environment_name\": \"production\",\n      \"config_template_id\": 104314179,\n      \"config_template_name\": \"MyFinish\"\n    },\n    {\n      \"id\": 281110143,\n      \"provisioning_template_id\": 269958254,\n      \"provisioning_template_name\": \"MyString2\",\n      \"hostgroup_id\": 636252244,\n      \"hostgroup_name\": \"Common\",\n      \"environment_id\": 334344675,\n      \"environment_name\": \"production\",\n      \"config_template_id\": 269958254,\n      \"config_template_name\": \"MyString2\"\n    },\n    {\n      \"id\": 980190962,\n      \"provisioning_template_id\": 943779058,\n      \"provisioning_template_name\": \"MyString\",\n      \"hostgroup_id\": 636252244,\n      \"hostgroup_name\": \"Common\",\n      \"environment_id\": 334344675,\n      \"environment_name\": \"production\",\n      \"config_template_id\": 943779058,\n      \"config_template_name\": \"MyString\"\n    }\n  ],\n  \"puppetclasses\": [\n    {\n      \"id\": 298486374,\n      \"name\": \"apache\",\n      \"module_name\": \"apache\"\n    },\n    {\n      \"id\": 638205575,\n      \"name\": \"auth\",\n      \"module_name\": \"auth\"\n    },\n    {\n      \"id\": 980190962,\n      \"name\": \"base\",\n      \"module_name\": \"base\"\n    },\n    {\n      \"id\": 51848956,\n      \"name\": \"chkmk\",\n      \"module_name\": \"chkmk\"\n    },\n    {\n      \"id\": 1018350795,\n      \"name\": \"nagios\",\n      \"module_name\": \"nagios\"\n    },\n    {\n      \"id\": 374648174,\n      \"name\": \"pam\",\n      \"module_name\": \"pam\"\n    },\n    {\n      \"id\": 281110143,\n      \"name\": \"vim\",\n      \"module_name\": \"vim\"\n    }\n  ],\n  \"locations\": [\n    {\n      \"id\": 255093256,\n      \"name\": \"Location 1\",\n      \"title\": \"Location 1\",\n      \"description\": null\n    }\n  ],\n  \"organizations\": [\n    {\n      \"id\": 447626438,\n      \"name\": \"Organization 1\",\n      \"title\": \"Organization 1\",\n      \"description\": null\n    }\n  ]\n}"],"metadata":null,"see":[]},{"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":"environment","full_name":"environment","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"environment[name]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"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,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":["POST /api/environments\n{\n  \"environment\": {\n    \"name\": \"Development\"\n  }\n}\n201\n{\n  \"created_at\": \"2015-12-01T02:40:36Z\",\n  \"updated_at\": \"2015-12-01T02:40:36Z\",\n  \"name\": \"Development\",\n  \"id\": 687036938,\n  \"template_combinations\": [],\n  \"puppetclasses\": [],\n  \"locations\": [],\n  \"organizations\": []\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true},{"name":"environment","full_name":"environment","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"environment[name]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"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,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":["PUT /api/environments/production\n{\n  \"environment\": {\n    \"name\": \"Development\"\n  }\n}\n200\n{\n  \"created_at\": \"2015-12-01T02:40:01Z\",\n  \"updated_at\": \"2015-12-01T02:40:36Z\",\n  \"name\": \"Development\",\n  \"id\": 334344675,\n  \"template_combinations\": [\n    {\n      \"id\": 113629430,\n      \"provisioning_template_id\": 104314179,\n      \"provisioning_template_name\": \"MyFinish\",\n      \"hostgroup_id\": null,\n      \"hostgroup_name\": null,\n      \"environment_id\": 334344675,\n      \"environment_name\": \"Development\",\n      \"config_template_id\": 104314179,\n      \"config_template_name\": \"MyFinish\"\n    },\n    {\n      \"id\": 281110143,\n      \"provisioning_template_id\": 269958254,\n      \"provisioning_template_name\": \"MyString2\",\n      \"hostgroup_id\": 636252244,\n      \"hostgroup_name\": \"Common\",\n      \"environment_id\": 334344675,\n      \"environment_name\": \"Development\",\n      \"config_template_id\": 269958254,\n      \"config_template_name\": \"MyString2\"\n    },\n    {\n      \"id\": 980190962,\n      \"provisioning_template_id\": 943779058,\n      \"provisioning_template_name\": \"MyString\",\n      \"hostgroup_id\": 636252244,\n      \"hostgroup_name\": \"Common\",\n      \"environment_id\": 334344675,\n      \"environment_name\": \"Development\",\n      \"config_template_id\": 943779058,\n      \"config_template_name\": \"MyString\"\n    }\n  ],\n  \"puppetclasses\": [\n    {\n      \"id\": 298486374,\n      \"name\": \"apache\",\n      \"module_name\": \"apache\"\n    },\n    {\n      \"id\": 638205575,\n      \"name\": \"auth\",\n      \"module_name\": \"auth\"\n    },\n    {\n      \"id\": 980190962,\n      \"name\": \"base\",\n      \"module_name\": \"base\"\n    },\n    {\n      \"id\": 51848956,\n      \"name\": \"chkmk\",\n      \"module_name\": \"chkmk\"\n    },\n    {\n      \"id\": 1018350795,\n      \"name\": \"nagios\",\n      \"module_name\": \"nagios\"\n    },\n    {\n      \"id\": 374648174,\n      \"name\": \"pam\",\n      \"module_name\": \"pam\"\n    },\n    {\n      \"id\": 281110143,\n      \"name\": \"vim\",\n      \"module_name\": \"vim\"\n    }\n  ],\n  \"locations\": [\n    {\n      \"id\": 255093256,\n      \"name\": \"Location 1\",\n      \"title\": \"Location 1\",\n      \"description\": null\n    }\n  ],\n  \"organizations\": [\n    {\n      \"id\": 447626438,\n      \"name\": \"Organization 1\",\n      \"title\": \"Organization 1\",\n      \"description\": null\n    }\n  ]\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true}],"examples":["DELETE /api/environments/testing\n200\n{\n  \"created_at\": \"2015-12-01T02:40:01Z\",\n  \"hostgroups_count\": 0,\n  \"hosts_count\": 0,\n  \"id\": 687036937,\n  \"name\": \"testing\",\n  \"updated_at\": \"2015-12-01T02:40:01Z\"\n}"],"metadata":null,"see":[]}]},"external_usergroups":{"doc_url":"../apidoc/v2/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":"usergroup_id","full_name":"usergroup_id","description":"\n\u003Cp\u003EID or name of user group\u003C/p\u003E\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/usergroups/1/external_usergroups\n200\n{\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\": [\n    {\n      \"id\": 1,\n      \"name\": \"external_usergroup1\",\n      \"auth_source_ldap\": {\n        \"id\": 980190963,\n        \"type\": \"AuthSourceLdap\",\n        \"name\": \"auth_source_ldap_1\"\n      }\n    }\n  ]\n}"],"metadata":null,"see":[]},{"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":"usergroup_id","full_name":"usergroup_id","description":"\n\u003Cp\u003EID or name of user group\u003C/p\u003E\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"id","full_name":"id","description":"\n\u003Cp\u003EID or name of external user group\u003C/p\u003E\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/usergroups/1/external_usergroups/1\n200\n{\n  \"id\": 1,\n  \"name\": \"external_usergroup2\",\n  \"auth_source_ldap\": {\n    \"id\": 980190963,\n    \"type\": \"AuthSourceLdap\",\n    \"name\": \"auth_source_ldap_2\"\n  }\n}"],"metadata":null,"see":[]},{"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":"usergroup_id","full_name":"usergroup_id","description":"\n\u003Cp\u003EID or name of user group\u003C/p\u003E\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"external_usergroup","full_name":"external_usergroup","description":"\n\u003Cp\u003EExternal user group information\u003C/p\u003E\n","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"external_usergroup[name]","description":"\n\u003Cp\u003EExternal user group name\u003C/p\u003E\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be Fixnum","expected_type":"numeric","metadata":null,"show":true}]}],"examples":["POST /api/usergroups/2-usergroup9/external_usergroups\n{\n  \"external_usergroup\": {\n    \"name\": \"foremanusergroup\",\n    \"auth_source_id\": \"980190964\"\n  }\n}\n201\n{\n  \"id\": 2,\n  \"name\": \"foremanusergroup\",\n  \"auth_source_ldap\": {\n    \"id\": 980190964,\n    \"type\": \"AuthSourceLdap\",\n    \"name\": \"auth_source_ldap_4\"\n  }\n}"],"metadata":null,"see":[]},{"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":"usergroup_id","full_name":"usergroup_id","description":"\n\u003Cp\u003EID or name of user group\u003C/p\u003E\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"id","full_name":"id","description":"\n\u003Cp\u003EID or name of external user group\u003C/p\u003E\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"external_usergroup","full_name":"external_usergroup","description":"\n\u003Cp\u003EExternal user group information\u003C/p\u003E\n","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"external_usergroup[name]","description":"\n\u003Cp\u003EExternal user group name\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be Fixnum","expected_type":"numeric","metadata":null,"show":true}]}],"examples":["PUT /api/usergroups/1/external_usergroups/1\n{\n  \"external_usergroup\": {\n    \"name\": \"foremanusergroup\"\n  }\n}\n200\n{\n  \"id\": 1,\n  \"name\": \"foremanusergroup\",\n  \"auth_source_ldap\": {\n    \"id\": 980190963,\n    \"type\": \"AuthSourceLdap\",\n    \"name\": \"auth_source_ldap_6\"\n  }\n}"],"metadata":null,"see":[]},{"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":"usergroup_id","full_name":"usergroup_id","description":"\n\u003Cp\u003EID or name of user group\u003C/p\u003E\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"id","full_name":"id","description":"\n\u003Cp\u003EID or name of external user group\u003C/p\u003E\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["PUT /api/usergroups/1/external_usergroups/1/refresh\n{\n  \"external_usergroup\": {}\n}\n200\n{\n  \"auth_source_id\": 980190963,\n  \"id\": 1,\n  \"name\": \"external_usergroup4\",\n  \"usergroup_id\": 1\n}"],"metadata":null,"see":[]},{"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":"usergroup_id","full_name":"usergroup_id","description":"\n\u003Cp\u003EID or name of user group\u003C/p\u003E\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"id","full_name":"id","description":"\n\u003Cp\u003EID or name external user group\u003C/p\u003E\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["DELETE /api/usergroups/1/external_usergroups/1\n200\n{\n  \"auth_source_id\": 980190963,\n  \"id\": 1,\n  \"name\": \"external_usergroup6\",\n  \"usergroup_id\": 1\n}"],"metadata":null,"see":[]}]},"fact_values":{"doc_url":"../apidoc/v2/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":"search","full_name":"search","description":"\n\u003Cp\u003Efilter results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003Cp\u003Esort results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003Cp\u003Epaginate results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003Cp\u003Enumber of entries per request\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/fact_values\n200\n{\n  \"total\": 1,\n  \"subtotal\": 1,\n  \"page\": 1,\n  \"per_page\": 20,\n  \"search\": \"\",\n  \"sort\": {\n    \"by\": null,\n    \"order\": null\n  },\n  \"results\": {\n    \"host42\": {\n      \"kernelversion\": \"2.6.9\"\n    }\n  }\n}"],"metadata":null,"see":[]}]},"filters":{"doc_url":"../apidoc/v2/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":"search","full_name":"search","description":"\n\u003Cp\u003Efilter results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003Cp\u003Esort results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003Cp\u003Epaginate results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003Cp\u003Enumber of entries per request\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/filters\n200\n{\n  \"total\": 70,\n  \"subtotal\": 70,\n  \"page\": 1,\n  \"per_page\": 20,\n  \"search\": null,\n  \"sort\": {\n    \"by\": null,\n    \"order\": null\n  },\n  \"results\": [\n    {\n      \"search\": null,\n      \"resource_type\": \"Ptable\",\n      \"unlimited?\": true,\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"id\": 139728896,\n      \"role\": {\n        \"name\": \"Manager\",\n        \"id\": 1\n      },\n      \"permissions\": [\n        {\n          \"name\": \"destroy_ptables\",\n          \"id\": 953432930,\n          \"resource_type\": \"Ptable\"\n        },\n        {\n          \"name\": \"view_ptables\",\n          \"id\": 769440046,\n          \"resource_type\": \"Ptable\"\n        },\n        {\n          \"name\": \"create_ptables\",\n          \"id\": 649673681,\n          \"resource_type\": \"Ptable\"\n        },\n        {\n          \"name\": \"edit_ptables\",\n          \"id\": 1048516464,\n          \"resource_type\": \"Ptable\"\n        }\n      ]\n    },\n    {\n      \"search\": null,\n      \"resource_type\": \"AuthSourceLdap\",\n      \"unlimited?\": true,\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"id\": 170801529,\n      \"role\": {\n        \"name\": \"Manager\",\n        \"id\": 1\n      },\n      \"permissions\": [\n        {\n          \"name\": \"create_authenticators\",\n          \"id\": 956119309,\n          \"resource_type\": \"AuthSourceLdap\"\n        },\n        {\n          \"name\": \"edit_authenticators\",\n          \"id\": 395314704,\n          \"resource_type\": \"AuthSourceLdap\"\n        },\n        {\n          \"name\": \"destroy_authenticators\",\n          \"id\": 1067518973,\n          \"resource_type\": \"AuthSourceLdap\"\n        },\n        {\n          \"name\": \"view_authenticators\",\n          \"id\": 687843582,\n          \"resource_type\": \"AuthSourceLdap\"\n        }\n      ]\n    },\n    {\n      \"search\": null,\n      \"resource_type\": \"CommonParameter\",\n      \"unlimited?\": true,\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"id\": 222559602,\n      \"role\": {\n        \"name\": \"Manager\",\n        \"id\": 1\n      },\n      \"permissions\": [\n        {\n          \"name\": \"create_globals\",\n          \"id\": 225414942,\n          \"resource_type\": \"CommonParameter\"\n        },\n        {\n          \"name\": \"edit_globals\",\n          \"id\": 363439011,\n          \"resource_type\": \"CommonParameter\"\n        },\n        {\n          \"name\": \"destroy_globals\",\n          \"id\": 318934959,\n          \"resource_type\": \"CommonParameter\"\n        },\n        {\n          \"name\": \"view_globals\",\n          \"id\": 101322209,\n          \"resource_type\": \"CommonParameter\"\n        }\n      ]\n    },\n    {\n      \"search\": null,\n      \"resource_type\": \"Location\",\n      \"unlimited?\": true,\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"id\": 225912082,\n      \"role\": {\n        \"name\": \"Manager\",\n        \"id\": 1\n      },\n      \"permissions\": [\n        {\n          \"name\": \"view_locations\",\n          \"id\": 342396477,\n          \"resource_type\": \"Location\"\n        },\n        {\n          \"name\": \"destroy_locations\",\n          \"id\": 302614650,\n          \"resource_type\": \"Location\"\n        },\n        {\n          \"name\": \"create_locations\",\n          \"id\": 919402658,\n          \"resource_type\": \"Location\"\n        },\n        {\n          \"name\": \"edit_locations\",\n          \"id\": 360701043,\n          \"resource_type\": \"Location\"\n        }\n      ]\n    },\n    {\n      \"search\": null,\n      \"resource_type\": null,\n      \"unlimited?\": true,\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"id\": 255448041,\n      \"role\": {\n        \"name\": \"Manager\",\n        \"id\": 1\n      },\n      \"permissions\": [\n        {\n          \"name\": \"access_settings\",\n          \"id\": 139485686,\n          \"resource_type\": null\n        },\n        {\n          \"name\": \"access_dashboard\",\n          \"id\": 220719619,\n          \"resource_type\": null\n        },\n        {\n          \"name\": \"view_statistics\",\n          \"id\": 955233873,\n          \"resource_type\": null\n        }\n      ]\n    },\n    {\n      \"search\": null,\n      \"resource_type\": \"Operatingsystem\",\n      \"unlimited?\": true,\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"id\": 291325508,\n      \"role\": {\n        \"name\": \"Manager\",\n        \"id\": 1\n      },\n      \"permissions\": [\n        {\n          \"name\": \"destroy_operatingsystems\",\n          \"id\": 936871672,\n          \"resource_type\": \"Operatingsystem\"\n        },\n        {\n          \"name\": \"view_operatingsystems\",\n          \"id\": 940057595,\n          \"resource_type\": \"Operatingsystem\"\n        },\n        {\n          \"name\": \"create_operatingsystems\",\n          \"id\": 1038489107,\n          \"resource_type\": \"Operatingsystem\"\n        },\n        {\n          \"name\": \"edit_operatingsystems\",\n          \"id\": 887912542,\n          \"resource_type\": \"Operatingsystem\"\n        }\n      ]\n    },\n    {\n      \"search\": null,\n      \"resource_type\": \"Architecture\",\n      \"unlimited?\": true,\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"id\": 321349837,\n      \"role\": {\n        \"name\": \"Manager\",\n        \"id\": 1\n      },\n      \"permissions\": [\n        {\n          \"name\": \"create_architectures\",\n          \"id\": 912770095,\n          \"resource_type\": \"Architecture\"\n        },\n        {\n          \"name\": \"edit_architectures\",\n          \"id\": 874798611,\n          \"resource_type\": \"Architecture\"\n        },\n        {\n          \"name\": \"destroy_architectures\",\n          \"id\": 586604735,\n          \"resource_type\": \"Architecture\"\n        },\n        {\n          \"name\": \"view_architectures\",\n          \"id\": 350275019,\n          \"resource_type\": \"Architecture\"\n        }\n      ]\n    },\n    {\n      \"search\": null,\n      \"resource_type\": \"Domain\",\n      \"unlimited?\": true,\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"id\": 340438230,\n      \"role\": {\n        \"name\": \"Manager\",\n        \"id\": 1\n      },\n      \"permissions\": [\n        {\n          \"name\": \"create_domains\",\n          \"id\": 776153244,\n          \"resource_type\": \"Domain\"\n        },\n        {\n          \"name\": \"edit_domains\",\n          \"id\": 914687015,\n          \"resource_type\": \"Domain\"\n        },\n        {\n          \"name\": \"destroy_domains\",\n          \"id\": 808331307,\n          \"resource_type\": \"Domain\"\n        },\n        {\n          \"name\": \"view_domains\",\n          \"id\": 623290985,\n          \"resource_type\": \"Domain\"\n        }\n      ]\n    },\n    {\n      \"search\": null,\n      \"resource_type\": \"Realm\",\n      \"unlimited?\": true,\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"id\": 343831726,\n      \"role\": {\n        \"name\": \"Manager\",\n        \"id\": 1\n      },\n      \"permissions\": [\n        {\n          \"name\": \"view_realms\",\n          \"id\": 959316070,\n          \"resource_type\": \"Realm\"\n        },\n        {\n          \"name\": \"destroy_realms\",\n          \"id\": 300788035,\n          \"resource_type\": \"Realm\"\n        },\n        {\n          \"name\": \"edit_realms\",\n          \"id\": 327146991,\n          \"resource_type\": \"Realm\"\n        },\n        {\n          \"name\": \"create_realms\",\n          \"id\": 125033645,\n          \"resource_type\": \"Realm\"\n        }\n      ]\n    },\n    {\n      \"search\": null,\n      \"resource_type\": \"User\",\n      \"unlimited?\": true,\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"id\": 372277853,\n      \"role\": {\n        \"name\": \"Manager\",\n        \"id\": 1\n      },\n      \"permissions\": [\n        {\n          \"name\": \"destroy_users\",\n          \"id\": 683333673,\n          \"resource_type\": \"User\"\n        },\n        {\n          \"name\": \"view_users\",\n          \"id\": 916456187,\n          \"resource_type\": \"User\"\n        },\n        {\n          \"name\": \"create_users\",\n          \"id\": 544005512,\n          \"resource_type\": \"User\"\n        },\n        {\n          \"name\": \"edit_users\",\n          \"id\": 758239380,\n          \"resource_type\": \"User\"\n        }\n      ]\n    },\n    {\n      \"search\": null,\n      \"resource_type\": \"Medium\",\n      \"unlimited?\": true,\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"id\": 503111935,\n      \"role\": {\n        \"name\": \"Manager\",\n        \"id\": 1\n      },\n      \"permissions\": [\n        {\n          \"name\": \"create_media\",\n          \"id\": 516151662,\n          \"resource_type\": \"Medium\"\n        },\n        {\n          \"name\": \"edit_media\",\n          \"id\": 329176178,\n          \"resource_type\": \"Medium\"\n        },\n        {\n          \"name\": \"destroy_media\",\n          \"id\": 370531533,\n          \"resource_type\": \"Medium\"\n        },\n        {\n          \"name\": \"view_media\",\n          \"id\": 135202335,\n          \"resource_type\": \"Medium\"\n        }\n      ]\n    },\n    {\n      \"search\": null,\n      \"resource_type\": \"Audit\",\n      \"unlimited?\": true,\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"id\": 528928374,\n      \"role\": {\n        \"name\": \"Manager\",\n        \"id\": 1\n      },\n      \"permissions\": [\n        {\n          \"name\": \"view_audit_logs\",\n          \"id\": 202577195,\n          \"resource_type\": \"Audit\"\n        }\n      ]\n    },\n    {\n      \"search\": null,\n      \"resource_type\": \"Usergroup\",\n      \"unlimited?\": true,\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"id\": 557298380,\n      \"role\": {\n        \"name\": \"Manager\",\n        \"id\": 1\n      },\n      \"permissions\": [\n        {\n          \"name\": \"destroy_usergroups\",\n          \"id\": 1032290172,\n          \"resource_type\": \"Usergroup\"\n        },\n        {\n          \"name\": \"view_usergroups\",\n          \"id\": 44766150,\n          \"resource_type\": \"Usergroup\"\n        },\n        {\n          \"name\": \"create_usergroups\",\n          \"id\": 198876242,\n          \"resource_type\": \"Usergroup\"\n        },\n        {\n          \"name\": \"edit_usergroups\",\n          \"id\": 225115552,\n          \"resource_type\": \"Usergroup\"\n        }\n      ]\n    },\n    {\n      \"search\": null,\n      \"resource_type\": \"LookupKey\",\n      \"unlimited?\": true,\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"id\": 592288835,\n      \"role\": {\n        \"name\": \"Manager\",\n        \"id\": 1\n      },\n      \"permissions\": [\n        {\n          \"name\": \"create_external_variables\",\n          \"id\": 140923897,\n          \"resource_type\": \"LookupKey\"\n        },\n        {\n          \"name\": \"edit_external_variables\",\n          \"id\": 1050695340,\n          \"resource_type\": \"LookupKey\"\n        },\n        {\n          \"name\": \"destroy_external_variables\",\n          \"id\": 693514154,\n          \"resource_type\": \"LookupKey\"\n        },\n        {\n          \"name\": \"view_external_variables\",\n          \"id\": 593459230,\n          \"resource_type\": \"LookupKey\"\n        }\n      ]\n    },\n    {\n      \"search\": null,\n      \"resource_type\": \"HostClass\",\n      \"unlimited?\": true,\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"id\": 595149887,\n      \"role\": {\n        \"name\": \"Manager\",\n        \"id\": 1\n      },\n      \"permissions\": [\n        {\n          \"name\": \"edit_classes\",\n          \"id\": 940819841,\n          \"resource_type\": \"HostClass\"\n        }\n      ]\n    },\n    {\n      \"search\": null,\n      \"resource_type\": \"Model\",\n      \"unlimited?\": true,\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"id\": 643462867,\n      \"role\": {\n        \"name\": \"Manager\",\n        \"id\": 1\n      },\n      \"permissions\": [\n        {\n          \"name\": \"destroy_models\",\n          \"id\": 147454802,\n          \"resource_type\": \"Model\"\n        },\n        {\n          \"name\": \"view_models\",\n          \"id\": 537547377,\n          \"resource_type\": \"Model\"\n        },\n        {\n          \"name\": \"create_models\",\n          \"id\": 509054658,\n          \"resource_type\": \"Model\"\n        },\n        {\n          \"name\": \"edit_models\",\n          \"id\": 173772800,\n          \"resource_type\": \"Model\"\n        }\n      ]\n    },\n    {\n      \"search\": null,\n      \"resource_type\": \"FactValue\",\n      \"unlimited?\": true,\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"id\": 679608033,\n      \"role\": {\n        \"name\": \"Manager\",\n        \"id\": 1\n      },\n      \"permissions\": [\n        {\n          \"name\": \"view_facts\",\n          \"id\": 958901131,\n          \"resource_type\": \"FactValue\"\n        }\n      ]\n    },\n    {\n      \"search\": null,\n      \"resource_type\": \"Host\",\n      \"unlimited?\": true,\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"id\": 721145960,\n      \"role\": {\n        \"name\": \"Manager\",\n        \"id\": 1\n      },\n      \"permissions\": [\n        {\n          \"name\": \"create_hosts\",\n          \"id\": 740433627,\n          \"resource_type\": \"Host\"\n        },\n        {\n          \"name\": \"edit_hosts\",\n          \"id\": 561976263,\n          \"resource_type\": \"Host\"\n        },\n        {\n          \"name\": \"destroy_hosts\",\n          \"id\": 619977594,\n          \"resource_type\": \"Host\"\n        },\n        {\n          \"name\": \"view_hosts\",\n          \"id\": 988725676,\n          \"resource_type\": \"Host\"\n        }\n      ]\n    },\n    {\n      \"search\": null,\n      \"resource_type\": \"Report\",\n      \"unlimited?\": true,\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"id\": 943645556,\n      \"role\": {\n        \"name\": \"Manager\",\n        \"id\": 1\n      },\n      \"permissions\": [\n        {\n          \"name\": \"view_reports\",\n          \"id\": 407024322,\n          \"resource_type\": \"Report\"\n        },\n        {\n          \"name\": \"destroy_reports\",\n          \"id\": 222966002,\n          \"resource_type\": \"Report\"\n        }\n      ]\n    },\n    {\n      \"search\": null,\n      \"resource_type\": \"Hostgroup\",\n      \"unlimited?\": true,\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"id\": 977587707,\n      \"role\": {\n        \"name\": \"Manager\",\n        \"id\": 1\n      },\n      \"permissions\": [\n        {\n          \"name\": \"create_hostgroups\",\n          \"id\": 175778558,\n          \"resource_type\": \"Hostgroup\"\n        },\n        {\n          \"name\": \"edit_hostgroups\",\n          \"id\": 214584076,\n          \"resource_type\": \"Hostgroup\"\n        },\n        {\n          \"name\": \"destroy_hostgroups\",\n          \"id\": 1009240528,\n          \"resource_type\": \"Hostgroup\"\n        },\n        {\n          \"name\": \"view_hostgroups\",\n          \"id\": 51094894,\n          \"resource_type\": \"Hostgroup\"\n        }\n      ]\n    }\n  ]\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/filters/321349837\n200\n{\n  \"search\": null,\n  \"resource_type\": \"Architecture\",\n  \"unlimited?\": true,\n  \"created_at\": \"2015-12-01T02:40:02Z\",\n  \"updated_at\": \"2015-12-01T02:40:02Z\",\n  \"id\": 321349837,\n  \"role\": {\n    \"name\": \"Manager\",\n    \"id\": 1\n  },\n  \"permissions\": [\n    {\n      \"name\": \"create_architectures\",\n      \"id\": 912770095,\n      \"resource_type\": \"Architecture\"\n    },\n    {\n      \"name\": \"edit_architectures\",\n      \"id\": 874798611,\n      \"resource_type\": \"Architecture\"\n    },\n    {\n      \"name\": \"destroy_architectures\",\n      \"id\": 586604735,\n      \"resource_type\": \"Architecture\"\n    },\n    {\n      \"name\": \"view_architectures\",\n      \"id\": 350275019,\n      \"resource_type\": \"Architecture\"\n    }\n  ],\n  \"organizations\": [],\n  \"locations\": []\n}"],"metadata":null,"see":[]},{"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":"filter","full_name":"filter","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"role_id","full_name":"filter[role_id]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"search","full_name":"filter[search]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"permission_ids","full_name":"filter[permission_ids]","description":"","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"organization_ids","full_name":"filter[organization_ids]","description":"","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"location_ids","full_name":"filter[location_ids]","description":"","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":["POST /api/filters\n{\n  \"filter\": {\n    \"role_id\": \"1\",\n    \"permission_ids\": [\n      \"350275019\"\n    ]\n  }\n}\n201\n{\n  \"search\": null,\n  \"resource_type\": \"Architecture\",\n  \"unlimited?\": true,\n  \"created_at\": \"2015-12-01T02:40:37Z\",\n  \"updated_at\": \"2015-12-01T02:40:37Z\",\n  \"id\": 1062414188,\n  \"role\": {\n    \"name\": \"Manager\",\n    \"id\": 1\n  },\n  \"permissions\": [\n    {\n      \"name\": \"view_architectures\",\n      \"id\": 350275019,\n      \"resource_type\": \"Architecture\"\n    }\n  ],\n  \"organizations\": [],\n  \"locations\": []\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"filter","full_name":"filter","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"role_id","full_name":"filter[role_id]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"search","full_name":"filter[search]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"permission_ids","full_name":"filter[permission_ids]","description":"","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"organization_ids","full_name":"filter[organization_ids]","description":"","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"location_ids","full_name":"filter[location_ids]","description":"","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":["PUT /api/filters/321349837\n{\n  \"filter\": {\n    \"role_id\": \"1\",\n    \"permission_ids\": [\n      \"350275019\"\n    ]\n  }\n}\n200\n{\n  \"search\": null,\n  \"resource_type\": \"Architecture\",\n  \"unlimited?\": true,\n  \"created_at\": \"2015-12-01T02:40:02Z\",\n  \"updated_at\": \"2015-12-01T02:40:02Z\",\n  \"id\": 321349837,\n  \"role\": {\n    \"name\": \"Manager\",\n    \"id\": 1\n  },\n  \"permissions\": [\n    {\n      \"name\": \"view_architectures\",\n      \"id\": 350275019,\n      \"resource_type\": \"Architecture\"\n    }\n  ],\n  \"organizations\": [],\n  \"locations\": []\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["DELETE /api/filters/1042311626\n200\n{\n  \"created_at\": \"2015-12-01T02:40:02Z\",\n  \"id\": 1042311626,\n  \"role_id\": 12,\n  \"search\": null,\n  \"taxonomy_search\": null,\n  \"updated_at\": \"2015-12-01T02:40:02Z\"\n}"],"metadata":null,"see":[]}]},"home":{"doc_url":"../apidoc/v2/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":[],"examples":["GET /api\n200\n{\n  \"links\": {\n    \"base\": {},\n    \"architectures\": {\n      \"List all architectures\": \"/api/architectures\",\n      \"Show an architecture\": \"/api/architectures/:id\",\n      \"Create an architecture\": \"/api/architectures\",\n      \"Update an architecture\": \"/api/architectures/:id\",\n      \"Delete an architecture\": \"/api/architectures/:id\"\n    },\n    \"audits\": {\n      \"List all audits\": \"/api/audits\",\n      \"Show an audit\": \"/api/audits/:id\"\n    },\n    \"auth_source_ldaps\": {\n      \"List all LDAP authentication sources\": \"/api/auth_source_ldaps\",\n      \"Show an LDAP authentication source\": \"/api/auth_source_ldaps/:id\",\n      \"Create an LDAP authentication source\": \"/api/auth_source_ldaps\",\n      \"Update an LDAP authentication source\": \"/api/auth_source_ldaps/:id\",\n      \"Delete an LDAP authentication source\": \"/api/auth_source_ldaps/:id\"\n    },\n    \"autosign\": {\n      \"List all autosign entries\": \"/api/smart_proxies/smart_proxy_id/autosign\"\n    },\n    \"bookmarks\": {\n      \"List all bookmarks\": \"/api/bookmarks\",\n      \"Show a bookmark\": \"/api/bookmarks/:id\",\n      \"Create a bookmark\": \"/api/bookmarks\",\n      \"Update a bookmark\": \"/api/bookmarks/:id\",\n      \"Delete a bookmark\": \"/api/bookmarks/:id\"\n    },\n    \"common_parameters\": {\n      \"List all global parameters\": \"/api/common_parameters\",\n      \"Show a global parameter\": \"/api/common_parameters/:id\",\n      \"Create a global parameter\": \"/api/common_parameters\",\n      \"Update a global parameter\": \"/api/common_parameters/:id\",\n      \"Delete a global parameter\": \"/api/common_parameters/:id\"\n    },\n    \"compute_attributes\": {\n      \"Create a compute attributes set\": \"/api/compute_resources/:compute_resource_id/compute_profiles/:compute_profile_id/compute_attributes\",\n      \"Update a compute attributes set\": \"/api/compute_resources/:compute_resource_id/compute_profiles/:compute_profile_id/compute_attributes/:id\"\n    },\n    \"compute_profiles\": {\n      \"List of compute profiles\": \"/api/compute_profiles\",\n      \"Show a compute profile\": \"/api/compute_profiles/:id\",\n      \"Create a compute profile\": \"/api/compute_profiles\",\n      \"Update a compute profile\": \"/api/compute_profiles/:id\",\n      \"Delete a compute profile\": \"/api/compute_profiles/:id\"\n    },\n    \"compute_resources\": {\n      \"List all compute resources\": \"/api/compute_resources\",\n      \"Show a compute resource\": \"/api/compute_resources/:id\",\n      \"Create a compute resource\": \"/api/compute_resources\",\n      \"Update a compute resource\": \"/api/compute_resources/:id\",\n      \"Delete a compute resource\": \"/api/compute_resources/:id\",\n      \"List available images for a compute resource\": \"/api/compute_resources/:id/available_images\",\n      \"List available clusters for a compute resource\": \"/api/compute_resources/:id/available_clusters\",\n      \"List available flavors for a compute resource\": \"/api/compute_resources/:id/available_flavors\",\n      \"List available folders for a compute resource\": \"/api/compute_resources/:id/available_folders\",\n      \"List available zone for a compute resource\": \"/api/compute_resources/:id/available_zones\",\n      \"List available networks for a compute resource\": \"/api/compute_resources/:id/available_networks\",\n      \"List resource pools for a compute resource cluster\": \"/api/compute_resources/:id/available_clusters/:cluster_id/available_resource_pools\",\n      \"List storage_domains for a compute resource\": \"/api/compute_resources/:id/available_storage_domains\",\n      \"List available security groups for a compute resource\": \"/api/compute_resources/:id/available_security_groups\",\n      \"Associate VMs to Hosts\": \"/api/compute_resources/:id/associate\"\n    },\n    \"config_templates\": {\n      \"List provisioning templates\": \"/api/config_templates\",\n      \"Show provisioning template details\": \"/api/config_templates/:id\",\n      \"Create a provisioning template\": \"/api/config_templates\",\n      \"Update a provisioning template\": \"/api/config_templates/:id\",\n      \"Delete a provisioning template\": \"/api/config_templates/:id\",\n      \"Update the default PXE menu on all configured TFTP servers\": \"/api/config_templates/build_pxe_default\",\n      \"Clone a provision template\": \"/api/config_templates/:id/clone\"\n    },\n    \"dashboard\": {\n      \"Get dashboard details\": \"/api/dashboard\"\n    },\n    \"domains\": {\n      \"List of domains\": \"/api/domains\",\n      \"Show a domain\": \"/api/domains/:id\",\n      \"Create a domain\": \"/api/domains\",\n      \"Update a domain\": \"/api/domains/:id\",\n      \"Delete a domain\": \"/api/domains/:id\"\n    },\n    \"environments\": {\n      \"Import puppet classes from puppet proxy\": \"/api/smart_proxies/:id/import_puppetclasses\",\n      \"List all environments\": \"/api/environments\",\n      \"Show an environment\": \"/api/environments/:id\",\n      \"Create an environment\": \"/api/environments\",\n      \"Update an environment\": \"/api/environments/:id\",\n      \"Delete an environment\": \"/api/environments/:id\"\n    },\n    \"external_usergroups\": {\n      \"List all external user groups for user group\": \"/api/usergroups/:usergroup_id/external_usergroups\",\n      \"Show an external user group for user group\": \"/api/usergroups/:usergroup_id/external_usergroups/:id\",\n      \"Create an external user group linked to a user group\": \"/api/usergroups/:usergroup_id/external_usergroups\",\n      \"Update external user group\": \"/api/usergroups/:usergroup_id/external_usergroups/:id\",\n      \"Refresh external user group\": \"/api/usergroups/:usergroup_id/external_usergroups/:id/refresh\",\n      \"Delete an external user group\": \"/api/usergroups/:usergroup_id/external_usergroups/:id\"\n    },\n    \"fact_values\": {\n      \"List all fact values\": \"/api/fact_values\"\n    },\n    \"filters\": {\n      \"List all filters\": \"/api/filters\",\n      \"Show a filter\": \"/api/filters/:id\",\n      \"Create a filter\": \"/api/filters\",\n      \"Update a filter\": \"/api/filters/:id\",\n      \"Delete a filter\": \"/api/filters/:id\"\n    },\n    \"home\": {\n      \"Show available API links\": \"/api\",\n      \"Show status\": \"/api/status\"\n    }\n  }\n}"],"metadata":null,"see":[]},{"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":[],"examples":[],"metadata":null,"see":[]}]},"host_classes":{"doc_url":"../apidoc/v2/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":[],"examples":["GET /api/hosts/host46/puppetclass_ids\n200\n{\n  \"results\": [\n    1018350796\n  ]\n}"],"metadata":null,"see":[]},{"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":"host_id","full_name":"host_id","description":"\n\u003Cp\u003EID of host\u003C/p\u003E\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"puppetclass_id","full_name":"puppetclass_id","description":"\n\u003Cp\u003EID of Puppet class\u003C/p\u003E\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["POST /api/hosts/host47/puppetclass_ids\n{\n  \"puppetclass_id\": \"281110143\",\n  \"host_class\": {\n    \"puppetclass_id\": \"281110143\"\n  }\n}\n200\n{\n  \"host_id\": 1,\n  \"puppetclass_id\": 281110143\n}"],"metadata":null,"see":[]},{"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":"host_id","full_name":"host_id","description":"\n\u003Cp\u003EID of host\u003C/p\u003E\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"id","full_name":"id","description":"\n\u003Cp\u003EID of Puppet class\u003C/p\u003E\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["DELETE /api/hosts/host48/puppetclass_ids/1018350796\n200\n[\n\n]"],"metadata":null,"see":[]}]},"hostgroup_classes":{"doc_url":"../apidoc/v2/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":[],"examples":["GET /api/hostgroups/636252244/puppetclass_ids\n200\n{\n  \"results\": [\n    980190962\n  ]\n}"],"metadata":null,"see":[]},{"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":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003Cp\u003EID of host group\u003C/p\u003E\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"puppetclass_id","full_name":"puppetclass_id","description":"\n\u003Cp\u003EID of Puppet class\u003C/p\u003E\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["POST /api/hostgroups/636252244/puppetclass_ids\n{\n  \"puppetclass_id\": \"281110143\",\n  \"hostgroup_class\": {\n    \"puppetclass_id\": \"281110143\"\n  }\n}\n200\n{\n  \"hostgroup_id\": 636252244,\n  \"puppetclass_id\": 281110143\n}"],"metadata":null,"see":[]},{"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":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003Cp\u003EID of host group\u003C/p\u003E\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"id","full_name":"id","description":"\n\u003Cp\u003EID of Puppet class\u003C/p\u003E\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["DELETE /api/hostgroups/636252244/puppetclass_ids/980190962\n200\n[\n\n]"],"metadata":null,"see":[]}]},"images":{"doc_url":"../apidoc/v2/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":"compute_resource_id","full_name":"compute_resource_id","description":"\n\u003Cp\u003EID of compute resource\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"architecture_id","full_name":"architecture_id","description":"\n\u003Cp\u003EID of architecture\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003Cp\u003EID of operating system\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"search","full_name":"search","description":"\n\u003Cp\u003Efilter results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003Cp\u003Esort results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003Cp\u003Epaginate results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003Cp\u003Enumber of entries per request\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/compute_resources/980190962/images\n200\n{\n  \"total\": 2,\n  \"subtotal\": 2,\n  \"page\": 1,\n  \"per_page\": 20,\n  \"search\": null,\n  \"sort\": {\n    \"by\": null,\n    \"order\": null\n  },\n  \"results\": [\n    {\n      \"operatingsystem_id\": 309172073,\n      \"operatingsystem_name\": \"centos 5.3\",\n      \"compute_resource_id\": 980190962,\n      \"compute_resource_name\": \"bigcompute\",\n      \"architecture_id\": 501905019,\n      \"architecture_name\": \"x86_64\",\n      \"uuid\": \"MyString2\",\n      \"username\": \"MyString\",\n      \"created_at\": \"2015-12-01T02:40:01Z\",\n      \"updated_at\": \"2015-12-01T02:40:01Z\",\n      \"id\": 298486374,\n      \"name\": \"centos-2\"\n    },\n    {\n      \"operatingsystem_id\": 309172073,\n      \"operatingsystem_name\": \"centos 5.3\",\n      \"compute_resource_id\": 980190962,\n      \"compute_resource_name\": \"bigcompute\",\n      \"architecture_id\": 501905019,\n      \"architecture_name\": \"x86_64\",\n      \"uuid\": \"string-of-uuid\",\n      \"username\": \"root\",\n      \"created_at\": \"2015-12-01T02:40:01Z\",\n      \"updated_at\": \"2015-12-01T02:40:01Z\",\n      \"id\": 980190962,\n      \"name\": \"centos-1\"\n    }\n  ]\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"architecture_id","full_name":"architecture_id","description":"\n\u003Cp\u003EID of architecture\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003Cp\u003EID of operating system\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/compute_resources/980190962/images/980190962\n200\n{\n  \"operatingsystem_id\": 309172073,\n  \"operatingsystem_name\": \"centos 5.3\",\n  \"compute_resource_id\": 980190962,\n  \"compute_resource_name\": \"bigcompute\",\n  \"architecture_id\": 501905019,\n  \"architecture_name\": \"x86_64\",\n  \"uuid\": \"string-of-uuid\",\n  \"username\": \"root\",\n  \"created_at\": \"2015-12-01T02:40:01Z\",\n  \"updated_at\": \"2015-12-01T02:40:01Z\",\n  \"id\": 980190962,\n  \"name\": \"centos-1\"\n}"],"metadata":null,"see":[]},{"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":"compute_resource_id","full_name":"compute_resource_id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true},{"name":"image","full_name":"image","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"image[name]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"username","full_name":"image[username]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"uuid","full_name":"image[uuid]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"architecture_id","full_name":"image[architecture_id]","description":"\n\u003Cp\u003EID of architecture\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"operatingsystem_id","full_name":"image[operatingsystem_id]","description":"\n\u003Cp\u003EID of operating system\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}]}],"examples":["POST /api/compute_resources/980190962/images\n{\n  \"image\": {\n    \"name\": \"TestImage\",\n    \"username\": \"ec2-user\",\n    \"uuid\": \"abcdef\",\n    \"operatingsystem_id\": \"775246587\",\n    \"compute_resource_id\": \"510899777\",\n    \"architecture_id\": \"331892513\"\n  }\n}\n201\n{\n  \"operatingsystem_id\": 775246587,\n  \"operatingsystem_name\": \"NoHosts 1.1\",\n  \"compute_resource_id\": 980190962,\n  \"compute_resource_name\": \"bigcompute\",\n  \"architecture_id\": 331892513,\n  \"architecture_name\": \"sparc\",\n  \"uuid\": \"abcdef\",\n  \"username\": \"ec2-user\",\n  \"created_at\": \"2015-12-01T02:40:51Z\",\n  \"updated_at\": \"2015-12-01T02:40:51Z\",\n  \"id\": 980190963,\n  \"name\": \"TestImage\"\n}"],"metadata":null,"see":[]},{"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":"compute_resource_id","full_name":"compute_resource_id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true},{"name":"image","full_name":"image","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"image[name]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"username","full_name":"image[username]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"uuid","full_name":"image[uuid]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"architecture_id","full_name":"image[architecture_id]","description":"\n\u003Cp\u003EID of architecture\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"operatingsystem_id","full_name":"image[operatingsystem_id]","description":"\n\u003Cp\u003EID of operating system\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}]}],"examples":["PUT /api/compute_resources/980190962/images/980190962\n{\n  \"image\": {}\n}\n200\n{\n  \"operatingsystem_id\": 309172073,\n  \"operatingsystem_name\": \"centos 5.3\",\n  \"compute_resource_id\": 980190962,\n  \"compute_resource_name\": \"bigcompute\",\n  \"architecture_id\": 501905019,\n  \"architecture_name\": \"x86_64\",\n  \"uuid\": \"string-of-uuid\",\n  \"username\": \"root\",\n  \"created_at\": \"2015-12-01T02:40:01Z\",\n  \"updated_at\": \"2015-12-01T02:40:01Z\",\n  \"id\": 980190962,\n  \"name\": \"centos-1\"\n}"],"metadata":null,"see":[]},{"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":"compute_resource_id","full_name":"compute_resource_id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true}],"examples":["DELETE /api/compute_resources/980190962/images/980190962\n200\n{\n  \"architecture_id\": 501905019,\n  \"compute_resource_id\": 980190962,\n  \"created_at\": \"2015-12-01T02:40:01Z\",\n  \"iam_role\": null,\n  \"id\": 980190962,\n  \"name\": \"centos-1\",\n  \"operatingsystem_id\": 309172073,\n  \"password\": null,\n  \"updated_at\": \"2015-12-01T02:40:01Z\",\n  \"user_data\": false,\n  \"username\": \"root\",\n  \"uuid\": \"string-of-uuid\"\n}"],"metadata":null,"see":[]}]},"locations":{"doc_url":"../apidoc/v2/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":"search","full_name":"search","description":"\n\u003Cp\u003Efilter results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003Cp\u003Esort results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003Cp\u003Epaginate results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003Cp\u003Enumber of entries per request\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/locations\n200\n{\n  \"total\": 2,\n  \"subtotal\": 2,\n  \"page\": 1,\n  \"per_page\": 20,\n  \"search\": null,\n  \"sort\": {\n    \"by\": null,\n    \"order\": null\n  },\n  \"results\": [\n    {\n      \"ancestry\": null,\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"id\": 255093256,\n      \"name\": \"Location 1\",\n      \"title\": \"Location 1\",\n      \"description\": null\n    },\n    {\n      \"ancestry\": null,\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"id\": 373111740,\n      \"name\": \"Location 2\",\n      \"title\": \"Location 2\",\n      \"description\": null\n    }\n  ]\n}"],"metadata":null,"see":[]},{"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":[],"examples":["GET /api/locations/255093256-Location%201\n200\n{\n  \"select_all_types\": [],\n  \"description\": null,\n  \"created_at\": \"2015-12-01T02:40:02Z\",\n  \"updated_at\": \"2015-12-01T02:40:02Z\",\n  \"ancestry\": null,\n  \"id\": 255093256,\n  \"name\": \"Location 1\",\n  \"title\": \"Location 1\",\n  \"users\": [],\n  \"smart_proxies\": [\n    {\n      \"name\": \"DHCP Proxy\",\n      \"id\": 980190962,\n      \"url\": \"https://somewhere.net:8443\"\n    },\n    {\n      \"name\": \"DNS Proxy\",\n      \"id\": 113629430,\n      \"url\": \"http://else.where:45671\"\n    },\n    {\n      \"name\": \"Puppetmaster Proxy\",\n      \"id\": 182953976,\n      \"url\": \"http://else.where:4567\"\n    },\n    {\n      \"name\": \"Realm Proxy\",\n      \"id\": 982965213,\n      \"url\": \"http://else.where:1337\"\n    },\n    {\n      \"name\": \"TFTP Proxy\",\n      \"id\": 298486374,\n      \"url\": \"http://somewhere.else\"\n    }\n  ],\n  \"subnets\": [\n    {\n      \"id\": 980190962,\n      \"name\": \"one\",\n      \"network_address\": \"2.3.4.0/24\"\n    }\n  ],\n  \"compute_resources\": [\n    {\n      \"id\": 980190962,\n      \"name\": \"bigcompute\",\n      \"provider\": \"Libvirt\",\n      \"provider_friendly_name\": \"Libvirt\"\n    }\n  ],\n  \"media\": [\n    {\n      \"id\": 980190962,\n      \"name\": \"CentOS 5.4\"\n    }\n  ],\n  \"config_templates\": [\n    {\n      \"id\": 269958254,\n      \"name\": \"MyString2\",\n      \"template_kind_id\": 983253650,\n      \"template_kind_name\": \"provision\"\n    }\n  ],\n  \"ptables\": [],\n  \"provisioning_templates\": [\n    {\n      \"id\": 269958254,\n      \"name\": \"MyString2\",\n      \"template_kind_id\": 983253650,\n      \"template_kind_name\": \"provision\"\n    }\n  ],\n  \"domains\": [\n    {\n      \"id\": 22495316,\n      \"name\": \"mydomain.net\"\n    },\n    {\n      \"id\": 589326610,\n      \"name\": \"yourdomain.net\"\n    }\n  ],\n  \"environments\": [\n    {\n      \"name\": \"production\",\n      \"id\": 334344675\n    }\n  ],\n  \"hostgroups\": [],\n  \"organizations\": [\n    {\n      \"id\": 447626438,\n      \"name\": \"Organization 1\",\n      \"title\": \"Organization 1\",\n      \"description\": null\n    }\n  ],\n  \"parameters\": {}\n}"],"metadata":null,"see":[]},{"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","full_name":"location","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"location[name]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"description","full_name":"location[description]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"user_ids","full_name":"location[user_ids]","description":"\n\u003Cp\u003EUser IDs\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"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,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"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,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"media_ids","full_name":"location[media_ids]","description":"\n\u003Cp\u003EMedia IDs\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"config_template_ids","full_name":"location[config_template_ids]","description":"\n\u003Cp\u003EProvisioning template IDs\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"ptable_ids","full_name":"location[ptable_ids]","description":"\n\u003Cp\u003EPartition template IDs\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"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,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"domain_ids","full_name":"location[domain_ids]","description":"\n\u003Cp\u003EDomain IDs\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"realm_ids","full_name":"location[realm_ids]","description":"\n\u003Cp\u003ERealm IDs\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"hostgroup_ids","full_name":"location[hostgroup_ids]","description":"\n\u003Cp\u003EHost group IDs\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"environment_ids","full_name":"location[environment_ids]","description":"\n\u003Cp\u003EEnvironment IDs\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"subnet_ids","full_name":"location[subnet_ids]","description":"\n\u003Cp\u003ESubnet IDs\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":["POST /api/locations\n{\n  \"location\": {\n    \"name\": \"\"\n  }\n}\n422\n{\n  \"error\": {\n    \"id\": null,\n    \"errors\": {\n      \"name\": [\n        \"can't be blank\"\n      ],\n      \"title\": [\n        \"can't be blank\"\n      ]\n    },\n    \"full_messages\": [\n      \"Name can't be blank\",\n      \"Title can't be blank\"\n    ]\n  }\n}"],"metadata":null,"see":[]},{"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","full_name":"location","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"location[name]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"description","full_name":"location[description]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"user_ids","full_name":"location[user_ids]","description":"\n\u003Cp\u003EUser IDs\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"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,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"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,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"media_ids","full_name":"location[media_ids]","description":"\n\u003Cp\u003EMedia IDs\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"config_template_ids","full_name":"location[config_template_ids]","description":"\n\u003Cp\u003EProvisioning template IDs\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"ptable_ids","full_name":"location[ptable_ids]","description":"\n\u003Cp\u003EPartition template IDs\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"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,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"domain_ids","full_name":"location[domain_ids]","description":"\n\u003Cp\u003EDomain IDs\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"realm_ids","full_name":"location[realm_ids]","description":"\n\u003Cp\u003ERealm IDs\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"hostgroup_ids","full_name":"location[hostgroup_ids]","description":"\n\u003Cp\u003EHost group IDs\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"environment_ids","full_name":"location[environment_ids]","description":"\n\u003Cp\u003EEnvironment IDs\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"subnet_ids","full_name":"location[subnet_ids]","description":"\n\u003Cp\u003ESubnet IDs\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":["PUT /api/locations/255093256-Location%201\n{\n  \"location\": {\n    \"name\": \"New Location\",\n    \"ignore_types\": [\n      \"Domain\",\n      \"Hostgroup\",\n      \"Environment\",\n      \"User\",\n      \"Medium\",\n      \"Subnet\",\n      \"SmartProxy\",\n      \"ProvisioningTemplate\",\n      \"ComputeResource\",\n      \"Realm\"\n    ]\n  }\n}\n200\n{\n  \"ancestry\": null,\n  \"created_at\": \"2015-12-01T02:40:02Z\",\n  \"description\": null,\n  \"id\": 255093256,\n  \"ignore_types\": [\n    \"Domain\",\n    \"Hostgroup\",\n    \"Environment\",\n    \"User\",\n    \"Medium\",\n    \"Subnet\",\n    \"SmartProxy\",\n    \"ProvisioningTemplate\",\n    \"ComputeResource\",\n    \"Realm\"\n  ],\n  \"name\": \"New Location\",\n  \"title\": \"New Location\",\n  \"updated_at\": \"2015-12-01T02:40:53Z\"\n}"],"metadata":null,"see":[]},{"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":[],"examples":["DELETE /api/locations/373111740-Location%202\n200\n{\n  \"ancestry\": null,\n  \"created_at\": \"2015-12-01T02:40:02Z\",\n  \"description\": null,\n  \"id\": 373111740,\n  \"ignore_types\": [],\n  \"name\": \"Location 2\",\n  \"title\": \"Location 2\",\n  \"updated_at\": \"2015-12-01T02:40:02Z\"\n}"],"metadata":null,"see":[]}]},"mail_notifications":{"doc_url":"../apidoc/v2/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":"search","full_name":"search","description":"\n\u003Cp\u003Efilter results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003Cp\u003Esort results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003Cp\u003Epaginate results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003Cp\u003Enumber of entries per request\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"\n\u003Cp\u003ENumerical ID or email notification name\u003C/p\u003E\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[]}]},"media":{"doc_url":"../apidoc/v2/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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"location_id","full_name":"location_id","description":"\n\u003Cp\u003EScope by locations\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"organization_id","full_name":"organization_id","description":"\n\u003Cp\u003EScope by organizations\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"search","full_name":"search","description":"\n\u003Cp\u003Efilter results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003Cp\u003Esort results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003Cp\u003Epaginate results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003Cp\u003Enumber of entries per request\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/media\n200\n{\n  \"total\": 4,\n  \"subtotal\": 4,\n  \"page\": 1,\n  \"per_page\": 20,\n  \"search\": null,\n  \"sort\": {\n    \"by\": null,\n    \"order\": null\n  },\n  \"results\": [\n    {\n      \"path\": \"http://mirror.centos.org/centos/6.0/os/$arch\",\n      \"os_family\": null,\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"id\": 980190962,\n      \"name\": \"CentOS 5.4\"\n    },\n    {\n      \"path\": \"http://brsla01/vol/solgi_5.10/sol$minor_$release_$arch\",\n      \"os_family\": null,\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"id\": 442321401,\n      \"name\": \"Solaris 10\"\n    },\n    {\n      \"path\": \"http://sg.archive.ubuntu.com\",\n      \"os_family\": null,\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"id\": 1011586618,\n      \"name\": \"Ubuntu Mirror\"\n    },\n    {\n      \"path\": \"http://nothing.intersting.com\",\n      \"os_family\": null,\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"id\": 338446587,\n      \"name\": \"unused\"\n    }\n  ]\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/media/980190962-CentOS%205-4\n200\n{\n  \"path\": \"http://mirror.centos.org/centos/6.0/os/$arch\",\n  \"os_family\": null,\n  \"created_at\": \"2015-12-01T02:40:02Z\",\n  \"updated_at\": \"2015-12-01T02:40:02Z\",\n  \"id\": 980190962,\n  \"name\": \"CentOS 5.4\",\n  \"operatingsystems\": [\n    {\n      \"id\": 1073012828,\n      \"name\": \"Redhat\",\n      \"title\": \"RHEL 6.1\"\n    },\n    {\n      \"id\": 309172073,\n      \"name\": \"centos\",\n      \"title\": \"centos 5.3\"\n    }\n  ],\n  \"locations\": [\n    {\n      \"id\": 255093256,\n      \"name\": \"Location 1\",\n      \"title\": \"Location 1\",\n      \"description\": null\n    }\n  ],\n  \"organizations\": []\n}"],"metadata":null,"see":[]},{"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":"medium","full_name":"medium","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"medium[name]","description":"\n\u003Cp\u003EName of media\u003C/p\u003E\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"path","full_name":"medium[path]","description":"\n\u003Cp\u003EThe path to the medium, can be a URL or a valid NFS server (exclusive of the architecture).\u003C/p\u003E\n\n\u003Cp\u003Efor example http://mirror.centos.org/centos/$version/os/$arch where $arch will be substituted for the host\u2019s actual OS architecture and $version, $major and $minor will be substituted for the version of the operating system.\u003C/p\u003E\n\n\u003Cp\u003ESolaris and Debian media may also use $release.\u003C/p\u003E\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"os_family","full_name":"medium[os_family]","description":"\n\u003Cp\u003EOperating system family, available values: AIX, Altlinux, Archlinux, Coreos, Debian, Freebsd, Gentoo, Junos, NXOS, Redhat, Solaris, Suse, Windows\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"operatingsystem_ids","full_name":"medium[operatingsystem_ids]","description":"","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"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,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"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,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":["POST /api/media\n{\n  \"medium\": {\n    \"name\": \"new medium\",\n    \"path\": \"http://www.newmedium.com/\"\n  }\n}\n201\n{\n  \"path\": \"http://www.newmedium.com/\",\n  \"os_family\": null,\n  \"created_at\": \"2015-12-01T02:40:57Z\",\n  \"updated_at\": \"2015-12-01T02:40:57Z\",\n  \"id\": 1011586619,\n  \"name\": \"new medium\",\n  \"operatingsystems\": [],\n  \"locations\": [],\n  \"organizations\": []\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"medium","full_name":"medium","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"medium[name]","description":"\n\u003Cp\u003EName of media\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"path","full_name":"medium[path]","description":"\n\u003Cp\u003EThe path to the medium, can be a URL or a valid NFS server (exclusive of the architecture).\u003C/p\u003E\n\n\u003Cp\u003Efor example http://mirror.centos.org/centos/$version/os/$arch where $arch will be substituted for the host\u2019s actual OS architecture and $version, $major and $minor will be substituted for the version of the operating system.\u003C/p\u003E\n\n\u003Cp\u003ESolaris and Debian media may also use $release.\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"os_family","full_name":"medium[os_family]","description":"\n\u003Cp\u003EOperating system family, available values: AIX, Altlinux, Archlinux, Coreos, Debian, Freebsd, Gentoo, Junos, NXOS, Redhat, Solaris, Suse, Windows\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"operatingsystem_ids","full_name":"medium[operatingsystem_ids]","description":"","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"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,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"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,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":["PUT /api/media/980190962\n{\n  \"name\": \"CentOS 5.4\",\n  \"medium\": {\n    \"name\": \"CentOS 5.4\"\n  }\n}\n200\n{\n  \"path\": \"http://mirror.centos.org/centos/6.0/os/$arch\",\n  \"os_family\": null,\n  \"created_at\": \"2015-12-01T02:40:02Z\",\n  \"updated_at\": \"2015-12-01T02:40:02Z\",\n  \"id\": 980190962,\n  \"name\": \"CentOS 5.4\",\n  \"operatingsystems\": [\n    {\n      \"id\": 1073012828,\n      \"name\": \"Redhat\",\n      \"title\": \"RHEL 6.1\"\n    },\n    {\n      \"id\": 309172073,\n      \"name\": \"centos\",\n      \"title\": \"centos 5.3\"\n    }\n  ],\n  \"locations\": [\n    {\n      \"id\": 255093256,\n      \"name\": \"Location 1\",\n      \"title\": \"Location 1\",\n      \"description\": null\n    }\n  ],\n  \"organizations\": []\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true}],"examples":["DELETE /api/media/338446587\n200\n{\n  \"config_path\": null,\n  \"created_at\": \"2015-12-01T02:40:02Z\",\n  \"id\": 338446587,\n  \"image_path\": null,\n  \"media_path\": null,\n  \"name\": \"unused\",\n  \"os_family\": null,\n  \"path\": \"http://nothing.intersting.com\",\n  \"updated_at\": \"2015-12-01T02:40:02Z\"\n}"],"metadata":null,"see":[]}]},"models":{"doc_url":"../apidoc/v2/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":"search","full_name":"search","description":"\n\u003Cp\u003Efilter results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003Cp\u003Esort results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003Cp\u003Epaginate results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003Cp\u003Enumber of entries per request\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/models\n200\n{\n  \"total\": 2,\n  \"subtotal\": 2,\n  \"page\": 1,\n  \"per_page\": 20,\n  \"search\": null,\n  \"sort\": {\n    \"by\": null,\n    \"order\": null\n  },\n  \"results\": [\n    {\n      \"info\": \"Virtual Machine\",\n      \"created_at\": \"2015-12-01T02:40:01Z\",\n      \"updated_at\": \"2015-12-01T02:40:01Z\",\n      \"vendor_class\": null,\n      \"hardware_model\": null,\n      \"id\": 980190962,\n      \"name\": \"KVM\"\n    },\n    {\n      \"info\": null,\n      \"created_at\": \"2015-12-01T02:40:01Z\",\n      \"updated_at\": \"2015-12-01T02:40:01Z\",\n      \"vendor_class\": \"Sun-Fire-V210\",\n      \"hardware_model\": \"SUN4U\",\n      \"id\": 139037058,\n      \"name\": \"SUN V210\"\n    }\n  ]\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/models/KVM\n200\n{\n  \"info\": \"Virtual Machine\",\n  \"created_at\": \"2015-12-01T02:40:01Z\",\n  \"updated_at\": \"2015-12-01T02:40:01Z\",\n  \"vendor_class\": null,\n  \"hardware_model\": null,\n  \"id\": 980190962,\n  \"name\": \"KVM\"\n}"],"metadata":null,"see":[]},{"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":"model","full_name":"model","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"model[name]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"info","full_name":"model[info]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"vendor_class","full_name":"model[vendor_class]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"hardware_model","full_name":"model[hardware_model]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}]}],"examples":["POST /api/models\n{\n  \"model\": {\n    \"name\": \"new model\"\n  }\n}\n201\n{\n  \"info\": null,\n  \"created_at\": \"2015-12-01T02:40:58Z\",\n  \"updated_at\": \"2015-12-01T02:40:58Z\",\n  \"vendor_class\": null,\n  \"hardware_model\": null,\n  \"id\": 980190963,\n  \"name\": \"new model\"\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"model","full_name":"model","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"model[name]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"info","full_name":"model[info]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"vendor_class","full_name":"model[vendor_class]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"hardware_model","full_name":"model[hardware_model]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}]}],"examples":["PUT /api/models/KVM\n{\n  \"name\": \"KVM\",\n  \"model\": {\n    \"name\": \"KVM\"\n  }\n}\n200\n{\n  \"info\": \"Virtual Machine\",\n  \"created_at\": \"2015-12-01T02:40:01Z\",\n  \"updated_at\": \"2015-12-01T02:40:01Z\",\n  \"vendor_class\": null,\n  \"hardware_model\": null,\n  \"id\": 980190962,\n  \"name\": \"KVM\"\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["DELETE /api/models/KVM\n200\n{\n  \"created_at\": \"2015-12-01T02:40:01Z\",\n  \"hardware_model\": null,\n  \"hosts_count\": 0,\n  \"id\": 980190962,\n  \"info\": \"Virtual Machine\",\n  \"name\": \"KVM\",\n  \"updated_at\": \"2015-12-01T02:40:01Z\",\n  \"vendor_class\": null\n}"],"metadata":null,"see":[]}]},"operatingsystems":{"doc_url":"../apidoc/v2/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/config_templates/:config_template_id/operatingsystems","http_method":"GET","short_description":"List all operating systems for nested provisioning template","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":"architecture_id","full_name":"architecture_id","description":"\n\u003Cp\u003EID of architecture\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"medium_id","full_name":"medium_id","description":"\n\u003Cp\u003EID of medium\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"ptable_id","full_name":"ptable_id","description":"\n\u003Cp\u003EID of partition table\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"config_template_id","full_name":"config_template_id","description":"\n\u003Cp\u003EID of template\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"provisioning_template_id","full_name":"provisioning_template_id","description":"\n\u003Cp\u003EID of template\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"search","full_name":"search","description":"\n\u003Cp\u003Efilter results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003Cp\u003Esort results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003Cp\u003Epaginate results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003Cp\u003Enumber of entries per request\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/operatingsystems\n200\n{\n  \"total\": 5,\n  \"subtotal\": 5,\n  \"page\": 1,\n  \"per_page\": 20,\n  \"search\": null,\n  \"sort\": {\n    \"by\": null,\n    \"order\": null\n  },\n  \"results\": [\n    {\n      \"description\": null,\n      \"major\": \"1\",\n      \"minor\": \"1\",\n      \"family\": \"Redhat\",\n      \"release_name\": null,\n      \"password_hash\": \"SHA256\",\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"id\": 775246587,\n      \"name\": \"NoHosts\",\n      \"title\": \"NoHosts 1.1\"\n    },\n    {\n      \"description\": \"RHEL 6.1\",\n      \"major\": \"6\",\n      \"minor\": \"1\",\n      \"family\": \"Redhat\",\n      \"release_name\": null,\n      \"password_hash\": \"SHA256\",\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"id\": 1073012828,\n      \"name\": \"Redhat\",\n      \"title\": \"RHEL 6.1\"\n    },\n    {\n      \"description\": null,\n      \"major\": \"5\",\n      \"minor\": \"10\",\n      \"family\": \"Solaris\",\n      \"release_name\": \"hw0910\",\n      \"password_hash\": \"SHA256\",\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"id\": 442321401,\n      \"name\": \"Solaris\",\n      \"title\": \"Solaris 5.10\"\n    },\n    {\n      \"description\": null,\n      \"major\": \"10\",\n      \"minor\": \"10\",\n      \"family\": \"Debian\",\n      \"release_name\": null,\n      \"password_hash\": \"SHA256\",\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"id\": 331303656,\n      \"name\": \"Ubuntu\",\n      \"title\": \"Ubuntu 10.10\"\n    },\n    {\n      \"description\": null,\n      \"major\": \"5\",\n      \"minor\": \"3\",\n      \"family\": \"Redhat\",\n      \"release_name\": null,\n      \"password_hash\": \"SHA256\",\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"id\": 309172073,\n      \"name\": \"centos\",\n      \"title\": \"centos 5.3\"\n    }\n  ]\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/operatingsystems/1073012828-RHEL%206-1\n200\n{\n  \"description\": \"RHEL 6.1\",\n  \"major\": \"6\",\n  \"minor\": \"1\",\n  \"family\": \"Redhat\",\n  \"release_name\": null,\n  \"password_hash\": \"SHA256\",\n  \"created_at\": \"2015-12-01T02:40:02Z\",\n  \"updated_at\": \"2015-12-01T02:40:02Z\",\n  \"id\": 1073012828,\n  \"name\": \"Redhat\",\n  \"title\": \"RHEL 6.1\",\n  \"parameters\": [\n    {\n      \"id\": 716195090,\n      \"name\": \"os1\",\n      \"value\": \"os1\"\n    }\n  ],\n  \"media\": [\n    {\n      \"id\": 980190962,\n      \"name\": \"CentOS 5.4\"\n    }\n  ],\n  \"architectures\": [\n    {\n      \"name\": \"x86_64\",\n      \"id\": 501905019\n    }\n  ],\n  \"ptables\": [],\n  \"config_templates\": [\n    {\n      \"id\": 104314179,\n      \"name\": \"MyFinish\",\n      \"template_kind_id\": 550103832,\n      \"template_kind_name\": \"finish\"\n    },\n    {\n      \"id\": 981457253,\n      \"name\": \"MyScript\",\n      \"template_kind_id\": 478250810,\n      \"template_kind_name\": \"script\"\n    },\n    {\n      \"id\": 943779058,\n      \"name\": \"MyString\",\n      \"template_kind_id\": 698706415,\n      \"template_kind_name\": \"iPXE\"\n    },\n    {\n      \"id\": 269958254,\n      \"name\": \"MyString2\",\n      \"template_kind_id\": 983253650,\n      \"template_kind_name\": \"provision\"\n    },\n    {\n      \"id\": 131565194,\n      \"name\": \"PXEGrub Dummy Menu\",\n      \"template_kind_id\": 131565194,\n      \"template_kind_name\": \"PXEGrub\"\n    },\n    {\n      \"id\": 821548108,\n      \"name\": \"PXELinux default local boot\",\n      \"template_kind_id\": 452984334,\n      \"template_kind_name\": \"PXELinux\"\n    },\n    {\n      \"id\": 352050261,\n      \"name\": \"PXELinux global default\",\n      \"template_kind_id\": 452984334,\n      \"template_kind_name\": \"PXELinux\"\n    },\n    {\n      \"id\": 1007981701,\n      \"name\": \"centos5_3_pxelinux\",\n      \"template_kind_id\": 452984334,\n      \"template_kind_name\": \"PXELinux\"\n    }\n  ],\n  \"provisioning_templates\": [\n    {\n      \"id\": 104314179,\n      \"name\": \"MyFinish\",\n      \"template_kind_id\": 550103832,\n      \"template_kind_name\": \"finish\"\n    },\n    {\n      \"id\": 981457253,\n      \"name\": \"MyScript\",\n      \"template_kind_id\": 478250810,\n      \"template_kind_name\": \"script\"\n    },\n    {\n      \"id\": 943779058,\n      \"name\": \"MyString\",\n      \"template_kind_id\": 698706415,\n      \"template_kind_name\": \"iPXE\"\n    },\n    {\n      \"id\": 269958254,\n      \"name\": \"MyString2\",\n      \"template_kind_id\": 983253650,\n      \"template_kind_name\": \"provision\"\n    },\n    {\n      \"id\": 131565194,\n      \"name\": \"PXEGrub Dummy Menu\",\n      \"template_kind_id\": 131565194,\n      \"template_kind_name\": \"PXEGrub\"\n    },\n    {\n      \"id\": 821548108,\n      \"name\": \"PXELinux default local boot\",\n      \"template_kind_id\": 452984334,\n      \"template_kind_name\": \"PXELinux\"\n    },\n    {\n      \"id\": 352050261,\n      \"name\": \"PXELinux global default\",\n      \"template_kind_id\": 452984334,\n      \"template_kind_name\": \"PXELinux\"\n    },\n    {\n      \"id\": 1007981701,\n      \"name\": \"centos5_3_pxelinux\",\n      \"template_kind_id\": 452984334,\n      \"template_kind_name\": \"PXELinux\"\n    }\n  ],\n  \"os_default_templates\": [\n    {\n      \"id\": 51848956,\n      \"provisioning_template_id\": 698706415,\n      \"provisioning_template_name\": \"iPXE Dummy Menu\",\n      \"template_kind_id\": 698706415,\n      \"template_kind_name\": \"iPXE\",\n      \"operatingsystem_id\": 1073012828,\n      \"operatingsystem_name\": \"RHEL 6.1\",\n      \"config_template_id\": 698706415,\n      \"config_template_name\": \"iPXE Dummy Menu\"\n    },\n    {\n      \"id\": 113629430,\n      \"provisioning_template_id\": 981457253,\n      \"provisioning_template_name\": \"MyScript\",\n      \"template_kind_id\": 478250810,\n      \"template_kind_name\": \"script\",\n      \"operatingsystem_id\": 1073012828,\n      \"operatingsystem_name\": \"RHEL 6.1\",\n      \"config_template_id\": 981457253,\n      \"config_template_name\": \"MyScript\"\n    },\n    {\n      \"id\": 281110143,\n      \"provisioning_template_id\": 1007981701,\n      \"provisioning_template_name\": \"centos5_3_pxelinux\",\n      \"template_kind_id\": 710512633,\n      \"template_kind_name\": null,\n      \"operatingsystem_id\": 1073012828,\n      \"operatingsystem_name\": \"RHEL 6.1\",\n      \"config_template_id\": 1007981701,\n      \"config_template_name\": \"centos5_3_pxelinux\"\n    },\n    {\n      \"id\": 298486374,\n      \"provisioning_template_id\": 269958254,\n      \"provisioning_template_name\": \"MyString2\",\n      \"template_kind_id\": 983253650,\n      \"template_kind_name\": \"provision\",\n      \"operatingsystem_id\": 1073012828,\n      \"operatingsystem_name\": \"RHEL 6.1\",\n      \"config_template_id\": 269958254,\n      \"config_template_name\": \"MyString2\"\n    },\n    {\n      \"id\": 980190962,\n      \"provisioning_template_id\": 943779058,\n      \"provisioning_template_name\": \"MyString\",\n      \"template_kind_id\": 698706415,\n      \"template_kind_name\": \"iPXE\",\n      \"operatingsystem_id\": 1073012828,\n      \"operatingsystem_name\": \"RHEL 6.1\",\n      \"config_template_id\": 943779058,\n      \"config_template_name\": \"MyString\"\n    },\n    {\n      \"id\": 1018350795,\n      \"provisioning_template_id\": 131565194,\n      \"provisioning_template_name\": \"PXEGrub Dummy Menu\",\n      \"template_kind_id\": 131565194,\n      \"template_kind_name\": \"PXEGrub\",\n      \"operatingsystem_id\": 1073012828,\n      \"operatingsystem_name\": \"RHEL 6.1\",\n      \"config_template_id\": 131565194,\n      \"config_template_name\": \"PXEGrub Dummy Menu\"\n    }\n  ],\n  \"images\": []\n}"],"metadata":null,"see":[]},{"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":"operatingsystem","full_name":"operatingsystem","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"operatingsystem[name]","description":"","required":true,"allow_nil":false,"validator":"Must match regular expression /\\A(\\S+)\\Z/.","expected_type":"string","metadata":null,"show":true},{"name":"major","full_name":"operatingsystem[major]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"minor","full_name":"operatingsystem[minor]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"description","full_name":"operatingsystem[description]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"family","full_name":"operatingsystem[family]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"release_name","full_name":"operatingsystem[release_name]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"password_hash","full_name":"operatingsystem[password_hash]","description":"\n\u003Cp\u003ERoot password hash function to use, one of MD5, SHA256, SHA512, Base64\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"architecture_ids","full_name":"operatingsystem[architecture_ids]","description":"\n\u003Cp\u003EIDs of associated architectures\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"config_template_ids","full_name":"operatingsystem[config_template_ids]","description":"\n\u003Cp\u003EIDs of associated provisioning templates\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"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,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"medium_ids","full_name":"operatingsystem[medium_ids]","description":"\n\u003Cp\u003EIDs of associated media\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"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,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":["POST /api/operatingsystems\n{\n  \"operatingsystem\": {\n    \"name\": \"awsome_os\",\n    \"major\": \"1\",\n    \"minor\": \"2\"\n  }\n}\n201\n{\n  \"description\": null,\n  \"major\": \"1\",\n  \"minor\": \"2\",\n  \"family\": null,\n  \"release_name\": null,\n  \"password_hash\": \"SHA256\",\n  \"created_at\": \"2015-12-01T02:40:58Z\",\n  \"updated_at\": \"2015-12-01T02:40:58Z\",\n  \"id\": 1073012829,\n  \"name\": \"awsome_os\",\n  \"title\": \"awsome_os 1.2\",\n  \"parameters\": [],\n  \"media\": [],\n  \"architectures\": [],\n  \"ptables\": [],\n  \"config_templates\": [],\n  \"provisioning_templates\": [],\n  \"os_default_templates\": [],\n  \"images\": []\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"operatingsystem","full_name":"operatingsystem","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"operatingsystem[name]","description":"","required":false,"allow_nil":false,"validator":"Must match regular expression /\\A(\\S+)\\Z/.","expected_type":"string","metadata":null,"show":true},{"name":"major","full_name":"operatingsystem[major]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"minor","full_name":"operatingsystem[minor]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"description","full_name":"operatingsystem[description]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"family","full_name":"operatingsystem[family]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"release_name","full_name":"operatingsystem[release_name]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"password_hash","full_name":"operatingsystem[password_hash]","description":"\n\u003Cp\u003ERoot password hash function to use, one of MD5, SHA256, SHA512, Base64\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"architecture_ids","full_name":"operatingsystem[architecture_ids]","description":"\n\u003Cp\u003EIDs of associated architectures\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"config_template_ids","full_name":"operatingsystem[config_template_ids]","description":"\n\u003Cp\u003EIDs of associated provisioning templates\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"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,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"medium_ids","full_name":"operatingsystem[medium_ids]","description":"\n\u003Cp\u003EIDs of associated media\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"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,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":["PUT /api/operatingsystems/1073012828-RHEL%206-1\n{\n  \"operatingsystem\": {\n    \"name\": \"new_name\"\n  }\n}\n200\n{\n  \"description\": \"RHEL 6.1\",\n  \"major\": \"6\",\n  \"minor\": \"1\",\n  \"family\": \"Redhat\",\n  \"release_name\": null,\n  \"password_hash\": \"SHA256\",\n  \"created_at\": \"2015-12-01T02:40:02Z\",\n  \"updated_at\": \"2015-12-01T02:40:58Z\",\n  \"id\": 1073012828,\n  \"name\": \"new_name\",\n  \"title\": \"RHEL 6.1\",\n  \"parameters\": [\n    {\n      \"id\": 716195090,\n      \"name\": \"os1\",\n      \"value\": \"os1\"\n    }\n  ],\n  \"media\": [\n    {\n      \"id\": 980190962,\n      \"name\": \"CentOS 5.4\"\n    }\n  ],\n  \"architectures\": [\n    {\n      \"name\": \"x86_64\",\n      \"id\": 501905019\n    }\n  ],\n  \"ptables\": [],\n  \"config_templates\": [\n    {\n      \"id\": 104314179,\n      \"name\": \"MyFinish\",\n      \"template_kind_id\": 550103832,\n      \"template_kind_name\": \"finish\"\n    },\n    {\n      \"id\": 981457253,\n      \"name\": \"MyScript\",\n      \"template_kind_id\": 478250810,\n      \"template_kind_name\": \"script\"\n    },\n    {\n      \"id\": 943779058,\n      \"name\": \"MyString\",\n      \"template_kind_id\": 698706415,\n      \"template_kind_name\": \"iPXE\"\n    },\n    {\n      \"id\": 269958254,\n      \"name\": \"MyString2\",\n      \"template_kind_id\": 983253650,\n      \"template_kind_name\": \"provision\"\n    },\n    {\n      \"id\": 131565194,\n      \"name\": \"PXEGrub Dummy Menu\",\n      \"template_kind_id\": 131565194,\n      \"template_kind_name\": \"PXEGrub\"\n    },\n    {\n      \"id\": 821548108,\n      \"name\": \"PXELinux default local boot\",\n      \"template_kind_id\": 452984334,\n      \"template_kind_name\": \"PXELinux\"\n    },\n    {\n      \"id\": 352050261,\n      \"name\": \"PXELinux global default\",\n      \"template_kind_id\": 452984334,\n      \"template_kind_name\": \"PXELinux\"\n    },\n    {\n      \"id\": 1007981701,\n      \"name\": \"centos5_3_pxelinux\",\n      \"template_kind_id\": 452984334,\n      \"template_kind_name\": \"PXELinux\"\n    }\n  ],\n  \"provisioning_templates\": [\n    {\n      \"id\": 104314179,\n      \"name\": \"MyFinish\",\n      \"template_kind_id\": 550103832,\n      \"template_kind_name\": \"finish\"\n    },\n    {\n      \"id\": 981457253,\n      \"name\": \"MyScript\",\n      \"template_kind_id\": 478250810,\n      \"template_kind_name\": \"script\"\n    },\n    {\n      \"id\": 943779058,\n      \"name\": \"MyString\",\n      \"template_kind_id\": 698706415,\n      \"template_kind_name\": \"iPXE\"\n    },\n    {\n      \"id\": 269958254,\n      \"name\": \"MyString2\",\n      \"template_kind_id\": 983253650,\n      \"template_kind_name\": \"provision\"\n    },\n    {\n      \"id\": 131565194,\n      \"name\": \"PXEGrub Dummy Menu\",\n      \"template_kind_id\": 131565194,\n      \"template_kind_name\": \"PXEGrub\"\n    },\n    {\n      \"id\": 821548108,\n      \"name\": \"PXELinux default local boot\",\n      \"template_kind_id\": 452984334,\n      \"template_kind_name\": \"PXELinux\"\n    },\n    {\n      \"id\": 352050261,\n      \"name\": \"PXELinux global default\",\n      \"template_kind_id\": 452984334,\n      \"template_kind_name\": \"PXELinux\"\n    },\n    {\n      \"id\": 1007981701,\n      \"name\": \"centos5_3_pxelinux\",\n      \"template_kind_id\": 452984334,\n      \"template_kind_name\": \"PXELinux\"\n    }\n  ],\n  \"os_default_templates\": [\n    {\n      \"id\": 51848956,\n      \"provisioning_template_id\": 698706415,\n      \"provisioning_template_name\": \"iPXE Dummy Menu\",\n      \"template_kind_id\": 698706415,\n      \"template_kind_name\": \"iPXE\",\n      \"operatingsystem_id\": 1073012828,\n      \"operatingsystem_name\": \"RHEL 6.1\",\n      \"config_template_id\": 698706415,\n      \"config_template_name\": \"iPXE Dummy Menu\"\n    },\n    {\n      \"id\": 113629430,\n      \"provisioning_template_id\": 981457253,\n      \"provisioning_template_name\": \"MyScript\",\n      \"template_kind_id\": 478250810,\n      \"template_kind_name\": \"script\",\n      \"operatingsystem_id\": 1073012828,\n      \"operatingsystem_name\": \"RHEL 6.1\",\n      \"config_template_id\": 981457253,\n      \"config_template_name\": \"MyScript\"\n    },\n    {\n      \"id\": 281110143,\n      \"provisioning_template_id\": 1007981701,\n      \"provisioning_template_name\": \"centos5_3_pxelinux\",\n      \"template_kind_id\": 710512633,\n      \"template_kind_name\": null,\n      \"operatingsystem_id\": 1073012828,\n      \"operatingsystem_name\": \"RHEL 6.1\",\n      \"config_template_id\": 1007981701,\n      \"config_template_name\": \"centos5_3_pxelinux\"\n    },\n    {\n      \"id\": 298486374,\n      \"provisioning_template_id\": 269958254,\n      \"provisioning_template_name\": \"MyString2\",\n      \"template_kind_id\": 983253650,\n      \"template_kind_name\": \"provision\",\n      \"operatingsystem_id\": 1073012828,\n      \"operatingsystem_name\": \"RHEL 6.1\",\n      \"config_template_id\": 269958254,\n      \"config_template_name\": \"MyString2\"\n    },\n    {\n      \"id\": 980190962,\n      \"provisioning_template_id\": 943779058,\n      \"provisioning_template_name\": \"MyString\",\n      \"template_kind_id\": 698706415,\n      \"template_kind_name\": \"iPXE\",\n      \"operatingsystem_id\": 1073012828,\n      \"operatingsystem_name\": \"RHEL 6.1\",\n      \"config_template_id\": 943779058,\n      \"config_template_name\": \"MyString\"\n    },\n    {\n      \"id\": 1018350795,\n      \"provisioning_template_id\": 131565194,\n      \"provisioning_template_name\": \"PXEGrub Dummy Menu\",\n      \"template_kind_id\": 131565194,\n      \"template_kind_name\": \"PXEGrub\",\n      \"operatingsystem_id\": 1073012828,\n      \"operatingsystem_name\": \"RHEL 6.1\",\n      \"config_template_id\": 131565194,\n      \"config_template_name\": \"PXEGrub Dummy Menu\"\n    }\n  ],\n  \"images\": []\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["DELETE /api/operatingsystems/775246587-NoHosts%201-1\n200\n{\n  \"created_at\": \"2015-12-01T02:40:02Z\",\n  \"description\": null,\n  \"hostgroups_count\": 0,\n  \"hosts_count\": 0,\n  \"id\": 775246587,\n  \"major\": \"1\",\n  \"minor\": \"1\",\n  \"name\": \"NoHosts\",\n  \"nameindicator\": null,\n  \"password_hash\": \"SHA256\",\n  \"release_name\": null,\n  \"title\": \"NoHosts 1.1\",\n  \"updated_at\": \"2015-12-01T02:40:02Z\"\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"medium","full_name":"medium","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"architecture","full_name":"architecture","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[]}]},"organizations":{"doc_url":"../apidoc/v2/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":"search","full_name":"search","description":"\n\u003Cp\u003Efilter results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003Cp\u003Esort results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003Cp\u003Epaginate results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003Cp\u003Enumber of entries per request\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[]},{"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":[],"examples":[],"metadata":null,"see":[]},{"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":"organization","full_name":"organization","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"organization[name]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"description","full_name":"organization[description]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"user_ids","full_name":"organization[user_ids]","description":"\n\u003Cp\u003EUser IDs\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"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,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"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,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"media_ids","full_name":"organization[media_ids]","description":"\n\u003Cp\u003EMedia IDs\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"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,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"ptable_ids","full_name":"organization[ptable_ids]","description":"\n\u003Cp\u003EPartition template IDs\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"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,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"domain_ids","full_name":"organization[domain_ids]","description":"\n\u003Cp\u003EDomain IDs\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"realm_ids","full_name":"organization[realm_ids]","description":"\n\u003Cp\u003ERealm IDs\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"hostgroup_ids","full_name":"organization[hostgroup_ids]","description":"\n\u003Cp\u003EHost group IDs\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"environment_ids","full_name":"organization[environment_ids]","description":"\n\u003Cp\u003EEnvironment IDs\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"subnet_ids","full_name":"organization[subnet_ids]","description":"\n\u003Cp\u003ESubnet IDs\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[]},{"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":"organization","full_name":"organization","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"organization[name]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"description","full_name":"organization[description]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"user_ids","full_name":"organization[user_ids]","description":"\n\u003Cp\u003EUser IDs\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"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,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"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,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"media_ids","full_name":"organization[media_ids]","description":"\n\u003Cp\u003EMedia IDs\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"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,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"ptable_ids","full_name":"organization[ptable_ids]","description":"\n\u003Cp\u003EPartition template IDs\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"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,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"domain_ids","full_name":"organization[domain_ids]","description":"\n\u003Cp\u003EDomain IDs\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"realm_ids","full_name":"organization[realm_ids]","description":"\n\u003Cp\u003ERealm IDs\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"hostgroup_ids","full_name":"organization[hostgroup_ids]","description":"\n\u003Cp\u003EHost group IDs\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"environment_ids","full_name":"organization[environment_ids]","description":"\n\u003Cp\u003EEnvironment IDs\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"subnet_ids","full_name":"organization[subnet_ids]","description":"\n\u003Cp\u003ESubnet IDs\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[]},{"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":[],"examples":[],"metadata":null,"see":[]}]},"os_default_templates":{"doc_url":"../apidoc/v2/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/config_templates/:config_template_id/os_default_templates","http_method":"GET","short_description":"List operating systems where this template is set as a default","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":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003Cp\u003EID of operating system\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"config_template_id","full_name":"config_template_id","description":"\n\u003Cp\u003EID of provisioning template\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003Cp\u003Epaginate results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003Cp\u003Enumber of entries per request\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/operatingsystems/1073012828-RHEL%206-1/os_default_templates\n200\n{\n  \"total\": 6,\n  \"subtotal\": 6,\n  \"page\": 1,\n  \"per_page\": 20,\n  \"search\": null,\n  \"sort\": {\n    \"by\": null,\n    \"order\": null\n  },\n  \"results\": [\n    {\n      \"id\": 51848956,\n      \"provisioning_template_id\": 698706415,\n      \"provisioning_template_name\": \"iPXE Dummy Menu\",\n      \"template_kind_id\": 698706415,\n      \"template_kind_name\": \"iPXE\",\n      \"operatingsystem_id\": 1073012828,\n      \"operatingsystem_name\": \"RHEL 6.1\",\n      \"config_template_id\": 698706415,\n      \"config_template_name\": \"iPXE Dummy Menu\"\n    },\n    {\n      \"id\": 113629430,\n      \"provisioning_template_id\": 981457253,\n      \"provisioning_template_name\": \"MyScript\",\n      \"template_kind_id\": 478250810,\n      \"template_kind_name\": \"script\",\n      \"operatingsystem_id\": 1073012828,\n      \"operatingsystem_name\": \"RHEL 6.1\",\n      \"config_template_id\": 981457253,\n      \"config_template_name\": \"MyScript\"\n    },\n    {\n      \"id\": 281110143,\n      \"provisioning_template_id\": 1007981701,\n      \"provisioning_template_name\": \"centos5_3_pxelinux\",\n      \"template_kind_id\": 710512633,\n      \"template_kind_name\": null,\n      \"operatingsystem_id\": 1073012828,\n      \"operatingsystem_name\": \"RHEL 6.1\",\n      \"config_template_id\": 1007981701,\n      \"config_template_name\": \"centos5_3_pxelinux\"\n    },\n    {\n      \"id\": 298486374,\n      \"provisioning_template_id\": 269958254,\n      \"provisioning_template_name\": \"MyString2\",\n      \"template_kind_id\": 983253650,\n      \"template_kind_name\": \"provision\",\n      \"operatingsystem_id\": 1073012828,\n      \"operatingsystem_name\": \"RHEL 6.1\",\n      \"config_template_id\": 269958254,\n      \"config_template_name\": \"MyString2\"\n    },\n    {\n      \"id\": 980190962,\n      \"provisioning_template_id\": 943779058,\n      \"provisioning_template_name\": \"MyString\",\n      \"template_kind_id\": 698706415,\n      \"template_kind_name\": \"iPXE\",\n      \"operatingsystem_id\": 1073012828,\n      \"operatingsystem_name\": \"RHEL 6.1\",\n      \"config_template_id\": 943779058,\n      \"config_template_name\": \"MyString\"\n    },\n    {\n      \"id\": 1018350795,\n      \"provisioning_template_id\": 131565194,\n      \"provisioning_template_name\": \"PXEGrub Dummy Menu\",\n      \"template_kind_id\": 131565194,\n      \"template_kind_name\": \"PXEGrub\",\n      \"operatingsystem_id\": 1073012828,\n      \"operatingsystem_name\": \"RHEL 6.1\",\n      \"config_template_id\": 131565194,\n      \"config_template_name\": \"PXEGrub Dummy Menu\"\n    }\n  ]\n}"],"metadata":null,"see":[]},{"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":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003Cp\u003EID of operating system\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/operatingsystems/1073012828-RHEL%206-1/os_default_templates/980190962\n200\n{\n  \"id\": 980190962,\n  \"provisioning_template_id\": 943779058,\n  \"provisioning_template_name\": \"MyString\",\n  \"template_kind_id\": 698706415,\n  \"template_kind_name\": \"iPXE\",\n  \"operatingsystem_id\": 1073012828,\n  \"operatingsystem_name\": \"RHEL 6.1\",\n  \"config_template_id\": 943779058,\n  \"config_template_name\": \"MyString\"\n}"],"metadata":null,"see":[]},{"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":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003Cp\u003EID of operating system\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"os_default_template","full_name":"os_default_template","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"template_kind_id","full_name":"os_default_template[template_kind_id]","description":"","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"config_template_id","full_name":"os_default_template[config_template_id]","description":"\n\u003Cp\u003EID of provisioning template\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true}]}],"examples":["POST /api/operatingsystems/1073012828-RHEL%206-1/os_default_templates\n{\n  \"os_default_template\": {\n    \"provisioning_template_id\": \"943779058\",\n    \"template_kind_id\": \"698706415\"\n  }\n}\n201\n{\n  \"id\": 1018350796,\n  \"provisioning_template_id\": 943779058,\n  \"provisioning_template_name\": \"MyString\",\n  \"template_kind_id\": 698706415,\n  \"template_kind_name\": \"iPXE\",\n  \"operatingsystem_id\": 1073012828,\n  \"operatingsystem_name\": \"RHEL 6.1\",\n  \"config_template_id\": 943779058,\n  \"config_template_name\": \"MyString\"\n}"],"metadata":null,"see":[]},{"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":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003Cp\u003EID of operating system\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"os_default_template","full_name":"os_default_template","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"template_kind_id","full_name":"os_default_template[template_kind_id]","description":"","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"config_template_id","full_name":"os_default_template[config_template_id]","description":"\n\u003Cp\u003EID of provisioning template\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true}]}],"examples":["PUT /api/operatingsystems/1073012828-RHEL%206-1/os_default_templates/980190962\n{\n  \"os_default_template\": {\n    \"provisioning_template_id\": \"821548108\",\n    \"template_kind_id\": \"452984334\"\n  }\n}\n200\n{\n  \"id\": 980190962,\n  \"provisioning_template_id\": 821548108,\n  \"provisioning_template_name\": \"PXELinux default local boot\",\n  \"template_kind_id\": 452984334,\n  \"template_kind_name\": \"PXELinux\",\n  \"operatingsystem_id\": 1073012828,\n  \"operatingsystem_name\": \"RHEL 6.1\",\n  \"config_template_id\": 821548108,\n  \"config_template_name\": \"PXELinux default local boot\"\n}"],"metadata":null,"see":[]},{"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":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003Cp\u003EID of operating system\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["DELETE /api/operatingsystems/1073012828-RHEL%206-1/os_default_templates/980190962\n200\n{\n  \"created_at\": \"2015-12-01T02:40:02Z\",\n  \"id\": 980190962,\n  \"operatingsystem_id\": 1073012828,\n  \"provisioning_template_id\": 943779058,\n  \"template_kind_id\": 698706415,\n  \"updated_at\": \"2015-12-01T02:40:02Z\"\n}"],"metadata":null,"see":[]}]},"override_values":{"doc_url":"../apidoc/v2/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_variables/:smart_variable_id/override_values","http_method":"GET","short_description":"List of override values for a specific smart variable","deprecated":null},{"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":"smart_variable_id","full_name":"smart_variable_id","description":"","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true},{"name":"smart_class_parameter_id","full_name":"smart_class_parameter_id","description":"","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003Cp\u003Epaginate results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003Cp\u003Enumber of entries per request\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/smart_variables/298486374-ssl_port/override_values\n200\n{\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\": [\n    {\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"id\": 281110143,\n      \"match\": \"hostgroup=Common\",\n      \"value\": \"8443\",\n      \"use_puppet_default\": false\n    }\n  ]\n}"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/override_values/show","name":"show","apis":[{"api_url":"/api/smart_variables/:smart_variable_id/override_values/:id","http_method":"GET","short_description":"Show an override value for a specific smart variable","deprecated":null},{"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":"smart_variable_id","full_name":"smart_variable_id","description":"","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true},{"name":"smart_class_parameter_id","full_name":"smart_class_parameter_id","description":"","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/smart_variables/298486374-ssl_port/override_values/281110143\n200\n{\n  \"created_at\": \"2015-12-01T02:40:02Z\",\n  \"updated_at\": \"2015-12-01T02:40:02Z\",\n  \"id\": 281110143,\n  \"match\": \"hostgroup=Common\",\n  \"value\": \"8443\",\n  \"use_puppet_default\": false\n}"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/override_values/create","name":"create","apis":[{"api_url":"/api/smart_variables/:smart_variable_id/override_values","http_method":"POST","short_description":"Create an override value for a specific smart variable","deprecated":null},{"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":"smart_variable_id","full_name":"smart_variable_id","description":"","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true},{"name":"smart_class_parameter_id","full_name":"smart_class_parameter_id","description":"","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true},{"name":"override_value","full_name":"override_value","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"match","full_name":"override_value[match]","description":"\n\u003Cp\u003EOverride match\u003C/p\u003E\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"value","full_name":"override_value[value]","description":"\n\u003Cp\u003EOverride value\u003C/p\u003E\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"use_puppet_default","full_name":"override_value[use_puppet_default]","description":"","required":false,"allow_nil":true,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true}]}],"examples":["POST /api/smart_variables/1018350796/override_values\n{\n  \"override_value\": {\n    \"match\": \"xyz=10\",\n    \"value\": \"string\"\n  }\n}\n201\n{\n  \"created_at\": \"2015-12-01T02:41:00Z\",\n  \"updated_at\": \"2015-12-01T02:41:00Z\",\n  \"id\": 1018350796,\n  \"match\": \"xyz=10\",\n  \"value\": \"string\",\n  \"use_puppet_default\": false\n}"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/override_values/update","name":"update","apis":[{"api_url":"/api/smart_variables/:smart_variable_id/override_values/:id","http_method":"PUT","short_description":"Update an override value for a specific smart variable","deprecated":null},{"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":"smart_variable_id","full_name":"smart_variable_id","description":"","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true},{"name":"smart_class_parameter_id","full_name":"smart_class_parameter_id","description":"","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true},{"name":"override_value","full_name":"override_value","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"match","full_name":"override_value[match]","description":"\n\u003Cp\u003EOverride match\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"value","full_name":"override_value[value]","description":"\n\u003Cp\u003EOverride value\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"use_puppet_default","full_name":"override_value[use_puppet_default]","description":"","required":false,"allow_nil":true,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true}]}],"examples":["PUT /api/smart_class_parameters/328495940-cluster/override_values/874520030\n{\n  \"override_value\": {\n    \"match\": \"host=abc.com\"\n  }\n}\n200\n{\n  \"created_at\": \"2015-12-01T02:40:02Z\",\n  \"updated_at\": \"2015-12-01T02:41:01Z\",\n  \"id\": 874520030,\n  \"match\": \"host=abc.com\",\n  \"value\": \"8080\",\n  \"use_puppet_default\": false\n}"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/override_values/destroy","name":"destroy","apis":[{"api_url":"/api/smart_variables/:smart_variable_id/override_values/:id","http_method":"DELETE","short_description":"Delete an override value for a specific smart variable","deprecated":null},{"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":"smart_variable_id","full_name":"smart_variable_id","description":"","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true},{"name":"smart_class_parameter_id","full_name":"smart_class_parameter_id","description":"","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true}],"examples":["DELETE /api/smart_class_parameters/328495940-cluster/override_values/874520030?override_value%5Bmatch%5D=host%3Dabc.com\n200\n{\n  \"created_at\": \"2015-12-01T02:40:02Z\",\n  \"updated_at\": \"2015-12-01T02:40:02Z\",\n  \"id\": 874520030,\n  \"match\": \"hostgroup=Common\",\n  \"value\": \"8080\",\n  \"use_puppet_default\": false\n}"],"metadata":null,"see":[]}]},"parameters":{"doc_url":"../apidoc/v2/parameters","api_url":"/api","name":"Parameters","short_description":null,"full_description":"\n\u003Cp\u003EThese API calls are related to \u003Cb\u003Enested parameters for a host, domain, host group, operating system\u003C/b\u003E. If you are looking for \u003Ca href='common_parameters.html'\u003Eglobal parameters\u003C/a\u003E, go to \u003Ca href='common_parameters.html'\u003Ethis link\u003C/a\u003E.\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}],"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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003Cp\u003EID of host group\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"domain_id","full_name":"domain_id","description":"\n\u003Cp\u003EID of domain\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003Cp\u003EID of operating system\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"location_id","full_name":"location_id","description":"\n\u003Cp\u003EID of location\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"organization_id","full_name":"organization_id","description":"\n\u003Cp\u003EID of organization\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"search","full_name":"search","description":"\n\u003Cp\u003Efilter results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003Cp\u003Esort results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003Cp\u003Epaginate results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003Cp\u003Enumber of entries per request\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/hosts/host118/parameters\n200\n{\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\": [\n    {\n      \"priority\": 4,\n      \"created_at\": \"2015-12-01T02:41:01Z\",\n      \"updated_at\": \"2015-12-01T02:41:01Z\",\n      \"id\": 840284802,\n      \"name\": \"parameter1\",\n      \"value\": \"parameter value 1\"\n    }\n  ]\n}"],"metadata":null,"see":[]},{"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}],"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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003Cp\u003EID of host group\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"domain_id","full_name":"domain_id","description":"\n\u003Cp\u003EID of domain\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003Cp\u003EID of operating system\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"location_id","full_name":"location_id","description":"\n\u003Cp\u003EID of location\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"organization_id","full_name":"organization_id","description":"\n\u003Cp\u003EID of organization\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"id","full_name":"id","description":"\n\u003Cp\u003EID of parameter\u003C/p\u003E\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/hosts/host124/parameters/840284802-parameter7\n200\n{\n  \"priority\": 4,\n  \"created_at\": \"2015-12-01T02:41:02Z\",\n  \"updated_at\": \"2015-12-01T02:41:02Z\",\n  \"id\": 840284802,\n  \"name\": \"parameter7\",\n  \"value\": \"parameter value 7\"\n}"],"metadata":null,"see":[]},{"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}],"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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003Cp\u003EID of host group\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"domain_id","full_name":"domain_id","description":"\n\u003Cp\u003EID of domain\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003Cp\u003EID of operating system\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"location_id","full_name":"location_id","description":"\n\u003Cp\u003EID of location\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"organization_id","full_name":"organization_id","description":"\n\u003Cp\u003EID of organization\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"parameter","full_name":"parameter","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"parameter[name]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"value","full_name":"parameter[value]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}]}],"examples":["POST /api/hosts/host131/parameters\n{\n  \"parameter\": {\n    \"name\": \"special_key\",\n    \"value\": \"123\"\n  }\n}\n201\n{\n  \"priority\": 4,\n  \"created_at\": \"2015-12-01T02:41:03Z\",\n  \"updated_at\": \"2015-12-01T02:41:03Z\",\n  \"id\": 840284803,\n  \"name\": \"special_key\",\n  \"value\": \"123\"\n}"],"metadata":null,"see":[]},{"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}],"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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003Cp\u003EID of host group\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"domain_id","full_name":"domain_id","description":"\n\u003Cp\u003EID of domain\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003Cp\u003EID of operating system\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"location_id","full_name":"location_id","description":"\n\u003Cp\u003EID of location\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"organization_id","full_name":"organization_id","description":"\n\u003Cp\u003EID of organization\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"id","full_name":"id","description":"\n\u003Cp\u003EID of parameter\u003C/p\u003E\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"parameter","full_name":"parameter","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"parameter[name]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"value","full_name":"parameter[value]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}]}],"examples":["PUT /api/hosts/host135/parameters/840284802-parameter18\n{\n  \"parameter\": {\n    \"name\": \"special_key\",\n    \"value\": \"123\"\n  }\n}\n200\n{\n  \"priority\": 4,\n  \"created_at\": \"2015-12-01T02:41:03Z\",\n  \"updated_at\": \"2015-12-01T02:41:03Z\",\n  \"id\": 840284802,\n  \"name\": \"special_key\",\n  \"value\": \"123\"\n}"],"metadata":null,"see":[]},{"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}],"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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003Cp\u003EID of host group\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"domain_id","full_name":"domain_id","description":"\n\u003Cp\u003EID of domain\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003Cp\u003EID of operating system\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"location_id","full_name":"location_id","description":"\n\u003Cp\u003EID of location\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"organization_id","full_name":"organization_id","description":"\n\u003Cp\u003EID of organization\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"id","full_name":"id","description":"\n\u003Cp\u003EID of parameter\u003C/p\u003E\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["DELETE /api/hosts/host139/parameters/840284802-parameter22\n200\n{\n  \"created_at\": \"2015-12-01T02:41:03Z\",\n  \"hidden_value\": \"*****\",\n  \"id\": 840284802,\n  \"name\": \"parameter22\",\n  \"priority\": 4,\n  \"reference_id\": 1,\n  \"updated_at\": \"2015-12-01T02:41:03Z\",\n  \"value\": \"parameter value 22\"\n}"],"metadata":null,"see":[]},{"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}],"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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003Cp\u003EID of host group\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"domain_id","full_name":"domain_id","description":"\n\u003Cp\u003EID of domain\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003Cp\u003EID of operating system\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"location_id","full_name":"location_id","description":"\n\u003Cp\u003EID of location\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"organization_id","full_name":"organization_id","description":"\n\u003Cp\u003EID of organization\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["DELETE /api/hosts/host143/parameters\n200\n[\n\n]"],"metadata":null,"see":[]}]},"permissions":{"doc_url":"../apidoc/v2/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":"search","full_name":"search","description":"\n\u003Cp\u003Efilter results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003Cp\u003Esort results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003Cp\u003Epaginate results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003Cp\u003Enumber of entries per request\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"resource_type","full_name":"resource_type","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"name","full_name":"name","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/permissions\n200\n{\n  \"total\": 141,\n  \"subtotal\": 141,\n  \"page\": 1,\n  \"per_page\": 20,\n  \"search\": null,\n  \"sort\": {\n    \"by\": null,\n    \"order\": null\n  },\n  \"results\": [\n    {\n      \"name\": \"view_usergroups\",\n      \"id\": 44766150,\n      \"resource_type\": \"Usergroup\"\n    },\n    {\n      \"name\": \"view_hostgroups\",\n      \"id\": 51094894,\n      \"resource_type\": \"Hostgroup\"\n    },\n    {\n      \"name\": \"destroy_puppetclasses\",\n      \"id\": 76106844,\n      \"resource_type\": \"Puppetclass\"\n    },\n    {\n      \"name\": \"create_smart_proxies\",\n      \"id\": 92702333,\n      \"resource_type\": \"SmartProxy\"\n    },\n    {\n      \"name\": \"view_plugins\",\n      \"id\": 98100110,\n      \"resource_type\": null\n    },\n    {\n      \"name\": \"view_globals\",\n      \"id\": 101322209,\n      \"resource_type\": \"CommonParameter\"\n    },\n    {\n      \"name\": \"view_subnets\",\n      \"id\": 102149605,\n      \"resource_type\": \"Subnet\"\n    },\n    {\n      \"name\": \"view_smart_proxies_autosign\",\n      \"id\": 120421563,\n      \"resource_type\": \"SmartProxy\"\n    },\n    {\n      \"name\": \"console_hosts\",\n      \"id\": 124793742,\n      \"resource_type\": \"Host\"\n    },\n    {\n      \"name\": \"create_realms\",\n      \"id\": 125033645,\n      \"resource_type\": \"Realm\"\n    },\n    {\n      \"name\": \"edit_smart_proxies\",\n      \"id\": 130358337,\n      \"resource_type\": \"SmartProxy\"\n    },\n    {\n      \"name\": \"view_media\",\n      \"id\": 135202335,\n      \"resource_type\": \"Medium\"\n    },\n    {\n      \"name\": \"access_settings\",\n      \"id\": 139485686,\n      \"resource_type\": null\n    },\n    {\n      \"name\": \"destroy_trends\",\n      \"id\": 139524545,\n      \"resource_type\": \"Trend\"\n    },\n    {\n      \"name\": \"create_external_variables\",\n      \"id\": 140923897,\n      \"resource_type\": \"LookupKey\"\n    },\n    {\n      \"name\": \"destroy_models\",\n      \"id\": 147454802,\n      \"resource_type\": \"Model\"\n    },\n    {\n      \"name\": \"edit_models\",\n      \"id\": 173772800,\n      \"resource_type\": \"Model\"\n    },\n    {\n      \"name\": \"create_hostgroups\",\n      \"id\": 175778558,\n      \"resource_type\": \"Hostgroup\"\n    },\n    {\n      \"name\": \"edit_trends\",\n      \"id\": 180522257,\n      \"resource_type\": \"Trend\"\n    },\n    {\n      \"name\": \"view_environments\",\n      \"id\": 189359466,\n      \"resource_type\": \"Environment\"\n    }\n  ]\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/permissions/350275019\n200\n{\n  \"name\": \"view_architectures\",\n  \"id\": 350275019,\n  \"resource_type\": \"Architecture\"\n}"],"metadata":null,"see":[]},{"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":[],"examples":["GET /api/permissions/resource_types\n200\n{\n  \"total\": 31,\n  \"subtotal\": 31,\n  \"page\": 1,\n  \"per_page\": 20,\n  \"search\": null,\n  \"sort\": {\n    \"by\": null,\n    \"order\": null\n  },\n  \"results\": [\n    {\n      \"name\": \"Architecture\"\n    },\n    {\n      \"name\": \"Audit\"\n    },\n    {\n      \"name\": \"AuthSourceLdap\"\n    },\n    {\n      \"name\": \"Bookmark\"\n    },\n    {\n      \"name\": \"CommonParameter\"\n    },\n    {\n      \"name\": \"ComputeResource\"\n    },\n    {\n      \"name\": \"Domain\"\n    },\n    {\n      \"name\": \"Environment\"\n    },\n    {\n      \"name\": \"FactValue\"\n    },\n    {\n      \"name\": \"Host\"\n    },\n    {\n      \"name\": \"HostClass\"\n    },\n    {\n      \"name\": \"Hostgroup\"\n    },\n    {\n      \"name\": \"Image\"\n    },\n    {\n      \"name\": \"Location\"\n    },\n    {\n      \"name\": \"LookupKey\"\n    },\n    {\n      \"name\": \"Medium\"\n    },\n    {\n      \"name\": \"Model\"\n    },\n    {\n      \"name\": \"Operatingsystem\"\n    },\n    {\n      \"name\": \"Organization\"\n    },\n    {\n      \"name\": \"Parameter\"\n    },\n    {\n      \"name\": \"ProvisioningTemplate\"\n    },\n    {\n      \"name\": \"Ptable\"\n    },\n    {\n      \"name\": \"Puppetclass\"\n    },\n    {\n      \"name\": \"Realm\"\n    },\n    {\n      \"name\": \"Report\"\n    },\n    {\n      \"name\": \"Role\"\n    },\n    {\n      \"name\": \"SmartProxy\"\n    },\n    {\n      \"name\": \"Subnet\"\n    },\n    {\n      \"name\": \"Trend\"\n    },\n    {\n      \"name\": \"User\"\n    },\n    {\n      \"name\": \"Usergroup\"\n    }\n  ]\n}"],"metadata":null,"see":[]}]},"plugins":{"doc_url":"../apidoc/v2/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":[],"examples":["GET /api/plugins\n200\n{\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\": [\n    {\n      \"id\": \"skip_test\",\n      \"name\": null,\n      \"author\": null,\n      \"description\": null,\n      \"url\": null,\n      \"version\": null\n    }\n  ]\n}"],"metadata":null,"see":[]}]},"provisioning_templates":{"doc_url":"../apidoc/v2/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/operatingsystem/: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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"location_id","full_name":"location_id","description":"\n\u003Cp\u003EScope by locations\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"organization_id","full_name":"organization_id","description":"\n\u003Cp\u003EScope by organizations\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"search","full_name":"search","description":"\n\u003Cp\u003Efilter results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003Cp\u003Esort results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003Cp\u003Epaginate results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003Cp\u003Enumber of entries per request\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/provisioning_templates\n200\n{\n  \"total\": 11,\n  \"subtotal\": 11,\n  \"page\": 1,\n  \"per_page\": 20,\n  \"search\": null,\n  \"sort\": {\n    \"by\": null,\n    \"order\": null\n  },\n  \"results\": [\n    {\n      \"snippet\": false,\n      \"audit_comment\": null,\n      \"created_at\": \"2015-12-01T02:40:01Z\",\n      \"updated_at\": \"2015-12-01T02:40:01Z\",\n      \"id\": 718456980,\n      \"name\": \"Locked Template\",\n      \"template_kind_id\": 983253650,\n      \"template_kind_name\": \"provision\"\n    },\n    {\n      \"snippet\": false,\n      \"audit_comment\": null,\n      \"created_at\": \"2015-12-01T02:40:01Z\",\n      \"updated_at\": \"2015-12-01T02:40:01Z\",\n      \"id\": 104314179,\n      \"name\": \"MyFinish\",\n      \"template_kind_id\": 550103832,\n      \"template_kind_name\": \"finish\"\n    },\n    {\n      \"snippet\": false,\n      \"audit_comment\": null,\n      \"created_at\": \"2015-12-01T02:40:01Z\",\n      \"updated_at\": \"2015-12-01T02:40:01Z\",\n      \"id\": 981457253,\n      \"name\": \"MyScript\",\n      \"template_kind_id\": 478250810,\n      \"template_kind_name\": \"script\"\n    },\n    {\n      \"snippet\": false,\n      \"audit_comment\": null,\n      \"created_at\": \"2015-12-01T02:40:01Z\",\n      \"updated_at\": \"2015-12-01T02:40:01Z\",\n      \"id\": 943779058,\n      \"name\": \"MyString\",\n      \"template_kind_id\": 698706415,\n      \"template_kind_name\": \"iPXE\"\n    },\n    {\n      \"snippet\": false,\n      \"audit_comment\": null,\n      \"created_at\": \"2015-12-01T02:40:01Z\",\n      \"updated_at\": \"2015-12-01T02:40:01Z\",\n      \"id\": 269958254,\n      \"name\": \"MyString2\",\n      \"template_kind_id\": 983253650,\n      \"template_kind_name\": \"provision\"\n    },\n    {\n      \"snippet\": false,\n      \"audit_comment\": null,\n      \"created_at\": \"2015-12-01T02:40:01Z\",\n      \"updated_at\": \"2015-12-01T02:40:01Z\",\n      \"id\": 684651467,\n      \"name\": \"PXE Default Menu\",\n      \"template_kind_id\": 710512633,\n      \"template_kind_name\": null\n    },\n    {\n      \"snippet\": false,\n      \"audit_comment\": null,\n      \"created_at\": \"2015-12-01T02:40:01Z\",\n      \"updated_at\": \"2015-12-01T02:40:01Z\",\n      \"id\": 131565194,\n      \"name\": \"PXEGrub Dummy Menu\",\n      \"template_kind_id\": 131565194,\n      \"template_kind_name\": \"PXEGrub\"\n    },\n    {\n      \"snippet\": false,\n      \"audit_comment\": null,\n      \"created_at\": \"2015-12-01T02:40:01Z\",\n      \"updated_at\": \"2015-12-01T02:40:01Z\",\n      \"id\": 821548108,\n      \"name\": \"PXELinux default local boot\",\n      \"template_kind_id\": 452984334,\n      \"template_kind_name\": \"PXELinux\"\n    },\n    {\n      \"snippet\": false,\n      \"audit_comment\": null,\n      \"created_at\": \"2015-12-01T02:40:01Z\",\n      \"updated_at\": \"2015-12-01T02:40:01Z\",\n      \"id\": 352050261,\n      \"name\": \"PXELinux global default\",\n      \"template_kind_id\": 452984334,\n      \"template_kind_name\": \"PXELinux\"\n    },\n    {\n      \"snippet\": false,\n      \"audit_comment\": null,\n      \"created_at\": \"2015-12-01T02:40:01Z\",\n      \"updated_at\": \"2015-12-01T02:40:01Z\",\n      \"id\": 1007981701,\n      \"name\": \"centos5_3_pxelinux\",\n      \"template_kind_id\": 452984334,\n      \"template_kind_name\": \"PXELinux\"\n    },\n    {\n      \"snippet\": false,\n      \"audit_comment\": null,\n      \"created_at\": \"2015-12-01T02:40:01Z\",\n      \"updated_at\": \"2015-12-01T02:40:01Z\",\n      \"id\": 698706415,\n      \"name\": \"iPXE Dummy Menu\",\n      \"template_kind_id\": 698706415,\n      \"template_kind_name\": \"iPXE\"\n    }\n  ]\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/provisioning_templates/1007981701-centos5_3_pxelinux\n200\n{\n  \"template\": \"default linux~label linux~kernel \u003C%= @kernel %\u003E~append initrd=\u003C%= @initrd %\u003E ks=\u003C%= foreman_url(\\\"kickstart\\\")%\u003E ksdevice=bootif network kssendmac\",\n  \"locked\": false,\n  \"snippet\": false,\n  \"audit_comment\": null,\n  \"created_at\": \"2015-12-01T02:40:01Z\",\n  \"updated_at\": \"2015-12-01T02:40:01Z\",\n  \"id\": 1007981701,\n  \"name\": \"centos5_3_pxelinux\",\n  \"template_kind_id\": 452984334,\n  \"template_kind_name\": \"PXELinux\",\n  \"template_combinations\": [],\n  \"operatingsystems\": [\n    {\n      \"id\": 1073012828,\n      \"name\": \"Redhat\",\n      \"title\": \"RHEL 6.1\"\n    },\n    {\n      \"id\": 331303656,\n      \"name\": \"Ubuntu\",\n      \"title\": \"Ubuntu 10.10\"\n    },\n    {\n      \"id\": 309172073,\n      \"name\": \"centos\",\n      \"title\": \"centos 5.3\"\n    }\n  ],\n  \"os_default_templates\": [\n    {\n      \"id\": 281110143,\n      \"provisioning_template_id\": 1007981701,\n      \"provisioning_template_name\": \"centos5_3_pxelinux\",\n      \"template_kind_id\": 710512633,\n      \"template_kind_name\": null,\n      \"operatingsystem_id\": 1073012828,\n      \"operatingsystem_name\": \"RHEL 6.1\",\n      \"config_template_id\": 1007981701,\n      \"config_template_name\": \"centos5_3_pxelinux\"\n    },\n    {\n      \"id\": 638205575,\n      \"provisioning_template_id\": 1007981701,\n      \"provisioning_template_name\": \"centos5_3_pxelinux\",\n      \"template_kind_id\": 710512633,\n      \"template_kind_name\": null,\n      \"operatingsystem_id\": 331303656,\n      \"operatingsystem_name\": \"Ubuntu 10.10\",\n      \"config_template_id\": 1007981701,\n      \"config_template_name\": \"centos5_3_pxelinux\"\n    }\n  ],\n  \"locations\": [],\n  \"organizations\": []\n}"],"metadata":null,"see":[]},{"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":"provisioning_template","full_name":"provisioning_template","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"provisioning_template[name]","description":"\n\u003Cp\u003Etemplate name\u003C/p\u003E\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"template","full_name":"provisioning_template[template]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"snippet","full_name":"provisioning_template[snippet]","description":"","required":false,"allow_nil":true,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true},{"name":"audit_comment","full_name":"provisioning_template[audit_comment]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"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,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"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,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"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,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":["POST /api/provisioning_templates\n{\n  \"provisioning_template\": {\n    \"template\": \"This is a test template\",\n    \"template_kind_id\": \"698706415\",\n    \"name\": \"RandomName\"\n  }\n}\n201\n{\n  \"template\": \"This is a test template\",\n  \"locked\": false,\n  \"snippet\": false,\n  \"audit_comment\": null,\n  \"created_at\": \"2015-12-01T02:41:05Z\",\n  \"updated_at\": \"2015-12-01T02:41:05Z\",\n  \"id\": 1007981702,\n  \"name\": \"RandomName\",\n  \"template_kind_id\": 698706415,\n  \"template_kind_name\": \"iPXE\",\n  \"template_combinations\": [],\n  \"operatingsystems\": [],\n  \"os_default_templates\": [],\n  \"locations\": [],\n  \"organizations\": []\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true},{"name":"provisioning_template","full_name":"provisioning_template","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"provisioning_template[name]","description":"\n\u003Cp\u003Etemplate name\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"template","full_name":"provisioning_template[template]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"snippet","full_name":"provisioning_template[snippet]","description":"","required":false,"allow_nil":true,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true},{"name":"audit_comment","full_name":"provisioning_template[audit_comment]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"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,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"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,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"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,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":["PUT /api/provisioning_templates/1007981701-centos5_3_pxelinux\n{\n  \"provisioning_template\": {\n    \"template\": \"blah\"\n  }\n}\n200\n{\n  \"template\": \"blah\",\n  \"locked\": false,\n  \"snippet\": false,\n  \"audit_comment\": null,\n  \"created_at\": \"2015-12-01T02:40:01Z\",\n  \"updated_at\": \"2015-12-01T02:41:06Z\",\n  \"id\": 1007981701,\n  \"name\": \"centos5_3_pxelinux\",\n  \"template_kind_id\": 452984334,\n  \"template_kind_name\": \"PXELinux\",\n  \"template_combinations\": [],\n  \"operatingsystems\": [\n    {\n      \"id\": 1073012828,\n      \"name\": \"Redhat\",\n      \"title\": \"RHEL 6.1\"\n    },\n    {\n      \"id\": 331303656,\n      \"name\": \"Ubuntu\",\n      \"title\": \"Ubuntu 10.10\"\n    },\n    {\n      \"id\": 309172073,\n      \"name\": \"centos\",\n      \"title\": \"centos 5.3\"\n    }\n  ],\n  \"os_default_templates\": [\n    {\n      \"id\": 281110143,\n      \"provisioning_template_id\": 1007981701,\n      \"provisioning_template_name\": \"centos5_3_pxelinux\",\n      \"template_kind_id\": 710512633,\n      \"template_kind_name\": null,\n      \"operatingsystem_id\": 1073012828,\n      \"operatingsystem_name\": \"RHEL 6.1\",\n      \"config_template_id\": 1007981701,\n      \"config_template_name\": \"centos5_3_pxelinux\"\n    },\n    {\n      \"id\": 638205575,\n      \"provisioning_template_id\": 1007981701,\n      \"provisioning_template_name\": \"centos5_3_pxelinux\",\n      \"template_kind_id\": 710512633,\n      \"template_kind_name\": null,\n      \"operatingsystem_id\": 331303656,\n      \"operatingsystem_name\": \"Ubuntu 10.10\",\n      \"config_template_id\": 1007981701,\n      \"config_template_name\": \"centos5_3_pxelinux\"\n    }\n  ],\n  \"locations\": [],\n  \"organizations\": []\n}"],"metadata":null,"see":[]},{"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":"version","full_name":"version","description":"\n\u003Cp\u003Etemplate version\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true}],"examples":["DELETE /api/provisioning_templates/1007981701-centos5_3_pxelinux\n422\n{\n  \"error\": {\n    \"id\": 1007981701,\n    \"errors\": {\n      \"base\": [\n        \"centos5_3_pxelinux is used by Redhat 6.1 - \",\n        \"centos5_3_pxelinux is used by Ubuntu 10.10 - \"\n      ]\n    },\n    \"full_messages\": [\n      \"centos5_3_pxelinux is used by Redhat 6.1 - \",\n      \"centos5_3_pxelinux is used by Ubuntu 10.10 - \"\n    ]\n  }\n}"],"metadata":null,"see":[]},{"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":[],"examples":["POST /api/provisioning_templates/build_pxe_default\n{\n  \"provisioning_template\": {}\n}\n200\n{\n  \"message\": \"PXE Default file has been deployed to all Smart Proxies\"\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true},{"name":"provisioning_template","full_name":"provisioning_template","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"provisioning_template[name]","description":"\n\u003Cp\u003Etemplate name\u003C/p\u003E\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}]}],"examples":["POST /api/provisioning_templates/1007981701-centos5_3_pxelinux/clone\n{\n  \"provisioning_template\": {\n    \"name\": \"MyClone\"\n  }\n}\n201\n{\n  \"created_at\": \"2015-12-01T02:41:06Z\",\n  \"default\": false,\n  \"id\": 1007981702,\n  \"locked\": false,\n  \"name\": \"MyClone\",\n  \"os_family\": null,\n  \"snippet\": false,\n  \"template\": \"default linux~label linux~kernel \u003C%= @kernel %\u003E~append initrd=\u003C%= @initrd %\u003E ks=\u003C%= foreman_url(\\\"kickstart\\\")%\u003E ksdevice=bootif network kssendmac\",\n  \"template_kind_id\": 452984334,\n  \"updated_at\": \"2015-12-01T02:41:06Z\",\n  \"vendor\": null\n}"],"metadata":null,"see":[]}]},"ptables":{"doc_url":"../apidoc/v2/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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"location_id","full_name":"location_id","description":"\n\u003Cp\u003EScope by locations\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"organization_id","full_name":"organization_id","description":"\n\u003Cp\u003EScope by organizations\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"search","full_name":"search","description":"\n\u003Cp\u003Efilter results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003Cp\u003Esort results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003Cp\u003Epaginate results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003Cp\u003Enumber of entries per request\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/ptables\n200\n{\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\": [\n    {\n      \"os_family\": \"Redhat\",\n      \"created_at\": \"2015-12-01T02:41:06Z\",\n      \"updated_at\": \"2015-12-01T02:41:06Z\",\n      \"name\": \"ptable76\",\n      \"id\": 1007981702\n    }\n  ]\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/ptables/1007981702-ptable77\n200\n{\n  \"layout\": \"zerombr yes\\\\nclearpart --all    --initlabel\\\\npart /boot --fstype ext3 --size=\u003C%= 10 * 10 %\u003E --asprimary\\\\npart /     --f   stype ext3 --size=1024 --grow\\\\npart swap  --recommended\",\n  \"os_family\": \"Redhat\",\n  \"created_at\": \"2015-12-01T02:41:06Z\",\n  \"updated_at\": \"2015-12-01T02:41:06Z\",\n  \"name\": \"ptable77\",\n  \"id\": 1007981702,\n  \"operatingsystems\": [],\n  \"locations\": [],\n  \"organizations\": []\n}"],"metadata":null,"see":[]},{"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":"ptable","full_name":"ptable","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"ptable[name]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"layout","full_name":"ptable[layout]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"snippet","full_name":"ptable[snippet]","description":"","required":false,"allow_nil":true,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true},{"name":"audit_comment","full_name":"ptable[audit_comment]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true},{"name":"os_family","full_name":"ptable[os_family]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"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,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"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,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"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,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"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,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":["POST /api/ptables\n{\n  \"ptable\": {\n    \"name\": \"ptable_test\",\n    \"layout\": \"d-i partman-auto/disk\"\n  }\n}\n201\n{\n  \"layout\": \"d-i partman-auto/disk\",\n  \"os_family\": null,\n  \"created_at\": \"2015-12-01T02:41:06Z\",\n  \"updated_at\": \"2015-12-01T02:41:06Z\",\n  \"name\": \"ptable_test\",\n  \"id\": 1007981703,\n  \"operatingsystems\": [],\n  \"locations\": [],\n  \"organizations\": []\n}"],"metadata":null,"see":[]},{"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":"version","full_name":"version","description":"\n\u003Cp\u003Etemplate version\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"ptable","full_name":"ptable","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"ptable[name]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"layout","full_name":"ptable[layout]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"snippet","full_name":"ptable[snippet]","description":"","required":false,"allow_nil":true,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true},{"name":"audit_comment","full_name":"ptable[audit_comment]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true},{"name":"os_family","full_name":"ptable[os_family]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"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,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"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,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"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,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"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,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":["PUT /api/ptables/1007981702-ptable79\n{\n  \"ptable\": {\n    \"name\": \"ptable_test\",\n    \"layout\": \"d-i partman-auto/disk\"\n  }\n}\n200\n{\n  \"layout\": \"d-i partman-auto/disk\",\n  \"os_family\": \"Redhat\",\n  \"created_at\": \"2015-12-01T02:41:06Z\",\n  \"updated_at\": \"2015-12-01T02:41:06Z\",\n  \"name\": \"ptable_test\",\n  \"id\": 1007981702,\n  \"operatingsystems\": [],\n  \"locations\": [],\n  \"organizations\": []\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["DELETE /api/ptables/1007981702-ptable81\n422\n{\n  \"error\": {\n    \"id\": 1007981702,\n    \"errors\": {\n      \"base\": [\n        \"ptable81 is used by host151\"\n      ]\n    },\n    \"full_messages\": [\n      \"ptable81 is used by host151\"\n    ]\n  }\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true},{"name":"ptable","full_name":"ptable","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"ptable[name]","description":"\n\u003Cp\u003Etemplate name\u003C/p\u003E\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}]}],"examples":["POST /api/ptables/1007981703-ptable86/clone\n{\n  \"ptable\": {\n    \"name\": \"MyClone\"\n  }\n}\n201\n{\n  \"created_at\": \"2015-12-01T02:41:07Z\",\n  \"default\": false,\n  \"id\": 1007981703,\n  \"locked\": false,\n  \"name\": \"MyClone\",\n  \"os_family\": \"Redhat\",\n  \"snippet\": false,\n  \"template\": \"zerombr yes\\\\nclearpart --all    --initlabel\\\\npart /boot --fstype ext3 --size=\u003C%= 10 * 10 %\u003E --asprimary\\\\npart /     --f   stype ext3 --size=1024 --grow\\\\npart swap  --recommended\",\n  \"template_kind_id\": null,\n  \"updated_at\": \"2015-12-01T02:41:07Z\",\n  \"vendor\": null\n}"],"metadata":null,"see":[]}]},"puppetclasses":{"doc_url":"../apidoc/v2/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":"host_id","full_name":"host_id","description":"\n\u003Cp\u003EID of host\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003Cp\u003EID of host group\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"environment_id","full_name":"environment_id","description":"\n\u003Cp\u003EID of environment\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"search","full_name":"search","description":"\n\u003Cp\u003Efilter results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003Cp\u003Esort results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003Cp\u003Epaginate results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003Cp\u003Enumber of entries per request\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/puppetclasses\n200\n{\n  \"total\": 8,\n  \"subtotal\": 8,\n  \"page\": 1,\n  \"per_page\": 20,\n  \"search\": null,\n  \"sort\": {\n    \"by\": null,\n    \"order\": null\n  },\n  \"results\": {\n    \"apache\": [\n      {\n        \"id\": 298486374,\n        \"name\": \"apache\",\n        \"created_at\": \"2015-12-01T02:40:02Z\",\n        \"updated_at\": \"2015-12-01T02:40:02Z\"\n      }\n    ],\n    \"auth\": [\n      {\n        \"id\": 638205575,\n        \"name\": \"auth\",\n        \"created_at\": \"2015-12-01T02:40:02Z\",\n        \"updated_at\": \"2015-12-01T02:40:02Z\"\n      }\n    ],\n    \"base\": [\n      {\n        \"id\": 980190962,\n        \"name\": \"base\",\n        \"created_at\": \"2015-12-01T02:40:02Z\",\n        \"updated_at\": \"2015-12-01T02:40:02Z\"\n      }\n    ],\n    \"chkmk\": [\n      {\n        \"id\": 51848956,\n        \"name\": \"chkmk\",\n        \"created_at\": \"2015-12-01T02:40:02Z\",\n        \"updated_at\": \"2015-12-01T02:40:02Z\"\n      }\n    ],\n    \"git\": [\n      {\n        \"id\": 113629430,\n        \"name\": \"git\",\n        \"created_at\": \"2015-12-01T02:40:02Z\",\n        \"updated_at\": \"2015-12-01T02:40:02Z\"\n      }\n    ],\n    \"nagios\": [\n      {\n        \"id\": 1018350795,\n        \"name\": \"nagios\",\n        \"created_at\": \"2015-12-01T02:40:02Z\",\n        \"updated_at\": \"2015-12-01T02:40:02Z\"\n      }\n    ],\n    \"pam\": [\n      {\n        \"id\": 374648174,\n        \"name\": \"pam\",\n        \"created_at\": \"2015-12-01T02:40:02Z\",\n        \"updated_at\": \"2015-12-01T02:40:02Z\"\n      }\n    ],\n    \"vim\": [\n      {\n        \"id\": 281110143,\n        \"name\": \"vim\",\n        \"created_at\": \"2015-12-01T02:40:02Z\",\n        \"updated_at\": \"2015-12-01T02:40:02Z\"\n      }\n    ]\n  }\n}"],"metadata":null,"see":[]},{"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":"host_id","full_name":"host_id","description":"\n\u003Cp\u003EID of host\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003Cp\u003EID of host group\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"environment_id","full_name":"environment_id","description":"\n\u003Cp\u003EID of environment\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"id","full_name":"id","description":"\n\u003Cp\u003EID of Puppet class\u003C/p\u003E\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/hosts/host154/puppetclasses/1018350796\n200\n{\n  \"created_at\": \"2015-12-01T02:41:08Z\",\n  \"updated_at\": \"2015-12-01T02:41:08Z\",\n  \"id\": 1018350796,\n  \"name\": \"class8\",\n  \"module_name\": \"class8\",\n  \"environments\": [\n    {\n      \"name\": \"environment9\",\n      \"id\": 687036938\n    }\n  ],\n  \"hostgroups\": [],\n  \"smart_variables\": [],\n  \"smart_class_parameters\": []\n}"],"metadata":null,"see":[]},{"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":"puppetclass","full_name":"puppetclass","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"puppetclass[name]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}]}],"examples":["POST /api/puppetclasses\n{\n  \"puppetclass\": {\n    \"name\": \"test_puppetclass\"\n  }\n}\n201\n{\n  \"created_at\": \"2015-12-01T02:41:07Z\",\n  \"updated_at\": \"2015-12-01T02:41:07Z\",\n  \"id\": 1018350796,\n  \"name\": \"test_puppetclass\",\n  \"module_name\": \"test_puppetclass\",\n  \"environments\": [],\n  \"hostgroups\": [],\n  \"smart_variables\": [],\n  \"smart_class_parameters\": []\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"puppetclass","full_name":"puppetclass","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"puppetclass[name]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}]}],"examples":["PUT /api/puppetclasses/980190962-base\n{\n  \"puppetclass\": {\n    \"name\": \"test_puppetclass\",\n    \"smart_class_parameter_ids\": [\n      328495940\n    ]\n  }\n}\n200\n{\n  \"created_at\": \"2015-12-01T02:40:02Z\",\n  \"updated_at\": \"2015-12-01T02:41:07Z\",\n  \"id\": 980190962,\n  \"name\": \"test_puppetclass\",\n  \"module_name\": \"test_puppetclass\",\n  \"environments\": [\n    {\n      \"name\": \"production\",\n      \"id\": 334344675\n    }\n  ],\n  \"hostgroups\": [\n    {\n      \"id\": 636252244,\n      \"name\": \"Common\",\n      \"title\": \"Common\"\n    }\n  ],\n  \"smart_variables\": [\n    {\n      \"variable\": \"ssl_port\",\n      \"id\": 298486374\n    }\n  ],\n  \"smart_class_parameters\": [\n    {\n      \"parameter\": \"cluster\",\n      \"id\": 328495940\n    }\n  ]\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["DELETE /api/puppetclasses/980190962-base\n200\n{\n  \"created_at\": \"2015-12-01T02:40:02Z\",\n  \"global_class_params_count\": 0,\n  \"hostgroups_count\": 0,\n  \"id\": 980190962,\n  \"name\": \"base\",\n  \"total_hosts\": 0,\n  \"updated_at\": \"2015-12-01T02:40:02Z\",\n  \"variable_lookup_keys_count\": 0\n}"],"metadata":null,"see":[]}]},"realms":{"doc_url":"../apidoc/v2/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,"validator":"Must be Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"organization_id","full_name":"organization_id","description":"\n\u003Cp\u003EScope by organizations\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"search","full_name":"search","description":"\n\u003Cp\u003Efilter results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003Cp\u003Esort results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003Cp\u003Epaginate results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003Cp\u003Enumber of entries per request\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/realms\n200\n{\n  \"total\": 4,\n  \"subtotal\": 4,\n  \"page\": 1,\n  \"per_page\": 20,\n  \"search\": null,\n  \"sort\": {\n    \"by\": null,\n    \"order\": null\n  },\n  \"results\": [\n    {\n      \"name\": \"myrealm.net\",\n      \"realm_proxy_id\": 982965213,\n      \"realm_type\": \"FreeIPA\",\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"id\": 664044182\n    },\n    {\n      \"name\": \"unused.net\",\n      \"realm_proxy_id\": 982965213,\n      \"realm_type\": \"FreeIPA\",\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"id\": 90728897\n    },\n    {\n      \"name\": \"useless.net\",\n      \"realm_proxy_id\": 982965213,\n      \"realm_type\": \"FreeIPA\",\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"id\": 229305443\n    },\n    {\n      \"name\": \"yourrealm.net\",\n      \"realm_proxy_id\": 982965213,\n      \"realm_type\": \"FreeIPA\",\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"id\": 936160439\n    }\n  ]\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"\n\u003Cp\u003ENumerical ID or realm name\u003C/p\u003E\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/realms/myrealm.net\n200\n{\n  \"name\": \"myrealm.net\",\n  \"realm_proxy_id\": 982965213,\n  \"realm_type\": \"FreeIPA\",\n  \"created_at\": \"2015-12-01T02:40:02Z\",\n  \"updated_at\": \"2015-12-01T02:40:02Z\",\n  \"id\": 664044182,\n  \"locations\": [\n    {\n      \"id\": 255093256,\n      \"name\": \"Location 1\",\n      \"title\": \"Location 1\",\n      \"description\": null\n    }\n  ],\n  \"organizations\": [\n    {\n      \"id\": 447626438,\n      \"name\": \"Organization 1\",\n      \"title\": \"Organization 1\",\n      \"description\": null\n    }\n  ]\n}"],"metadata":null,"see":[]},{"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 \u003Cb\u003Ename\u003C/b\u003E field is used for the name of the realm.\u003C/p\u003E\n","errors":[],"params":[{"name":"realm","full_name":"realm","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"realm_proxy_id","full_name":"realm[realm_proxy_id]","description":"\n\u003Cp\u003EProxy to use for this realm\u003C/p\u003E\n","required":true,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"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,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":["POST /api/realms\n{\n  \"realm\": {\n    \"name\": \"\"\n  }\n}\n422\n{\n  \"error\": {\n    \"id\": null,\n    \"errors\": {\n      \"name\": [\n        \"can't be blank\"\n      ],\n      \"realm_type\": [\n        \"can't be blank\",\n        \"is not included in the list\"\n      ],\n      \"realm_proxy_id\": [\n        \"can't be blank\"\n      ]\n    },\n    \"full_messages\": [\n      \"Name can't be blank\",\n      \"Realm type can't be blank\",\n      \"Realm type is not included in the list\",\n      \"Realm proxy can't be blank\"\n    ]\n  }\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true},{"name":"realm","full_name":"realm","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"realm_proxy_id","full_name":"realm[realm_proxy_id]","description":"\n\u003Cp\u003EProxy to use for this realm\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"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,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":["PUT /api/realms/myrealm.net\n{\n  \"realm\": {\n    \"name\": \"realm.new\"\n  }\n}\n200\n{\n  \"name\": \"realm.new\",\n  \"realm_proxy_id\": 982965213,\n  \"realm_type\": \"FreeIPA\",\n  \"created_at\": \"2015-12-01T02:40:02Z\",\n  \"updated_at\": \"2015-12-01T02:41:09Z\",\n  \"id\": 664044182,\n  \"locations\": [\n    {\n      \"id\": 255093256,\n      \"name\": \"Location 1\",\n      \"title\": \"Location 1\",\n      \"description\": null\n    }\n  ],\n  \"organizations\": [\n    {\n      \"id\": 447626438,\n      \"name\": \"Organization 1\",\n      \"title\": \"Organization 1\",\n      \"description\": null\n    }\n  ]\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true}],"examples":["DELETE /api/realms/myrealm.net\n200\n{\n  \"created_at\": \"2015-12-01T02:40:02Z\",\n  \"hostgroups_count\": 0,\n  \"hosts_count\": 0,\n  \"id\": 664044182,\n  \"name\": \"myrealm.net\",\n  \"realm_proxy_id\": 982965213,\n  \"realm_type\": \"FreeIPA\",\n  \"updated_at\": \"2015-12-01T02:40:02Z\"\n}"],"metadata":null,"see":[]}]},"settings":{"doc_url":"../apidoc/v2/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":"search","full_name":"search","description":"\n\u003Cp\u003Efilter results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003Cp\u003Esort results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003Cp\u003Epaginate results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003Cp\u003Enumber of entries per request\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/settings\n200\n{\n  \"total\": 54,\n  \"subtotal\": 54,\n  \"page\": 1,\n  \"per_page\": 20,\n  \"search\": null,\n  \"sort\": {\n    \"by\": null,\n    \"order\": null\n  },\n  \"results\": [\n    {\n      \"value\": [\n        \"fqdn\",\n        \"hostgroup\",\n        \"os\",\n        \"domain\"\n      ],\n      \"description\": \"The Default path in which foreman resolves host specific variables\",\n      \"category\": \"Setting::Puppet\",\n      \"settings_type\": null,\n      \"default\": [\n        \"fqdn\",\n        \"hostgroup\",\n        \"os\",\n        \"domain\"\n      ],\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"id\": 515381208,\n      \"name\": \"Default_variables_Lookup_Path\"\n    },\n    {\n      \"value\": true,\n      \"description\": \"Foreman smart variables will be exposed via the ENC yaml output\",\n      \"category\": \"Setting::Puppet\",\n      \"settings_type\": null,\n      \"default\": true,\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"id\": 712617915,\n      \"name\": \"Enable_Smart_Variables_in_ENC\"\n    },\n    {\n      \"value\": false,\n      \"description\": \"Should Foreman use the new format (2.6.5+) to answer Setting::Puppet in its ENC yaml output?\",\n      \"category\": \"Setting::Puppet\",\n      \"settings_type\": null,\n      \"default\": false,\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"id\": 43152518,\n      \"name\": \"Parametrized_Classes_in_ENC\"\n    },\n    {\n      \"value\": \"root@some.host.fqdn\",\n      \"description\": \"The Default administrator email address\",\n      \"category\": \"Setting::General\",\n      \"settings_type\": \"string\",\n      \"default\": \"root@some.host.fqdn\",\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"id\": 333972760,\n      \"name\": \"administrator\"\n    },\n    {\n      \"value\": false,\n      \"description\": \"Setting::Authorize login delegation with REMOTE_USER environment variable\",\n      \"category\": \"Setting::General\",\n      \"settings_type\": null,\n      \"default\": false,\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"id\": 737268150,\n      \"name\": \"authorize_login_delegation\"\n    },\n    {\n      \"value\": false,\n      \"description\": \"Setting::Authorize login delegation with REMOTE_USER environment variable for API calls\",\n      \"category\": \"Setting::General\",\n      \"settings_type\": null,\n      \"default\": false,\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"id\": 898974743,\n      \"name\": \"authorize_login_delegation_api\"\n    },\n    {\n      \"value\": true,\n      \"description\": \"Foreman will create the host when new facts are received\",\n      \"category\": \"Setting::Puppet\",\n      \"settings_type\": null,\n      \"default\": true,\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"id\": 183693096,\n      \"name\": \"create_new_host_when_facts_are_uploaded\"\n    },\n    {\n      \"value\": true,\n      \"description\": \"Foreman will create the host when a report is received\",\n      \"category\": \"Setting::Puppet\",\n      \"settings_type\": null,\n      \"default\": true,\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"id\": 903449968,\n      \"name\": \"create_new_host_when_report_is_uploaded\"\n    },\n    {\n      \"value\": \"Location 1\",\n      \"description\": \"Default location when importing hosts\",\n      \"category\": \"Setting::Puppet\",\n      \"settings_type\": null,\n      \"default\": \"Location 1\",\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"id\": 348705543,\n      \"name\": \"default_location\"\n    },\n    {\n      \"value\": \"Organization 1\",\n      \"description\": \"Default organization when importing hosts\",\n      \"category\": \"Setting::Puppet\",\n      \"settings_type\": null,\n      \"default\": \"Organization 1\",\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"id\": 600826774,\n      \"name\": \"default_organization\"\n    },\n    {\n      \"value\": \"production\",\n      \"description\": \"The Setting::Puppet environment foreman would default to in case it can't auto detect it\",\n      \"category\": \"Setting::Puppet\",\n      \"settings_type\": null,\n      \"default\": \"production\",\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"id\": 489917738,\n      \"name\": \"default_puppet_environment\"\n    },\n    {\n      \"value\": \"/home/olevy/git/foreman/public/puppet/rdoc\",\n      \"description\": \"Document root where puppetdoc files should be created\",\n      \"category\": \"Setting::Puppet\",\n      \"settings_type\": null,\n      \"default\": \"/home/olevy/git/foreman/public/puppet/rdoc\",\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"id\": 785572700,\n      \"name\": \"document_root\"\n    },\n    {\n      \"value\": \"Foreman-noreply@#{SETTINGS[:domain]}\",\n      \"description\": \"Email reply address for emails that Foreman is sending\",\n      \"category\": \"Setting::General\",\n      \"settings_type\": null,\n      \"default\": \"Foreman-noreply@#{SETTINGS[:domain]}\",\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"id\": 349877246,\n      \"name\": \"email_reply_address\"\n    },\n    {\n      \"value\": [\n        \"foreman\"\n      ],\n      \"description\": \"Prefix to add to all outgoing email\",\n      \"category\": \"Setting::General\",\n      \"settings_type\": null,\n      \"default\": [\n        \"foreman\"\n      ],\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"id\": 987026133,\n      \"name\": \"email_subject_prefix\"\n    },\n    {\n      \"value\": true,\n      \"description\": \"Should Foreman provide puppet environment in ENC yaml output? (this avoids the mismatch error between puppet.conf and ENC environment)\",\n      \"category\": \"Setting::Puppet\",\n      \"settings_type\": null,\n      \"default\": true,\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"id\": 537488238,\n      \"name\": \"enc_environment\"\n    },\n    {\n      \"value\": 20,\n      \"description\": \"The amount of records shown per page in foreman\",\n      \"category\": \"Setting::General\",\n      \"settings_type\": null,\n      \"default\": 20,\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"id\": 817264379,\n      \"name\": \"entries_per_page\"\n    },\n    {\n      \"value\": false,\n      \"description\": \"Enable Email Alerts per each failed puppet report\",\n      \"category\": \"Setting::Puppet\",\n      \"settings_type\": null,\n      \"default\": false,\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"id\": 14451317,\n      \"name\": \"failed_report_email_notification\"\n    },\n    {\n      \"value\": \"http://foreman.some.host.fqdn\",\n      \"description\": \"The URL Foreman should point to in emails etc\",\n      \"category\": \"Setting::General\",\n      \"settings_type\": null,\n      \"default\": \"http://foreman.some.host.fqdn\",\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"id\": 182539440,\n      \"name\": \"foreman_url\"\n    },\n    {\n      \"value\": 5,\n      \"description\": \"idle timeout\",\n      \"category\": \"Setting::General\",\n      \"settings_type\": null,\n      \"default\": 5,\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"id\": 386817023,\n      \"name\": \"idle_timeout\"\n    },\n    {\n      \"value\": [\n        \"lo\",\n        \"usb*\",\n        \"vnet*\",\n        \"macvtap*\"\n      ],\n      \"description\": \"Ignore interfaces that match these values during facts importing, you can use * wildcard to match names with indexes e.g. macvtap*\",\n      \"category\": \"Setting::Provisioning\",\n      \"settings_type\": null,\n      \"default\": [\n        \"lo\",\n        \"usb*\",\n        \"vnet*\",\n        \"macvtap*\"\n      ],\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"id\": 862101244,\n      \"name\": \"ignored_interface_identifiers\"\n    }\n  ]\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/settings/administrator\n200\n{\n  \"value\": \"root@some.host.fqdn\",\n  \"description\": \"The Default administrator email address\",\n  \"category\": \"Setting::General\",\n  \"settings_type\": \"string\",\n  \"default\": \"root@some.host.fqdn\",\n  \"created_at\": \"2015-12-01T02:40:02Z\",\n  \"updated_at\": \"2015-12-01T02:40:02Z\",\n  \"id\": 333972760,\n  \"name\": \"administrator\"\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"setting","full_name":"setting","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"value","full_name":"setting[value]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}]}],"examples":["PUT /api/settings/administrator\n{\n  \"setting\": {}\n}\n422\n{\n  \"error\": {\n    \"message\": \"No setting value provided.\"\n  }\n}"],"metadata":null,"see":[]}]},"smart_class_parameters":{"doc_url":"../apidoc/v2/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":"host_id","full_name":"host_id","description":"","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true},{"name":"puppetclass_id","full_name":"puppetclass_id","description":"","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true},{"name":"environment_id","full_name":"environment_id","description":"","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true},{"name":"search","full_name":"search","description":"\n\u003Cp\u003Efilter results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003Cp\u003Esort results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003Cp\u003Epaginate results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003Cp\u003Enumber of entries per request\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/smart_class_parameters\n200\n{\n  \"total\": 2,\n  \"subtotal\": 2,\n  \"page\": 1,\n  \"per_page\": 20,\n  \"search\": null,\n  \"sort\": {\n    \"by\": null,\n    \"order\": null\n  },\n  \"results\": [\n    {\n      \"description\": null,\n      \"override\": true,\n      \"parameter_type\": \"string\",\n      \"default_value\": \"secret\",\n      \"use_puppet_default\": null,\n      \"required\": false,\n      \"validator_type\": null,\n      \"validator_rule\": null,\n      \"merge_overrides\": null,\n      \"merge_default\": false,\n      \"avoid_duplicates\": null,\n      \"override_value_order\": \"organization,location\",\n      \"override_values_count\": 0,\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"parameter\": \"cluster\",\n      \"id\": 328495940\n    },\n    {\n      \"description\": null,\n      \"override\": true,\n      \"parameter_type\": \"string\",\n      \"default_value\": \"abcdef\",\n      \"use_puppet_default\": null,\n      \"required\": false,\n      \"validator_type\": null,\n      \"validator_rule\": null,\n      \"merge_overrides\": null,\n      \"merge_default\": false,\n      \"avoid_duplicates\": null,\n      \"override_value_order\": \"organization,location\",\n      \"override_values_count\": 0,\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"parameter\": \"custom_class_param\",\n      \"id\": 1018350795\n    }\n  ]\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/puppetclasses/298486374/smart_class_parameters/1018350795-custom_class_param\n200\n{\n  \"description\": null,\n  \"override\": true,\n  \"parameter_type\": \"string\",\n  \"default_value\": \"abcdef\",\n  \"use_puppet_default\": null,\n  \"required\": false,\n  \"validator_type\": null,\n  \"validator_rule\": null,\n  \"merge_overrides\": null,\n  \"merge_default\": false,\n  \"avoid_duplicates\": null,\n  \"override_value_order\": \"organization,location\",\n  \"override_values_count\": 0,\n  \"created_at\": \"2015-12-01T02:40:02Z\",\n  \"updated_at\": \"2015-12-01T02:40:02Z\",\n  \"parameter\": \"custom_class_param\",\n  \"id\": 1018350795,\n  \"environments\": [\n    {\n      \"id\": 334344675,\n      \"name\": \"production\"\n    }\n  ],\n  \"override_values\": []\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true},{"name":"smart_class_parameter","full_name":"smart_class_parameter","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"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,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true},{"name":"description","full_name":"smart_class_parameter[description]","description":"\n\u003Cp\u003EDescription of smart class\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"use_puppet_default","full_name":"smart_class_parameter[use_puppet_default]","description":"\n\u003Cp\u003EDo not send this parameter via the ENC. Puppet will use the value defined in the Puppet manifest for this parameter\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be one of: regexp, list.","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be one of: string, boolean, integer, real, array, hash, yaml, json.","expected_type":"string","metadata":null,"show":true},{"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 provide a value\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true}]}],"examples":["PUT /api/smart_class_parameters/1018350795-custom_class_param\n{\n  \"smart_class_parameter\": {\n    \"default_value\": \"33333\"\n  }\n}\n200\n{\n  \"description\": null,\n  \"override\": true,\n  \"parameter_type\": \"string\",\n  \"default_value\": \"33333\",\n  \"use_puppet_default\": null,\n  \"required\": false,\n  \"validator_type\": null,\n  \"validator_rule\": null,\n  \"merge_overrides\": null,\n  \"merge_default\": false,\n  \"avoid_duplicates\": null,\n  \"override_value_order\": \"organization,location\",\n  \"override_values_count\": 0,\n  \"created_at\": \"2015-12-01T02:40:02Z\",\n  \"updated_at\": \"2015-12-01T02:41:14Z\",\n  \"parameter\": \"custom_class_param\",\n  \"id\": 1018350795,\n  \"environments\": [\n    {\n      \"id\": 334344675,\n      \"name\": \"production\"\n    }\n  ],\n  \"puppetclass\": {\n    \"id\": 298486374,\n    \"name\": \"apache\",\n    \"module_name\": \"apache\"\n  },\n  \"override_values\": []\n}"],"metadata":null,"see":[]}]},"smart_proxies":{"doc_url":"../apidoc/v2/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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true},{"name":"smart_proxy_id","full_name":"smart_proxy_id","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"environment_id","full_name":"environment_id","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"dryrun","full_name":"dryrun","description":"","required":false,"allow_nil":false,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true},{"name":"except","full_name":"except","description":"\n\u003Cp\u003EOptional comma-delimited string containing either \u2018new\u2019, \u2018updated\u2019, or \u2018obsolete\u2019 that is used to limit the imported Puppet classes\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["POST /api/smart_proxies/182953976/import_puppetclasses\n{\n  \"smart_proxy\": {}\n}\n200\n{\n  \"message\": \"Successfully updated environment and puppetclasses from the on-disk puppet installation\",\n  \"environments_with_new_puppetclasses\": 2,\n  \"environments_updated_puppetclasses\": 0,\n  \"environments_obsolete\": 0,\n  \"results\": [\n    {\n      \"name\": \"env1\",\n      \"actions\": [\n        \"new\"\n      ],\n      \"new_puppetclasses\": [\n        \"a\"\n      ]\n    },\n    {\n      \"name\": \"env2\",\n      \"actions\": [\n        \"new\"\n      ],\n      \"new_puppetclasses\": [\n        \"a\"\n      ]\n    }\n  ]\n}"],"metadata":null,"see":[]},{"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,"validator":"Must be Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"organization_id","full_name":"organization_id","description":"\n\u003Cp\u003EScope by organizations\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"search","full_name":"search","description":"\n\u003Cp\u003Efilter results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003Cp\u003Esort results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003Cp\u003Epaginate results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003Cp\u003Enumber of entries per request\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/smart_proxies\n200\n{\n  \"total\": 7,\n  \"subtotal\": 7,\n  \"page\": 1,\n  \"per_page\": 20,\n  \"search\": null,\n  \"sort\": {\n    \"by\": null,\n    \"order\": null\n  },\n  \"results\": [\n    {\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"name\": \"BMC proxy\",\n      \"id\": 821748566,\n      \"url\": \"http://else.where:45673\",\n      \"features\": [\n        {\n          \"name\": \"BMC\",\n          \"id\": 821748566\n        }\n      ]\n    },\n    {\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"name\": \"DHCP Proxy\",\n      \"id\": 980190962,\n      \"url\": \"https://somewhere.net:8443\",\n      \"features\": [\n        {\n          \"name\": \"DHCP\",\n          \"id\": 219245707\n        }\n      ]\n    },\n    {\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"name\": \"DNS Proxy\",\n      \"id\": 113629430,\n      \"url\": \"http://else.where:45671\",\n      \"features\": [\n        {\n          \"name\": \"DNS\",\n          \"id\": 49142851\n        }\n      ]\n    },\n    {\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"name\": \"Puppetmaster Proxy\",\n      \"id\": 182953976,\n      \"url\": \"http://else.where:4567\",\n      \"features\": [\n        {\n          \"name\": \"Puppet\",\n          \"id\": 1006510553\n        },\n        {\n          \"name\": \"Puppet CA\",\n          \"id\": 783807086\n        }\n      ]\n    },\n    {\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"name\": \"Realm Proxy\",\n      \"id\": 982965213,\n      \"url\": \"http://else.where:1337\",\n      \"features\": [\n        {\n          \"name\": \"Realm\",\n          \"id\": 982965213\n        }\n      ]\n    },\n    {\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"name\": \"TFTP Proxy\",\n      \"id\": 298486374,\n      \"url\": \"http://somewhere.else\",\n      \"features\": [\n        {\n          \"name\": \"TFTP\",\n          \"id\": 303403661\n        }\n      ]\n    },\n    {\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"name\": \"Unused Proxy\",\n      \"id\": 281110143,\n      \"url\": \"http://else.where:45672\",\n      \"features\": []\n    }\n  ]\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/smart_proxies/980190962-DHCP%20Proxy\n200\n{\n  \"created_at\": \"2015-12-01T02:40:02Z\",\n  \"updated_at\": \"2015-12-01T02:40:02Z\",\n  \"name\": \"DHCP Proxy\",\n  \"id\": 980190962,\n  \"url\": \"https://somewhere.net:8443\",\n  \"features\": [\n    {\n      \"name\": \"DHCP\",\n      \"id\": 219245707\n    }\n  ],\n  \"locations\": [\n    {\n      \"id\": 255093256,\n      \"name\": \"Location 1\",\n      \"title\": \"Location 1\",\n      \"description\": null\n    }\n  ],\n  \"organizations\": [\n    {\n      \"id\": 447626438,\n      \"name\": \"Organization 1\",\n      \"title\": \"Organization 1\",\n      \"description\": null\n    }\n  ]\n}"],"metadata":null,"see":[]},{"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":"smart_proxy","full_name":"smart_proxy","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"smart_proxy[name]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"url","full_name":"smart_proxy[url]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"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,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":["POST /api/smart_proxies\n{\n  \"smart_proxy\": {\n    \"name\": \"master02\",\n    \"url\": \"http://server:8443\"\n  }\n}\n201\n{\n  \"created_at\": \"2015-12-01T02:41:14Z\",\n  \"updated_at\": \"2015-12-01T02:41:14Z\",\n  \"name\": \"master02\",\n  \"id\": 982965214,\n  \"url\": \"http://server:8443\",\n  \"features\": [],\n  \"locations\": [],\n  \"organizations\": []\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"smart_proxy","full_name":"smart_proxy","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"smart_proxy[name]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"url","full_name":"smart_proxy[url]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"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,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":["PUT /api/smart_proxies/980190962-DHCP%20Proxy\n{\n  \"smart_proxy\": {\n    \"name\": \"master02\",\n    \"url\": \"http://server:8443\"\n  }\n}\n200\n{\n  \"created_at\": \"2015-12-01T02:40:02Z\",\n  \"updated_at\": \"2015-12-01T02:41:14Z\",\n  \"name\": \"master02\",\n  \"id\": 980190962,\n  \"url\": \"http://server:8443\",\n  \"features\": [\n    {\n      \"name\": \"DHCP\",\n      \"id\": 219245707\n    }\n  ],\n  \"locations\": [\n    {\n      \"id\": 255093256,\n      \"name\": \"Location 1\",\n      \"title\": \"Location 1\",\n      \"description\": null\n    }\n  ],\n  \"organizations\": [\n    {\n      \"id\": 447626438,\n      \"name\": \"Organization 1\",\n      \"title\": \"Organization 1\",\n      \"description\": null\n    }\n  ]\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["DELETE /api/smart_proxies/281110143-Unused%20Proxy\n200\n{\n  \"created_at\": \"2015-12-01T02:40:02Z\",\n  \"id\": 281110143,\n  \"name\": \"Unused Proxy\",\n  \"updated_at\": \"2015-12-01T02:40:02Z\",\n  \"url\": \"http://else.where:45672\"\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["POST /api/smart_proxies/980190962-DHCP%20Proxy/refresh\n{\n  \"smart_proxy\": {}\n}\n201\n{\n  \"created_at\": \"2015-12-01T02:40:02Z\",\n  \"id\": 980190962,\n  \"name\": \"DHCP Proxy\",\n  \"updated_at\": \"2015-12-01T02:40:02Z\",\n  \"url\": \"https://somewhere.net:8443\"\n}"],"metadata":null,"see":[]}]},"smart_variables":{"doc_url":"../apidoc/v2/smart_variables","api_url":"/api","name":"Smart variables","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/smart_variables/index","name":"index","apis":[{"api_url":"/api/smart_variables","http_method":"GET","short_description":"List all smart variables","deprecated":null},{"api_url":"/api/hosts/:host_id/smart_variables","http_method":"GET","short_description":"List of smart variables for a specific host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/smart_variables","http_method":"GET","short_description":"List of smart variables for a specific host group","deprecated":null},{"api_url":"/api/puppetclasses/:puppetclass_id/smart_variables","http_method":"GET","short_description":"List of smart variables for a specific Puppet class","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true},{"name":"puppetclass_id","full_name":"puppetclass_id","description":"","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true},{"name":"search","full_name":"search","description":"\n\u003Cp\u003Efilter results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003Cp\u003Esort results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003Cp\u003Epaginate results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003Cp\u003Enumber of entries per request\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/smart_variables\n200\n{\n  \"total\": 2,\n  \"subtotal\": 2,\n  \"page\": 1,\n  \"per_page\": 20,\n  \"search\": null,\n  \"sort\": {\n    \"by\": null,\n    \"order\": null\n  },\n  \"results\": [\n    {\n      \"description\": null,\n      \"parameter_type\": \"string\",\n      \"default_value\": \"secret\",\n      \"validator_type\": null,\n      \"validator_rule\": null,\n      \"override_value_order\": \"organization,location\",\n      \"override_values_count\": 0,\n      \"merge_overrides\": null,\n      \"merge_default\": false,\n      \"avoid_duplicates\": null,\n      \"puppetclass_id\": 298486374,\n      \"puppetclass_name\": \"apache\",\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"variable\": \"special_info\",\n      \"id\": 281110143\n    },\n    {\n      \"description\": null,\n      \"parameter_type\": \"string\",\n      \"default_value\": \"443\",\n      \"validator_type\": \"list\",\n      \"validator_rule\": \"443,8443\",\n      \"override_value_order\": \"fqdn\\nhostgroup\\nos\\ndomain\",\n      \"override_values_count\": 0,\n      \"merge_overrides\": null,\n      \"merge_default\": false,\n      \"avoid_duplicates\": null,\n      \"puppetclass_id\": 980190962,\n      \"puppetclass_name\": \"base\",\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"variable\": \"ssl_port\",\n      \"id\": 298486374\n    }\n  ]\n}"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/smart_variables/show","name":"show","apis":[{"api_url":"/api/smart_variables/:id","http_method":"GET","short_description":"Show a smart variable","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/puppetclasses/980190962/smart_variables/298486374-ssl_port\n200\n{\n  \"description\": null,\n  \"parameter_type\": \"string\",\n  \"default_value\": \"443\",\n  \"validator_type\": \"list\",\n  \"validator_rule\": \"443,8443\",\n  \"override_value_order\": \"fqdn\\nhostgroup\\nos\\ndomain\",\n  \"override_values_count\": 0,\n  \"merge_overrides\": null,\n  \"merge_default\": false,\n  \"avoid_duplicates\": null,\n  \"puppetclass_id\": 980190962,\n  \"puppetclass_name\": \"base\",\n  \"created_at\": \"2015-12-01T02:40:02Z\",\n  \"updated_at\": \"2015-12-01T02:40:02Z\",\n  \"variable\": \"ssl_port\",\n  \"id\": 298486374,\n  \"override_values\": [\n    {\n      \"id\": 281110143,\n      \"match\": \"hostgroup=Common\",\n      \"value\": \"8443\",\n      \"use_puppet_default\": false\n    }\n  ]\n}"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/smart_variables/create","name":"create","apis":[{"api_url":"/api/smart_variables","http_method":"POST","short_description":"Create a smart variable","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"smart_variable","full_name":"smart_variable","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"variable","full_name":"smart_variable[variable]","description":"\n\u003Cp\u003EName of variable\u003C/p\u003E\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"puppetclass_id","full_name":"smart_variable[puppetclass_id]","description":"\n\u003Cp\u003EPuppet class ID\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"default_value","full_name":"smart_variable[default_value]","description":"\n\u003Cp\u003EDefault value of variable\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"override_value_order","full_name":"smart_variable[override_value_order]","description":"\n\u003Cp\u003EThe order in which values are resolved\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"description","full_name":"smart_variable[description]","description":"\n\u003Cp\u003EDescription of variable\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"validator_type","full_name":"smart_variable[validator_type]","description":"\n\u003Cp\u003ETypes of validation values\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be one of: regexp, list.","expected_type":"string","metadata":null,"show":true},{"name":"validator_rule","full_name":"smart_variable[validator_rule]","description":"\n\u003Cp\u003EUsed to enforce certain values for the parameter values\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"variable_type","full_name":"smart_variable[variable_type]","description":"\n\u003Cp\u003ETypes of variable values\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be one of: string, boolean, integer, real, array, hash, yaml, json.","expected_type":"string","metadata":null,"show":true},{"name":"merge_overrides","full_name":"smart_variable[merge_overrides]","description":"\n\u003Cp\u003EMerge all matching values (only array/hash type)\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true},{"name":"merge_default","full_name":"smart_variable[merge_default]","description":"\n\u003Cp\u003EInclude default value when merging all matching values\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true},{"name":"avoid_duplicates","full_name":"smart_variable[avoid_duplicates]","description":"\n\u003Cp\u003ERemove duplicate values (only array type)\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true}]}],"examples":["POST /api/smart_variables\n{\n  \"smart_variable\": {\n    \"variable\": \"test_smart_variable\",\n    \"puppetclass_id\": \"980190962\"\n  }\n}\n201\n{\n  \"description\": null,\n  \"parameter_type\": null,\n  \"default_value\": null,\n  \"validator_type\": null,\n  \"validator_rule\": null,\n  \"override_value_order\": \"fqdn\\nhostgroup\\nos\\ndomain\",\n  \"override_values_count\": 0,\n  \"merge_overrides\": null,\n  \"merge_default\": false,\n  \"avoid_duplicates\": null,\n  \"puppetclass_id\": 980190962,\n  \"created_at\": \"2015-12-01T02:41:22Z\",\n  \"updated_at\": \"2015-12-01T02:41:22Z\",\n  \"variable\": \"test_smart_variable\",\n  \"id\": 1018350796,\n  \"override_values\": []\n}"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/smart_variables/update","name":"update","apis":[{"api_url":"/api/smart_variables/:id","http_method":"PUT","short_description":"Update a smart variable","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true},{"name":"smart_variable","full_name":"smart_variable","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"variable","full_name":"smart_variable[variable]","description":"\n\u003Cp\u003EName of variable\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"puppetclass_id","full_name":"smart_variable[puppetclass_id]","description":"\n\u003Cp\u003EPuppet class ID\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"default_value","full_name":"smart_variable[default_value]","description":"\n\u003Cp\u003EDefault value of variable\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"override_value_order","full_name":"smart_variable[override_value_order]","description":"\n\u003Cp\u003EThe order in which values are resolved\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"description","full_name":"smart_variable[description]","description":"\n\u003Cp\u003EDescription of variable\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"validator_type","full_name":"smart_variable[validator_type]","description":"\n\u003Cp\u003ETypes of validation values\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be one of: regexp, list.","expected_type":"string","metadata":null,"show":true},{"name":"validator_rule","full_name":"smart_variable[validator_rule]","description":"\n\u003Cp\u003EUsed to enforce certain values for the parameter values\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"variable_type","full_name":"smart_variable[variable_type]","description":"\n\u003Cp\u003ETypes of variable values\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be one of: string, boolean, integer, real, array, hash, yaml, json.","expected_type":"string","metadata":null,"show":true},{"name":"merge_overrides","full_name":"smart_variable[merge_overrides]","description":"\n\u003Cp\u003EMerge all matching values (only array/hash type)\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true},{"name":"merge_default","full_name":"smart_variable[merge_default]","description":"\n\u003Cp\u003EInclude default value when merging all matching values\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true},{"name":"avoid_duplicates","full_name":"smart_variable[avoid_duplicates]","description":"\n\u003Cp\u003ERemove duplicate values (only array type)\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true}]}],"examples":["PUT /api/smart_variables/281110143-special_info\n{\n  \"smart_variable\": {\n    \"default_value\": \"newstring\"\n  }\n}\n200\n{\n  \"description\": null,\n  \"parameter_type\": \"string\",\n  \"default_value\": \"newstring\",\n  \"validator_type\": null,\n  \"validator_rule\": null,\n  \"override_value_order\": \"organization,location\",\n  \"override_values_count\": 0,\n  \"merge_overrides\": null,\n  \"merge_default\": false,\n  \"avoid_duplicates\": null,\n  \"puppetclass_id\": 298486374,\n  \"puppetclass_name\": \"apache\",\n  \"created_at\": \"2015-12-01T02:40:02Z\",\n  \"updated_at\": \"2015-12-01T02:41:22Z\",\n  \"variable\": \"special_info\",\n  \"id\": 281110143,\n  \"override_values\": [\n    {\n      \"id\": 51848956,\n      \"match\": \"hostgroup=Parent/inherited\",\n      \"value\": \"8443\",\n      \"use_puppet_default\": false\n    },\n    {\n      \"id\": 1018350795,\n      \"match\": \"hostgroup=Parent\",\n      \"value\": \"8443\",\n      \"use_puppet_default\": false\n    }\n  ]\n}"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/smart_variables/destroy","name":"destroy","apis":[{"api_url":"/api/smart_variables/:id","http_method":"DELETE","short_description":"Delete a smart variable","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true}],"examples":["DELETE /api/smart_variables/281110143-special_info\n200\n{\n  \"description\": null,\n  \"parameter_type\": \"string\",\n  \"default_value\": \"secret\",\n  \"validator_type\": null,\n  \"validator_rule\": null,\n  \"override_value_order\": \"organization,location\",\n  \"override_values_count\": 0,\n  \"merge_overrides\": null,\n  \"merge_default\": false,\n  \"avoid_duplicates\": null,\n  \"puppetclass_id\": 298486374,\n  \"puppetclass_name\": \"apache\",\n  \"created_at\": \"2015-12-01T02:40:02Z\",\n  \"updated_at\": \"2015-12-01T02:40:02Z\",\n  \"variable\": \"special_info\",\n  \"id\": 281110143,\n  \"override_values\": []\n}"],"metadata":null,"see":[]}]},"statistics":{"doc_url":"../apidoc/v2/statistics","api_url":"/api","name":"Statistics","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/statistics/index","name":"index","apis":[{"api_url":"/api/statistics","http_method":"GET","short_description":"Get statistics","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":["GET /api/statistics\n200\n{\n  \"os_count\": [],\n  \"arch_count\": [],\n  \"swap_size\": 0,\n  \"env_count\": [],\n  \"klass_count\": [],\n  \"cpu_count\": [],\n  \"model_count\": [],\n  \"mem_size\": 0,\n  \"mem_free\": 0,\n  \"swap_free\": 0,\n  \"mem_totsize\": 0.0,\n  \"mem_totfree\": 0.0\n}"],"metadata":null,"see":[]}]},"subnets":{"doc_url":"../apidoc/v2/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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"location_id","full_name":"location_id","description":"\n\u003Cp\u003EScope by locations\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"organization_id","full_name":"organization_id","description":"\n\u003Cp\u003EScope by organizations\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"search","full_name":"search","description":"\n\u003Cp\u003Efilter results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003Cp\u003Esort results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003Cp\u003Epaginate results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003Cp\u003Enumber of entries per request\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/subnets\n200\n{\n  \"total\": 5,\n  \"subtotal\": 5,\n  \"page\": 1,\n  \"per_page\": 20,\n  \"search\": null,\n  \"sort\": {\n    \"by\": null,\n    \"order\": null\n  },\n  \"results\": [\n    {\n      \"network\": \"10.0.0.0\",\n      \"cidr\": 24,\n      \"mask\": \"255.255.255.0\",\n      \"priority\": null,\n      \"vlanid\": null,\n      \"gateway\": null,\n      \"dns_primary\": null,\n      \"dns_secondary\": null,\n      \"from\": null,\n      \"to\": null,\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"ipam\": \"DHCP\",\n      \"boot_mode\": \"DHCP\",\n      \"id\": 1018350795,\n      \"name\": \"five\",\n      \"network_address\": \"10.0.0.0/24\",\n      \"dhcp\": {\n        \"name\": \"DHCP Proxy\",\n        \"id\": 980190962,\n        \"url\": \"https://somewhere.net:8443\"\n      },\n      \"tftp\": {\n        \"name\": \"TFTP Proxy\",\n        \"id\": 298486374,\n        \"url\": \"http://somewhere.else\"\n      },\n      \"dns\": {\n        \"name\": \"DNS Proxy\",\n        \"id\": 113629430,\n        \"url\": \"http://else.where:45671\"\n      }\n    },\n    {\n      \"network\": \"2.3.4.0\",\n      \"cidr\": 24,\n      \"mask\": \"255.255.255.0\",\n      \"priority\": null,\n      \"vlanid\": \"41\",\n      \"gateway\": null,\n      \"dns_primary\": null,\n      \"dns_secondary\": null,\n      \"from\": null,\n      \"to\": null,\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"ipam\": \"DHCP\",\n      \"boot_mode\": \"DHCP\",\n      \"id\": 980190962,\n      \"name\": \"one\",\n      \"network_address\": \"2.3.4.0/24\",\n      \"dhcp\": {\n        \"name\": \"DHCP Proxy\",\n        \"id\": 980190962,\n        \"url\": \"https://somewhere.net:8443\"\n      },\n      \"tftp\": {\n        \"name\": \"TFTP Proxy\",\n        \"id\": 298486374,\n        \"url\": \"http://somewhere.else\"\n      },\n      \"dns\": {\n        \"name\": \"DNS Proxy\",\n        \"id\": 113629430,\n        \"url\": \"http://else.where:45671\"\n      }\n    },\n    {\n      \"network\": \"3.3.4.0\",\n      \"cidr\": 24,\n      \"mask\": \"255.255.255.0\",\n      \"priority\": null,\n      \"vlanid\": \"42\",\n      \"gateway\": null,\n      \"dns_primary\": null,\n      \"dns_secondary\": null,\n      \"from\": null,\n      \"to\": null,\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"ipam\": \"DHCP\",\n      \"boot_mode\": \"DHCP\",\n      \"id\": 298486374,\n      \"name\": \"two\",\n      \"network_address\": \"3.3.4.0/24\",\n      \"dhcp\": {\n        \"name\": \"DHCP Proxy\",\n        \"id\": 980190962,\n        \"url\": \"https://somewhere.net:8443\"\n      },\n      \"tftp\": {\n        \"name\": \"TFTP Proxy\",\n        \"id\": 298486374,\n        \"url\": \"http://somewhere.else\"\n      },\n      \"dns\": null\n    },\n    {\n      \"network\": \"3.3.4.3\",\n      \"cidr\": 24,\n      \"mask\": \"255.255.255.0\",\n      \"priority\": null,\n      \"vlanid\": \"43\",\n      \"gateway\": null,\n      \"dns_primary\": null,\n      \"dns_secondary\": null,\n      \"from\": null,\n      \"to\": null,\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"ipam\": \"DHCP\",\n      \"boot_mode\": \"DHCP\",\n      \"id\": 113629430,\n      \"name\": \"three\",\n      \"network_address\": \"3.3.4.3/24\",\n      \"dhcp\": {\n        \"name\": \"DHCP Proxy\",\n        \"id\": 980190962,\n        \"url\": \"https://somewhere.net:8443\"\n      },\n      \"tftp\": {\n        \"name\": \"TFTP Proxy\",\n        \"id\": 298486374,\n        \"url\": \"http://somewhere.else\"\n      },\n      \"dns\": null\n    },\n    {\n      \"network\": \"3.3.5.0\",\n      \"cidr\": 24,\n      \"mask\": \"255.255.255.0\",\n      \"priority\": null,\n      \"vlanid\": \"44\",\n      \"gateway\": null,\n      \"dns_primary\": null,\n      \"dns_secondary\": null,\n      \"from\": null,\n      \"to\": null,\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"ipam\": \"DHCP\",\n      \"boot_mode\": \"DHCP\",\n      \"id\": 281110143,\n      \"name\": \"four\",\n      \"network_address\": \"3.3.5.0/24\",\n      \"dhcp\": null,\n      \"tftp\": {\n        \"name\": \"TFTP Proxy\",\n        \"id\": 298486374,\n        \"url\": \"http://somewhere.else\"\n      },\n      \"dns\": null\n    }\n  ]\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/subnets/980190962-one\n200\n{\n  \"network\": \"2.3.4.0\",\n  \"cidr\": 24,\n  \"mask\": \"255.255.255.0\",\n  \"priority\": null,\n  \"vlanid\": \"41\",\n  \"gateway\": null,\n  \"dns_primary\": null,\n  \"dns_secondary\": null,\n  \"from\": null,\n  \"to\": null,\n  \"created_at\": \"2015-12-01T02:40:02Z\",\n  \"updated_at\": \"2015-12-01T02:40:02Z\",\n  \"ipam\": \"DHCP\",\n  \"boot_mode\": \"DHCP\",\n  \"id\": 980190962,\n  \"name\": \"one\",\n  \"network_address\": \"2.3.4.0/24\",\n  \"dhcp\": {\n    \"name\": \"DHCP Proxy\",\n    \"id\": 980190962,\n    \"url\": \"https://somewhere.net:8443\"\n  },\n  \"tftp\": {\n    \"name\": \"TFTP Proxy\",\n    \"id\": 298486374,\n    \"url\": \"http://somewhere.else\"\n  },\n  \"dns\": {\n    \"name\": \"DNS Proxy\",\n    \"id\": 113629430,\n    \"url\": \"http://else.where:45671\"\n  },\n  \"domains\": [\n    {\n      \"id\": 22495316,\n      \"name\": \"mydomain.net\"\n    }\n  ],\n  \"interfaces\": [],\n  \"locations\": [\n    {\n      \"id\": 255093256,\n      \"name\": \"Location 1\",\n      \"title\": \"Location 1\",\n      \"description\": null\n    }\n  ],\n  \"organizations\": [\n    {\n      \"id\": 447626438,\n      \"name\": \"Organization 1\",\n      \"title\": \"Organization 1\",\n      \"description\": null\n    }\n  ]\n}"],"metadata":null,"see":[]},{"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":"subnet","full_name":"subnet","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"subnet[name]","description":"\n\u003Cp\u003ESubnet name\u003C/p\u003E\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"network","full_name":"subnet[network]","description":"\n\u003Cp\u003ESubnet network\u003C/p\u003E\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"mask","full_name":"subnet[mask]","description":"\n\u003Cp\u003ENetmask for this subnet\u003C/p\u003E\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"gateway","full_name":"subnet[gateway]","description":"\n\u003Cp\u003EPrimary DNS for this subnet\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"ipam","full_name":"subnet[ipam]","description":"\n\u003Cp\u003EIP Address auto suggestion mode for this subnet, valid values are \u201cDHCP\u201d, \u201cInternal DB\u201d, \u201cNone\u201d\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"vlanid","full_name":"subnet[vlanid]","description":"\n\u003Cp\u003EVLAN ID for this subnet\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"dhcp_id","full_name":"subnet[dhcp_id]","description":"\n\u003Cp\u003EDHCP Proxy to use within this subnet\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"tftp_id","full_name":"subnet[tftp_id]","description":"\n\u003Cp\u003ETFTP Proxy to use within this subnet\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"dns_id","full_name":"subnet[dns_id]","description":"\n\u003Cp\u003EDNS Proxy to use within this subnet\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"boot_mode","full_name":"subnet[boot_mode]","description":"\n\u003Cp\u003EDefault boot mode for interfaces assigned to this subnet, valid values are \u201cStatic\u201d, \u201cDHCP\u201d\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"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,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":["POST /api/subnets\n{\n  \"subnet\": {\n    \"name\": \"QA2\",\n    \"network\": \"10.35.2.27\",\n    \"mask\": \"255.255.255.0\"\n  }\n}\n201\n{\n  \"network\": \"10.35.2.27\",\n  \"cidr\": 24,\n  \"mask\": \"255.255.255.0\",\n  \"priority\": null,\n  \"vlanid\": null,\n  \"gateway\": null,\n  \"dns_primary\": null,\n  \"dns_secondary\": null,\n  \"from\": null,\n  \"to\": null,\n  \"created_at\": \"2015-12-01T02:41:23Z\",\n  \"updated_at\": \"2015-12-01T02:41:23Z\",\n  \"ipam\": \"DHCP\",\n  \"boot_mode\": \"DHCP\",\n  \"id\": 1018350796,\n  \"name\": \"QA2\",\n  \"network_address\": \"10.35.2.27/24\",\n  \"dhcp\": null,\n  \"tftp\": null,\n  \"dns\": null,\n  \"domains\": [],\n  \"interfaces\": [],\n  \"locations\": [],\n  \"organizations\": []\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"\n\u003Cp\u003ESubnet numeric identifier\u003C/p\u003E\n","required":true,"allow_nil":false,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"subnet","full_name":"subnet","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"subnet[name]","description":"\n\u003Cp\u003ESubnet name\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"network","full_name":"subnet[network]","description":"\n\u003Cp\u003ESubnet network\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"mask","full_name":"subnet[mask]","description":"\n\u003Cp\u003ENetmask for this subnet\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"gateway","full_name":"subnet[gateway]","description":"\n\u003Cp\u003EPrimary DNS for this subnet\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"ipam","full_name":"subnet[ipam]","description":"\n\u003Cp\u003EIP Address auto suggestion mode for this subnet, valid values are \u201cDHCP\u201d, \u201cInternal DB\u201d, \u201cNone\u201d\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"vlanid","full_name":"subnet[vlanid]","description":"\n\u003Cp\u003EVLAN ID for this subnet\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"dhcp_id","full_name":"subnet[dhcp_id]","description":"\n\u003Cp\u003EDHCP Proxy to use within this subnet\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"tftp_id","full_name":"subnet[tftp_id]","description":"\n\u003Cp\u003ETFTP Proxy to use within this subnet\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"dns_id","full_name":"subnet[dns_id]","description":"\n\u003Cp\u003EDNS Proxy to use within this subnet\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"boot_mode","full_name":"subnet[boot_mode]","description":"\n\u003Cp\u003EDefault boot mode for interfaces assigned to this subnet, valid values are \u201cStatic\u201d, \u201cDHCP\u201d\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"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,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":["PUT /api/subnets/980190962-one\n{\n  \"subnet\": {\n    \"name\": \"QA2\",\n    \"network\": \"10.35.2.27\",\n    \"mask\": \"255.255.255.0\"\n  }\n}\n200\n{\n  \"network\": \"10.35.2.27\",\n  \"cidr\": 24,\n  \"mask\": \"255.255.255.0\",\n  \"priority\": null,\n  \"vlanid\": \"41\",\n  \"gateway\": null,\n  \"dns_primary\": null,\n  \"dns_secondary\": null,\n  \"from\": null,\n  \"to\": null,\n  \"created_at\": \"2015-12-01T02:40:02Z\",\n  \"updated_at\": \"2015-12-01T02:41:23Z\",\n  \"ipam\": \"DHCP\",\n  \"boot_mode\": \"DHCP\",\n  \"id\": 980190962,\n  \"name\": \"QA2\",\n  \"network_address\": \"10.35.2.27/24\",\n  \"dhcp\": {\n    \"name\": \"DHCP Proxy\",\n    \"id\": 980190962,\n    \"url\": \"https://somewhere.net:8443\"\n  },\n  \"tftp\": {\n    \"name\": \"TFTP Proxy\",\n    \"id\": 298486374,\n    \"url\": \"http://somewhere.else\"\n  },\n  \"dns\": {\n    \"name\": \"DNS Proxy\",\n    \"id\": 113629430,\n    \"url\": \"http://else.where:45671\"\n  },\n  \"domains\": [\n    {\n      \"id\": 22495316,\n      \"name\": \"mydomain.net\"\n    }\n  ],\n  \"interfaces\": [],\n  \"locations\": [\n    {\n      \"id\": 255093256,\n      \"name\": \"Location 1\",\n      \"title\": \"Location 1\",\n      \"description\": null\n    }\n  ],\n  \"organizations\": [\n    {\n      \"id\": 447626438,\n      \"name\": \"Organization 1\",\n      \"title\": \"Organization 1\",\n      \"description\": null\n    }\n  ]\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"\n\u003Cp\u003ESubnet numeric identifier\u003C/p\u003E\n","required":true,"allow_nil":false,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true}],"examples":["DELETE /api/subnets/281110143-four\n200\n{\n  \"boot_mode\": \"DHCP\",\n  \"created_at\": \"2015-12-01T02:40:02Z\",\n  \"dhcp_id\": null,\n  \"dns_id\": null,\n  \"dns_primary\": null,\n  \"dns_secondary\": null,\n  \"from\": null,\n  \"gateway\": null,\n  \"id\": 281110143,\n  \"ipam\": \"DHCP\",\n  \"mask\": \"255.255.255.0\",\n  \"name\": \"four\",\n  \"network\": \"3.3.5.0\",\n  \"priority\": null,\n  \"tftp_id\": 298486374,\n  \"to\": null,\n  \"updated_at\": \"2015-12-01T02:40:02Z\",\n  \"vlanid\": \"44\",\n  \"to_label\": \"four (3.3.5.0/24)\"\n}"],"metadata":null,"see":[]}]},"tasks":{"doc_url":"../apidoc/v2/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":[],"examples":["GET /api/orchestration/tasks\n404\n{\n  \"error\": {\n    \"message\": \"Resource task not found by id ''\"\n  }\n}"],"metadata":null,"see":[]}]},"template_combinations":{"doc_url":"../apidoc/v2/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/config_templates/:config_template_id/template_combinations","http_method":"GET","short_description":"List template combination","deprecated":true},{"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":"config_template_id","full_name":"config_template_id","description":"\n\u003Cp\u003EID of config template\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003Cp\u003EID of host group\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"environment_id","full_name":"environment_id","description":"\n\u003Cp\u003EID of environment\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/config_templates/269958254/template_combinations\n200\n{\n  \"total\": 2,\n  \"subtotal\": 2,\n  \"page\": 1,\n  \"per_page\": 20,\n  \"search\": null,\n  \"sort\": {\n    \"by\": null,\n    \"order\": null\n  },\n  \"results\": [\n    {\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"id\": 281110143,\n      \"provisioning_template_id\": 269958254,\n      \"provisioning_template_name\": \"MyString2\",\n      \"hostgroup_id\": 636252244,\n      \"hostgroup_name\": \"Common\",\n      \"environment_id\": 334344675,\n      \"environment_name\": \"production\",\n      \"config_template_id\": 269958254,\n      \"config_template_name\": \"MyString2\"\n    },\n    {\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"id\": 298486374,\n      \"provisioning_template_id\": 269958254,\n      \"provisioning_template_name\": \"MyString2\",\n      \"hostgroup_id\": 0,\n      \"hostgroup_name\": null,\n      \"environment_id\": null,\n      \"environment_name\": null,\n      \"config_template_id\": 269958254,\n      \"config_template_name\": \"MyString2\"\n    }\n  ]\n}"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/template_combinations/create","name":"create","apis":[{"api_url":"/api/config_templates/:config_template_id/template_combinations","http_method":"POST","short_description":"Add a template combination","deprecated":true},{"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":"config_template_id","full_name":"config_template_id","description":"\n\u003Cp\u003EID of config template\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003Cp\u003EID of host group\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"environment_id","full_name":"environment_id","description":"\n\u003Cp\u003EID of environment\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"template_combination","full_name":"template_combination","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"environment_id","full_name":"template_combination[environment_id]","description":"\n\u003Cp\u003Eenvironment id\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"hostgroup_id","full_name":"template_combination[hostgroup_id]","description":"\n\u003Cp\u003Ehost group id\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true}]}],"examples":["POST /api/config_templates/269958254/template_combinations\n{\n  \"template_combination\": {\n    \"environment_id\": \"334344675\",\n    \"hostgroup_id\": \"866317115\"\n  }\n}\n201\n{\n  \"created_at\": \"2015-12-01T02:41:24Z\",\n  \"updated_at\": \"2015-12-01T02:41:24Z\",\n  \"id\": 980190963,\n  \"provisioning_template_id\": 269958254,\n  \"provisioning_template_name\": \"MyString2\",\n  \"hostgroup_id\": 866317115,\n  \"hostgroup_name\": \"Unusual\",\n  \"environment_id\": 334344675,\n  \"environment_name\": \"production\",\n  \"config_template_id\": 269958254,\n  \"config_template_name\": \"MyString2\"\n}"],"metadata":null,"see":[]},{"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/config_templates/:config_template_id/template_combinations/:id","http_method":"GET","short_description":"Show template combination","deprecated":true},{"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":"config_template_id","full_name":"config_template_id","description":"\n\u003Cp\u003EID of config template\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003Cp\u003EID of host group\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"environment_id","full_name":"environment_id","description":"\n\u003Cp\u003EID of environment\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/config_templates/269958254-MyString2/template_combinations/298486374\n200\n{\n  \"created_at\": \"2015-12-01T02:40:02Z\",\n  \"updated_at\": \"2015-12-01T02:40:02Z\",\n  \"id\": 298486374,\n  \"provisioning_template_id\": 269958254,\n  \"provisioning_template_name\": \"MyString2\",\n  \"hostgroup_id\": 0,\n  \"hostgroup_name\": null,\n  \"environment_id\": null,\n  \"environment_name\": null,\n  \"config_template_id\": 269958254,\n  \"config_template_name\": \"MyString2\"\n}"],"metadata":null,"see":[]},{"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/config_templates/:config_template_id/template_combinations/:id","http_method":"PUT","short_description":"Update template combination","deprecated":true},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true},{"name":"config_template_id","full_name":"config_template_id","description":"\n\u003Cp\u003EID of config template\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003Cp\u003EID of host group\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"environment_id","full_name":"environment_id","description":"\n\u003Cp\u003EID of environment\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"template_combination","full_name":"template_combination","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"environment_id","full_name":"template_combination[environment_id]","description":"\n\u003Cp\u003Eenvironment id\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"hostgroup_id","full_name":"template_combination[hostgroup_id]","description":"\n\u003Cp\u003Ehost group id\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true}]}],"examples":["PUT /api/config_templates/269958254/template_combinations/298486374\n{\n  \"template_combination\": {\n    \"environment_id\": \"687036937\",\n    \"hostgroup_id\": \"636252244\"\n  }\n}\n200\n{\n  \"created_at\": \"2015-12-01T02:40:02Z\",\n  \"updated_at\": \"2015-12-01T02:41:24Z\",\n  \"id\": 298486374,\n  \"provisioning_template_id\": 269958254,\n  \"provisioning_template_name\": \"MyString2\",\n  \"hostgroup_id\": 636252244,\n  \"hostgroup_name\": \"Common\",\n  \"environment_id\": 687036937,\n  \"environment_name\": \"testing\",\n  \"config_template_id\": 269958254,\n  \"config_template_name\": \"MyString2\"\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true}],"examples":["DELETE /api/template_combinations/298486374?config_template_id=269958254\n200\n{\n  \"created_at\": \"2015-12-01T02:40:02Z\",\n  \"environment_id\": null,\n  \"hostgroup_id\": 0,\n  \"id\": 298486374,\n  \"provisioning_template_id\": 269958254,\n  \"updated_at\": \"2015-12-01T02:40:02Z\"\n}"],"metadata":null,"see":[]}]},"template_kinds":{"doc_url":"../apidoc/v2/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":"search","full_name":"search","description":"\n\u003Cp\u003Efilter results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003Cp\u003Esort results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003Cp\u003Epaginate results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003Cp\u003Enumber of entries per request\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/template_kinds\n200\n{\n  \"total\": 6,\n  \"subtotal\": 6,\n  \"page\": 1,\n  \"per_page\": 20,\n  \"search\": null,\n  \"sort\": {\n    \"by\": null,\n    \"order\": null\n  },\n  \"results\": [\n    {\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"name\": \"PXEGrub\",\n      \"id\": 131565194\n    },\n    {\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"name\": \"PXELinux\",\n      \"id\": 452984334\n    },\n    {\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"name\": \"script\",\n      \"id\": 478250810\n    },\n    {\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"name\": \"finish\",\n      \"id\": 550103832\n    },\n    {\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"name\": \"iPXE\",\n      \"id\": 698706415\n    },\n    {\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"name\": \"provision\",\n      \"id\": 983253650\n    }\n  ]\n}"],"metadata":null,"see":[]}]},"usergroups":{"doc_url":"../apidoc/v2/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":"search","full_name":"search","description":"\n\u003Cp\u003Efilter results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003Cp\u003Esort results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003Cp\u003Epaginate results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003Cp\u003Enumber of entries per request\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/usergroups\n200\n{\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\": [\n    {\n      \"admin\": false,\n      \"created_at\": \"2015-12-01T02:41:24Z\",\n      \"updated_at\": \"2015-12-01T02:41:24Z\",\n      \"name\": \"usergroup13\",\n      \"id\": 1\n    }\n  ]\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/usergroups/1-usergroup14\n200\n{\n  \"admin\": false,\n  \"created_at\": \"2015-12-01T02:41:24Z\",\n  \"updated_at\": \"2015-12-01T02:41:24Z\",\n  \"name\": \"usergroup14\",\n  \"id\": 1,\n  \"external_usergroups\": [],\n  \"usergroups\": [],\n  \"users\": [],\n  \"roles\": []\n}"],"metadata":null,"see":[]},{"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":"usergroup","full_name":"usergroup","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"usergroup[name]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"user_ids","full_name":"usergroup[user_ids]","description":"","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"usergroup_ids","full_name":"usergroup[usergroup_ids]","description":"","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"role_ids","full_name":"usergroup[role_ids]","description":"","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":["POST /api/usergroups\n{\n  \"usergroup\": {\n    \"name\": \"test_usergroup\"\n  }\n}\n201\n{\n  \"admin\": false,\n  \"created_at\": \"2015-12-01T02:41:25Z\",\n  \"updated_at\": \"2015-12-01T02:41:25Z\",\n  \"name\": \"test_usergroup\",\n  \"id\": 2,\n  \"external_usergroups\": [],\n  \"usergroups\": [],\n  \"users\": [],\n  \"roles\": []\n}"],"metadata":null,"see":[]},{"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":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"usergroup","full_name":"usergroup","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"usergroup[name]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"user_ids","full_name":"usergroup[user_ids]","description":"","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"usergroup_ids","full_name":"usergroup[usergroup_ids]","description":"","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"role_ids","full_name":"usergroup[role_ids]","description":"","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":["PUT /api/usergroups/1-usergroup16\n{\n  \"usergroup\": {\n    \"name\": \"test_usergroup\"\n  }\n}\n200\n{\n  \"admin\": false,\n  \"created_at\": \"2015-12-01T02:41:25Z\",\n  \"updated_at\": \"2015-12-01T02:41:25Z\",\n  \"name\": \"test_usergroup\",\n  \"id\": 1,\n  \"external_usergroups\": [],\n  \"usergroups\": [],\n  \"users\": [],\n  \"roles\": []\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["DELETE /api/usergroups/1-usergroup17\n200\n{\n  \"admin\": false,\n  \"created_at\": \"2015-12-01T02:41:25Z\",\n  \"id\": 1,\n  \"name\": \"usergroup17\",\n  \"updated_at\": \"2015-12-01T02:41:25Z\"\n}"],"metadata":null,"see":[]}]},"users":{"doc_url":"../apidoc/v2/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/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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"usergroup_id","full_name":"usergroup_id","description":"\n\u003Cp\u003EID of user group\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"role_id","full_name":"role_id","description":"\n\u003Cp\u003EID of role\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"location_id","full_name":"location_id","description":"\n\u003Cp\u003EScope by locations\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"organization_id","full_name":"organization_id","description":"\n\u003Cp\u003EScope by organizations\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"search","full_name":"search","description":"\n\u003Cp\u003Efilter results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003Cp\u003Esort results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003Cp\u003Epaginate results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003Cp\u003Enumber of entries per request\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/users\n200\n{\n  \"total\": 6,\n  \"subtotal\": 6,\n  \"page\": 1,\n  \"per_page\": 20,\n  \"search\": null,\n  \"sort\": {\n    \"by\": null,\n    \"order\": null\n  },\n  \"results\": [\n    {\n      \"firstname\": \"Admin\",\n      \"lastname\": \"User\",\n      \"mail\": \"admin@someware.com\",\n      \"admin\": true,\n      \"auth_source_id\": 200482051,\n      \"auth_source_name\": \"Internal\",\n      \"timezone\": null,\n      \"locale\": null,\n      \"last_login_on\": \"2009-10-12T21:50:04Z\",\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"id\": 135138680,\n      \"login\": \"secret_admin\",\n      \"default_location\": null,\n      \"locations\": [],\n      \"default_organization\": null,\n      \"organizations\": []\n    },\n    {\n      \"firstname\": \"One\",\n      \"lastname\": \"User\",\n      \"mail\": \"userone@someware.com\",\n      \"admin\": false,\n      \"auth_source_id\": 980190962,\n      \"auth_source_name\": \"ldap-server\",\n      \"timezone\": null,\n      \"locale\": null,\n      \"last_login_on\": \"2009-10-12T21:50:04Z\",\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"id\": 980190962,\n      \"login\": \"one\",\n      \"default_location\": null,\n      \"locations\": [],\n      \"default_organization\": null,\n      \"organizations\": []\n    },\n    {\n      \"firstname\": \"Restricted\",\n      \"lastname\": \"User\",\n      \"mail\": \"userrestricted@someware.com\",\n      \"admin\": false,\n      \"auth_source_id\": 980190962,\n      \"auth_source_name\": \"ldap-server\",\n      \"timezone\": null,\n      \"locale\": null,\n      \"last_login_on\": \"2009-10-12T21:50:04Z\",\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"id\": 130842698,\n      \"login\": \"restricted\",\n      \"default_location\": null,\n      \"locations\": [],\n      \"default_organization\": null,\n      \"organizations\": []\n    },\n    {\n      \"firstname\": \"Two\",\n      \"lastname\": \"User\",\n      \"mail\": \"usertwo@someware.com\",\n      \"admin\": false,\n      \"auth_source_id\": 980190962,\n      \"auth_source_name\": \"ldap-server\",\n      \"timezone\": null,\n      \"locale\": null,\n      \"last_login_on\": \"2009-10-12T21:50:04Z\",\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"id\": 298486374,\n      \"login\": \"two\",\n      \"default_location\": null,\n      \"locations\": [],\n      \"default_organization\": null,\n      \"organizations\": []\n    },\n    {\n      \"firstname\": \"apiadmin\",\n      \"lastname\": \"User\",\n      \"mail\": \"apiadmin@someware.com\",\n      \"admin\": true,\n      \"auth_source_id\": 200482051,\n      \"auth_source_name\": \"Internal\",\n      \"timezone\": null,\n      \"locale\": null,\n      \"last_login_on\": \"2009-10-12T21:50:04Z\",\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"id\": 886836129,\n      \"login\": \"apiadmin\",\n      \"default_location\": null,\n      \"locations\": [],\n      \"default_organization\": null,\n      \"organizations\": []\n    },\n    {\n      \"firstname\": \"test\",\n      \"lastname\": \"User\",\n      \"mail\": \"testuser@someware.com\",\n      \"admin\": false,\n      \"auth_source_id\": 200482051,\n      \"auth_source_name\": \"Internal\",\n      \"timezone\": null,\n      \"locale\": null,\n      \"last_login_on\": \"2009-10-12T21:50:04Z\",\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"id\": 200482051,\n      \"login\": \"test\",\n      \"default_location\": null,\n      \"locations\": [],\n      \"default_organization\": null,\n      \"organizations\": []\n    }\n  ]\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/users/980190962\n200\n{\n  \"firstname\": \"One\",\n  \"lastname\": \"User\",\n  \"mail\": \"userone@someware.com\",\n  \"admin\": false,\n  \"auth_source_id\": 980190962,\n  \"auth_source_name\": \"ldap-server\",\n  \"timezone\": null,\n  \"locale\": null,\n  \"last_login_on\": \"2009-10-12T21:50:04Z\",\n  \"created_at\": \"2015-12-01T02:40:02Z\",\n  \"updated_at\": \"2015-12-01T02:40:02Z\",\n  \"id\": 980190962,\n  \"login\": \"one\",\n  \"default_location\": null,\n  \"locations\": [],\n  \"default_organization\": null,\n  \"organizations\": [],\n  \"auth_source_ldap\": {\n    \"id\": 980190962,\n    \"type\": \"AuthSourceLdap\",\n    \"name\": \"ldap-server\"\n  },\n  \"mail_notifications\": [],\n  \"roles\": [\n    {\n      \"name\": \"Anonymous\",\n      \"id\": 7\n    },\n    {\n      \"name\": \"Viewer\",\n      \"id\": 5\n    }\n  ],\n  \"usergroups\": []\n}"],"metadata":null,"see":[]},{"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 \u2018Anonymous\u2019 to the user by default\u003C/p\u003E\n","errors":[],"params":[{"name":"user","full_name":"user","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"login","full_name":"user[login]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"firstname","full_name":"user[firstname]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"lastname","full_name":"user[lastname]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"mail","full_name":"user[mail]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"admin","full_name":"user[admin]","description":"\n\u003Cp\u003Eis an admin account\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true},{"name":"password","full_name":"user[password]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"default_location_id","full_name":"user[default_location_id]","description":"","required":false,"allow_nil":true,"validator":"Must be Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"default_organization_id","full_name":"user[default_organization_id]","description":"","required":false,"allow_nil":true,"validator":"Must be Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"auth_source_id","full_name":"user[auth_source_id]","description":"","required":true,"allow_nil":false,"validator":"Must be Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"timezone","full_name":"user[timezone]","description":"\n\u003Cp\u003EUser\u2019s timezone\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be one of: UTC, International Date Line West, Midway Island, American Samoa, Hawaii, Alaska, Pacific Time (US \u0026 Canada), Tijuana, Mountain Time (US \u0026 Canada), Arizona, Chihuahua, Mazatlan, Central Time (US \u0026 Canada), Saskatchewan, Guadalajara, Mexico City, Monterrey, Central America, Eastern Time (US \u0026 Canada), Indiana (East), Bogota, Lima, Quito, Atlantic Time (Canada), Caracas, La Paz, Santiago, Newfoundland, Brasilia, Buenos Aires, Georgetown, Greenland, Mid-Atlantic, Azores, Cape Verde Is., Dublin, Edinburgh, Lisbon, London, Casablanca, Monrovia, Belgrade, Bratislava, Budapest, Ljubljana, Prague, Sarajevo, Skopje, Warsaw, Zagreb, Brussels, Copenhagen, Madrid, Paris, Amsterdam, Berlin, Bern, Rome, Stockholm, Vienna, West Central Africa, Bucharest, Cairo, Helsinki, Kyiv, Riga, Sofia, Tallinn, Vilnius, Athens, Istanbul, Minsk, Jerusalem, Harare, Pretoria, Moscow, St. Petersburg, Volgograd, Kuwait, Riyadh, Nairobi, Baghdad, Tehran, Abu Dhabi, Muscat, Baku, Tbilisi, Yerevan, Kabul, Ekaterinburg, Islamabad, Karachi, Tashkent, Chennai, Kolkata, Mumbai, New Delhi, Kathmandu, Astana, Dhaka, Sri Jayawardenepura, Almaty, Novosibirsk, Rangoon, Bangkok, Hanoi, Jakarta, Krasnoyarsk, Beijing, Chongqing, Hong Kong, Urumqi, Kuala Lumpur, Singapore, Taipei, Perth, Irkutsk, Ulaan Bataar, Seoul, Osaka, Sapporo, Tokyo, Yakutsk, Darwin, Adelaide, Canberra, Melbourne, Sydney, Brisbane, Hobart, Vladivostok, Guam, Port Moresby, Magadan, Solomon Is., New Caledonia, Fiji, Kamchatka, Marshall Is., Auckland, Wellington, Nuku'alofa, Tokelau Is., Samoa.","expected_type":"string","metadata":null,"show":true},{"name":"locale","full_name":"user[locale]","description":"\n\u003Cp\u003EUser\u2019s preferred locale\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be one of: de, en, en_GB, es, fr, ja, sv_SE, zh_CN, gl, it, ko, pt_BR, ru, zh_TW.","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"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,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":["POST /api/users\n{\n  \"user\": {\n    \"login\": \"new_admin\",\n    \"auth_source_id\": \"980190962\"\n  }\n}\n201\n{\n  \"firstname\": null,\n  \"lastname\": null,\n  \"mail\": null,\n  \"admin\": true,\n  \"auth_source_id\": 980190962,\n  \"auth_source_name\": \"ldap-server\",\n  \"timezone\": null,\n  \"locale\": null,\n  \"last_login_on\": null,\n  \"created_at\": \"2015-12-01T02:41:27Z\",\n  \"updated_at\": \"2015-12-01T02:41:27Z\",\n  \"id\": 980190963,\n  \"login\": \"new_admin\",\n  \"default_location\": null,\n  \"locations\": [],\n  \"default_organization\": null,\n  \"organizations\": [],\n  \"auth_source_ldap\": {\n    \"id\": 980190962,\n    \"type\": \"AuthSourceLdap\",\n    \"name\": \"ldap-server\"\n  },\n  \"mail_notifications\": [],\n  \"roles\": [\n    {\n      \"name\": \"Anonymous\",\n      \"id\": 7\n    }\n  ],\n  \"usergroups\": []\n}"],"metadata":null,"see":[]},{"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 \u2018Anonymous\u2019 to the user if it is not already present. Only another admin can change the admin account attribute.\u003C/p\u003E\n","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"user","full_name":"user","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"login","full_name":"user[login]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"firstname","full_name":"user[firstname]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"lastname","full_name":"user[lastname]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"mail","full_name":"user[mail]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"admin","full_name":"user[admin]","description":"\n\u003Cp\u003Eis an admin account\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true},{"name":"password","full_name":"user[password]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"default_location_id","full_name":"user[default_location_id]","description":"","required":false,"allow_nil":true,"validator":"Must be Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"default_organization_id","full_name":"user[default_organization_id]","description":"","required":false,"allow_nil":true,"validator":"Must be Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"auth_source_id","full_name":"user[auth_source_id]","description":"","required":false,"allow_nil":false,"validator":"Must be Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"timezone","full_name":"user[timezone]","description":"\n\u003Cp\u003EUser\u2019s timezone\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be one of: UTC, International Date Line West, Midway Island, American Samoa, Hawaii, Alaska, Pacific Time (US \u0026 Canada), Tijuana, Mountain Time (US \u0026 Canada), Arizona, Chihuahua, Mazatlan, Central Time (US \u0026 Canada), Saskatchewan, Guadalajara, Mexico City, Monterrey, Central America, Eastern Time (US \u0026 Canada), Indiana (East), Bogota, Lima, Quito, Atlantic Time (Canada), Caracas, La Paz, Santiago, Newfoundland, Brasilia, Buenos Aires, Georgetown, Greenland, Mid-Atlantic, Azores, Cape Verde Is., Dublin, Edinburgh, Lisbon, London, Casablanca, Monrovia, Belgrade, Bratislava, Budapest, Ljubljana, Prague, Sarajevo, Skopje, Warsaw, Zagreb, Brussels, Copenhagen, Madrid, Paris, Amsterdam, Berlin, Bern, Rome, Stockholm, Vienna, West Central Africa, Bucharest, Cairo, Helsinki, Kyiv, Riga, Sofia, Tallinn, Vilnius, Athens, Istanbul, Minsk, Jerusalem, Harare, Pretoria, Moscow, St. Petersburg, Volgograd, Kuwait, Riyadh, Nairobi, Baghdad, Tehran, Abu Dhabi, Muscat, Baku, Tbilisi, Yerevan, Kabul, Ekaterinburg, Islamabad, Karachi, Tashkent, Chennai, Kolkata, Mumbai, New Delhi, Kathmandu, Astana, Dhaka, Sri Jayawardenepura, Almaty, Novosibirsk, Rangoon, Bangkok, Hanoi, Jakarta, Krasnoyarsk, Beijing, Chongqing, Hong Kong, Urumqi, Kuala Lumpur, Singapore, Taipei, Perth, Irkutsk, Ulaan Bataar, Seoul, Osaka, Sapporo, Tokyo, Yakutsk, Darwin, Adelaide, Canberra, Melbourne, Sydney, Brisbane, Hobart, Vladivostok, Guam, Port Moresby, Magadan, Solomon Is., New Caledonia, Fiji, Kamchatka, Marshall Is., Auckland, Wellington, Nuku'alofa, Tokelau Is., Samoa.","expected_type":"string","metadata":null,"show":true},{"name":"locale","full_name":"user[locale]","description":"\n\u003Cp\u003EUser\u2019s preferred locale\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be one of: de, en, en_GB, es, fr, ja, sv_SE, zh_CN, gl, it, ko, pt_BR, ru, zh_TW.","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"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,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":["PUT /api/users/980190963\n{\n  \"user\": {\n    \"login\": \"johnsmith\",\n    \"mail\": \"john@example.com\",\n    \"auth_source_id\": \"200482051\",\n    \"password\": \"123456\"\n  }\n}\n200\n{\n  \"firstname\": null,\n  \"lastname\": null,\n  \"mail\": \"john@example.com\",\n  \"admin\": false,\n  \"auth_source_id\": 200482051,\n  \"auth_source_name\": \"Internal\",\n  \"timezone\": null,\n  \"locale\": null,\n  \"last_login_on\": null,\n  \"created_at\": \"2015-12-01T02:41:25Z\",\n  \"updated_at\": \"2015-12-01T02:41:25Z\",\n  \"id\": 980190963,\n  \"login\": \"johnsmith\",\n  \"default_location\": null,\n  \"locations\": [],\n  \"default_organization\": null,\n  \"organizations\": [],\n  \"auth_source_internal\": {\n    \"id\": 200482051,\n    \"type\": \"AuthSourceInternal\",\n    \"name\": \"Internal\"\n  },\n  \"mail_notifications\": [],\n  \"roles\": [\n    {\n      \"name\": \"Anonymous\",\n      \"id\": 7\n    }\n  ],\n  \"usergroups\": []\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["DELETE /api/users/980190962\n200\n{\n  \"admin\": false,\n  \"auth_source_id\": 980190962,\n  \"avatar_hash\": null,\n  \"created_at\": \"2015-12-01T02:40:02Z\",\n  \"default_location_id\": null,\n  \"default_organization_id\": null,\n  \"firstname\": \"One\",\n  \"id\": 980190962,\n  \"last_login_on\": \"2009-10-12T21:50:04Z\",\n  \"lastname\": \"User\",\n  \"locale\": null,\n  \"login\": \"one\",\n  \"lower_login\": \"one\",\n  \"mail\": \"userone@someware.com\",\n  \"mail_enabled\": true,\n  \"password_hash\": null,\n  \"password_salt\": null,\n  \"timezone\": null,\n  \"updated_at\": \"2015-12-01T02:40:02Z\"\n}"],"metadata":null,"see":[]}]},"audits":{"doc_url":"../apidoc/v2/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":"search","full_name":"search","description":"\n\u003Cp\u003Efilter results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003Cp\u003Esort results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003Cp\u003Epaginate results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003Cp\u003Enumber of entries per request\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/audits\n200\n{\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\": [\n    {\n      \"user_id\": null,\n      \"user_type\": null,\n      \"user_name\": null,\n      \"version\": 1,\n      \"comment\": null,\n      \"associated_id\": 272,\n      \"associated_type\": \"Host\",\n      \"remote_address\": null,\n      \"associated_name\": null,\n      \"created_at\": \"2009-12-14T08:01:17Z\",\n      \"id\": 980190962,\n      \"auditable_id\": 980190962,\n      \"auditable_name\": null,\n      \"auditable_type\": \"Host\",\n      \"action\": \"update\",\n      \"audited_changes\": {\n        \"architecture_id\": [\n          10463,\n          10466\n        ]\n      }\n    }\n  ]\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/audits/980190962\n200\n{\n  \"user_id\": null,\n  \"user_type\": null,\n  \"user_name\": null,\n  \"version\": 1,\n  \"comment\": null,\n  \"associated_id\": 272,\n  \"associated_type\": \"Host\",\n  \"remote_address\": null,\n  \"associated_name\": null,\n  \"created_at\": \"2009-12-14T08:01:17Z\",\n  \"id\": 980190962,\n  \"auditable_id\": 980190962,\n  \"auditable_name\": null,\n  \"auditable_type\": \"Host\",\n  \"action\": \"update\",\n  \"audited_changes\": {\n    \"architecture_id\": [\n      10463,\n      10466\n    ]\n  }\n}"],"metadata":null,"see":[]}]},"auth_source_ldaps":{"doc_url":"../apidoc/v2/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}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"\n\u003Cp\u003Efilter results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003Cp\u003Esort results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003Cp\u003Epaginate results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003Cp\u003Enumber of entries per request\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/auth_source_ldaps\n200\n{\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\": [\n    {\n      \"host\": \"ldap\",\n      \"port\": 123,\n      \"account\": null,\n      \"base_dn\": \"dn=x,dn=y\",\n      \"ldap_filter\": null,\n      \"attr_login\": \"uid\",\n      \"attr_firstname\": \"givenName\",\n      \"attr_lastname\": \"sn\",\n      \"attr_mail\": \"mail\",\n      \"attr_photo\": null,\n      \"onthefly_register\": true,\n      \"usergroup_sync\": true,\n      \"tls\": true,\n      \"created_at\": \"2015-12-01T02:40:01Z\",\n      \"updated_at\": \"2015-12-01T02:40:01Z\",\n      \"id\": 980190962,\n      \"type\": \"AuthSourceLdap\",\n      \"name\": \"ldap-server\"\n    }\n  ]\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/auth_source_ldaps/980190962-ldap-server\n200\n{\n  \"host\": \"ldap\",\n  \"port\": 123,\n  \"account\": null,\n  \"base_dn\": \"dn=x,dn=y\",\n  \"ldap_filter\": null,\n  \"attr_login\": \"uid\",\n  \"attr_firstname\": \"givenName\",\n  \"attr_lastname\": \"sn\",\n  \"attr_mail\": \"mail\",\n  \"attr_photo\": null,\n  \"onthefly_register\": true,\n  \"usergroup_sync\": true,\n  \"tls\": true,\n  \"created_at\": \"2015-12-01T02:40:01Z\",\n  \"updated_at\": \"2015-12-01T02:40:01Z\",\n  \"id\": 980190962,\n  \"type\": \"AuthSourceLdap\",\n  \"name\": \"ldap-server\",\n  \"external_usergroups\": []\n}"],"metadata":null,"see":[]},{"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":"auth_source_ldap","full_name":"auth_source_ldap","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"auth_source_ldap[name]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"host","full_name":"auth_source_ldap[host]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"port","full_name":"auth_source_ldap[port]","description":"\n\u003Cp\u003Edefaults to 389\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"account","full_name":"auth_source_ldap[account]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"base_dn","full_name":"auth_source_ldap[base_dn]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"attr_photo","full_name":"auth_source_ldap[attr_photo]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"onthefly_register","full_name":"auth_source_ldap[onthefly_register]","description":"","required":false,"allow_nil":true,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true},{"name":"tls","full_name":"auth_source_ldap[tls]","description":"","required":false,"allow_nil":true,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be one of: free_ipa, active_directory, posix.","expected_type":"string","metadata":null,"show":true},{"name":"ldap_filter","full_name":"auth_source_ldap[ldap_filter]","description":"\n\u003Cp\u003ELDAP filter\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}]}],"examples":["POST /api/auth_source_ldaps\n{\n  \"auth_source_ldap\": {\n    \"name\": \"ldap2\",\n    \"host\": \"ldap2\",\n    \"server_type\": \"posix\"\n  }\n}\n201\n{\n  \"host\": \"ldap2\",\n  \"port\": 389,\n  \"account\": null,\n  \"base_dn\": null,\n  \"ldap_filter\": null,\n  \"attr_login\": null,\n  \"attr_firstname\": null,\n  \"attr_lastname\": null,\n  \"attr_mail\": null,\n  \"attr_photo\": null,\n  \"onthefly_register\": false,\n  \"usergroup_sync\": true,\n  \"tls\": false,\n  \"created_at\": \"2015-12-01T02:40:29Z\",\n  \"updated_at\": \"2015-12-01T02:40:29Z\",\n  \"id\": 980190963,\n  \"type\": \"AuthSourceLdap\",\n  \"name\": \"ldap2\",\n  \"external_usergroups\": []\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"auth_source_ldap","full_name":"auth_source_ldap","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"auth_source_ldap[name]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"host","full_name":"auth_source_ldap[host]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"port","full_name":"auth_source_ldap[port]","description":"\n\u003Cp\u003Edefaults to 389\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"account","full_name":"auth_source_ldap[account]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"base_dn","full_name":"auth_source_ldap[base_dn]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"attr_photo","full_name":"auth_source_ldap[attr_photo]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"onthefly_register","full_name":"auth_source_ldap[onthefly_register]","description":"","required":false,"allow_nil":true,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true},{"name":"tls","full_name":"auth_source_ldap[tls]","description":"","required":false,"allow_nil":true,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"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,"validator":"Must be one of: free_ipa, active_directory, posix.","expected_type":"string","metadata":null,"show":true},{"name":"ldap_filter","full_name":"auth_source_ldap[ldap_filter]","description":"\n\u003Cp\u003ELDAP filter\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}]}],"examples":["PUT /api/auth_source_ldaps/980190962-ldap-server\n{\n  \"auth_source_ldap\": {\n    \"name\": \"ldap2\",\n    \"host\": \"ldap2\",\n    \"server_type\": \"posix\"\n  }\n}\n200\n{\n  \"host\": \"ldap2\",\n  \"port\": 123,\n  \"account\": null,\n  \"base_dn\": \"dn=x,dn=y\",\n  \"ldap_filter\": null,\n  \"attr_login\": \"uid\",\n  \"attr_firstname\": \"givenName\",\n  \"attr_lastname\": \"sn\",\n  \"attr_mail\": \"mail\",\n  \"attr_photo\": null,\n  \"onthefly_register\": true,\n  \"usergroup_sync\": true,\n  \"tls\": true,\n  \"created_at\": \"2015-12-01T02:40:01Z\",\n  \"updated_at\": \"2015-12-01T02:40:29Z\",\n  \"id\": 980190962,\n  \"type\": \"AuthSourceLdap\",\n  \"name\": \"ldap2\",\n  \"external_usergroups\": []\n}"],"metadata":null,"see":[]},{"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":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["DELETE /api/auth_source_ldaps/980190962\n200\n{\n  \"account\": null,\n  \"account_password\": null,\n  \"attr_firstname\": \"givenName\",\n  \"attr_lastname\": \"sn\",\n  \"attr_login\": \"uid\",\n  \"attr_mail\": \"mail\",\n  \"attr_photo\": null,\n  \"base_dn\": \"dn=x,dn=y\",\n  \"created_at\": \"2015-12-01T02:40:01Z\",\n  \"groups_base\": null,\n  \"host\": \"ldap\",\n  \"id\": 980190962,\n  \"ldap_filter\": null,\n  \"name\": \"ldap-server\",\n  \"onthefly_register\": true,\n  \"port\": 123,\n  \"server_type\": \"posix\",\n  \"tls\": true,\n  \"updated_at\": \"2015-12-01T02:40:01Z\",\n  \"usergroup_sync\": true\n}"],"metadata":null,"see":[]}]},"config_templates":{"doc_url":"../apidoc/v2/config_templates","api_url":"/api","name":"Config templates","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/config_templates/index","name":"index","apis":[{"api_url":"/api/config_templates","http_method":"GET","short_description":"List provisioning templates","deprecated":null},{"api_url":"/api/operatingsystem/:operatingsystem_id/config_templates","http_method":"GET","short_description":"List provisioning templates per operating system","deprecated":null},{"api_url":"/api/locations/:location_id/config_templates","http_method":"GET","short_description":"List provisioning templates per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/config_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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"location_id","full_name":"location_id","description":"\n\u003Cp\u003EScope by locations\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"organization_id","full_name":"organization_id","description":"\n\u003Cp\u003EScope by organizations\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"search","full_name":"search","description":"\n\u003Cp\u003Efilter results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003Cp\u003Esort results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003Cp\u003Epaginate results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003Cp\u003Enumber of entries per request\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/config_templates\n200\n{\n  \"total\": 11,\n  \"subtotal\": 11,\n  \"page\": 1,\n  \"per_page\": 20,\n  \"search\": null,\n  \"sort\": {\n    \"by\": null,\n    \"order\": null\n  },\n  \"results\": [\n    {\n      \"snippet\": false,\n      \"audit_comment\": null,\n      \"created_at\": \"2015-12-01T02:40:01Z\",\n      \"updated_at\": \"2015-12-01T02:40:01Z\",\n      \"id\": 718456980,\n      \"name\": \"Locked Template\",\n      \"template_kind_id\": 983253650,\n      \"template_kind_name\": \"provision\"\n    },\n    {\n      \"snippet\": false,\n      \"audit_comment\": null,\n      \"created_at\": \"2015-12-01T02:40:01Z\",\n      \"updated_at\": \"2015-12-01T02:40:01Z\",\n      \"id\": 104314179,\n      \"name\": \"MyFinish\",\n      \"template_kind_id\": 550103832,\n      \"template_kind_name\": \"finish\"\n    },\n    {\n      \"snippet\": false,\n      \"audit_comment\": null,\n      \"created_at\": \"2015-12-01T02:40:01Z\",\n      \"updated_at\": \"2015-12-01T02:40:01Z\",\n      \"id\": 981457253,\n      \"name\": \"MyScript\",\n      \"template_kind_id\": 478250810,\n      \"template_kind_name\": \"script\"\n    },\n    {\n      \"snippet\": false,\n      \"audit_comment\": null,\n      \"created_at\": \"2015-12-01T02:40:01Z\",\n      \"updated_at\": \"2015-12-01T02:40:01Z\",\n      \"id\": 943779058,\n      \"name\": \"MyString\",\n      \"template_kind_id\": 698706415,\n      \"template_kind_name\": \"iPXE\"\n    },\n    {\n      \"snippet\": false,\n      \"audit_comment\": null,\n      \"created_at\": \"2015-12-01T02:40:01Z\",\n      \"updated_at\": \"2015-12-01T02:40:01Z\",\n      \"id\": 269958254,\n      \"name\": \"MyString2\",\n      \"template_kind_id\": 983253650,\n      \"template_kind_name\": \"provision\"\n    },\n    {\n      \"snippet\": false,\n      \"audit_comment\": null,\n      \"created_at\": \"2015-12-01T02:40:01Z\",\n      \"updated_at\": \"2015-12-01T02:40:01Z\",\n      \"id\": 684651467,\n      \"name\": \"PXE Default Menu\",\n      \"template_kind_id\": 710512633,\n      \"template_kind_name\": null\n    },\n    {\n      \"snippet\": false,\n      \"audit_comment\": null,\n      \"created_at\": \"2015-12-01T02:40:01Z\",\n      \"updated_at\": \"2015-12-01T02:40:01Z\",\n      \"id\": 131565194,\n      \"name\": \"PXEGrub Dummy Menu\",\n      \"template_kind_id\": 131565194,\n      \"template_kind_name\": \"PXEGrub\"\n    },\n    {\n      \"snippet\": false,\n      \"audit_comment\": null,\n      \"created_at\": \"2015-12-01T02:40:01Z\",\n      \"updated_at\": \"2015-12-01T02:40:01Z\",\n      \"id\": 821548108,\n      \"name\": \"PXELinux default local boot\",\n      \"template_kind_id\": 452984334,\n      \"template_kind_name\": \"PXELinux\"\n    },\n    {\n      \"snippet\": false,\n      \"audit_comment\": null,\n      \"created_at\": \"2015-12-01T02:40:01Z\",\n      \"updated_at\": \"2015-12-01T02:40:01Z\",\n      \"id\": 352050261,\n      \"name\": \"PXELinux global default\",\n      \"template_kind_id\": 452984334,\n      \"template_kind_name\": \"PXELinux\"\n    },\n    {\n      \"snippet\": false,\n      \"audit_comment\": null,\n      \"created_at\": \"2015-12-01T02:40:01Z\",\n      \"updated_at\": \"2015-12-01T02:40:01Z\",\n      \"id\": 1007981701,\n      \"name\": \"centos5_3_pxelinux\",\n      \"template_kind_id\": 452984334,\n      \"template_kind_name\": \"PXELinux\"\n    },\n    {\n      \"snippet\": false,\n      \"audit_comment\": null,\n      \"created_at\": \"2015-12-01T02:40:01Z\",\n      \"updated_at\": \"2015-12-01T02:40:01Z\",\n      \"id\": 698706415,\n      \"name\": \"iPXE Dummy Menu\",\n      \"template_kind_id\": 698706415,\n      \"template_kind_name\": \"iPXE\"\n    }\n  ]\n}"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/config_templates/show","name":"show","apis":[{"api_url":"/api/config_templates/:id","http_method":"GET","short_description":"Show provisioning template details","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/config_templates/1007981701-centos5_3_pxelinux\n200\n{\n  \"template\": \"default linux~label linux~kernel \u003C%= @kernel %\u003E~append initrd=\u003C%= @initrd %\u003E ks=\u003C%= foreman_url(\\\"kickstart\\\")%\u003E ksdevice=bootif network kssendmac\",\n  \"locked\": false,\n  \"snippet\": false,\n  \"audit_comment\": null,\n  \"created_at\": \"2015-12-01T02:40:01Z\",\n  \"updated_at\": \"2015-12-01T02:40:01Z\",\n  \"id\": 1007981701,\n  \"name\": \"centos5_3_pxelinux\",\n  \"template_kind_id\": 452984334,\n  \"template_kind_name\": \"PXELinux\",\n  \"template_combinations\": [],\n  \"operatingsystems\": [\n    {\n      \"id\": 1073012828,\n      \"name\": \"Redhat\",\n      \"title\": \"RHEL 6.1\"\n    },\n    {\n      \"id\": 331303656,\n      \"name\": \"Ubuntu\",\n      \"title\": \"Ubuntu 10.10\"\n    },\n    {\n      \"id\": 309172073,\n      \"name\": \"centos\",\n      \"title\": \"centos 5.3\"\n    }\n  ],\n  \"os_default_templates\": [\n    {\n      \"id\": 281110143,\n      \"provisioning_template_id\": 1007981701,\n      \"provisioning_template_name\": \"centos5_3_pxelinux\",\n      \"template_kind_id\": 710512633,\n      \"template_kind_name\": null,\n      \"operatingsystem_id\": 1073012828,\n      \"operatingsystem_name\": \"RHEL 6.1\",\n      \"config_template_id\": 1007981701,\n      \"config_template_name\": \"centos5_3_pxelinux\"\n    },\n    {\n      \"id\": 638205575,\n      \"provisioning_template_id\": 1007981701,\n      \"provisioning_template_name\": \"centos5_3_pxelinux\",\n      \"template_kind_id\": 710512633,\n      \"template_kind_name\": null,\n      \"operatingsystem_id\": 331303656,\n      \"operatingsystem_name\": \"Ubuntu 10.10\",\n      \"config_template_id\": 1007981701,\n      \"config_template_name\": \"centos5_3_pxelinux\"\n    }\n  ],\n  \"locations\": [],\n  \"organizations\": []\n}"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/config_templates/create","name":"create","apis":[{"api_url":"/api/config_templates","http_method":"POST","short_description":"Create a provisioning template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"config_template","full_name":"config_template","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"config_template[name]","description":"\n\u003Cp\u003Etemplate name\u003C/p\u003E\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"template","full_name":"config_template[template]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"snippet","full_name":"config_template[snippet]","description":"","required":false,"allow_nil":true,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true},{"name":"audit_comment","full_name":"config_template[audit_comment]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"template_kind_id","full_name":"config_template[template_kind_id]","description":"\n\u003Cp\u003Enot relevant for snippet\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"template_combinations_attributes","full_name":"config_template[template_combinations_attributes]","description":"\n\u003Cp\u003EArray of template combinations (hostgroup_id, environment_id)\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"operatingsystem_ids","full_name":"config_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,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"locked","full_name":"config_template[locked]","description":"\n\u003Cp\u003EWhether or not the template is locked for editing\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true},{"name":"location_ids","full_name":"config_template[location_ids]","description":"\n\u003Cp\u003EREPLACE locations with given ids\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"organization_ids","full_name":"config_template[organization_ids]","description":"\n\u003Cp\u003EREPLACE organizations with given ids.\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":["POST /api/config_templates\n{\n  \"config_template\": {\n    \"template\": \"This is a test template\",\n    \"template_kind_id\": \"698706415\",\n    \"name\": \"RandomName\"\n  }\n}\n201\n{\n  \"template\": \"This is a test template\",\n  \"locked\": false,\n  \"snippet\": false,\n  \"audit_comment\": null,\n  \"created_at\": \"2015-12-01T02:40:33Z\",\n  \"updated_at\": \"2015-12-01T02:40:33Z\",\n  \"id\": 1007981702,\n  \"name\": \"RandomName\",\n  \"template_kind_id\": 698706415,\n  \"template_kind_name\": \"iPXE\",\n  \"template_combinations\": [],\n  \"operatingsystems\": [],\n  \"os_default_templates\": [],\n  \"locations\": [],\n  \"organizations\": []\n}"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/config_templates/update","name":"update","apis":[{"api_url":"/api/config_templates/:id","http_method":"PUT","short_description":"Update a provisioning template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true},{"name":"config_template","full_name":"config_template","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"config_template[name]","description":"\n\u003Cp\u003Etemplate name\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"template","full_name":"config_template[template]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"snippet","full_name":"config_template[snippet]","description":"","required":false,"allow_nil":true,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true},{"name":"audit_comment","full_name":"config_template[audit_comment]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"template_kind_id","full_name":"config_template[template_kind_id]","description":"\n\u003Cp\u003Enot relevant for snippet\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"template_combinations_attributes","full_name":"config_template[template_combinations_attributes]","description":"\n\u003Cp\u003EArray of template combinations (hostgroup_id, environment_id)\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"operatingsystem_ids","full_name":"config_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,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"locked","full_name":"config_template[locked]","description":"\n\u003Cp\u003EWhether or not the template is locked for editing\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true},{"name":"location_ids","full_name":"config_template[location_ids]","description":"\n\u003Cp\u003EREPLACE locations with given ids\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"organization_ids","full_name":"config_template[organization_ids]","description":"\n\u003Cp\u003EREPLACE organizations with given ids.\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":["PUT /api/config_templates/1007981701-centos5_3_pxelinux\n{\n  \"config_template\": {\n    \"template\": \"blah\"\n  }\n}\n200\n{\n  \"template\": \"blah\",\n  \"locked\": false,\n  \"snippet\": false,\n  \"audit_comment\": null,\n  \"created_at\": \"2015-12-01T02:40:01Z\",\n  \"updated_at\": \"2015-12-01T02:40:33Z\",\n  \"id\": 1007981701,\n  \"name\": \"centos5_3_pxelinux\",\n  \"template_kind_id\": 452984334,\n  \"template_kind_name\": \"PXELinux\",\n  \"template_combinations\": [],\n  \"operatingsystems\": [\n    {\n      \"id\": 1073012828,\n      \"name\": \"Redhat\",\n      \"title\": \"RHEL 6.1\"\n    },\n    {\n      \"id\": 331303656,\n      \"name\": \"Ubuntu\",\n      \"title\": \"Ubuntu 10.10\"\n    },\n    {\n      \"id\": 309172073,\n      \"name\": \"centos\",\n      \"title\": \"centos 5.3\"\n    }\n  ],\n  \"os_default_templates\": [\n    {\n      \"id\": 281110143,\n      \"provisioning_template_id\": 1007981701,\n      \"provisioning_template_name\": \"centos5_3_pxelinux\",\n      \"template_kind_id\": 710512633,\n      \"template_kind_name\": null,\n      \"operatingsystem_id\": 1073012828,\n      \"operatingsystem_name\": \"RHEL 6.1\",\n      \"config_template_id\": 1007981701,\n      \"config_template_name\": \"centos5_3_pxelinux\"\n    },\n    {\n      \"id\": 638205575,\n      \"provisioning_template_id\": 1007981701,\n      \"provisioning_template_name\": \"centos5_3_pxelinux\",\n      \"template_kind_id\": 710512633,\n      \"template_kind_name\": null,\n      \"operatingsystem_id\": 331303656,\n      \"operatingsystem_name\": \"Ubuntu 10.10\",\n      \"config_template_id\": 1007981701,\n      \"config_template_name\": \"centos5_3_pxelinux\"\n    }\n  ],\n  \"locations\": [],\n  \"organizations\": []\n}"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/config_templates/revision","name":"revision","apis":[{"api_url":"/api/config_templates/revision","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"version","full_name":"version","description":"\n\u003Cp\u003Etemplate version\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/config_templates/destroy","name":"destroy","apis":[{"api_url":"/api/config_templates/:id","http_method":"DELETE","short_description":"Delete a provisioning template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true}],"examples":["DELETE /api/config_templates/1007981701-centos5_3_pxelinux\n422\n{\n  \"error\": {\n    \"id\": 1007981701,\n    \"errors\": {\n      \"base\": [\n        \"centos5_3_pxelinux is used by Redhat 6.1 - \",\n        \"centos5_3_pxelinux is used by Ubuntu 10.10 - \"\n      ]\n    },\n    \"full_messages\": [\n      \"centos5_3_pxelinux is used by Redhat 6.1 - \",\n      \"centos5_3_pxelinux is used by Ubuntu 10.10 - \"\n    ]\n  }\n}"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/config_templates/build_pxe_default","name":"build_pxe_default","apis":[{"api_url":"/api/config_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":[],"examples":["POST /api/config_templates/build_pxe_default\n{\n  \"config_template\": {}\n}\n200\n{\n  \"message\": \"PXE Default file has been deployed to all Smart Proxies\"\n}"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/config_templates/clone","name":"clone","apis":[{"api_url":"/api/config_templates/:id/clone","http_method":"POST","short_description":"Clone a provision template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true},{"name":"config_template","full_name":"config_template","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"config_template[name]","description":"\n\u003Cp\u003Etemplate name\u003C/p\u003E\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}]}],"examples":["POST /api/config_templates/1007981701-centos5_3_pxelinux/clone\n{\n  \"config_template\": {\n    \"name\": \"MyClone\"\n  }\n}\n201\n{\n  \"created_at\": \"2015-12-01T02:40:34Z\",\n  \"default\": false,\n  \"id\": 1007981702,\n  \"locked\": false,\n  \"name\": \"MyClone\",\n  \"os_family\": null,\n  \"snippet\": false,\n  \"template\": \"default linux~label linux~kernel \u003C%= @kernel %\u003E~append initrd=\u003C%= @initrd %\u003E ks=\u003C%= foreman_url(\\\"kickstart\\\")%\u003E ksdevice=bootif network kssendmac\",\n  \"template_kind_id\": 452984334,\n  \"updated_at\": \"2015-12-01T02:40:34Z\",\n  \"vendor\": null\n}"],"metadata":null,"see":[]}]},"reports":{"doc_url":"../apidoc/v2/reports","api_url":"/api","name":"Reports","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/reports/index","name":"index","apis":[{"api_url":"/api/reports","http_method":"GET","short_description":"List all reports","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"\n\u003Cp\u003Efilter results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003Cp\u003Esort results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003Cp\u003Epaginate results\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003Cp\u003Enumber of entries per request\u003C/p\u003E\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/reports\n200\n{\n  \"total\": 1,\n  \"subtotal\": 1,\n  \"page\": 1,\n  \"per_page\": 20,\n  \"search\": \"\",\n  \"sort\": {\n    \"by\": null,\n    \"order\": null\n  },\n  \"results\": [\n    {\n      \"metrics\": {\n        \"time\": {\n          \"schedule\": 0.00083,\n          \"service\": 0.149739,\n          \"mailalias\": 0.000283,\n          \"cron\": 0.000419,\n          \"config_retrieval\": 16.3637869358063,\n          \"package\": 0.003989,\n          \"filebucket\": 0.000171,\n          \"file\": 0.007025,\n          \"exec\": 0.000299\n        },\n        \"resources\": {\n          \"total\": 33\n        },\n        \"changes\": {},\n        \"events\": {\n          \"total\": 0\n        }\n      },\n      \"created_at\": \"2015-12-01T02:40:02Z\",\n      \"updated_at\": \"2015-12-01T02:40:02Z\",\n      \"id\": 70219655,\n      \"host_id\": 980190962,\n      \"host_name\": null,\n      \"reported_at\": \"2015-11-24T02:40:01Z\",\n      \"status\": {\n        \"applied\": 0,\n        \"restarted\": 0,\n        \"failed\": 0,\n        \"failed_restarts\": 0,\n        \"skipped\": 0,\n        \"pending\": 0\n      }\n    }\n  ]\n}"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/reports/show","name":"show","apis":[{"api_url":"/api/reports/:id","http_method":"GET","short_description":"Show a report","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/reports/70219655\n200\n{\n  \"metrics\": {\n    \"time\": {\n      \"schedule\": 0.00083,\n      \"service\": 0.149739,\n      \"mailalias\": 0.000283,\n      \"cron\": 0.000419,\n      \"config_retrieval\": 16.3637869358063,\n      \"package\": 0.003989,\n      \"filebucket\": 0.000171,\n      \"file\": 0.007025,\n      \"exec\": 0.000299\n    },\n    \"resources\": {\n      \"total\": 33\n    },\n    \"changes\": {},\n    \"events\": {\n      \"total\": 0\n    }\n  },\n  \"created_at\": \"2015-12-01T02:40:02Z\",\n  \"updated_at\": \"2015-12-01T02:40:02Z\",\n  \"id\": 70219655,\n  \"host_id\": 980190962,\n  \"host_name\": null,\n  \"reported_at\": \"2015-11-24T02:40:01Z\",\n  \"status\": {\n    \"applied\": 0,\n    \"restarted\": 0,\n    \"failed\": 0,\n    \"failed_restarts\": 0,\n    \"skipped\": 0,\n    \"pending\": 0\n  },\n  \"logs\": [],\n  \"summary\": \"Success\"\n}"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/reports/create","name":"create","apis":[{"api_url":"/api/reports","http_method":"POST","short_description":"Create a report","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"report","full_name":"report","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"host","full_name":"report[host]","description":"\n\u003Cp\u003EHostname or certname\u003C/p\u003E\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"reported_at","full_name":"report[reported_at]","description":"\n\u003Cp\u003EUTC time of report\u003C/p\u003E\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"status","full_name":"report[status]","description":"\n\u003Cp\u003EHash of status type totals\u003C/p\u003E\n","required":true,"allow_nil":false,"validator":"Must be Hash","expected_type":"hash","metadata":null,"show":true},{"name":"metrics","full_name":"report[metrics]","description":"\n\u003Cp\u003EHash of report metrics, can be just {}\u003C/p\u003E\n","required":true,"allow_nil":false,"validator":"Must be Hash","expected_type":"hash","metadata":null,"show":true},{"name":"logs","full_name":"report[logs]","description":"\n\u003Cp\u003EOptional array of log hashes\u003C/p\u003E\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":["POST /api/reports\n{\n  \"report\": {\n    \"host\": \"rhel6n01.corp.com\",\n    \"reported_at\": \"2010-11-19 02:39:04 UTC\",\n    \"metrics\": {},\n    \"status\": {\n      \"applied\": \"0\",\n      \"failed\": \"0\",\n      \"failed_restarts\": \"0\",\n      \"pending\": \"0\",\n      \"restarted\": \"0\",\n      \"skipped\": \"0\"\n    },\n    \"logs\": [\n      {\n        \"log\": {\n          \"sources\": {\n            \"source\": \"Puppet\"\n          },\n          \"messages\": {\n            \"message\": \"Could not retrieve catalog from remote server: Error 400 on SERVER: Could not find node 'rhel6n01.corp.com'; cannot compile\"\n          },\n          \"level\": \"err\"\n        }\n      },\n      {\n        \"log\": {\n          \"sources\": {\n            \"source\": \"Puppet\"\n          },\n          \"messages\": {\n            \"message\": \"Using cached catalog\"\n          },\n          \"level\": \"notice\"\n        }\n      },\n      {\n        \"log\": {\n          \"sources\": {\n            \"source\": \"Puppet\"\n          },\n          \"messages\": {\n            \"message\": \"Could not retrieve catalog; skipping run\"\n          },\n          \"level\": \"err\"\n        }\n      }\n    ]\n  }\n}\n500\n{\n  \"error\": {\n    \"message\": \"SQLite3::SQLException: table reports has no column named type: INSERT INTO \\\"reports\\\" (\\\"created_at\\\", \\\"host_id\\\", \\\"metrics\\\", \\\"reported_at\\\", \\\"status\\\", \\\"type\\\", \\\"updated_at\\\") VALUES (?, ?, ?, ?, ?, ?, ?)\"\n  }\n}"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/reports/destroy","name":"destroy","apis":[{"api_url":"/api/reports/:id","http_method":"DELETE","short_description":"Delete a report","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["DELETE /api/reports/70219655\n200\n{\n  \"created_at\": \"2015-12-01T02:40:02Z\",\n  \"host_id\": 980190962,\n  \"id\": 70219655,\n  \"metrics\": {\n    \"time\": {\n      \"schedule\": 0.00083,\n      \"service\": 0.149739,\n      \"mailalias\": 0.000283,\n      \"cron\": 0.000419,\n      \"config_retrieval\": 16.3637869358063,\n      \"package\": 0.003989,\n      \"filebucket\": 0.000171,\n      \"file\": 0.007025,\n      \"exec\": 0.000299\n    },\n    \"resources\": {\n      \"total\": 33\n    },\n    \"changes\": {},\n    \"events\": {\n      \"total\": 0\n    }\n  },\n  \"reported_at\": \"2015-11-24T02:40:01Z\",\n  \"status\": {\n    \"applied\": 0,\n    \"restarted\": 0,\n    \"failed\": 0,\n    \"failed_restarts\": 0,\n    \"skipped\": 0,\n    \"pending\": 0\n  },\n  \"updated_at\": \"2015-12-01T02:40:02Z\"\n}"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/reports/last","name":"last","apis":[{"api_url":"/api/hosts/:host_id/reports/last","http_method":"GET","short_description":"Show the last report for a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/hosts/host159/reports/last\n404\n{\n  \"error\": {\n    \"message\": \"Resource report not found by id ''\"\n  }\n}"],"metadata":null,"see":[]}]}},"link_extension":".en.html"}}

data/test/unit/data/README.md

@@ -0,0 +1,22 @@
+# Data for tests
+
+## How to include API tests for new Foreman release
+
+ 1. on the **foreman instance** run the tests with recording of examples turned on
+
+    ```bash
+    $ APIPIE_RECORD=examples rake test:functionals
+    ```
+ 1. on the **Foreman instance** generate API documentation cache. It will land in `/usr/share/foreman/public/apipie-cache/apidoc.json`
+
+    ```bash
+    $ FOREMAN_APIPIE_LANGS=en foreman-rake apipie:cache
+    ```
+ 1. in **hammer-cli-foreman** in `test/unit/data/` Create directory with name matching the Foreman version in `test/unit/data/` (e.g. `test/unit/data/1.10`)
+ 1. copy the API cache from the Foreman instance into the newly created directory and name it as `foreman_api.json`
+ 1. update the following line in `test/unit/test_helper.rb` to match the new default Foreman version
+
+    ```ruby
+    FOREMAN_VERSION = Gem::Version.new(ENV['TEST_API_VERSION'] || '1.10')
+    ```
+ 1. make sure the tests are green

data/test/unit/data/test_api.json

@@ -0,0 +1,609 @@
+{
+  "docs": {
+    "name": "Dummy",
+    "info": "Another API description",
+    "copyright": null,
+    "doc_url": "./apipie/1.0",
+    "api_url": "/",
+    "resources": {
+      "posts": {
+        "doc_url": "./apipie/1.0/posts",
+        "api_url": "/",
+        "name": "Posts",
+        "short_description": null,
+        "full_description": null,
+        "version": "1.0",
+        "formats": null,
+        "metadata": null,
+        "methods": [
+          {
+            "doc_url": "./apipie/1.0/posts/index",
+            "name": "index",
+            "apis": [
+              {
+                "api_url": "/users/:user_id/posts",
+                "http_method": "GET",
+                "short_description": null,
+                "deprecated": null
+              }
+            ],
+            "formats": null,
+            "full_description": "",
+            "errors": [],
+            "params": [
+              {
+                "name": "user_id",
+                "full_name": "user_id",
+                "description": "\n<p>ID of user</p>\n",
+                "required": true,
+                "allow_nil": false,
+                "validator": "Must be String",
+                "expected_type": "string",
+                "metadata": null,
+                "show": true
+              }
+            ],
+            "examples": [
+              "GET /users/1/posts\n200\n[ {\"post\": {\"id\": 1, \"title\": \"Hello World\", \"body\": \"This is the body of the post\"}}]\n"
+            ],
+            "metadata": null,
+            "see": []
+          },
+          {
+            "doc_url": "./apipie/1.0/posts/show",
+            "name": "show",
+            "apis": [
+              {
+                "api_url": "/users/:user_id/posts/:id",
+                "http_method": "GET",
+                "short_description": null,
+                "deprecated": null
+              }
+            ],
+            "formats": null,
+            "full_description": "",
+            "errors": [],
+            "params": [
+              {
+                "name": "user_id",
+                "full_name": "user_id",
+                "description": "\n<p>ID of user</p>\n",
+                "required": true,
+                "allow_nil": false,
+                "validator": "Must be String",
+                "expected_type": "string",
+                "metadata": null,
+                "show": true
+              },
+              {
+                "name": "id",
+                "full_name": "id",
+                "description": "DESC",
+                "required": true,
+                "allow_nil": false,
+                "validator": "Must be String",
+                "expected_type": "string",
+                "metadata": null,
+                "show": true
+              }
+            ],
+            "examples": [],
+            "metadata": null,
+            "see": []
+          },
+          {
+            "doc_url": "./apipie/1.0/posts/create",
+            "name": "create",
+            "apis": [
+              {
+                "api_url": "/users/:user_id/posts",
+                "http_method": "POST",
+                "short_description": null,
+                "deprecated": null
+              }
+            ],
+            "formats": null,
+            "full_description": "",
+            "errors": [],
+            "params": [],
+            "examples": [],
+            "metadata": null,
+            "see": []
+          },
+          {
+            "doc_url": "./apipie/1.0/posts/update",
+            "name": "update",
+            "apis": [
+              {
+                "api_url": "/users/:user_id/posts/:id",
+                "http_method": "PATCH",
+                "short_description": null,
+                "deprecated": null
+              },
+              {
+                "api_url": "/users/:user_id/posts/:id",
+                "http_method": "PUT",
+                "short_description": null,
+                "deprecated": null
+              }
+            ],
+            "formats": null,
+            "full_description": "",
+            "errors": [],
+            "params": [],
+            "examples": [],
+            "metadata": null,
+            "see": []
+          },
+          {
+            "doc_url": "./apipie/1.0/posts/destroy",
+            "name": "destroy",
+            "apis": [
+              {
+                "api_url": "/users/:user_id/posts/:id",
+                "http_method": "DELETE",
+                "short_description": null,
+                "deprecated": null
+              }
+            ],
+            "formats": null,
+            "full_description": "",
+            "errors": [],
+            "params": [],
+            "examples": [],
+            "metadata": null,
+            "see": []
+          }
+        ]
+      },
+      "users": {
+        "doc_url": "./apipie/1.0/users",
+        "api_url": "/",
+        "name": "Users",
+        "short_description": null,
+        "full_description": null,
+        "version": "1.0",
+        "formats": null,
+        "metadata": null,
+        "methods": [
+          {
+            "doc_url": "./apipie/1.0/users/index",
+            "name": "index",
+            "apis": [
+              {
+                "api_url": "/users",
+                "http_method": "GET",
+                "short_description": null,
+                "deprecated": null
+              }
+            ],
+            "formats": null,
+            "full_description": "",
+            "errors": [],
+            "params": [],
+            "examples": [
+              "GET /users\n200\n[ {\"user\":{\"name\":\"John Doe\" }} ]\n"
+            ],
+            "metadata": null,
+            "see": []
+          },
+          {
+            "doc_url": "./apipie/1.0/users/show",
+            "name": "show",
+            "apis": [
+              {
+                "api_url": "/users/:id",
+                "http_method": "GET",
+                "short_description": null,
+                "deprecated": null
+              }
+            ],
+            "formats": null,
+            "full_description": "",
+            "errors": [],
+            "params": [
+              {
+                "name": "id",
+                "full_name": "id",
+                "description": "DESC",
+                "required": true,
+                "allow_nil": false,
+                "validator": "Must be String",
+                "expected_type": "string",
+                "metadata": null,
+                "show": true
+              }
+            ],
+            "examples": [],
+            "metadata": null,
+            "see": []
+          },
+          {
+            "doc_url": "./apipie/1.0/users/create",
+            "name": "create",
+            "apis": [
+              {
+                "api_url": "/users",
+                "http_method": "POST",
+                "short_description": null,
+                "deprecated": null
+              }
+            ],
+            "formats": null,
+            "full_description": "",
+            "errors": [],
+            "params": [
+              {
+                "name": "user",
+                "full_name": "user",
+                "description": "",
+                "required": false,
+                "allow_nil": false,
+                "validator": "Must be a Hash",
+                "expected_type": "hash",
+                "metadata": null,
+                "show": true,
+                "params": [
+                  {
+                    "name": "name",
+                    "full_name": "user[name]",
+                    "description": "",
+                    "required": true,
+                    "allow_nil": false,
+                    "validator": "Must be String",
+                    "expected_type": "string",
+                    "metadata": null,
+                    "show": true
+                  },
+                  {
+                    "name": "vip",
+                    "full_name": "user[vip]",
+                    "description": "",
+                    "required": false,
+                    "allow_nil": false,
+                    "validator": "Must be 'true' or 'false'",
+                    "expected_type": "boolean",
+                    "metadata": null,
+                    "show": true
+                  },
+                  {
+                    "name": "address",
+                    "full_name": "user[address]",
+                    "description": "",
+                    "required": false,
+                    "allow_nil": false,
+                    "validator": "Must be a Hash",
+                    "expected_type": "hash",
+                    "metadata": null,
+                    "show": true,
+                    "params": [
+                      {
+                        "name": "city",
+                        "full_name": "user[address][city]",
+                        "description": "",
+                        "required": true,
+                        "allow_nil": false,
+                        "validator": "Must be String",
+                        "expected_type": "string",
+                        "metadata": null,
+                        "show": true
+                      },
+                      {
+                        "name": "street",
+                        "full_name": "user[address][street]",
+                        "description": "",
+                        "required": false,
+                        "allow_nil": false,
+                        "validator": "Must be String",
+                        "expected_type": "string",
+                        "metadata": null,
+                        "show": true
+                      }
+                    ]
+                  },
+                  {
+                    "name": "contacts",
+                    "full_name": "user[contacts]",
+                    "description": "",
+                    "required": false,
+                    "allow_nil": false,
+                    "validator": "Must be an Array of nested elements",
+                    "expected_type": "array",
+                    "metadata": null,
+                    "show": true,
+                    "params": [
+                      {
+                        "name": "contact",
+                        "full_name": "user[contacts][contact]",
+                        "description": "",
+                        "required": true,
+                        "allow_nil": false,
+                        "validator": "Must be String",
+                        "expected_type": "string",
+                        "metadata": null,
+                        "show": true
+                      },
+                      {
+                        "name": "kind",
+                        "full_name": "user[contacts][kind]",
+                        "description": "",
+                        "required": false,
+                        "allow_nil": false,
+                        "validator": "Must be String",
+                        "expected_type": "string",
+                        "metadata": null,
+                        "show": true
+                      }
+                    ]
+                  }
+                ]
+              }
+            ],
+            "examples": [],
+            "metadata": null,
+            "see": []
+          },
+          {
+            "doc_url": "./apipie/1.0/users/update",
+            "name": "update",
+            "apis": [
+              {
+                "api_url": "/users/:id",
+                "http_method": "PATCH",
+                "short_description": null,
+                "deprecated": null
+              },
+              {
+                "api_url": "/users/:id",
+                "http_method": "PUT",
+                "short_description": null,
+                "deprecated": null
+              }
+            ],
+            "formats": null,
+            "full_description": "",
+            "errors": [],
+            "params": [],
+            "examples": [],
+            "metadata": null,
+            "see": []
+          },
+          {
+            "doc_url": "./apipie/1.0/users/destroy",
+            "name": "destroy",
+            "apis": [
+              {
+                "api_url": "/users/:id",
+                "http_method": "DELETE",
+                "short_description": null,
+                "deprecated": null
+              }
+            ],
+            "formats": null,
+            "full_description": "",
+            "errors": [],
+            "params": [],
+            "examples": [],
+            "metadata": null,
+            "see": []
+          },
+          {
+            "doc_url": "./apipie/1.0/users/create_unnested",
+            "name": "create_unnested",
+            "apis": [
+              {
+                "api_url": "/users/create_unnested",
+                "http_method": "POST",
+                "short_description": null,
+                "deprecated": null
+              }
+            ],
+            "formats": null,
+            "full_description": "",
+            "errors": [],
+            "params": [
+              {
+                "name": "name",
+                "full_name": "name",
+                "description": "",
+                "required": true,
+                "allow_nil": false,
+                "validator": "Must be String",
+                "expected_type": "string",
+                "metadata": null,
+                "show": true
+              }
+            ],
+            "examples": [],
+            "metadata": null,
+            "see": []
+          }
+        ]
+      },
+      "comments": {
+        "doc_url": "./apipie/1.0/comments",
+        "api_url": "/",
+        "name": "Comments",
+        "short_description": null,
+        "full_description": null,
+        "version": "1.0",
+        "formats": null,
+        "metadata": null,
+        "methods": [
+          {
+            "doc_url": "./apipie/1.0/comments/index",
+            "name": "index",
+            "apis": [
+              {
+                "api_url": "/users/:user_id/posts/:post_id/comments",
+                "http_method": "GET",
+                "short_description": null,
+                "deprecated": null
+              }
+            ],
+            "formats": null,
+            "full_description": "",
+            "errors": [],
+            "params": [
+              {
+                "name": "user_id",
+                "full_name": "user_id",
+                "description": "\n<p>ID of user</p>\n",
+                "required": true,
+                "allow_nil": false,
+                "validator": "Must be String",
+                "expected_type": "string",
+                "metadata": null,
+                "show": true
+              },
+              {
+                "name": "post_id",
+                "full_name": "post_id",
+                "description": "\n<p>ID of post</p>\n",
+                "required": true,
+                "allow_nil": false,
+                "validator": "Must be String",
+                "expected_type": "string",
+                "metadata": null,
+                "show": true
+              }
+            ],
+            "examples": [],
+            "metadata": null,
+            "see": []
+          },
+          {
+            "doc_url": "./apipie/1.0/comments/show",
+            "name": "show",
+            "apis": [
+              {
+                "api_url": "/users/:user_id/posts/:post_id/comments/:id",
+                "http_method": "GET",
+                "short_description": null,
+                "deprecated": null
+              }
+            ],
+            "formats": null,
+            "full_description": "",
+            "errors": [],
+            "params": [],
+            "examples": [],
+            "metadata": null,
+            "see": []
+          },
+          {
+            "doc_url": "./apipie/1.0/comments/create",
+            "name": "create",
+            "apis": [
+              {
+                "api_url": "/users/:user_id/posts/:post_id/comments",
+                "http_method": "POST",
+                "short_description": null,
+                "deprecated": null
+              }
+            ],
+            "formats": null,
+            "full_description": "",
+            "errors": [],
+            "params": [
+              {
+                "name": "user_id",
+                "full_name": "user_id",
+                "description": "\n<p>ID of user</p>\n",
+                "required": true,
+                "allow_nil": false,
+                "validator": "Must be String",
+                "expected_type": "string",
+                "metadata": null,
+                "show": true
+              },
+              {
+                "name": "post_id",
+                "full_name": "post_id",
+                "description": "\n<p>ID of post</p>\n",
+                "required": true,
+                "allow_nil": false,
+                "validator": "Must be String",
+                "expected_type": "string",
+                "metadata": null,
+                "show": true
+              },
+              {
+                "name": "comment",
+                "full_name": "comment",
+                "description": "\n<p>Comment</p>\n",
+                "required": true,
+                "allow_nil": false,
+                "validator": "Must be Hash",
+                "expected_type": "hash",
+                "metadata": null,
+                "show": true,
+                "params": [
+                  {
+                    "name": "user_id",
+                    "full_name": "comment[user_id]",
+                    "description": "\n<p>ID of commenter</p>\n",
+                    "required": true,
+                    "allow_nil": false,
+                    "validator": "Must be String",
+                    "expected_type": "string",
+                    "metadata": null,
+                    "show": true
+                  }
+                ]
+              }
+            ],
+            "examples": [],
+            "metadata": null,
+            "see": []
+          },
+          {
+            "doc_url": "./apipie/1.0/comments/update",
+            "name": "update",
+            "apis": [
+              {
+                "api_url": "/users/:user_id/posts/:post_id/comments/:id",
+                "http_method": "PATCH",
+                "short_description": null,
+                "deprecated": null
+              },
+              {
+                "api_url": "/users/:user_id/posts/:post_id/comments/:id",
+                "http_method": "PUT",
+                "short_description": null,
+                "deprecated": null
+              }
+            ],
+            "formats": null,
+            "full_description": "",
+            "errors": [],
+            "params": [],
+            "examples": [],
+            "metadata": null,
+            "see": []
+          },
+          {
+            "doc_url": "./apipie/1.0/comments/destroy",
+            "name": "destroy",
+            "apis": [
+              {
+                "api_url": "/users/:user_id/posts/:post_id/comments/:id",
+                "http_method": "DELETE",
+                "short_description": null,
+                "deprecated": null
+              }
+            ],
+            "formats": null,
+            "full_description": "",
+            "errors": [],
+            "params": [],
+            "examples": [],
+            "metadata": null,
+            "see": []
+          }
+        ]
+      }
+    },
+    "link_extension": ".html"
+  }
+}