foreman_api 0.1.4 → 0.1.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (64) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +1 -0
  3. data/doc/ForemanApi.html +5 -5
  4. data/doc/ForemanApi/Resources.html +5 -5
  5. data/doc/ForemanApi/Resources/Architecture.html +13 -13
  6. data/doc/ForemanApi/Resources/Audit.html +8 -8
  7. data/doc/ForemanApi/Resources/AuthSourceLdap.html +11 -11
  8. data/doc/ForemanApi/Resources/Bookmark.html +11 -11
  9. data/doc/ForemanApi/Resources/CommonParameter.html +11 -11
  10. data/doc/ForemanApi/Resources/ComputeResource.html +11 -11
  11. data/doc/ForemanApi/Resources/ConfigTemplate.html +17 -17
  12. data/doc/ForemanApi/Resources/Dashboard.html +7 -7
  13. data/doc/ForemanApi/Resources/Domain.html +13 -13
  14. data/doc/ForemanApi/Resources/Environment.html +11 -11
  15. data/doc/ForemanApi/Resources/FactValue.html +7 -7
  16. data/doc/ForemanApi/Resources/Home.html +8 -8
  17. data/doc/ForemanApi/Resources/Host.html +15 -15
  18. data/doc/ForemanApi/Resources/HostClass.html +9 -9
  19. data/doc/ForemanApi/Resources/Hostgroup.html +26 -22
  20. data/doc/ForemanApi/Resources/HostgroupClass.html +9 -9
  21. data/doc/ForemanApi/Resources/Image.html +11 -11
  22. data/doc/ForemanApi/Resources/Location.html +98 -35
  23. data/doc/ForemanApi/Resources/LookupKey.html +817 -81
  24. data/doc/ForemanApi/Resources/Medium.html +17 -19
  25. data/doc/ForemanApi/Resources/Model.html +11 -11
  26. data/doc/ForemanApi/Resources/OperatingSystem.html +12 -12
  27. data/doc/ForemanApi/Resources/Organization.html +96 -33
  28. data/doc/ForemanApi/Resources/Parameter.html +28 -41
  29. data/doc/ForemanApi/Resources/Ptable.html +11 -11
  30. data/doc/ForemanApi/Resources/Puppetclass.html +11 -11
  31. data/doc/ForemanApi/Resources/Report.html +10 -10
  32. data/doc/ForemanApi/Resources/Role.html +11 -11
  33. data/doc/ForemanApi/Resources/Setting.html +9 -9
  34. data/doc/ForemanApi/Resources/SmartProxy.html +11 -11
  35. data/doc/ForemanApi/Resources/Subnet.html +13 -13
  36. data/doc/ForemanApi/Resources/TemplateCombination.html +10 -10
  37. data/doc/ForemanApi/Resources/TemplateKind.html +7 -7
  38. data/doc/ForemanApi/Resources/User.html +11 -11
  39. data/doc/ForemanApi/Resources/Usergroup.html +11 -11
  40. data/doc/_index.html +6 -6
  41. data/doc/class_list.html +2 -1
  42. data/doc/css/style.css +10 -0
  43. data/doc/file.MIT-LICENSE.html +8 -8
  44. data/doc/file.README.html +36 -36
  45. data/doc/file_list.html +3 -2
  46. data/doc/frames.html +1 -1
  47. data/doc/index.html +36 -36
  48. data/doc/js/full_list.js +7 -2
  49. data/doc/method_list.html +367 -722
  50. data/doc/top-level-namespace.html +5 -5
  51. data/lib/foreman_api/documentation.json +1 -1
  52. data/lib/foreman_api/resources/architecture.rb +2 -2
  53. data/lib/foreman_api/resources/config_template.rb +4 -4
  54. data/lib/foreman_api/resources/domain.rb +2 -2
  55. data/lib/foreman_api/resources/host.rb +2 -2
  56. data/lib/foreman_api/resources/hostgroup.rb +2 -0
  57. data/lib/foreman_api/resources/location.rb +8 -4
  58. data/lib/foreman_api/resources/lookup_key.rb +61 -3
  59. data/lib/foreman_api/resources/medium.rb +2 -2
  60. data/lib/foreman_api/resources/organization.rb +6 -2
  61. data/lib/foreman_api/resources/parameter.rb +4 -5
  62. data/lib/foreman_api/resources/subnet.rb +2 -2
  63. data/lib/foreman_api/version.rb +1 -1
  64. metadata +13 -21
data/doc/top-level-namespace.html CHANGED
@@ -6,13 +6,13 @@
6
6
  <title>
7
7
  Top Level Namespace
8
8
 
9
- &mdash; Documentation by YARD 0.8.3
9
+ &mdash; Documentation by YARD 0.8.7
10
10
 
11
11
  </title>
12
12
 
13
- <link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
13
+ <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
14
14
 
15
- <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
15
+ <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
16
16
 
17
17
  <script type="text/javascript" charset="utf-8">
18
18
  hasFrames = window.top.frames.main ? true : false;
@@ -103,9 +103,9 @@
103
103
  </div>
104
104
 
105
105
  <div id="footer">
106
- Generated on Thu Jun 20 12:05:19 2013 by
106
+ Generated on Tue Jul 30 15:43:14 2013 by
107
107
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
108
- 0.8.3 (ruby-1.9.3).
108
+ 0.8.7 (ruby-2.0.0).
109
109
  </div>
110
110
 
111
111
  </body>
data/lib/foreman_api/documentation.json CHANGED
@@ -1 +1 @@
1
- {"docs":{"name":"Foreman","info":"Another API description","copyright":"","doc_url":"/apidoc/v2","api_url":"/api","resources":{"roles":{"doc_url":"/apidoc/v2/roles","api_url":"/api","name":"Roles","short_description":null,"full_description":null,"version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/roles/index","name":"index","apis":[{"api_url":"/api/roles","http_method":"GET","short_description":"List all roles."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"page","full_name":"page","description":"<p>paginate results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"per_page","full_name":"per_page","description":"<p>number of entries per request</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/roles/show","name":"show","apis":[{"api_url":"/api/roles/:id","http_method":"GET","short_description":"Show an role."}],"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"}],"examples":["GET /api/roles/1\n200\n{\n \"role\": {\n \"name\": \"Manager\",\n \"id\": 1,\n \"builtin\": 0,\n \"permissions\": [\n \"view_architectures\",\n \"create_architectures\",\n \"edit_architectures\",\n \"destroy_architectures\",\n \"view_authenticators\",\n \"create_authenticators\",\n \"edit_authenticators\",\n \"destroy_authenticators\",\n \"view_environments\",\n \"create_environments\",\n \"edit_environments\",\n \"destroy_environments\",\n \"import_environments\",\n \"view_external_variables\",\n \"create_external_variables\",\n \"edit_external_variables\",\n \"destroy_external_variables\",\n \"view_domains\",\n \"create_domain\",\n \"edit_domains\",\n \"destroy_domains\",\n \"view_globals\",\n \"create_globals\",\n \"edit_globals\",\n \"destroy_globals\",\n \"view_hostgroups\",\n \"create_hostgroups\",\n \"edit_hostgroups\",\n \"destroy_hostgroups\",\n \"view_hosts\",\n \"create_hosts\",\n \"edit_hosts\",\n \"destroy_hosts\",\n \"view_media\",\n \"create_media\",\n \"edit_media\",\n \"destroy_media\",\n \"view_models\",\n \"create_models\",\n \"edit_models\",\n \"destroy_models\",\n \"view_operatingsystems\",\n \"create_operatingsystems\",\n \"edit_operatingsystems\",\n \"destroy_operatingsystems\",\n \"view_ptables\",\n \"create_ptables\",\n \"edit_ptables\",\n \"destroy_ptables\",\n \"view_puppetclasses\",\n \"create_puppetclasses\",\n \"edit_puppetclasses\",\n \"destroy_puppetclasses\",\n \"import_puppetclasses\",\n \"view_usergroups\",\n \"create_usergroups\",\n \"edit_usergroups\",\n \"destroy_usergroups\",\n \"view_users\",\n \"create_users\",\n \"edit_users\",\n \"destroy_users\",\n \"access_settings\",\n \"access_dashboard\",\n \"view_reports\",\n \"destroy_reports\",\n \"view_facts\",\n \"view_audit_logs\",\n \"view_statistics\",\n \"view_locations\",\n \"edit_locations\",\n \"create_locations\",\n \"destroy_locations\",\n \"view_organizations\",\n \"edit_organizations\",\n \"create_organizations\",\n \"destroy_organizations\"\n ]\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/roles/create","name":"create","apis":[{"api_url":"/api/roles","http_method":"POST","short_description":"Create an role."}],"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","params":[{"name":"name","full_name":"role[name]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"}]}],"examples":["POST /api/roles\n{\n \"role\": {\n \"name\": \"staff\"\n }\n}\n200\n{\n \"role\": {\n \"name\": \"staff\",\n \"id\": 11,\n \"builtin\": 0,\n \"permissions\": []\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/roles/update","name":"update","apis":[{"api_url":"/api/roles/:id","http_method":"PUT","short_description":"Update an role."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"role","full_name":"role","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"name","full_name":"role[name]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}]}],"examples":["PUT /api/roles/1\n{\n \"role\": {}\n}\n200\n{\n \"role\": {\n \"name\": \"Manager\",\n \"id\": 1,\n \"builtin\": 0,\n \"permissions\": [\n \"view_architectures\",\n \"create_architectures\",\n \"edit_architectures\",\n \"destroy_architectures\",\n \"view_authenticators\",\n \"create_authenticators\",\n \"edit_authenticators\",\n \"destroy_authenticators\",\n \"view_environments\",\n \"create_environments\",\n \"edit_environments\",\n \"destroy_environments\",\n \"import_environments\",\n \"view_external_variables\",\n \"create_external_variables\",\n \"edit_external_variables\",\n \"destroy_external_variables\",\n \"view_domains\",\n \"create_domain\",\n \"edit_domains\",\n \"destroy_domains\",\n \"view_globals\",\n \"create_globals\",\n \"edit_globals\",\n \"destroy_globals\",\n \"view_hostgroups\",\n \"create_hostgroups\",\n \"edit_hostgroups\",\n \"destroy_hostgroups\",\n \"view_hosts\",\n \"create_hosts\",\n \"edit_hosts\",\n \"destroy_hosts\",\n \"view_media\",\n \"create_media\",\n \"edit_media\",\n \"destroy_media\",\n \"view_models\",\n \"create_models\",\n \"edit_models\",\n \"destroy_models\",\n \"view_operatingsystems\",\n \"create_operatingsystems\",\n \"edit_operatingsystems\",\n \"destroy_operatingsystems\",\n \"view_ptables\",\n \"create_ptables\",\n \"edit_ptables\",\n \"destroy_ptables\",\n \"view_puppetclasses\",\n \"create_puppetclasses\",\n \"edit_puppetclasses\",\n \"destroy_puppetclasses\",\n \"import_puppetclasses\",\n \"view_usergroups\",\n \"create_usergroups\",\n \"edit_usergroups\",\n \"destroy_usergroups\",\n \"view_users\",\n \"create_users\",\n \"edit_users\",\n \"destroy_users\",\n \"access_settings\",\n \"access_dashboard\",\n \"view_reports\",\n \"destroy_reports\",\n \"view_facts\",\n \"view_audit_logs\",\n \"view_statistics\",\n \"view_locations\",\n \"edit_locations\",\n \"create_locations\",\n \"destroy_locations\",\n \"view_organizations\",\n \"edit_organizations\",\n \"create_organizations\",\n \"destroy_organizations\"\n ]\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/roles/destroy","name":"destroy","apis":[{"api_url":"/api/roles/:id","http_method":"DELETE","short_description":"Delete an role."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["DELETE /api/roles/1\n200\n{\n \"role\": {\n \"name\": \"Manager\",\n \"id\": 1,\n \"builtin\": 0,\n \"permissions\": [\n \"view_architectures\",\n \"create_architectures\",\n \"edit_architectures\",\n \"destroy_architectures\",\n \"view_authenticators\",\n \"create_authenticators\",\n \"edit_authenticators\",\n \"destroy_authenticators\",\n \"view_environments\",\n \"create_environments\",\n \"edit_environments\",\n \"destroy_environments\",\n \"import_environments\",\n \"view_external_variables\",\n \"create_external_variables\",\n \"edit_external_variables\",\n \"destroy_external_variables\",\n \"view_domains\",\n \"create_domain\",\n \"edit_domains\",\n \"destroy_domains\",\n \"view_globals\",\n \"create_globals\",\n \"edit_globals\",\n \"destroy_globals\",\n \"view_hostgroups\",\n \"create_hostgroups\",\n \"edit_hostgroups\",\n \"destroy_hostgroups\",\n \"view_hosts\",\n \"create_hosts\",\n \"edit_hosts\",\n \"destroy_hosts\",\n \"view_media\",\n \"create_media\",\n \"edit_media\",\n \"destroy_media\",\n \"view_models\",\n \"create_models\",\n \"edit_models\",\n \"destroy_models\",\n \"view_operatingsystems\",\n \"create_operatingsystems\",\n \"edit_operatingsystems\",\n \"destroy_operatingsystems\",\n \"view_ptables\",\n \"create_ptables\",\n \"edit_ptables\",\n \"destroy_ptables\",\n \"view_puppetclasses\",\n \"create_puppetclasses\",\n \"edit_puppetclasses\",\n \"destroy_puppetclasses\",\n \"import_puppetclasses\",\n \"view_usergroups\",\n \"create_usergroups\",\n \"edit_usergroups\",\n \"destroy_usergroups\",\n \"view_users\",\n \"create_users\",\n \"edit_users\",\n \"destroy_users\",\n \"access_settings\",\n \"access_dashboard\",\n \"view_reports\",\n \"destroy_reports\",\n \"view_facts\",\n \"view_audit_logs\",\n \"view_statistics\",\n \"view_locations\",\n \"edit_locations\",\n \"create_locations\",\n \"destroy_locations\",\n \"view_organizations\",\n \"edit_organizations\",\n \"create_organizations\",\n \"destroy_organizations\"\n ]\n }\n}"],"see":[]}]},"images":{"doc_url":"/apidoc/v2/images","api_url":"/api","name":"Images","short_description":null,"full_description":null,"version":"v2","formats":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 compute resource"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"<p>filter results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"order","full_name":"order","description":"<p>sort results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"page","full_name":"page","description":"<p>paginate results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"per_page","full_name":"per_page","description":"<p>number of entries per request</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"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"}],"examples":["GET /api/compute_resources/980190962/images\n200\n[\n {\n \"image\": {\n \"name\": \"centos-2\",\n \"id\": 298486374,\n \"uuid\": \"MyString2\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"operatingsystem_id\": 309172073,\n \"username\": \"MyString\",\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"architecture_id\": 501905019,\n \"compute_resource_id\": 980190962\n }\n },\n {\n \"image\": {\n \"name\": \"centos-1\",\n \"id\": 980190962,\n \"uuid\": \"string-of-uuid\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"operatingsystem_id\": 309172073,\n \"username\": \"root\",\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"architecture_id\": 501905019,\n \"compute_resource_id\": 980190962\n }\n }\n]"],"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"}],"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"},{"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"}],"examples":["GET /api/compute_resources/980190962/images/980190962\n200\n{\n \"image\": {\n \"name\": \"centos-1\",\n \"id\": 980190962,\n \"uuid\": \"string-of-uuid\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"operatingsystem_id\": 309172073,\n \"username\": \"root\",\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"architecture_id\": 501905019,\n \"compute_resource_id\": 980190962\n }\n}"],"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 a image"}],"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"},{"name":"image","full_name":"image","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"name","full_name":"image[name]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"username","full_name":"image[username]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"uuid","full_name":"image[uuid]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"compute_resource_id","full_name":"image[compute_resource_id]","description":"","required":true,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"architecture_id","full_name":"image[architecture_id]","description":"","required":true,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"operatingsystem_id","full_name":"image[operatingsystem_id]","description":"","required":true,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"}]}],"examples":["POST /api/compute_resources/980190962/images\n{\n \"image\": {\n \"name\": \"TestImage\",\n \"uuid\": \"abcdef\",\n \"username\": \"ec2-user\",\n \"operatingsystem_id\": 309172073,\n \"compute_resource_id\": 367690737,\n \"architecture_id\": 381564594\n }\n}\n201\n{\n \"compute_resource\": {\n \"url\": \"qemu://stam/system\",\n \"name\": \"MyString\",\n \"user\": \"MyString\",\n \"id\": 980190962,\n \"uuid\": \"MyString\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"description\": \"MyString\",\n \"attrs\": null,\n \"created_at\": \"2012-12-18T15:24:42Z\"\n }\n}"],"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 a image."}],"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"},{"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"},{"name":"image","full_name":"image","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"name","full_name":"image[name]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"username","full_name":"image[username]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"uuid","full_name":"image[uuid]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"compute_resource_id","full_name":"image[compute_resource_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"architecture_id","full_name":"image[architecture_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"operatingsystem_id","full_name":"image[operatingsystem_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"}]}],"examples":["PUT /api/compute_resources/980190962/images/980190962\n{\n \"image\": {}\n}\n200\n{\n \"image\": {\n \"name\": \"centos-1\",\n \"id\": 980190962,\n \"uuid\": \"string-of-uuid\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"username\": \"root\",\n \"operatingsystem_id\": 309172073,\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"compute_resource_id\": 980190962,\n \"architecture_id\": 501905019\n }\n}"],"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."}],"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"},{"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"}],"examples":["DELETE /api/compute_resources/980190962/images/980190962\n200\n{\n \"image\": {\n \"name\": \"centos-1\",\n \"id\": 980190962,\n \"uuid\": \"string-of-uuid\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"username\": \"root\",\n \"operatingsystem_id\": 309172073,\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"compute_resource_id\": 980190962,\n \"architecture_id\": 501905019\n }\n}"],"see":[]}]},"reports":{"doc_url":"/apidoc/v2/reports","api_url":"/api","name":"Reports","short_description":null,"full_description":null,"version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/reports/index","name":"index","apis":[{"api_url":"/api/reports","http_method":"GET","short_description":"List all reports."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"<p>filter results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"order","full_name":"order","description":"<p>sort results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"page","full_name":"page","description":"<p>paginate results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"per_page","full_name":"per_page","description":"<p>number of entries per request</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["GET /api/reports\n200\n[\n {\n \"report\": {\n \"summary\": \"Success\",\n \"status\": {\n \"skipped\": 0,\n \"failed_restarts\": 0,\n \"failed\": 0,\n \"pending\": 0,\n \"restarted\": 0,\n \"applied\": 0\n },\n \"id\": 70219655,\n \"reported_at\": \"2012-12-11T15:24:42Z\",\n \"metrics\": {\n \"events\": {\n \"total\": 0\n },\n \"time\": {\n \"package\": 0.003989,\n \"schedule\": 0.00083,\n \"cron\": 0.000419,\n \"exec\": 0.000299,\n \"service\": 0.149739,\n \"config_retrieval\": 16.3637869358063,\n \"file\": 0.007025,\n \"filebucket\": 0.000171,\n \"mailalias\": 0.000283\n },\n \"resources\": {\n \"total\": 33\n },\n \"changes\": {}\n },\n \"logs\": []\n }\n }\n]"],"see":[]},{"doc_url":"/apidoc/v2/reports/show","name":"show","apis":[{"api_url":"/api/reports/:id","http_method":"GET","short_description":"Show a report."}],"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"}],"examples":["GET /api/reports/70219655\n200\n{\n \"report\": {\n \"summary\": \"Success\",\n \"status\": {\n \"skipped\": 0,\n \"failed_restarts\": 0,\n \"failed\": 0,\n \"pending\": 0,\n \"restarted\": 0,\n \"applied\": 0\n },\n \"id\": 70219655,\n \"reported_at\": \"2012-12-11T15:24:42Z\",\n \"metrics\": {\n \"events\": {\n \"total\": 0\n },\n \"time\": {\n \"package\": 0.003989,\n \"schedule\": 0.00083,\n \"cron\": 0.000419,\n \"exec\": 0.000299,\n \"service\": 0.149739,\n \"config_retrieval\": 16.3637869358063,\n \"file\": 0.007025,\n \"filebucket\": 0.000171,\n \"mailalias\": 0.000283\n },\n \"resources\": {\n \"total\": 33\n },\n \"changes\": {}\n },\n \"logs\": []\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/reports/destroy","name":"destroy","apis":[{"api_url":"/api/ptables/:id","http_method":"DELETE","short_description":"Delete a report."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["DELETE /api/reports/70219655\n200\n{\n \"report\": {\n \"summary\": \"Success\",\n \"status\": {\n \"skipped\": 0,\n \"failed_restarts\": 0,\n \"failed\": 0,\n \"pending\": 0,\n \"restarted\": 0,\n \"applied\": 0\n },\n \"id\": 70219655,\n \"host\": \"my5name.mydomain.net\",\n \"reported_at\": \"2012-12-11T15:24:42Z\",\n \"logs\": [],\n \"metrics\": {\n \"events\": {\n \"total\": 0\n },\n \"time\": {\n \"package\": 0.003989,\n \"schedule\": 0.00083,\n \"cron\": 0.000419,\n \"service\": 0.149739,\n \"exec\": 0.000299,\n \"config_retrieval\": 16.3637869358063,\n \"file\": 0.007025,\n \"mailalias\": 0.000283,\n \"filebucket\": 0.000171\n },\n \"changes\": {},\n \"resources\": {\n \"total\": 33\n }\n }\n }\n}"],"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 given host."}],"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"}],"examples":["GET /api/reports/last\n200\n{\n \"report\": {\n \"summary\": \"Success\",\n \"status\": {\n \"skipped\": 0,\n \"failed_restarts\": 0,\n \"failed\": 0,\n \"pending\": 0,\n \"restarted\": 0,\n \"applied\": 0\n },\n \"id\": 70219655,\n \"reported_at\": \"2012-12-11T15:24:42Z\",\n \"metrics\": {\n \"events\": {\n \"total\": 0\n },\n \"time\": {\n \"package\": 0.003989,\n \"schedule\": 0.00083,\n \"cron\": 0.000419,\n \"exec\": 0.000299,\n \"service\": 0.149739,\n \"config_retrieval\": 16.3637869358063,\n \"file\": 0.007025,\n \"filebucket\": 0.000171,\n \"mailalias\": 0.000283\n },\n \"resources\": {\n \"total\": 33\n },\n \"changes\": {}\n },\n \"logs\": []\n }\n}"],"see":[]}]},"hosts":{"doc_url":"/apidoc/v2/hosts","api_url":"/api","name":"Hosts","short_description":null,"full_description":null,"version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/hosts/index","name":"index","apis":[{"api_url":"/api/hosts","http_method":"GET","short_description":"List all hosts."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"<p>Filter results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"order","full_name":"order","description":"<p>Sort results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"page","full_name":"page","description":"<p>paginate results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"per_page","full_name":"per_page","description":"<p>number of entries per request</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["GET /api/hosts\n200\n[\n {\n \"host\": {\n \"name\": \"anotherfullhost\",\n \"id\": 55602819,\n \"operatingsystem_id\": 1073012828,\n \"hostgroup_id\": null\n }\n },\n {\n \"host\": {\n \"name\": \"dhcp.mydomain.net\",\n \"id\": 219245707,\n \"operatingsystem_id\": 1073012828,\n \"hostgroup_id\": null\n }\n },\n {\n \"host\": {\n \"name\": \"my5name.mydomain.net\",\n \"id\": 980190962,\n \"operatingsystem_id\": 1073012828,\n \"hostgroup_id\": null\n }\n },\n {\n \"host\": {\n \"name\": \"myfullname.mydomain.net\",\n \"id\": 1053842695,\n \"operatingsystem_id\": 309172073,\n \"hostgroup_id\": null\n }\n },\n {\n \"host\": {\n \"name\": \"otherfullhost\",\n \"id\": 661942085,\n \"operatingsystem_id\": 1073012828,\n \"hostgroup_id\": null\n }\n },\n {\n \"host\": {\n \"name\": \"sdhcp.mydomain.net\",\n \"id\": 500757383,\n \"operatingsystem_id\": 1073012828,\n \"hostgroup_id\": null\n }\n },\n {\n \"host\": {\n \"name\": \"sol10host\",\n \"id\": 715054938,\n \"operatingsystem_id\": 442321401,\n \"hostgroup_id\": null\n }\n },\n {\n \"host\": {\n \"name\": \"suse01.yourdomain.net\",\n \"id\": 859751735,\n \"operatingsystem_id\": 859751735,\n \"hostgroup_id\": null\n }\n },\n {\n \"host\": {\n \"name\": \"temp-01.yourdomain.net\",\n \"id\": 1011586618,\n \"operatingsystem_id\": 331303656,\n \"hostgroup_id\": null\n }\n },\n {\n \"host\": {\n \"name\": \"temp01.yourdomain.net\",\n \"id\": 1073012828,\n \"operatingsystem_id\": 1073012828,\n \"hostgroup_id\": null\n }\n },\n {\n \"host\": {\n \"name\": \"temp-02.useless.net\",\n \"id\": 3666571,\n \"operatingsystem_id\": 331303656,\n \"hostgroup_id\": null\n }\n },\n {\n \"host\": {\n \"name\": \"temp.yourdomain.net\",\n \"id\": 298486374,\n \"operatingsystem_id\": 309172073,\n \"hostgroup_id\": null\n }\n }\n]"],"see":[]},{"doc_url":"/apidoc/v2/hosts/show","name":"show","apis":[{"api_url":"/api/hosts/:id","http_method":"GET","short_description":"Show a host."}],"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"}],"examples":["GET /api/hosts/my5name.mydomain.net\n200\n{\n \"host\": {\n \"host_parameters\": [\n {\n \"host_parameter\": {\n \"priority\": 4,\n \"name\": \"host1\",\n \"value\": \"host1\",\n \"id\": 254219264,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"reference_id\": 980190962,\n \"created_at\": \"2012-12-18T15:24:43Z\"\n }\n }\n ],\n \"name\": \"my5name.mydomain.net\",\n \"installed_at\": null,\n \"sp_ip\": \"\",\n \"image_file\": \"\",\n \"sp_name\": \"\",\n \"last_report\": null,\n \"enabled\": true,\n \"ip\": \"2.3.4.1\",\n \"id\": 980190962,\n \"puppet_ca_proxy_id\": null,\n \"certname\": \"my5name.mydomain.net\",\n \"medium_id\": null,\n \"sp_mac\": \"\",\n \"model_id\": null,\n \"comment\": null,\n \"uuid\": null,\n \"mac\": \"aabbCCddeeee\",\n \"use_image\": null,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"operatingsystem_id\": 1073012828,\n \"owner_id\": null,\n \"environment_id\": 334344675,\n \"build\": false,\n \"subnet_id\": 980190962,\n \"domain_id\": 22495316,\n \"environment\": {\n \"environment\": {\n \"name\": \"production\",\n \"id\": 334344675\n }\n },\n \"sp_subnet_id\": null,\n \"hostgroup_id\": null,\n \"puppet_proxy_id\": 182953976,\n \"owner_type\": null,\n \"ptable_id\": 980190962,\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"disk\": null,\n \"managed\": true,\n \"architecture_id\": 501905019,\n \"image_id\": null,\n \"compute_resource_id\": 980190962\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/hosts/create","name":"create","apis":[{"api_url":"/api/hosts","http_method":"POST","short_description":"Create a host."}],"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","params":[{"name":"name","full_name":"host[name]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"environment_id","full_name":"host[environment_id]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"ip","full_name":"host[ip]","description":"<p>not required if using a subnet with dhcp proxy</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"mac","full_name":"host[mac]","description":"<p>not required if its a virtual machine</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"architecture_id","full_name":"host[architecture_id]","description":"","required":true,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"domain_id","full_name":"host[domain_id]","description":"","required":true,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"puppet_proxy_id","full_name":"host[puppet_proxy_id]","description":"","required":true,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"operatingsystem_id","full_name":"host[operatingsystem_id]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"medium_id","full_name":"host[medium_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"ptable_id","full_name":"host[ptable_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"subnet_id","full_name":"host[subnet_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"sp_subnet_id","full_name":"host[sp_subnet_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"model_id_id","full_name":"host[model_id_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"hostgroup_id","full_name":"host[hostgroup_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"owner_id","full_name":"host[owner_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"puppet_ca_proxy_id","full_name":"host[puppet_ca_proxy_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"image_id","full_name":"host[image_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"host_parameters_attributes","full_name":"host[host_parameters_attributes]","description":"","required":false,"allow_nil":false,"validator":"Must be Array","expected_type":"string"}]}],"examples":["POST /api/hosts\n{\n \"host\": {\n \"name\": \"testhost11\",\n \"ip\": \"10.0.0.20\",\n \"mac\": \"52:53:00:1e:85:93\",\n \"operatingsystem_id\": 1073012828,\n \"environment_id\": 334344675,\n \"domain_id\": 22495316,\n \"puppet_proxy_id\": 7,\n \"architecture_id\": 501905019\n }\n}\n200\n{\n \"host\": {\n \"name\": \"testhost11.mydomain.net\",\n \"host_parameters\": [],\n \"installed_at\": null,\n \"sp_ip\": \"\",\n \"sp_name\": \"\",\n \"image_file\": \"\",\n \"last_report\": null,\n \"enabled\": true,\n \"id\": 1073012829,\n \"ip\": \"10.0.0.20\",\n \"puppet_ca_proxy_id\": null,\n \"certname\": \"fcfce82c-33d1-4565-843a-4f58ff8e371a\",\n \"medium_id\": null,\n \"sp_mac\": \"\",\n \"model_id\": null,\n \"comment\": null,\n \"uuid\": null,\n \"mac\": \"52:53:00:1e:85:93\",\n \"updated_at\": \"2012-12-18T15:24:48Z\",\n \"use_image\": null,\n \"operatingsystem_id\": 1073012828,\n \"owner_id\": 886836129,\n \"environment_id\": 334344675,\n \"build\": false,\n \"subnet_id\": null,\n \"environment\": {\n \"environment\": {\n \"name\": \"production\",\n \"id\": 334344675\n }\n },\n \"domain_id\": 22495316,\n \"sp_subnet_id\": null,\n \"hostgroup_id\": null,\n \"puppet_proxy_id\": 7,\n \"owner_type\": \"User\",\n \"ptable_id\": null,\n \"created_at\": \"2012-12-18T15:24:48Z\",\n \"disk\": null,\n \"managed\": true,\n \"architecture_id\": 501905019,\n \"compute_resource_id\": null,\n \"image_id\": null\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/hosts/update","name":"update","apis":[{"api_url":"/api/hosts/:id","http_method":"PUT","short_description":"Update a host."}],"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"},{"name":"host","full_name":"host","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"name","full_name":"host[name]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"environment_id","full_name":"host[environment_id]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"ip","full_name":"host[ip]","description":"<p>not required if using a subnet with dhcp proxy</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"mac","full_name":"host[mac]","description":"<p>not required if its a virtual machine</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"architecture_id","full_name":"host[architecture_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"domain_id","full_name":"host[domain_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"puppet_proxy_id","full_name":"host[puppet_proxy_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"operatingsystem_id","full_name":"host[operatingsystem_id]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"medium_id","full_name":"host[medium_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"ptable_id","full_name":"host[ptable_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"subnet_id","full_name":"host[subnet_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"sp_subnet_id","full_name":"host[sp_subnet_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"model_id_id","full_name":"host[model_id_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"hostgroup_id","full_name":"host[hostgroup_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"owner_id","full_name":"host[owner_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"puppet_ca_proxy_id","full_name":"host[puppet_ca_proxy_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"image_id","full_name":"host[image_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"host_parameters_attributes","full_name":"host[host_parameters_attributes]","description":"","required":false,"allow_nil":false,"validator":"Must be Array","expected_type":"string"}]}],"examples":["PUT /api/hosts/temp.yourdomain.net\n{\n \"host\": {}\n}\n200\n{\n \"host\": {\n \"sp_name\": \"\",\n \"sp_ip\": \"\",\n \"serial\": null,\n \"name\": \"temp.yourdomain.net\",\n \"installed_at\": null,\n \"image_file\": \"\",\n \"last_report\": null,\n \"enabled\": true,\n \"sp_mac\": \"\",\n \"puppet_ca_proxy_id\": null,\n \"medium_id\": 980190962,\n \"ip\": \"2.3.4.5\",\n \"id\": 298486374,\n \"certname\": \"temp.yourdomain.net\",\n \"uuid\": null,\n \"use_image\": null,\n \"updated_at\": \"2012-12-18T15:24:48Z\",\n \"root_pass\": \"xybxa6JUkz63w\",\n \"model_id\": null,\n \"mac\": \"aa:bb:cc:dd:ee:ff\",\n \"last_compile\": null,\n \"comment\": null,\n \"owner_id\": 886836129,\n \"operatingsystem_id\": 309172073,\n \"location_id\": null,\n \"organization_id\": null,\n \"environment_id\": 334344675,\n \"build\": false,\n \"subnet_id\": 980190962,\n \"sp_subnet_id\": null,\n \"hostgroup_id\": null,\n \"environment\": {\n \"environment\": {\n \"name\": \"production\",\n \"id\": 334344675\n }\n },\n \"domain_id\": 589326610,\n \"source_file_id\": null,\n \"puppet_proxy_id\": 182953976,\n \"ptable_id\": 980190962,\n \"owner_type\": \"User\",\n \"puppet_status\": 0,\n \"disk\": null,\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"managed\": null,\n \"last_freshcheck\": null,\n \"image_id\": null,\n \"compute_resource_id\": 980190962,\n \"architecture_id\": 501905019\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/hosts/destroy","name":"destroy","apis":[{"api_url":"/api/hosts/:id","http_method":"DELETE","short_description":"Delete an host."}],"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"}],"examples":["DELETE /api/hosts/my5name.mydomain.net\n200\n{\n \"host\": {\n \"sp_name\": \"\",\n \"sp_ip\": \"\",\n \"serial\": null,\n \"name\": \"my5name.mydomain.net\",\n \"installed_at\": null,\n \"image_file\": \"\",\n \"last_report\": null,\n \"enabled\": true,\n \"sp_mac\": \"\",\n \"puppet_ca_proxy_id\": null,\n \"medium_id\": null,\n \"ip\": \"2.3.4.1\",\n \"id\": 980190962,\n \"certname\": \"my5name.mydomain.net\",\n \"uuid\": null,\n \"use_image\": null,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"root_pass\": \"xybxa6JUkz63w\",\n \"model_id\": null,\n \"mac\": \"aabbCCddeeee\",\n \"last_compile\": null,\n \"comment\": null,\n \"owner_id\": null,\n \"operatingsystem_id\": 1073012828,\n \"location_id\": null,\n \"organization_id\": null,\n \"environment_id\": 334344675,\n \"build\": false,\n \"subnet_id\": 980190962,\n \"sp_subnet_id\": null,\n \"hostgroup_id\": null,\n \"environment\": {\n \"environment\": {\n \"name\": \"production\",\n \"id\": 334344675\n }\n },\n \"domain_id\": 22495316,\n \"source_file_id\": null,\n \"puppet_proxy_id\": 182953976,\n \"ptable_id\": 980190962,\n \"owner_type\": null,\n \"puppet_status\": 0,\n \"disk\": null,\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"managed\": true,\n \"last_freshcheck\": null,\n \"image_id\": null,\n \"compute_resource_id\": 980190962,\n \"architecture_id\": 501905019\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/hosts/status","name":"status","apis":[{"api_url":"/api/hosts/:id/status","http_method":"GET","short_description":"Get status of host"}],"formats":null,"full_description":"<p>Return value may either be one of the following:</p>\n\n<ul>\n<li>missing</li>\n\n<li>failed</li>\n\n<li>pending</li>\n\n<li>changed</li>\n\n<li>unchanged</li>\n\n<li>unreported</li>\n</ul>","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"}],"examples":["GET /api/hosts/my5name.mydomain.net/status\n200\n{\n \"status\": \"missing\"\n}"],"see":[]},{"doc_url":"/apidoc/v2/hosts/puppetrun","name":"puppetrun","apis":[{"api_url":"/api/hosts/:id/puppetrun","http_method":"GET","short_description":"Force a puppet run on the agent."}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"see":[]}]},"architectures":{"doc_url":"/apidoc/v2/architectures","api_url":"/api","name":"Architectures","short_description":null,"full_description":null,"version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/architectures/index","name":"index","apis":[{"api_url":"/api/architectures","http_method":"GET","short_description":"List all architectures."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"<p>filter results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"order","full_name":"order","description":"<p>sort results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"page","full_name":"page","description":"<p>paginate results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"per_page","full_name":"per_page","description":"<p>number of entries per request</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["GET /api/architectures\n200\n[\n {\n \"architecture\": {\n \"name\": \"s390\",\n \"id\": 381564594,\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"operatingsystem_ids\": [],\n \"created_at\": \"2012-12-18T15:24:42Z\"\n }\n },\n {\n \"architecture\": {\n \"name\": \"sparc\",\n \"id\": 331892513,\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"operatingsystem_ids\": [\n 442321401\n ],\n \"created_at\": \"2012-12-18T15:24:42Z\"\n }\n },\n {\n \"architecture\": {\n \"name\": \"x86_64\",\n \"id\": 501905019,\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"operatingsystem_ids\": [\n 331303656,\n 309172073,\n 1073012828\n ],\n \"created_at\": \"2012-12-18T15:24:42Z\"\n }\n }\n]"],"see":[]},{"doc_url":"/apidoc/v2/architectures/show","name":"show","apis":[{"api_url":"/api/architectures/:id","http_method":"GET","short_description":"Show an architecture."}],"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"}],"examples":["GET /api/architectures/x86_64\n200\n{\n \"architecture\": {\n \"name\": \"x86_64\",\n \"id\": 501905019,\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"operatingsystem_ids\": [\n 309172073,\n 1073012828,\n 331303656\n ],\n \"created_at\": \"2012-12-18T15:24:42Z\"\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/architectures/create","name":"create","apis":[{"api_url":"/api/architectures","http_method":"POST","short_description":"Create an architecture."}],"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","params":[{"name":"name","full_name":"architecture[name]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"operatingsystem_ids","full_name":"architecture[operatingsystem_ids]","description":"<p>Operatingsystem ID&#8217;s</p>","required":false,"allow_nil":false,"validator":"Must be Array","expected_type":"string"}]}],"examples":["POST /api/architectures\n{\n \"architecture\": {\n \"name\": \"i386\"\n }\n}\n200\n{\n \"architecture\": {\n \"name\": \"i386\",\n \"id\": 501905020,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"operatingsystem_ids\": [],\n \"created_at\": \"2012-12-18T15:24:43Z\"\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/architectures/update","name":"update","apis":[{"api_url":"/api/architectures/:id","http_method":"PUT","short_description":"Update an architecture."}],"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"},{"name":"architecture","full_name":"architecture","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"name","full_name":"architecture[name]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"operatingsystem_ids","full_name":"architecture[operatingsystem_ids]","description":"<p>Operatingsystem ID&#8217;s</p>","required":false,"allow_nil":false,"validator":"Must be Array","expected_type":"string"}]}],"examples":["PUT /api/architectures/x86_64\n{\n \"architecture\": {}\n}\n200\n{\n \"architecture\": {\n \"name\": \"x86_64\",\n \"id\": 501905019\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/architectures/destroy","name":"destroy","apis":[{"api_url":"/api/architectures/:id","http_method":"DELETE","short_description":"Delete an architecture."}],"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"}],"examples":["DELETE /api/architectures/s390\n200\n{\n \"architecture\": {\n \"name\": \"s390\",\n \"id\": 381564594\n }\n}"],"see":[]}]},"operatingsystems":{"doc_url":"/apidoc/v2/operatingsystems","api_url":"/api","name":"Operating systems","short_description":null,"full_description":"","version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/operatingsystems/index","name":"index","apis":[{"api_url":"/api/operatingsystems","http_method":"GET","short_description":"List all operating systems."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"<p>filter results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"order","full_name":"order","description":"<p>for example, name ASC, or name DESC</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"page","full_name":"page","description":"<p>paginate results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"per_page","full_name":"per_page","description":"<p>number of entries per request</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/operatingsystems/show","name":"show","apis":[{"api_url":"/api/operatingsystems/:id","http_method":"GET","short_description":"Show an OS."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["GET /api/operatingsystems/1073012828\n200\n{\n \"operatingsystem\": {\n \"name\": \"Redhat\",\n \"minor\": \"1\",\n \"id\": 1073012828,\n \"family\": \"Redhat\",\n \"ptables\": [\n {\n \"ptable\": {\n \"name\": \"default\",\n \"id\": 980190962\n }\n }\n ],\n \"os_default_templates\": [],\n \"architectures\": [\n {\n \"architecture\": {\n \"name\": \"x86_64\",\n \"id\": 501905019\n }\n }\n ],\n \"config_templates\": [\n {\n \"config_template\": {\n \"name\": \"centos5_3_pxelinux\",\n \"id\": 1007981701\n }\n },\n {\n \"config_template\": {\n \"name\": \"MyFinish\",\n \"id\": 104314179\n }\n },\n {\n \"config_template\": {\n \"name\": \"MyScript\",\n \"id\": 981457253\n }\n },\n {\n \"config_template\": {\n \"name\": \"MyString\",\n \"id\": 943779058\n }\n },\n {\n \"config_template\": {\n \"name\": \"MyString2\",\n \"id\": 269958254\n }\n },\n {\n \"config_template\": {\n \"name\": \"PXE Default File\",\n \"id\": 352050261\n }\n },\n {\n \"config_template\": {\n \"name\": \"PXE Localboot Default\",\n \"id\": 821548108\n }\n }\n ],\n \"release_name\": null,\n \"major\": \"6\",\n \"media\": [\n {\n \"medium\": {\n \"name\": \"CentOS 5.4\",\n \"id\": 980190962\n }\n }\n ]\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/operatingsystems/create","name":"create","apis":[{"api_url":"/api/operatingsystems","http_method":"POST","short_description":"Create an OS."}],"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","params":[{"name":"name","full_name":"operatingsystem[name]","description":"","required":true,"allow_nil":false,"validator":"Must match regular expression /\\A(\\S+)\\Z/.","expected_type":"string"},{"name":"major","full_name":"operatingsystem[major]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"minor","full_name":"operatingsystem[minor]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"family","full_name":"operatingsystem[family]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"release_name","full_name":"operatingsystem[release_name]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}]}],"examples":["POST /api/operatingsystems\n{\n \"operatingsystem\": {\n \"minor\": \"2\",\n \"name\": \"awsome_os\",\n \"major\": \"1\"\n }\n}\n200\n{\n \"operatingsystem\": {\n \"name\": \"awsome_os\",\n \"minor\": \"2\",\n \"id\": 1073012829,\n \"family\": null,\n \"ptables\": [],\n \"os_default_templates\": [],\n \"release_name\": null,\n \"config_templates\": [],\n \"architectures\": [],\n \"major\": \"1\",\n \"media\": []\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/operatingsystems/update","name":"update","apis":[{"api_url":"/api/operatingsystems/:id","http_method":"PUT","short_description":"Update an OS."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"operatingsystem","full_name":"operatingsystem","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"name","full_name":"operatingsystem[name]","description":"","required":false,"allow_nil":false,"validator":"Must match regular expression /\\A(\\S+)\\Z/.","expected_type":"string"},{"name":"major","full_name":"operatingsystem[major]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"minor","full_name":"operatingsystem[minor]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"family","full_name":"operatingsystem[family]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"release_name","full_name":"operatingsystem[release_name]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}]}],"examples":["PUT /api/operatingsystems/1073012828\n{\n \"operatingsystem\": {\n \"name\": \"new_name\"\n }\n}\n200\n{\n \"operatingsystem\": {\n \"name\": \"new_name\",\n \"minor\": \"1\",\n \"id\": 1073012828,\n \"family\": \"Redhat\",\n \"ptables\": [\n {\n \"ptable\": {\n \"name\": \"default\",\n \"id\": 980190962\n }\n }\n ],\n \"os_default_templates\": [],\n \"config_templates\": [\n {\n \"config_template\": {\n \"name\": \"centos5_3_pxelinux\",\n \"id\": 1007981701\n }\n },\n {\n \"config_template\": {\n \"name\": \"MyFinish\",\n \"id\": 104314179\n }\n },\n {\n \"config_template\": {\n \"name\": \"MyScript\",\n \"id\": 981457253\n }\n },\n {\n \"config_template\": {\n \"name\": \"MyString\",\n \"id\": 943779058\n }\n },\n {\n \"config_template\": {\n \"name\": \"MyString2\",\n \"id\": 269958254\n }\n },\n {\n \"config_template\": {\n \"name\": \"PXE Default File\",\n \"id\": 352050261\n }\n },\n {\n \"config_template\": {\n \"name\": \"PXE Localboot Default\",\n \"id\": 821548108\n }\n }\n ],\n \"architectures\": [\n {\n \"architecture\": {\n \"name\": \"x86_64\",\n \"id\": 501905019\n }\n }\n ],\n \"release_name\": null,\n \"media\": [\n {\n \"medium\": {\n \"name\": \"CentOS 5.4\",\n \"id\": 980190962\n }\n }\n ],\n \"major\": \"6\"\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/operatingsystems/destroy","name":"destroy","apis":[{"api_url":"/api/operatingsystems/:id","http_method":"DELETE","short_description":"Delete an OS."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["DELETE /api/operatingsystems/775246587\n200\n{\n \"operatingsystem\": {\n \"name\": \"NoHosts 1.1\",\n \"id\": 775246587,\n \"ptables\": [],\n \"architectures\": [],\n \"config_templates\": [],\n \"media\": []\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/operatingsystems/bootfiles","name":"bootfiles","apis":[{"api_url":"/api/operatingsystems/:id/bootfiles","http_method":"GET","short_description":"List boot files an OS."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"medium","full_name":"medium","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"architecture","full_name":"architecture","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":[],"see":[]}]},"puppetclasses":{"doc_url":"/apidoc/v2/puppetclasses","api_url":"/api","name":"Puppetclasses","short_description":null,"full_description":null,"version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/puppetclasses/index","name":"index","apis":[{"api_url":"/api/puppetclasses","http_method":"GET","short_description":"List all puppetclasses."},{"api_url":"/api/hosts/:host_id/puppetclasses","http_method":"GET","short_description":"List all puppetclasses for host"},{"api_url":"/api/hostgroups/:hostgroup_id/puppetclasses","http_method":"GET","short_description":"List all puppetclasses for hostgroup"},{"api_url":"/api/environments/:environment_id/puppetclasses","http_method":"GET","short_description":"List all puppetclasses for environment"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"<p>id of nested host</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"<p>id of nested hostgroup</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"environment_id","full_name":"environment_id","description":"<p>id of nested environment</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["GET /api/puppetclasses\n200\n{\n \"base\": [\n {\n \"puppetclass\": {\n \"name\": \"base\",\n \"id\": 980190962,\n \"lookup_keys\": [\n {\n \"id\": 298486374\n }\n ]\n }\n }\n ],\n \"apache\": [\n {\n \"puppetclass\": {\n \"name\": \"apache\",\n \"id\": 298486374,\n \"lookup_keys\": []\n }\n }\n ]\n}"],"see":[]},{"doc_url":"/apidoc/v2/puppetclasses/show","name":"show","apis":[{"api_url":"/api/puppetclasses/:id","http_method":"GET","short_description":"Show a puppetclass"},{"api_url":"/api/hosts/:host_id/puppetclasses/:id","http_method":"GET","short_description":"Show a puppetclass for host"},{"api_url":"/api/hostgroups/:hostgroup_id/puppetclasses/:id","http_method":"GET","short_description":"Show a puppetclass for hostgroup"},{"api_url":"/api/environments/:environment_id/puppetclasses/:id","http_method":"GET","short_description":"Show a puppetclass for environment"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"<p>id of nested host</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"<p>id of nested hostgroup</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"environment_id","full_name":"environment_id","description":"<p>id of nested environment</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"id","full_name":"id","description":"<p>id of puppetclass</p>","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["GET /api/puppetclasses/base\n200\n{\n \"puppetclass\": {\n \"name\": \"base\",\n \"id\": 980190962,\n \"lookup_keys\": [\n {\n \"lookup_key\": {\n \"required\": false,\n \"id\": 298486374,\n \"description\": null,\n \"key\": \"ssl_port\",\n \"is_param\": false,\n \"override\": false,\n \"default_value\": \"443\"\n }\n }\n ]\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/puppetclasses/create","name":"create","apis":[{"api_url":"/api/puppetclasses","http_method":"POST","short_description":"Create a puppetclass."}],"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","params":[{"name":"name","full_name":"puppetclass[name]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"}]}],"examples":["POST /api/puppetclasses\n{\n \"puppetclass\": {\n \"name\": \"test_puppetclass\"\n }\n}\n201\n{\n \"puppetclass\": {\n \"name\": \"test_puppetclass\",\n \"id\": 980190963,\n \"lookup_keys\": []\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/puppetclasses/update","name":"update","apis":[{"api_url":"/api/puppetclasses/:id","http_method":"PUT","short_description":"Update a puppetclass."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"puppetclass","full_name":"puppetclass","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"name","full_name":"puppetclass[name]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}]}],"examples":["PUT /api/puppetclasses/base\n{\n \"puppetclass\": {}\n}\n200\n{\n \"puppetclass\": {\n \"name\": \"base\",\n \"id\": 980190962,\n \"lookup_keys\": [\n {\n \"id\": 298486374\n }\n ]\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/puppetclasses/destroy","name":"destroy","apis":[{"api_url":"/api/puppetclasses/:id","http_method":"DELETE","short_description":"Delete a puppetclass."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["DELETE /api/puppetclasses/base\n200\n{\n \"puppetclass\": {\n \"name\": \"base\",\n \"id\": 980190962,\n \"lookup_keys\": [\n {\n \"id\": 298486374\n }\n ]\n }\n}"],"see":[]}]},"audits":{"doc_url":"/apidoc/v2/audits","api_url":"/api","name":"Audits","short_description":null,"full_description":null,"version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/audits/index","name":"index","apis":[{"api_url":"/api/audits","http_method":"GET","short_description":"List all audits."},{"api_url":"/api/hosts/:host_id/audits","http_method":"GET","short_description":"List all audits for a given host."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"<p>filter results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"order","full_name":"order","description":"<p>sort results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"page","full_name":"page","description":"<p>paginate results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"per_page","full_name":"per_page","description":"<p>number of entries per request</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["GET /api/audits\n200\n[\n {\n \"audit\": {\n \"auditable_name\": null,\n \"user_id\": null,\n \"associated_id\": 272,\n \"associated_name\": null,\n \"id\": 1,\n \"comment\": null,\n \"auditable_id\": 0,\n \"auditable_type\": \"Host\",\n \"associated_type\": \"Host\",\n \"remote_address\": null,\n \"action\": \"update\",\n \"audited_changes\": {\n \"architecture_id\": [\n 10463,\n 10466\n ]\n },\n \"user_type\": null,\n \"version\": 1,\n \"created_at\": \"2009-12-14T08:01:17Z\"\n }\n }\n]"],"see":[]},{"doc_url":"/apidoc/v2/audits/show","name":"show","apis":[{"api_url":"/api/audits/:id","http_method":"GET","short_description":"Show an audit"}],"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"}],"examples":["GET /api/audits/1\n200\n{\n \"audit\": {\n \"auditable_name\": null,\n \"user_id\": null,\n \"associated_id\": 272,\n \"associated_name\": null,\n \"id\": 1,\n \"comment\": null,\n \"auditable_id\": 0,\n \"auditable_type\": \"Host\",\n \"associated_type\": \"Host\",\n \"remote_address\": null,\n \"action\": \"update\",\n \"audited_changes\": {\n \"architecture_id\": [\n 10463,\n 10466\n ]\n },\n \"user_type\": null,\n \"version\": 1,\n \"created_at\": \"2009-12-14T08:01:17Z\"\n }\n}"],"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,"methods":[{"doc_url":"/apidoc/v2/smart_proxies/index","name":"index","apis":[{"api_url":"/api/smart_proxies","http_method":"GET","short_description":"List all smart_proxies."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"type","full_name":"type","description":"<p>filter by type</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"page","full_name":"page","description":"<p>paginate results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"per_page","full_name":"per_page","description":"<p>number of entries per request</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["GET /api/smart_proxies?type=unknown_type\n500\n{\n \"error\": {\n \"message\": \"Invalid feature type. Select one of: TFTP, BMC, DNS, DHCP, Puppetca, Puppet.\"\n }\n}"],"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."}],"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"}],"examples":["GET /api/smart_proxies/980190962-dhcp-proxy\n200\n{\n \"smart_proxy\": {\n \"name\": \"DHCP Proxy\",\n \"features\": [],\n \"url\": \"https://somewhere.net:8443\",\n \"id\": 980190962,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"created_at\": \"2012-12-18T15:24:43Z\"\n }\n}"],"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."}],"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","params":[{"name":"name","full_name":"smart_proxy[name]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"url","full_name":"smart_proxy[url]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"}]}],"examples":["POST /api/smart_proxies\n{\n \"smart_proxy\": {\n \"url\": \"http://server:8443\",\n \"name\": \"master02\"\n }\n}\n201\n{\n \"smart_proxy\": {\n \"url\": \"http://server:8443\",\n \"name\": \"master02\",\n \"id\": 980190963,\n \"updated_at\": \"2012-12-18T15:24:52Z\",\n \"created_at\": \"2012-12-18T15:24:52Z\"\n }\n}"],"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."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"smart_proxy","full_name":"smart_proxy","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"name","full_name":"smart_proxy[name]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"url","full_name":"smart_proxy[url]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}]}],"examples":["PUT /api/smart_proxies/980190962-dhcp-proxy\n{\n \"smart_proxy\": {}\n}\n200\n{\n \"smart_proxy\": {\n \"url\": \"https://somewhere.net:8443\",\n \"name\": \"DHCP Proxy\",\n \"id\": 980190962,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"created_at\": \"2012-12-18T15:24:43Z\"\n }\n}"],"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."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["DELETE /api/smart_proxies/281110143-unused-proxy\n200\n{\n \"smart_proxy\": {\n \"url\": \"http://else.where:4567\",\n \"name\": \"Unused Proxy\",\n \"id\": 281110143,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"created_at\": \"2012-12-18T15:24:43Z\"\n }\n}"],"see":[]}]},"settings":{"doc_url":"/apidoc/v2/settings","api_url":"/api","name":"Settings","short_description":null,"full_description":null,"version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/settings/index","name":"index","apis":[{"api_url":"/api/settings","http_method":"GET","short_description":"List all settings."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"<p>Filter results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"order","full_name":"order","description":"<p>Sort results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"page","full_name":"page","description":"<p>paginate results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"per_page","full_name":"per_page","description":"<p>number of entries per request</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/settings/show","name":"show","apis":[{"api_url":"/api/settings/:id","http_method":"GET","short_description":"Show an setting."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["GET /api/settings/333972760\n200\n{\n \"setting\": {\n \"name\": \"administrator\",\n \"value\": \"root@some.host.fqdn\",\n \"id\": 333972760,\n \"description\": \"The Default administrator email address\",\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"category\": \"General\",\n \"settings_type\": null,\n \"default\": \"root@some.host.fqdn\",\n \"created_at\": \"2012-12-18T15:24:43Z\"\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/settings/update","name":"update","apis":[{"api_url":"/api/settings/:id","http_method":"PUT","short_description":"Update a setting."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"setting","full_name":"setting","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"value","full_name":"setting[value]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}]}],"examples":["PUT /api/settings/333972760\n{\n \"setting\": {}\n}\n200\n{\n \"setting\": {\n \"name\": \"administrator\",\n \"value\": \"root@some.host.fqdn\",\n \"id\": 333972760,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"description\": \"The Default administrator email address\",\n \"settings_type\": null,\n \"category\": \"General\",\n \"default\": \"root@some.host.fqdn\",\n \"created_at\": \"2012-12-18T15:24:43Z\"\n }\n}"],"see":[]}]},"models":{"doc_url":"/apidoc/v2/models","api_url":"/api","name":"Models","short_description":null,"full_description":null,"version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/models/index","name":"index","apis":[{"api_url":"/api/models","http_method":"GET","short_description":"List all models."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"<p>filter results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"order","full_name":"order","description":"<p>sort results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"page","full_name":"page","description":"<p>paginate results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"per_page","full_name":"per_page","description":"<p>number of entries per request</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["GET /api/models\n200\n[\n {\n \"model\": {\n \"name\": \"KVM\",\n \"id\": 980190962,\n \"vendor_class\": null,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"info\": \"Virtual Machine\",\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"hardware_model\": null\n }\n },\n {\n \"model\": {\n \"name\": \"SUN V210\",\n \"id\": 139037058,\n \"vendor_class\": \"Sun-Fire-V210\",\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"info\": null,\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"hardware_model\": \"SUN4U\"\n }\n }\n]"],"see":[]},{"doc_url":"/apidoc/v2/models/show","name":"show","apis":[{"api_url":"/api/models/:id","http_method":"GET","short_description":"Show a model."}],"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"}],"examples":["GET /api/models/980190962\n200\n{\n \"model\": {\n \"name\": \"KVM\",\n \"id\": 980190962,\n \"vendor_class\": null,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"info\": \"Virtual Machine\",\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"hardware_model\": null\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/models/create","name":"create","apis":[{"api_url":"/api/models","http_method":"POST","short_description":"Create a model."}],"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","params":[{"name":"name","full_name":"model[name]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"info","full_name":"model[info]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"vendor_class","full_name":"model[vendor_class]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"hardware_model","full_name":"model[hardware_model]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}]}],"examples":["POST /api/models\n{\n \"model\": {\n \"name\": \"new model\"\n }\n}\n201\n{\n \"model\": {\n \"name\": \"new model\",\n \"vendor_class\": null,\n \"id\": 980190963,\n \"updated_at\": \"2012-12-18T15:24:49Z\",\n \"info\": null,\n \"created_at\": \"2012-12-18T15:24:49Z\",\n \"hardware_model\": null\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/models/update","name":"update","apis":[{"api_url":"/api/models/:id","http_method":"PUT","short_description":"Update a model."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"model","full_name":"model","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"name","full_name":"model[name]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"info","full_name":"model[info]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"vendor_class","full_name":"model[vendor_class]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"hardware_model","full_name":"model[hardware_model]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}]}],"examples":["PUT /api/models/980190962\n{\n \"name\": \"KVM\"\n}\n200\n{\n \"model\": {\n \"name\": \"KVM\",\n \"vendor_class\": null,\n \"id\": 980190962,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"info\": \"Virtual Machine\",\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"hardware_model\": null\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/models/destroy","name":"destroy","apis":[{"api_url":"/api/models/:id","http_method":"DELETE","short_description":"Delete a model."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["DELETE /api/models/980190962\n200\n{\n \"model\": {\n \"name\": \"KVM\",\n \"vendor_class\": null,\n \"id\": 980190962,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"info\": \"Virtual Machine\",\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"hardware_model\": null\n }\n}"],"see":[]}]},"hostgroups":{"doc_url":"/apidoc/v2/hostgroups","api_url":"/api","name":"Hostgroups","short_description":null,"full_description":null,"version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/hostgroups/index","name":"index","apis":[{"api_url":"/api/hostgroups","http_method":"GET","short_description":"List all hostgroups."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"<p>filter results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"order","full_name":"order","description":"<p>sort results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"page","full_name":"page","description":"<p>paginate results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"per_page","full_name":"per_page","description":"<p>number of entries per request</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["GET /api/hostgroups\n200\n[\n {\n \"hostgroup\": {\n \"name\": \"db\",\n \"label\": \"db\",\n \"id\": 603241515,\n \"operatingsystem_id\": 309172073,\n \"ancestry\": null,\n \"environment_id\": 334344675,\n \"parameters\": {},\n \"subnet_id\": null,\n \"domain_id\": null,\n \"puppetclass_ids\": []\n }\n },\n {\n \"hostgroup\": {\n \"name\": \"Common\",\n \"label\": \"Common\",\n \"id\": 636252244,\n \"operatingsystem_id\": 309172073,\n \"ancestry\": null,\n \"environment_id\": 334344675,\n \"parameters\": {\n \"group1\": \"group1\"\n },\n \"subnet_id\": null,\n \"domain_id\": 22495316,\n \"puppetclass_ids\": [\n 980190962\n ]\n }\n },\n {\n \"hostgroup\": {\n \"name\": \"Unusual\",\n \"label\": \"Unusual\",\n \"id\": 866317115,\n \"operatingsystem_id\": null,\n \"ancestry\": null,\n \"environment_id\": null,\n \"parameters\": {},\n \"subnet_id\": null,\n \"domain_id\": null,\n \"puppetclass_ids\": []\n }\n }\n]"],"see":[]},{"doc_url":"/apidoc/v2/hostgroups/show","name":"show","apis":[{"api_url":"/api/hostgroups/:id","http_method":"GET","short_description":"Show a hostgroup."}],"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"}],"examples":["GET /api/hostgroups/636252244-common\n200\n{\n \"hostgroup\": {\n \"name\": \"Common\",\n \"label\": \"Common\",\n \"id\": 636252244,\n \"operatingsystem_id\": 309172073,\n \"ancestry\": null,\n \"environment_id\": 334344675,\n \"parameters\": {\n \"group1\": \"group1\"\n },\n \"subnet_id\": null,\n \"domain_id\": 22495316,\n \"puppetclass_ids\": [\n 980190962\n ]\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/hostgroups/create","name":"create","apis":[{"api_url":"/api/hostgroups","http_method":"POST","short_description":"Create an hostgroup."}],"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","params":[{"name":"name","full_name":"hostgroup[name]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"environment_id","full_name":"hostgroup[environment_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"operatingsystem_id","full_name":"hostgroup[operatingsystem_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"architecture_id","full_name":"hostgroup[architecture_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"medium_id","full_name":"hostgroup[medium_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"ptable_id","full_name":"hostgroup[ptable_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"puppet_ca_proxy_id","full_name":"hostgroup[puppet_ca_proxy_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"subnet_id","full_name":"hostgroup[subnet_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"domain_id","full_name":"hostgroup[domain_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"puppet_proxy_id","full_name":"hostgroup[puppet_proxy_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"}]}],"examples":["POST /api/hostgroups\n{\n \"hostgroup\": {\n \"name\": \"TestHostgroup\"\n }\n}\n200\n{\n \"hostgroup\": {\n \"name\": \"TestHostgroup\",\n \"label\": \"TestHostgroup\",\n \"id\": 866317116,\n \"operatingsystem_id\": null,\n \"ancestry\": null,\n \"environment_id\": null,\n \"parameters\": {},\n \"subnet_id\": null,\n \"domain_id\": null,\n \"puppetclass_ids\": []\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/hostgroups/update","name":"update","apis":[{"api_url":"/api/hostgroups/:id","http_method":"PUT","short_description":"Update an hostgroup."}],"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"},{"name":"hostgroup","full_name":"hostgroup","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"name","full_name":"hostgroup[name]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"environment_id","full_name":"hostgroup[environment_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"operatingsystem_id","full_name":"hostgroup[operatingsystem_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"architecture_id","full_name":"hostgroup[architecture_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"medium_id","full_name":"hostgroup[medium_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"ptable_id","full_name":"hostgroup[ptable_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"puppet_ca_proxy_id","full_name":"hostgroup[puppet_ca_proxy_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"subnet_id","full_name":"hostgroup[subnet_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"domain_id","full_name":"hostgroup[domain_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"puppet_proxy_id","full_name":"hostgroup[puppet_proxy_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"}]}],"examples":["PUT /api/hostgroups/636252244-common\n{\n \"hostgroup\": {}\n}\n200\n{\n \"hostgroup\": {\n \"name\": \"Common\",\n \"label\": \"Common\",\n \"id\": 636252244,\n \"operatingsystem_id\": 309172073,\n \"ancestry\": null,\n \"parameters\": {\n \"group1\": \"group1\"\n },\n \"environment_id\": 334344675,\n \"subnet_id\": null,\n \"domain_id\": 22495316,\n \"puppetclass_ids\": [\n 980190962\n ]\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/hostgroups/destroy","name":"destroy","apis":[{"api_url":"/api/hostgroups/:id","http_method":"DELETE","short_description":"Delete an hostgroup."}],"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"}],"examples":["DELETE /api/hostgroups/636252244-common\n200\n{\n \"hostgroup\": {\n \"name\": \"Common\",\n \"label\": \"Common\",\n \"id\": 636252244,\n \"operatingsystem_id\": 309172073,\n \"ancestry\": null,\n \"parameters\": {},\n \"environment_id\": 334344675,\n \"subnet_id\": null,\n \"domain_id\": 22495316,\n \"puppetclass_ids\": []\n }\n}"],"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,"methods":[{"doc_url":"/apidoc/v2/common_parameters/index","name":"index","apis":[{"api_url":"/api/common_parameters","http_method":"GET","short_description":"List all common parameters."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"<p>filter results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"order","full_name":"order","description":"<p>sort results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"page","full_name":"page","description":"<p>paginate results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"per_page","full_name":"per_page","description":"<p>number of entries per request</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["GET /api/common_parameters\n200\n[\n {\n \"common_parameter\": {\n \"name\": \"test\",\n \"value\": \"myvalue\",\n \"id\": 636252244\n }\n }\n]"],"see":[]},{"doc_url":"/apidoc/v2/common_parameters/show","name":"show","apis":[{"api_url":"/api/common_parameters/:id","http_method":"GET","short_description":"Show a common parameter."}],"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"}],"examples":["GET /api/common_parameters/636252244\n200\n{\n \"common_parameter\": {\n \"name\": \"test\",\n \"value\": \"myvalue\",\n \"id\": 636252244\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/common_parameters/create","name":"create","apis":[{"api_url":"/api/common_parameters","http_method":"POST","short_description":"Create a common_parameter"}],"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","params":[{"name":"name","full_name":"common_parameter[name]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"value","full_name":"common_parameter[value]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"}]}],"examples":["POST /api/common_parameters\n{\n \"common_parameter\": {\n \"name\": \"special_key\",\n \"value\": \"123\"\n }\n}\n200\n{\n \"common_parameter\": {\n \"name\": \"special_key\",\n \"value\": \"123\",\n \"id\": 767575239\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/common_parameters/update","name":"update","apis":[{"api_url":"/api/common_parameters/:id","http_method":"PUT","short_description":"Update a common_parameter"}],"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"},{"name":"common_parameter","full_name":"common_parameter","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"name","full_name":"common_parameter[name]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"value","full_name":"common_parameter[value]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}]}],"examples":["PUT /api/common_parameters/636252244\n{\n \"common_parameter\": {}\n}\n200\n{\n \"common_parameter\": {\n \"name\": \"test\",\n \"value\": \"myvalue\",\n \"id\": 636252244\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/common_parameters/destroy","name":"destroy","apis":[{"api_url":"/api/common_parameters/:id","http_method":"DELETE","short_description":"Delete a common_parameter"}],"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"}],"examples":["DELETE /api/common_parameters/636252244\n200\n{\n \"common_parameter\": {\n \"name\": \"test\",\n \"value\": \"myvalue\",\n \"id\": 636252244\n }\n}"],"see":[]}]},"dashboard":{"doc_url":"/apidoc/v2/dashboard","api_url":"/api","name":"Dashboard","short_description":null,"full_description":null,"version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/dashboard/index","name":"index","apis":[{"api_url":"/api/dashboard","http_method":"GET","short_description":"Get Dashboard results"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"<p>filter results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["GET /api/dashboard\n200\n{\n \"disabled_hosts\": 0,\n \"ok_hosts\": 0,\n \"good_hosts\": 0,\n \"active_hosts_ok\": 0,\n \"pending_hosts_enabled\": 0,\n \"active_hosts_ok_enabled\": 0,\n \"good_hosts_enabled\": 0,\n \"active_hosts\": 0,\n \"percentage\": 0,\n \"out_of_sync_hosts\": 0,\n \"total_hosts\": 12,\n \"bad_hosts\": 0,\n \"out_of_sync_hosts_enabled\": 0,\n \"pending_hosts\": 0,\n \"bad_hosts_enabled\": 0,\n \"ok_hosts_enabled\": 0,\n \"reports_missing\": 12\n}"],"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,"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."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"page","full_name":"page","description":"<p>paginate results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"per_page","full_name":"per_page","description":"<p>number of entries per request</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["GET /api/template_kinds\n200\n[\n {\n \"template_kind\": {\n \"name\": \"PXELinux\",\n \"id\": 452984334\n }\n },\n {\n \"template_kind\": {\n \"name\": \"script\",\n \"id\": 478250810\n }\n },\n {\n \"template_kind\": {\n \"name\": \"gPXE\",\n \"id\": 158998239\n }\n },\n {\n \"template_kind\": {\n \"name\": \"finish\",\n \"id\": 550103832\n }\n },\n {\n \"template_kind\": {\n \"name\": \"provision\",\n \"id\": 983253650\n }\n }\n]"],"see":[]}]},"bookmarks":{"doc_url":"/apidoc/v2/bookmarks","api_url":"/api","name":"Bookmarks","short_description":null,"full_description":null,"version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/bookmarks/index","name":"index","apis":[{"api_url":"/api/bookmarks","http_method":"GET","short_description":"List all bookmarks."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"page","full_name":"page","description":"<p>paginate results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"per_page","full_name":"per_page","description":"<p>number of entries per request</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["GET /api/bookmarks\n200\n[\n {\n \"bookmark\": {\n \"name\": \"bar\",\n \"query\": \"bar=car\",\n \"id\": 298486374,\n \"owner_id\": null,\n \"public\": false,\n \"controller\": \"hosts\",\n \"owner_type\": null\n }\n },\n {\n \"bookmark\": {\n \"name\": \"foo\",\n \"query\": \"foo=boo\",\n \"id\": 980190962,\n \"owner_id\": null,\n \"public\": true,\n \"controller\": \"hosts\",\n \"owner_type\": null\n }\n }\n]"],"see":[]},{"doc_url":"/apidoc/v2/bookmarks/show","name":"show","apis":[{"api_url":"/api/bookmarks/:id","http_method":"GET","short_description":"Show a bookmark."}],"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"}],"examples":["GET /api/bookmarks/foo\n200\n{\n \"bookmark\": {\n \"name\": \"foo\",\n \"query\": \"foo=boo\",\n \"id\": 980190962,\n \"owner_id\": null,\n \"public\": true,\n \"controller\": \"hosts\",\n \"owner_type\": null\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/bookmarks/create","name":"create","apis":[{"api_url":"/api/bookmarks","http_method":"POST","short_description":"Create a bookmark."}],"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","params":[{"name":"name","full_name":"bookmark[name]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"controller","full_name":"bookmark[controller]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"query","full_name":"bookmark[query]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"public","full_name":"bookmark[public]","description":"","required":false,"allow_nil":false,"validator":"Must be 'true' or 'false'","expected_type":"string"}]}],"examples":["POST /api/bookmarks\n{\n \"bookmark\": {\n \"query\": \"bar\",\n \"name\": \"foo-bar\",\n \"public\": false,\n \"controller\": \"hosts\"\n }\n}\n200\n{\n \"bookmark\": {\n \"name\": \"foo-bar\",\n \"query\": \"bar\",\n \"id\": 980190963,\n \"owner_id\": 886836129,\n \"public\": false,\n \"controller\": \"hosts\",\n \"owner_type\": \"User\"\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/bookmarks/update","name":"update","apis":[{"api_url":"/api/bookmarks/:id","http_method":"PUT","short_description":"Update a bookmark."}],"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"},{"name":"bookmark","full_name":"bookmark","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"name","full_name":"bookmark[name]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"controller","full_name":"bookmark[controller]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"query","full_name":"bookmark[query]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"public","full_name":"bookmark[public]","description":"","required":false,"allow_nil":false,"validator":"Must be 'true' or 'false'","expected_type":"string"}]}],"examples":["PUT /api/bookmarks/foo\n{\n \"bookmark\": {}\n}\n200\n{\n \"bookmark\": {\n \"name\": \"foo\",\n \"query\": \"foo=boo\",\n \"user\": {\n \"name\": \"apiadmin User\",\n \"login\": \"apiadmin\",\n \"email\": \"apiadmin@someware.com\"\n },\n \"id\": 980190962,\n \"public\": true,\n \"controller\": \"hosts\"\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/bookmarks/destroy","name":"destroy","apis":[{"api_url":"/api/bookmarks/:id","http_method":"DELETE","short_description":"Delete a bookmark."}],"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"}],"examples":["DELETE /api/bookmarks/foo\n200\n{\n \"bookmark\": {\n \"query\": \"foo=boo\",\n \"name\": \"foo\",\n \"id\": 980190962,\n \"public\": true,\n \"owner_id\": null,\n \"controller\": \"hosts\",\n \"owner_type\": null\n }\n}"],"see":[]}]},"users":{"doc_url":"/apidoc/v2/users","api_url":"/api","name":"Users","short_description":null,"full_description":null,"version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/users/index","name":"index","apis":[{"api_url":"/api/users","http_method":"GET","short_description":"List all users."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"<p>filter results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"order","full_name":"order","description":"<p>sort results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"page","full_name":"page","description":"<p>paginate results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"per_page","full_name":"per_page","description":"<p>number of entries per request</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["GET /api/users\n200\n[\n {\n \"user\": {\n \"domains_andor\": \"or\",\n \"filter_on_owner\": null,\n \"role_id\": null,\n \"mail\": \"admin@someware.com\",\n \"id\": 135138680,\n \"hostgroups_andor\": \"or\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"compute_resources_andor\": \"or\",\n \"admin\": true,\n \"last_login_on\": \"2009-10-12T21:50:04Z\",\n \"lastname\": \"User\",\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"login\": \"admin\",\n \"firstname\": \"Admin\",\n \"facts_andor\": \"or\",\n \"auth_source_id\": 980190962\n }\n },\n {\n \"user\": {\n \"domains_andor\": \"or\",\n \"filter_on_owner\": null,\n \"role_id\": null,\n \"mail\": \"apiadmin@someware.com\",\n \"id\": 886836129,\n \"hostgroups_andor\": \"or\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"compute_resources_andor\": \"or\",\n \"admin\": true,\n \"last_login_on\": \"2009-10-12T21:50:04Z\",\n \"lastname\": \"User\",\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"login\": \"apiadmin\",\n \"firstname\": \"apiadmin\",\n \"facts_andor\": \"or\",\n \"auth_source_id\": 200482051\n }\n },\n {\n \"user\": {\n \"domains_andor\": \"or\",\n \"filter_on_owner\": null,\n \"role_id\": null,\n \"mail\": \"userone@someware.com\",\n \"id\": 980190962,\n \"hostgroups_andor\": \"or\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"compute_resources_andor\": \"or\",\n \"admin\": false,\n \"last_login_on\": \"2009-10-12T21:50:04Z\",\n \"lastname\": \"User\",\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"login\": \"one\",\n \"firstname\": \"One\",\n \"facts_andor\": \"or\",\n \"auth_source_id\": 980190962\n }\n },\n {\n \"user\": {\n \"domains_andor\": \"or\",\n \"filter_on_owner\": null,\n \"role_id\": null,\n \"mail\": \"testuser@someware.com\",\n \"id\": 200482051,\n \"hostgroups_andor\": \"or\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"compute_resources_andor\": \"or\",\n \"admin\": false,\n \"last_login_on\": \"2009-10-12T21:50:04Z\",\n \"lastname\": \"User\",\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"login\": \"test\",\n \"firstname\": \"test\",\n \"facts_andor\": \"or\",\n \"auth_source_id\": 200482051\n }\n },\n {\n \"user\": {\n \"domains_andor\": \"or\",\n \"filter_on_owner\": null,\n \"role_id\": null,\n \"mail\": \"usertwo@someware.com\",\n \"id\": 298486374,\n \"hostgroups_andor\": \"or\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"compute_resources_andor\": \"or\",\n \"admin\": false,\n \"last_login_on\": \"2009-10-12T21:50:04Z\",\n \"lastname\": \"User\",\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"login\": \"two\",\n \"firstname\": \"Two\",\n \"facts_andor\": \"or\",\n \"auth_source_id\": 980190962\n }\n }\n]"],"see":[]},{"doc_url":"/apidoc/v2/users/show","name":"show","apis":[{"api_url":"/api/users/:id","http_method":"GET","short_description":"Show an user."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["GET /api/users/980190962-one\n200\n{\n \"user\": {\n \"domains_andor\": \"or\",\n \"filter_on_owner\": null,\n \"roles\": [\n {\n \"role\": {\n \"name\": \"Viewer\",\n \"id\": 5,\n \"builtin\": 0,\n \"permissions\": [\n \"view_architectures\",\n \"view_audit_logs\",\n \"view_authenticators\",\n \"access_dashboard\",\n \"view_domains\",\n \"view_environments\",\n \"view_external_variables\",\n \"view_facts\",\n \"view_globals\",\n \"view_hostgroups\",\n \"view_hosts\",\n \"view_locations\",\n \"view_media\",\n \"view_models\",\n \"view_operatingsystems\",\n \"view_ptables\",\n \"view_puppetclasses\",\n \"view_reports\",\n \"access_settings\",\n \"view_statistics\",\n \"view_organizations\",\n \"view_usergroups\",\n \"view_users\"\n ]\n }\n },\n {\n \"role\": {\n \"name\": \"Anonymous\",\n \"id\": 7,\n \"builtin\": 2,\n \"permissions\": [\n \"view_hosts\"\n ]\n }\n }\n ],\n \"role_id\": null,\n \"auth_source_ldap\": {\n \"name\": \"ldap\",\n \"tls\": true,\n \"attr_login\": \"uid\",\n \"attr_firstname\": \"givenName\",\n \"port\": 123,\n \"attr_lastname\": \"sn\",\n \"id\": 980190962,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"attr_mail\": \"mail\",\n \"base_dn\": \"dn=x,dn=y\",\n \"host\": \"ldap\",\n \"account\": null,\n \"type\": \"AuthSourceLdap\",\n \"onthefly_register\": true,\n \"created_at\": \"2012-12-18T15:24:43Z\"\n },\n \"mail\": \"userone@someware.com\",\n \"id\": 980190962,\n \"hostgroups_andor\": \"or\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"compute_resources_andor\": \"or\",\n \"admin\": false,\n \"last_login_on\": \"2009-10-12T21:50:04Z\",\n \"lastname\": \"User\",\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"login\": \"one\",\n \"firstname\": \"One\",\n \"facts_andor\": \"or\",\n \"auth_source_id\": 980190962\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/users/create","name":"create","apis":[{"api_url":"/api/users","http_method":"POST","short_description":"Create an user."}],"formats":null,"full_description":"<p>Adds role &#8216;Anonymous&#8217; to the user by default</p>","errors":[],"params":[{"name":"user","full_name":"user","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"login","full_name":"user[login]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"firstname","full_name":"user[firstname]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"lastname","full_name":"user[lastname]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"mail","full_name":"user[mail]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"admin","full_name":"user[admin]","description":"<p>Is an admin account?</p>","required":false,"allow_nil":false,"validator":"Must be 'true' or 'false'","expected_type":"string"},{"name":"password","full_name":"user[password]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"auth_source_id","full_name":"user[auth_source_id]","description":"","required":true,"allow_nil":false,"validator":"Must be Integer","expected_type":"numeric"}]}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/users/update","name":"update","apis":[{"api_url":"/api/users/:id","http_method":"PUT","short_description":"Update an user."}],"formats":null,"full_description":"<p>Adds role &#8216;Anonymous&#8217; to the user if it is not already present. Only admin can set admin account.</p>","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"user","full_name":"user","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"login","full_name":"user[login]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"firstname","full_name":"user[firstname]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string"},{"name":"lastname","full_name":"user[lastname]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string"},{"name":"mail","full_name":"user[mail]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"admin","full_name":"user[admin]","description":"<p>Is an admin account?</p>","required":false,"allow_nil":false,"validator":"Must be 'true' or 'false'","expected_type":"string"},{"name":"password","full_name":"user[password]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}]}],"examples":["PUT /api/users/980190963\n{\n \"user\": {\n \"password_confirmation\": \"DUMMY\",\n \"password\": \"dummy\",\n \"login\": \"johnsmith\"\n }\n}\n422\n{\n \"user\": {\n \"id\": 980190963,\n \"errors\": {\n \"password\": [\n \"doesn't match confirmation\"\n ]\n },\n \"full_messages\": [\n \"Password doesn't match confirmation\"\n ]\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/users/destroy","name":"destroy","apis":[{"api_url":"/api/users/:id","http_method":"DELETE","short_description":"Delete an user."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["DELETE /api/users/980190962\n200\n{\n \"user\": {\n \"filter_on_owner\": null,\n \"domains_andor\": \"or\",\n \"role_id\": null,\n \"organizations_andor\": \"or\",\n \"mail\": \"userone@someware.com\",\n \"id\": 980190962,\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"hostgroups_andor\": \"or\",\n \"compute_resources_andor\": \"or\",\n \"admin\": false,\n \"password_hash\": null,\n \"last_login_on\": \"2009-10-12T21:50:04Z\",\n \"locations_andor\": \"or\",\n \"lastname\": \"User\",\n \"password_salt\": null,\n \"login\": \"one\",\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"firstname\": \"One\",\n \"facts_andor\": \"or\",\n \"auth_source_id\": 980190962\n }\n}"],"see":[]}]},"environments":{"doc_url":"/apidoc/v2/environments","api_url":"/api","name":"Environments","short_description":null,"full_description":null,"version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/environments/index","name":"index","apis":[{"api_url":"/api/environments","http_method":"GET","short_description":"List all environments."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"<p>Filter results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"order","full_name":"order","description":"<p>Sort results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"page","full_name":"page","description":"<p>paginate results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"per_page","full_name":"per_page","description":"<p>number of entries per request</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["GET /api/environments\n200\n[\n {\n \"environment\": {\n \"name\": \"global_puppetmaster\",\n \"id\": 153855663,\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"created_at\": \"2012-12-18T15:24:42Z\"\n }\n },\n {\n \"environment\": {\n \"name\": \"production\",\n \"id\": 334344675,\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"created_at\": \"2012-12-18T15:24:42Z\"\n }\n },\n {\n \"environment\": {\n \"name\": \"testing\",\n \"id\": 687036937,\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"created_at\": \"2012-12-18T15:24:42Z\"\n }\n }\n]"],"see":[]},{"doc_url":"/apidoc/v2/environments/show","name":"show","apis":[{"api_url":"/api/environments/:id","http_method":"GET","short_description":"Show an environment."}],"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"}],"examples":["GET /api/environments/production\n200\n{\n \"environment\": {\n \"name\": \"production\",\n \"id\": 334344675,\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"created_at\": \"2012-12-18T15:24:42Z\"\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/environments/create","name":"create","apis":[{"api_url":"/api/environments","http_method":"POST","short_description":"Create an environment."}],"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","params":[{"name":"name","full_name":"environment[name]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"}]}],"examples":["POST /api/environments\n{\n \"environment\": {\n \"name\": \"Development\"\n }\n}\n200\n{\n \"environment\": {\n \"name\": \"Development\",\n \"id\": 687036938,\n \"updated_at\": \"2012-12-18T15:24:46Z\",\n \"created_at\": \"2012-12-18T15:24:46Z\"\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/environments/update","name":"update","apis":[{"api_url":"/api/environments/:id","http_method":"PUT","short_description":"Update an environment."}],"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"},{"name":"environment","full_name":"environment","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"name","full_name":"environment[name]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}]}],"examples":["PUT /api/environments/production\n{\n \"environment\": {}\n}\n200\n{\n \"environment\": {\n \"name\": \"production\",\n \"id\": 334344675\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/environments/destroy","name":"destroy","apis":[{"api_url":"/api/environments/:id","http_method":"DELETE","short_description":"Delete an environment."}],"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"}],"examples":["DELETE /api/environments/testing\n200\n{\n \"environment\": {\n \"name\": \"testing\",\n \"id\": 687036937\n }\n}"],"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,"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 authsource ldaps"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"page","full_name":"page","description":"<p>paginate results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"per_page","full_name":"per_page","description":"<p>number of entries per request</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["GET /api/auth_source_ldaps\n200\n[\n {\n \"auth_source_ldap\": {\n \"name\": \"ldap\",\n \"attr_lastname\": \"sn\",\n \"port\": 123,\n \"attr_firstname\": \"givenName\",\n \"attr_login\": \"uid\",\n \"tls\": true,\n \"id\": 980190962,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"host\": \"ldap\",\n \"base_dn\": \"dn=x,dn=y\",\n \"attr_mail\": \"mail\",\n \"account\": null,\n \"type\": \"AuthSourceLdap\",\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"onthefly_register\": true\n }\n }\n]"],"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 authsource ldap."}],"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"}],"examples":["GET /api/auth_source_ldaps/980190962\n200\n{\n \"auth_source_ldap\": {\n \"name\": \"ldap\",\n \"attr_lastname\": \"sn\",\n \"attr_firstname\": \"givenName\",\n \"port\": 123,\n \"attr_login\": \"uid\",\n \"tls\": true,\n \"id\": 980190962,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"host\": \"ldap\",\n \"base_dn\": \"dn=x,dn=y\",\n \"attr_mail\": \"mail\",\n \"account\": null,\n \"type\": \"AuthSourceLdap\",\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"onthefly_register\": true\n }\n}"],"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 auth_source_ldap."}],"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","params":[{"name":"name","full_name":"auth_source_ldap[name]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"host","full_name":"auth_source_ldap[host]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"port","full_name":"auth_source_ldap[port]","description":"<p>defaults to 389</p>","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"account","full_name":"auth_source_ldap[account]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"base_dn","full_name":"auth_source_ldap[base_dn]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"account_password","full_name":"auth_source_ldap[account_password]","description":"<p>required if onthefly_register is true</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"attr_login","full_name":"auth_source_ldap[attr_login]","description":"<p>required if onthefly_register is true</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"attr_firstname","full_name":"auth_source_ldap[attr_firstname]","description":"<p>required if onthefly_register is true</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"attr_lastname","full_name":"auth_source_ldap[attr_lastname]","description":"<p>required if onthefly_register is true</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"attr_mail","full_name":"auth_source_ldap[attr_mail]","description":"<p>required if onthefly_register is true</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"onthefly_register","full_name":"auth_source_ldap[onthefly_register]","description":"","required":false,"allow_nil":false,"validator":"Must be 'true' or 'false'","expected_type":"string"},{"name":"tls","full_name":"auth_source_ldap[tls]","description":"","required":false,"allow_nil":false,"validator":"Must be 'true' or 'false'","expected_type":"string"}]}],"examples":["POST /api/auth_source_ldaps\n{\n \"auth_source_ldap\": {\n \"name\": \"ldap2\",\n \"host\": \"ldap2\"\n }\n}\n201\n{\n \"auth_source_ldap\": {\n \"name\": \"ldap2\",\n \"tls\": false,\n \"port\": 389,\n \"attr_login\": null,\n \"attr_lastname\": null,\n \"attr_firstname\": null,\n \"id\": 980190963,\n \"updated_at\": \"2012-12-18T15:24:44Z\",\n \"host\": \"ldap2\",\n \"base_dn\": null,\n \"attr_mail\": null,\n \"account_password\": null,\n \"account\": null,\n \"onthefly_register\": false,\n \"created_at\": \"2012-12-18T15:24:44Z\"\n }\n}"],"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 auth_source_ldap."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"auth_source_ldap","full_name":"auth_source_ldap","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"name","full_name":"auth_source_ldap[name]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"host","full_name":"auth_source_ldap[host]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"port","full_name":"auth_source_ldap[port]","description":"<p>defaults to 389</p>","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"account","full_name":"auth_source_ldap[account]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"base_dn","full_name":"auth_source_ldap[base_dn]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"account_password","full_name":"auth_source_ldap[account_password]","description":"<p>required if onthefly_register is true</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"attr_login","full_name":"auth_source_ldap[attr_login]","description":"<p>required if onthefly_register is true</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"attr_firstname","full_name":"auth_source_ldap[attr_firstname]","description":"<p>required if onthefly_register is true</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"attr_lastname","full_name":"auth_source_ldap[attr_lastname]","description":"<p>required if onthefly_register is true</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"attr_mail","full_name":"auth_source_ldap[attr_mail]","description":"<p>required if onthefly_register is true</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"onthefly_register","full_name":"auth_source_ldap[onthefly_register]","description":"","required":false,"allow_nil":false,"validator":"Must be 'true' or 'false'","expected_type":"string"},{"name":"tls","full_name":"auth_source_ldap[tls]","description":"","required":false,"allow_nil":false,"validator":"Must be 'true' or 'false'","expected_type":"string"}]}],"examples":["PUT /api/auth_source_ldaps/980190962\n{\n \"auth_source_ldap\": {}\n}\n200\n{\n \"auth_source_ldap\": {\n \"name\": \"ldap\",\n \"tls\": true,\n \"port\": 123,\n \"attr_login\": \"uid\",\n \"attr_lastname\": \"sn\",\n \"attr_firstname\": \"givenName\",\n \"id\": 980190962,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"host\": \"ldap\",\n \"base_dn\": \"dn=x,dn=y\",\n \"attr_mail\": \"mail\",\n \"account_password\": null,\n \"account\": null,\n \"onthefly_register\": true,\n \"created_at\": \"2012-12-18T15:24:43Z\"\n }\n}"],"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 auth_source_ldap."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["DELETE /api/auth_source_ldaps/980190962\n200\n{\n \"auth_source_ldap\": {\n \"name\": \"ldap\",\n \"tls\": true,\n \"port\": 123,\n \"attr_login\": \"uid\",\n \"attr_lastname\": \"sn\",\n \"attr_firstname\": \"givenName\",\n \"id\": 980190962,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"host\": \"ldap\",\n \"base_dn\": \"dn=x,dn=y\",\n \"attr_mail\": \"mail\",\n \"account_password\": null,\n \"account\": null,\n \"onthefly_register\": true,\n \"created_at\": \"2012-12-18T15:24:43Z\"\n }\n}"],"see":[]}]},"media":{"doc_url":"/apidoc/v2/media","api_url":"/api","name":"Media","short_description":null,"full_description":null,"version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/media/index","name":"index","apis":[{"api_url":"/api/media","http_method":"GET","short_description":"List all media."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"<p>filter results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"order","full_name":"order","description":"<p>for example, name ASC, or name DESC</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"page","full_name":"page","description":"<p>paginate results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"per_page","full_name":"per_page","description":"<p>number of entries per request</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["GET /api/media\n200\n[\n {\n \"medium\": {\n \"name\": \"CentOS 5.4\",\n \"id\": 980190962,\n \"path\": \"http://mirror.averse.net/centos/6.0/os/$arch\"\n }\n },\n {\n \"medium\": {\n \"name\": \"OpenSuse Mirror\",\n \"id\": 859751735,\n \"path\": \"http://mirror.isoc.org.il/pub/opensuse/distribution/$major.$minor/repo/oss\"\n }\n },\n {\n \"medium\": {\n \"name\": \"Solaris 10\",\n \"id\": 442321401,\n \"path\": \"http://brsla01/vol/solgi_5.10/sol$minor_$release_$arch\"\n }\n },\n {\n \"medium\": {\n \"name\": \"Ubuntu Mirror\",\n \"id\": 1011586618,\n \"path\": \"http://sg.archive.ubuntu.com\"\n }\n },\n {\n \"medium\": {\n \"name\": \"unused\",\n \"id\": 338446587,\n \"path\": \"http://nothing.intersting.com\"\n }\n }\n]"],"see":[]},{"doc_url":"/apidoc/v2/media/show","name":"show","apis":[{"api_url":"/api/media/:id","http_method":"GET","short_description":"Show a medium."}],"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"}],"examples":["GET /api/media/980190962\n200\n{\n \"medium\": {\n \"name\": \"CentOS 5.4\",\n \"id\": 980190962,\n \"path\": \"http://mirror.averse.net/centos/6.0/os/$arch\"\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/media/create","name":"create","apis":[{"api_url":"/api/media","http_method":"POST","short_description":"Create a medium."}],"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","params":[{"name":"name","full_name":"medium[name]","description":"<p>Name of media</p>","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"path","full_name":"medium[path]","description":"<p>The path to the medium, can be a URL or a valid NFS server (exclusive of the architecture).</p>\n\n<p>for example http://mirror.averse.net/centos/$version/os/$arch where $arch will be substituted for the host&#8217;s actual OS architecture and $version, $major and $minor will be substituted for the version of the operating system.</p>\n\n<p>Solaris and Debian media may also use $release.</p>","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"os_family","full_name":"medium[os_family]","description":"<p>The family that the operating system belongs to.</p>\n\n<p>Available families:</p>\n\n<ul>\n<li>Archlinux</li>\n\n<li>Debian</li>\n\n<li>Gentoo</li>\n\n<li>Redhat</li>\n\n<li>Solaris</li>\n\n<li>Suse</li>\n\n<li>Windows</li>\n</ul>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}]}],"examples":["POST /api/media\n{\n \"medium\": {\n \"name\": \"new medium\",\n \"path\": \"http://www.newmedium.com/\"\n }\n}\n201\n{\n \"medium\": {\n \"name\": \"new medium\",\n \"id\": 1011586619\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/media/update","name":"update","apis":[{"api_url":"/api/media/:id","http_method":"PUT","short_description":"Update a medium."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"medium","full_name":"medium","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"name","full_name":"medium[name]","description":"<p>Name of media</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"path","full_name":"medium[path]","description":"<p>The path to the medium, can be a URL or a valid NFS server (exclusive of the architecture).</p>\n\n<p>for example http://mirror.averse.net/centos/$version/os/$arch where $arch will be substituted for the host&#8217;s actual OS architecture and $version, $major and $minor will be substituted for the version of the operating system.</p>\n\n<p>Solaris and Debian media may also use $release.</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"os_family","full_name":"medium[os_family]","description":"<p>The family that the operating system belongs to.</p>\n\n<p>Available families:</p>\n\n<ul>\n<li>Archlinux</li>\n\n<li>Debian</li>\n\n<li>Gentoo</li>\n\n<li>Redhat</li>\n\n<li>Solaris</li>\n\n<li>Suse</li>\n\n<li>Windows</li>\n</ul>","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string"}]}],"examples":["PUT /api/media/980190962\n{\n \"name\": \"CentOS 5.4\"\n}\n200\n{\n \"medium\": {\n \"name\": \"CentOS 5.4\",\n \"id\": 980190962\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/media/destroy","name":"destroy","apis":[{"api_url":"/api/media/:id","http_method":"DELETE","short_description":"Delete a medium."}],"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"}],"examples":["DELETE /api/media/338446587\n200\n{\n \"medium\": {\n \"name\": \"unused\",\n \"id\": 338446587\n }\n}"],"see":[]}]},"lookup_keys":{"doc_url":"/apidoc/v2/lookup_keys","api_url":"/api","name":"Lookup keys","short_description":null,"full_description":null,"version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/lookup_keys/index","name":"index","apis":[{"api_url":"/api/lookup_keys","http_method":"GET","short_description":"List all lookup_keys."},{"api_url":"/api/hosts/:host_id/lookup_keys","http_method":"GET","short_description":"List all lookup_keys of a given host."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"<p>filter results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"order","full_name":"order","description":"<p>sort results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"page","full_name":"page","description":"<p>paginate results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"per_page","full_name":"per_page","description":"<p>number of entries per request</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["GET /api/lookup_keys\n200\n[\n {\n \"lookup_key\": {\n \"id\": 980190962,\n \"required\": false,\n \"description\": null,\n \"key\": \"port\",\n \"is_param\": true,\n \"override\": false,\n \"default_value\": \"80\"\n }\n },\n {\n \"lookup_key\": {\n \"id\": 113629430,\n \"required\": false,\n \"description\": null,\n \"key\": \"ssl\",\n \"is_param\": true,\n \"override\": true,\n \"default_value\": \"t\"\n }\n },\n {\n \"lookup_key\": {\n \"id\": 298486374,\n \"required\": false,\n \"description\": null,\n \"key\": \"ssl_port\",\n \"is_param\": false,\n \"override\": false,\n \"default_value\": \"443\"\n }\n }\n]"],"see":[]},{"doc_url":"/apidoc/v2/lookup_keys/show","name":"show","apis":[{"api_url":"/api/lookup_keys/:id","http_method":"GET","short_description":"Show a lookup key."}],"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"}],"examples":["GET /api/lookup_keys/980190962-port\n200\n{\n \"lookup_key\": {\n \"id\": 980190962,\n \"required\": false,\n \"description\": null,\n \"key\": \"port\",\n \"is_param\": true,\n \"override\": false,\n \"default_value\": \"80\"\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/lookup_keys/create","name":"create","apis":[{"api_url":"/api/lookup_keys","http_method":"POST","short_description":"Create a lookup key."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"lookup_key","full_name":"lookup_key","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"key","full_name":"lookup_key[key]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"puppetclass_id","full_name":"lookup_key[puppetclass_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"default_value","full_name":"lookup_key[default_value]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"path","full_name":"lookup_key[path]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"description","full_name":"lookup_key[description]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"lookup_values_count","full_name":"lookup_key[lookup_values_count]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"}]}],"examples":["POST /api/lookup_keys\n{\n \"lookup_key\": {\n \"is_param\": true,\n \"key\": \"testkey\"\n }\n}\n201\n{\n \"lookup_key\": {\n \"required\": false,\n \"id\": 980190963,\n \"description\": null,\n \"key\": \"testkey\",\n \"is_param\": true,\n \"override\": false,\n \"default_value\": null\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/lookup_keys/update","name":"update","apis":[{"api_url":"/api/lookup_keys/:id","http_method":"PUT","short_description":"Update a lookup key."}],"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"},{"name":"lookup_key","full_name":"lookup_key","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"key","full_name":"lookup_key[key]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"puppetclass_id","full_name":"lookup_key[puppetclass_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"default_value","full_name":"lookup_key[default_value]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"path","full_name":"lookup_key[path]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"description","full_name":"lookup_key[description]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"lookup_values_count","full_name":"lookup_key[lookup_values_count]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"}]}],"examples":["PUT /api/lookup_keys/980190962-port\n{\n \"lookup_key\": {\n \"default_value\": 8080\n }\n}\n200\n{\n \"lookup_key\": {\n \"required\": false,\n \"id\": 980190962,\n \"description\": null,\n \"key\": \"port\",\n \"is_param\": true,\n \"override\": false,\n \"default_value\": 8080\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/lookup_keys/destroy","name":"destroy","apis":[{"api_url":"/api/lookup_keys/:id","http_method":"DELETE","short_description":"Delete a lookup key."}],"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"}],"examples":["DELETE /api/lookup_keys/980190962-port\n200\n{\n \"lookup_key\": {\n \"required\": false,\n \"id\": 980190962,\n \"description\": null,\n \"key\": \"port\",\n \"is_param\": true,\n \"override\": false,\n \"default_value\": \"80\"\n }\n}"],"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,"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."},{"api_url":"/api/hosts/:host_id/facts","http_method":"GET","short_description":"List all fact values of a given host."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"<p>filter results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"order","full_name":"order","description":"<p>sort results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"page","full_name":"page","description":"<p>paginate results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"per_page","full_name":"per_page","description":"<p>number of entries per request</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["GET /api/hosts/my5name.mydomain.net/facts\n200\n{\n \"my5name.mydomain.net\": {\n \"ipaddress\": \"10.0.19.33\",\n \"kernelversion\": \"2.6.9\"\n }\n}"],"see":[]}]},"domains":{"doc_url":"/apidoc/v2/domains","api_url":"/api","name":"Domains","short_description":null,"full_description":"<p>Foreman 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 <i>hostname</i>.<b>somewhere.com</b> then the domain is <b>somewhere.com</b>. 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.</p>","version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/domains/index","name":"index","apis":[{"api_url":"/api/domains","http_method":"GET","short_description":"List of domains"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"<p>Filter results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"order","full_name":"order","description":"<p>Sort results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"page","full_name":"page","description":"<p>paginate results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"per_page","full_name":"per_page","description":"<p>number of entries per request</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["GET /api/domains\n200\n[\n {\n \"domain\": {\n \"name\": \"mydomain.net\",\n \"id\": 22495316,\n \"dns_id\": 113629430,\n \"fullname\": null,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"created_at\": \"2012-12-18T15:24:43Z\"\n }\n },\n {\n \"domain\": {\n \"name\": \"unused.net\",\n \"id\": 759776763,\n \"dns_id\": 113629430,\n \"fullname\": \"somewhare that is never used\",\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"created_at\": \"2012-12-18T15:24:43Z\"\n }\n },\n {\n \"domain\": {\n \"name\": \"useless.net\",\n \"id\": 229305443,\n \"dns_id\": null,\n \"fullname\": null,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"created_at\": \"2012-12-18T15:24:43Z\"\n }\n },\n {\n \"domain\": {\n \"name\": \"yourdomain.net\",\n \"id\": 589326610,\n \"dns_id\": 113629430,\n \"fullname\": \"somewhere in yourdomain\",\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"created_at\": \"2012-12-18T15:24:43Z\"\n }\n }\n]"],"see":[]},{"doc_url":"/apidoc/v2/domains/show","name":"show","apis":[{"api_url":"/api/domains/:id","http_method":"GET","short_description":"Show a domain."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"<p>May be numerical id or domain name</p>","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"}],"examples":["GET /api/domains/mydomain.net\n200\n{\n \"domain\": {\n \"name\": \"mydomain.net\",\n \"id\": 22495316,\n \"dns_id\": 113629430,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"fullname\": null,\n \"created_at\": \"2012-12-18T15:24:43Z\"\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/domains/create","name":"create","apis":[{"api_url":"/api/domains","http_method":"POST","short_description":"Create a domain."}],"formats":null,"full_description":"<p>The <b>fullname</b> field is used for human readability in reports and other pages that refer to domains, and also available as an external node parameter</p>","errors":[],"params":[{"name":"domain","full_name":"domain","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"name","full_name":"domain[name]","description":"<p>The full DNS Domain name</p>","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"fullname","full_name":"domain[fullname]","description":"<p>Full name describing the domain</p>","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string"},{"name":"dns_id","full_name":"domain[dns_id]","description":"<p>DNS Proxy to use within this domain</p>","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string"},{"name":"domain_parameters_attributes","full_name":"domain[domain_parameters_attributes]","description":"<p>Array of parameters (name, value)</p>","required":false,"allow_nil":false,"validator":"Must be Array","expected_type":"string"}]}],"examples":["POST /api/domains\n{\n \"domain\": {\n \"name\": \"domain.net\"\n }\n}\n201\n{\n \"domain\": {\n \"name\": \"domain.net\",\n \"id\": 759776764\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/domains/update","name":"update","apis":[{"api_url":"/api/domains/:id","http_method":"PUT","short_description":"Update a domain."}],"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"},{"name":"domain","full_name":"domain","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"name","full_name":"domain[name]","description":"<p>The full DNS Domain name</p>","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string"},{"name":"fullname","full_name":"domain[fullname]","description":"<p>Full name describing the domain</p>","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string"},{"name":"dns_id","full_name":"domain[dns_id]","description":"<p>DNS Proxy to use within this domain</p>","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string"},{"name":"domain_parameters_attributes","full_name":"domain[domain_parameters_attributes]","description":"<p>Array of parameters (name, value)</p>","required":false,"allow_nil":false,"validator":"Must be Array","expected_type":"string"}]}],"examples":["PUT /api/domains/mydomain.net\n{\n \"domain\": {\n \"name\": \"\"\n }\n}\n422\n{\n \"domain\": {\n \"id\": 22495316,\n \"errors\": {\n \"name\": [\n \"can't be blank\"\n ]\n },\n \"full_messages\": [\n \"Name can't be blank\"\n ]\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/domains/destroy","name":"destroy","apis":[{"api_url":"/api/domains/:id","http_method":"DELETE","short_description":"Delete a domain."}],"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"}],"examples":["DELETE /api/domains/mydomain.net\n200\n{\n \"domain\": {\n \"name\": \"mydomain.net\",\n \"id\": 22495316\n }\n}"],"see":[]}]},"usergroups":{"doc_url":"/apidoc/v2/usergroups","api_url":"/api","name":"Usergroups","short_description":null,"full_description":null,"version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/usergroups/index","name":"index","apis":[{"api_url":"/api/usergroups","http_method":"GET","short_description":"List all usergroups."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"page","full_name":"page","description":"<p>paginate results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"per_page","full_name":"per_page","description":"<p>number of entries per request</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"search","full_name":"search","description":"<p>filter results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"order","full_name":"order","description":"<p>sort results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["GET /api/usergroups\n200\n[\n {\n \"usergroup\": {\n \"name\": \"MyString\",\n \"id\": 980190962,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"created_at\": \"2012-12-18T15:24:43Z\"\n }\n },\n {\n \"usergroup\": {\n \"name\": \"MyString2\",\n \"id\": 298486374,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"created_at\": \"2012-12-18T15:24:43Z\"\n }\n }\n]"],"see":[]},{"doc_url":"/apidoc/v2/usergroups/show","name":"show","apis":[{"api_url":"/api/usergroups/:id","http_method":"GET","short_description":"Show a usergroup."}],"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"}],"examples":["GET /api/usergroups/980190962\n200\n{\n \"usergroup\": {\n \"name\": \"MyString\",\n \"id\": 980190962,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"created_at\": \"2012-12-18T15:24:43Z\"\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/usergroups/create","name":"create","apis":[{"api_url":"/api/usergroups","http_method":"POST","short_description":"Create a usergroup."}],"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","params":[{"name":"name","full_name":"usergroup[name]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"}]}],"examples":["POST /api/usergroups\n{\n \"usergroup\": {\n \"name\": \"test_usergroup\"\n }\n}\n201\n{\n \"usergroup\": {\n \"name\": \"test_usergroup\",\n \"id\": 980190963\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/usergroups/update","name":"update","apis":[{"api_url":"/api/usergroups/:id","http_method":"PUT","short_description":"Update a usergroup."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"usergroup","full_name":"usergroup","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"name","full_name":"usergroup[name]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}]}],"examples":["PUT /api/usergroups/980190962\n{\n \"usergroup\": {}\n}\n200\n{\n \"usergroup\": {\n \"name\": \"MyString\",\n \"id\": 980190962\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/usergroups/destroy","name":"destroy","apis":[{"api_url":"/api/usergroups/:id","http_method":"DELETE","short_description":"Delete a usergroup."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["DELETE /api/usergroups/980190962\n200\n{\n \"usergroup\": {\n \"name\": \"MyString\",\n \"id\": 980190962\n }\n}"],"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,"methods":[{"doc_url":"/apidoc/v2/config_templates/index","name":"index","apis":[{"api_url":"/api/config_templates","http_method":"GET","short_description":"List templates"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"<p>filter results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"order","full_name":"order","description":"<p>sort results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"page","full_name":"page","description":"<p>paginate results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"per_page","full_name":"per_page","description":"<p>number of entries per request</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["GET /api/config_templates\n200\n[\n {\n \"config_template\": {\n \"name\": \"centos5_3_pxelinux\",\n \"audit_comment\": null,\n \"id\": 1007981701,\n \"snippet\": null,\n \"template\": \"default linux~label linux~kernel <%= @kernel %>~append initrd=<%= @initrd %> ks=<%= foreman_url(\\\"kickstart\\\")%> ksdevice=bootif network kssendmac\",\n \"template_kind\": {\n \"name\": \"PXELinux\",\n \"id\": 452984334\n }\n }\n },\n {\n \"config_template\": {\n \"name\": \"MyFinish\",\n \"audit_comment\": null,\n \"id\": 104314179,\n \"snippet\": null,\n \"template\": \"MyFinish\",\n \"template_kind\": {\n \"name\": \"finish\",\n \"id\": 550103832\n }\n }\n },\n {\n \"config_template\": {\n \"name\": \"MyScript\",\n \"audit_comment\": null,\n \"id\": 981457253,\n \"snippet\": null,\n \"template\": \"MyText\",\n \"template_kind\": {\n \"name\": \"script\",\n \"id\": 478250810\n }\n }\n },\n {\n \"config_template\": {\n \"name\": \"MyString\",\n \"audit_comment\": null,\n \"id\": 943779058,\n \"snippet\": null,\n \"template\": \"MyText\",\n \"template_kind\": {\n \"name\": \"gPXE\",\n \"id\": 158998239\n }\n }\n },\n {\n \"config_template\": {\n \"name\": \"MyString2\",\n \"audit_comment\": null,\n \"id\": 269958254,\n \"snippet\": null,\n \"template\": \"MyText\",\n \"template_kind\": {\n \"name\": \"provision\",\n \"id\": 983253650\n }\n }\n },\n {\n \"config_template\": {\n \"name\": \"PXE Default File\",\n \"audit_comment\": null,\n \"id\": 352050261,\n \"snippet\": null,\n \"template\": \"default linux~label linux~kernel <%= @kernel %>~append initrd=<%= @initrd %> ksdevice=bootif network kssendmac\",\n \"template_kind\": {\n \"name\": \"PXELinux\",\n \"id\": 452984334\n }\n }\n },\n {\n \"config_template\": {\n \"name\": \"PXE Default Menu\",\n \"audit_comment\": null,\n \"id\": 684651467,\n \"\": null,\n \"snippet\": null,\n \"template\": \"FOO\"\n }\n },\n {\n \"config_template\": {\n \"name\": \"PXE Localboot Default\",\n \"audit_comment\": null,\n \"id\": 821548108,\n \"snippet\": null,\n \"template\": \"DEFAULT menu~PROMPT 0~MENU TITLE PXE Menu~TIMEOUT 200~TOTALTIMEOUT 6000~ONTIMEOUT local~~LABEL local~MENU LABEL (local)~MENU DEFAULT~LOCALBOOT 0\",\n \"template_kind\": {\n \"name\": \"PXELinux\",\n \"id\": 452984334\n }\n }\n }\n]"],"see":[]},{"doc_url":"/apidoc/v2/config_templates/show","name":"show","apis":[{"api_url":"/api/config_templates/:id","http_method":"GET","short_description":"Show template details"}],"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"}],"examples":["GET /api/config_templates/centos5_3_pxelinux\n200\n{\n \"config_template\": {\n \"name\": \"centos5_3_pxelinux\",\n \"id\": 1007981701,\n \"audit_comment\": null,\n \"snippet\": null,\n \"template\": \"default linux~label linux~kernel <%= @kernel %>~append initrd=<%= @initrd %> ks=<%= foreman_url(\\\"kickstart\\\")%> ksdevice=bootif network kssendmac\",\n \"template_kind\": {\n \"name\": \"PXELinux\",\n \"id\": 452984334\n }\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/config_templates/create","name":"create","apis":[{"api_url":"/api/config_templates","http_method":"POST","short_description":"Create a template"}],"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","params":[{"name":"name","full_name":"config_template[name]","description":"<p>template name</p>","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"template","full_name":"config_template[template]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"snippet","full_name":"config_template[snippet]","description":"","required":false,"allow_nil":true,"validator":"Must be 'true' or 'false'","expected_type":"string"},{"name":"audit_comment","full_name":"config_template[audit_comment]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string"},{"name":"template_kind_id","full_name":"config_template[template_kind_id]","description":"<p>not relevant for snippet</p>","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string"},{"name":"template_combinations_attributes","full_name":"config_template[template_combinations_attributes]","description":"<p>Array of template combinations (hostgroup_id, environment_id)</p>","required":false,"allow_nil":false,"validator":"Must be Array","expected_type":"string"},{"name":"operatingsystem_ids","full_name":"config_template[operatingsystem_ids]","description":"<p>Array of operating systems ID to associate the template with</p>","required":false,"allow_nil":false,"validator":"Must be Array","expected_type":"string"}]}],"examples":["POST /api/config_templates\n{\n \"config_template\": {\n \"name\": \"RandomName\",\n \"template\": \"This is a test template\",\n \"template_kind_id\": 1\n }\n}\n200\n{\n \"config_template\": {\n \"name\": \"RandomName\",\n \"audit_comment\": null,\n \"id\": 1007981702,\n \"\": null,\n \"snippet\": null,\n \"template\": \"This is a test template\"\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/config_templates/update","name":"update","apis":[{"api_url":"/api/config_templates/:id","http_method":"PUT","short_description":"Update a template"}],"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"},{"name":"config_template","full_name":"config_template","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"name","full_name":"config_template[name]","description":"<p>template name</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"template","full_name":"config_template[template]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"snippet","full_name":"config_template[snippet]","description":"","required":false,"allow_nil":false,"validator":"Must be 'true' or 'false'","expected_type":"string"},{"name":"audit_comment","full_name":"config_template[audit_comment]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string"},{"name":"template_kind_id","full_name":"config_template[template_kind_id]","description":"<p>not relevant for snippet</p>","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string"},{"name":"template_combinations_attributes","full_name":"config_template[template_combinations_attributes]","description":"<p>Array of template combinations (hostgroup_id, environment_id)</p>","required":false,"allow_nil":false,"validator":"Must be Array","expected_type":"string"},{"name":"operatingsystem_ids","full_name":"config_template[operatingsystem_ids]","description":"<p>Array of operating systems ID to associate the template with</p>","required":false,"allow_nil":false,"validator":"Must be Array","expected_type":"string"}]}],"examples":["PUT /api/config_templates/centos5_3_pxelinux\n{\n \"config_template\": {\n \"audit_comment\": \"aha\",\n \"template\": \"tmp\"\n }\n}\n200\n{\n \"config_template\": {\n \"name\": \"centos5_3_pxelinux\",\n \"id\": 1007981701,\n \"template\": \"tmp\",\n \"snippet\": null,\n \"template_kind\": {\n \"name\": \"PXELinux\",\n \"id\": 452984334\n }\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/config_templates/revision","name":"revision","apis":[{"api_url":"/api/config_templates/revision","http_method":"GET","short_description":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"version","full_name":"version","description":"<p>template version</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/config_templates/destroy","name":"destroy","apis":[{"api_url":"/api/config_templates/:id","http_method":"DELETE","short_description":"Delete a template"}],"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"}],"examples":["DELETE /api/config_templates/centos5_3_pxelinux\n200\n{\n \"config_template\": {\n \"name\": \"centos5_3_pxelinux\",\n \"id\": 1007981701,\n \"template\": \"default linux~label linux~kernel <%= @kernel %>~append initrd=<%= @initrd %> ks=<%= foreman_url(\\\"kickstart\\\")%> ksdevice=bootif network kssendmac\",\n \"snippet\": null,\n \"template_kind\": {\n \"name\": \"PXELinux\",\n \"id\": 452984334\n }\n }\n}"],"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":"GET","short_description":"Change the default PXE menu on all configured TFTP servers"}],"formats":null,"full_description":"","errors":[],"params":[],"examples":["GET /api/config_templates/build_pxe_default\n200\nPXE Default file has been deployed to all Smart Proxies"],"see":[]}]},"subnets":{"doc_url":"/apidoc/v2/subnets","api_url":"/api","name":"Subnets","short_description":null,"full_description":null,"version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/subnets/index","name":"index","apis":[{"api_url":"/api/subnets","http_method":"GET","short_description":"List of subnets"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"<p>Filter results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"order","full_name":"order","description":"<p>Sort results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"page","full_name":"page","description":"<p>paginate results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"per_page","full_name":"per_page","description":"<p>number of entries per request</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["GET /api/subnets\n200\n[\n {\n \"subnet\": {\n \"priority\": null,\n \"name\": \"one\",\n \"network\": \"2.3.4.0\",\n \"dns_secondary\": null,\n \"domain_ids\": [\n 822172901\n ],\n \"tftp_id\": 298486374,\n \"id\": 980190962,\n \"dhcp_id\": 980190962,\n \"dns_id\": 113629430,\n \"dns_primary\": null,\n \"vlanid\": \"41\",\n \"mask\": \"255.255.255.0\",\n \"from\": null,\n \"gateway\": null,\n \"to\": null\n }\n },\n {\n \"subnet\": {\n \"priority\": null,\n \"name\": \"two\",\n \"network\": \"3.3.4.0\",\n \"dns_secondary\": null,\n \"domain_ids\": [\n 534821992\n ],\n \"tftp_id\": 298486374,\n \"id\": 298486374,\n \"dhcp_id\": 980190962,\n \"dns_id\": null,\n \"dns_primary\": null,\n \"vlanid\": \"42\",\n \"mask\": \"255.255.255.0\",\n \"from\": null,\n \"gateway\": null,\n \"to\": null\n }\n },\n {\n \"subnet\": {\n \"priority\": null,\n \"name\": \"three\",\n \"network\": \"3.3.4.3\",\n \"dns_secondary\": null,\n \"domain_ids\": [],\n \"tftp_id\": 298486374,\n \"id\": 113629430,\n \"dhcp_id\": 980190962,\n \"dns_id\": null,\n \"dns_primary\": null,\n \"vlanid\": \"43\",\n \"mask\": \"255.255.255.0\",\n \"from\": null,\n \"gateway\": null,\n \"to\": null\n }\n }\n]"],"see":[]},{"doc_url":"/apidoc/v2/subnets/show","name":"show","apis":[{"api_url":"/api/subnets/:id","http_method":"GET","short_description":"Show a subnet."}],"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"}],"examples":["GET /api/subnets/980190962\n200\n{\n \"subnet\": {\n \"priority\": null,\n \"name\": \"one\",\n \"network\": \"2.3.4.0\",\n \"dns\": {\n \"url\": \"http://else.where:4567\",\n \"name\": \"DNS Proxy\",\n \"id\": 113629430\n },\n \"dns_secondary\": null,\n \"domain_ids\": [\n 822172901\n ],\n \"tftp_id\": 298486374,\n \"id\": 980190962,\n \"dhcp_id\": 980190962,\n \"dns_id\": 113629430,\n \"dhcp\": {\n \"url\": \"https://somewhere.net:8443\",\n \"name\": \"DHCP Proxy\",\n \"id\": 980190962\n },\n \"dns_primary\": null,\n \"vlanid\": \"41\",\n \"mask\": \"255.255.255.0\",\n \"tftp\": {\n \"url\": \"http://somewhere.else\",\n \"name\": \"TFTP Proxy\",\n \"id\": 298486374\n },\n \"from\": null,\n \"gateway\": null,\n \"to\": null\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/subnets/create","name":"create","apis":[{"api_url":"/api/subnets","http_method":"POST","short_description":"Create a subnet"}],"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","params":[{"name":"name","full_name":"subnet[name]","description":"<p>Subnet name</p>","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"network","full_name":"subnet[network]","description":"<p>Subnet network</p>","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"mask","full_name":"subnet[mask]","description":"<p>Netmask for this subnet</p>","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"gateway","full_name":"subnet[gateway]","description":"<p>Primary DNS for this subnet</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"dns_primary","full_name":"subnet[dns_primary]","description":"<p>Primary DNS for this subnet</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"dns_secondary","full_name":"subnet[dns_secondary]","description":"<p>Secondary DNS for this subnet</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"from","full_name":"subnet[from]","description":"<p>Starting IP Address for IP auto suggestion</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"to","full_name":"subnet[to]","description":"<p>Ending IP Address for IP auto suggestion</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"vlanid","full_name":"subnet[vlanid]","description":"<p>VLAN ID for this subnet</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"domain_ids","full_name":"subnet[domain_ids]","description":"<p>Domains in which this subnet is part</p>","required":false,"allow_nil":false,"validator":"Must be Array","expected_type":"string"},{"name":"dhcp_id","full_name":"subnet[dhcp_id]","description":"<p>DHCP Proxy to use within this subnet</p>","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"tftp_id","full_name":"subnet[tftp_id]","description":"<p>TFTP Proxy to use within this subnet</p>","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"dns_id","full_name":"subnet[dns_id]","description":"<p>DNS Proxy to use within this subnet</p>","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"}]}],"examples":["POST /api/subnets\n{\n \"subnet\": {\n \"name\": \"QA2\",\n \"network\": \"10.35.2.27\",\n \"mask\": \"255.255.255.0\"\n }\n}\n200\n{\n \"subnet\": {\n \"priority\": null,\n \"name\": \"QA2\",\n \"dns\": null,\n \"network\": \"10.35.2.27\",\n \"dns_secondary\": null,\n \"domain_ids\": [],\n \"id\": 980190963,\n \"tftp_id\": null,\n \"dhcp_id\": null,\n \"dns_id\": null,\n \"dhcp\": null,\n \"dns_primary\": null,\n \"vlanid\": null,\n \"mask\": \"255.255.255.0\",\n \"tftp\": null,\n \"gateway\": null,\n \"from\": null,\n \"to\": null\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/subnets/update","name":"update","apis":[{"api_url":"/api/subnets/:id","http_method":"PUT","short_description":"Update a subnet"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"<p>Subnet numeric identifier</p>","required":true,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"subnet","full_name":"subnet","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"name","full_name":"subnet[name]","description":"<p>Subnet name</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"network","full_name":"subnet[network]","description":"<p>Subnet network</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"mask","full_name":"subnet[mask]","description":"<p>Netmask for this subnet</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"gateway","full_name":"subnet[gateway]","description":"<p>Primary DNS for this subnet</p>","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string"},{"name":"dns_primary","full_name":"subnet[dns_primary]","description":"<p>Primary DNS for this subnet</p>","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string"},{"name":"dns_secondary","full_name":"subnet[dns_secondary]","description":"<p>Secondary DNS for this subnet</p>","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string"},{"name":"from","full_name":"subnet[from]","description":"<p>Starting IP Address for IP auto suggestion</p>","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string"},{"name":"to","full_name":"subnet[to]","description":"<p>Ending IP Address for IP auto suggestion</p>","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string"},{"name":"vlanid","full_name":"subnet[vlanid]","description":"<p>VLAN ID for this subnet</p>","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string"},{"name":"domain_ids","full_name":"subnet[domain_ids]","description":"<p>Domains in which this subnet is part</p>","required":false,"allow_nil":true,"validator":"Must be Array","expected_type":"string"},{"name":"dhcp_id","full_name":"subnet[dhcp_id]","description":"<p>DHCP Proxy to use within this subnet</p>","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string"},{"name":"tftp_id","full_name":"subnet[tftp_id]","description":"<p>TFTP Proxy to use within this subnet</p>","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string"},{"name":"dns_id","full_name":"subnet[dns_id]","description":"<p>DNS Proxy to use within this subnet</p>","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string"}]}],"examples":["PUT /api/subnets/980190962\n{\n \"subnet\": {}\n}\n200\n{\n \"subnet\": {\n \"priority\": null,\n \"name\": \"one\",\n \"dns\": {\n \"url\": \"http://else.where:4567\",\n \"name\": \"DNS Proxy\",\n \"id\": 113629430\n },\n \"network\": \"2.3.4.0\",\n \"dns_secondary\": null,\n \"domain_ids\": [\n 822172901\n ],\n \"id\": 980190962,\n \"tftp_id\": 298486374,\n \"dhcp_id\": 980190962,\n \"dns_id\": 113629430,\n \"dhcp\": {\n \"url\": \"https://somewhere.net:8443\",\n \"name\": \"DHCP Proxy\",\n \"id\": 980190962\n },\n \"dns_primary\": null,\n \"vlanid\": \"41\",\n \"mask\": \"255.255.255.0\",\n \"tftp\": {\n \"url\": \"http://somewhere.else\",\n \"name\": \"TFTP Proxy\",\n \"id\": 298486374\n },\n \"gateway\": null,\n \"from\": null,\n \"to\": null\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/subnets/destroy","name":"destroy","apis":[{"api_url":"/api/subnets/:id","http_method":"DELETE","short_description":"Delete a subnet"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"<p>Subnet numeric identifier</p>","required":true,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"}],"examples":["DELETE /api/subnets/980190962\n422\n{\n \"subnet\": {\n \"id\": 980190962,\n \"errors\": {\n \"base\": [\n \"2.3.4.0/24 is used by temp-01.yourdomain.net\",\n \"2.3.4.0/24 is used by suse01.yourdomain.net\",\n \"2.3.4.0/24 is used by temp01.yourdomain.net\",\n \"2.3.4.0/24 is used by anotherfullhost\",\n \"2.3.4.0/24 is used by temp.yourdomain.net\",\n \"2.3.4.0/24 is used by my5name.mydomain.net\",\n \"2.3.4.0/24 is used by dhcp.mydomain.net\",\n \"2.3.4.0/24 is used by otherfullhost\",\n \"2.3.4.0/24 is used by sdhcp.mydomain.net\",\n \"2.3.4.0/24 is used by sol10host\",\n \"2.3.4.0/24 is used by sdhcp.mydomain.net\"\n ]\n },\n \"full_messages\": [\n \"2.3.4.0/24 is used by temp-01.yourdomain.net\",\n \"2.3.4.0/24 is used by suse01.yourdomain.net\",\n \"2.3.4.0/24 is used by temp01.yourdomain.net\",\n \"2.3.4.0/24 is used by anotherfullhost\",\n \"2.3.4.0/24 is used by temp.yourdomain.net\",\n \"2.3.4.0/24 is used by my5name.mydomain.net\",\n \"2.3.4.0/24 is used by dhcp.mydomain.net\",\n \"2.3.4.0/24 is used by otherfullhost\",\n \"2.3.4.0/24 is used by sdhcp.mydomain.net\",\n \"2.3.4.0/24 is used by sol10host\",\n \"2.3.4.0/24 is used by sdhcp.mydomain.net\"\n ]\n }\n}"],"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,"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."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"<p>filter results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"order","full_name":"order","description":"<p>sort results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"page","full_name":"page","description":"<p>paginate results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"per_page","full_name":"per_page","description":"<p>number of entries per request</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["GET /api/compute_resources\n200\n[\n {\n \"compute_resource\": {\n \"name\": \"mycompute\",\n \"url\": \"test:///default\",\n \"user\": \"MyString\",\n \"provider\": \"Libvirt\",\n \"id\": 367690737,\n \"description\": \"mycompute\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"created_at\": \"2012-12-18T15:24:42Z\"\n }\n },\n {\n \"compute_resource\": {\n \"name\": \"MyString\",\n \"url\": \"qemu://stam/system\",\n \"user\": \"MyString\",\n \"provider\": \"Libvirt\",\n \"id\": 980190962,\n \"description\": \"MyString\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"created_at\": \"2012-12-18T15:24:42Z\"\n }\n },\n {\n \"compute_resource\": {\n \"name\": \"yourcompute\",\n \"url\": \"test:///default\",\n \"user\": \"MyString\",\n \"provider\": \"Libvirt\",\n \"id\": 932571420,\n \"description\": \"yourcompute\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"created_at\": \"2012-12-18T15:24:42Z\"\n }\n }\n]"],"see":[]},{"doc_url":"/apidoc/v2/compute_resources/show","name":"show","apis":[{"api_url":"/api/compute_resources/:id","http_method":"GET","short_description":"Show an compute resource."}],"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"}],"examples":["GET /api/compute_resources/980190962-mystring\n200\n{\n \"compute_resource\": {\n \"name\": \"MyString\",\n \"url\": \"qemu://stam/system\",\n \"user\": \"MyString\",\n \"provider\": \"Libvirt\",\n \"id\": 980190962,\n \"description\": \"MyString\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"created_at\": \"2012-12-18T15:24:42Z\"\n }\n}"],"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."}],"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","params":[{"name":"name","full_name":"compute_resource[name]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"provider","full_name":"compute_resource[provider]","description":"<p>Providers include Libvirt, Ovirt, EC2, Vmware, Openstack, Rackspace</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"url","full_name":"compute_resource[url]","description":"<p>URL for Libvirt, Ovirt, and Openstack</p>","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"description","full_name":"compute_resource[description]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"user","full_name":"compute_resource[user]","description":"<p>Username for Ovirt, EC2, Vmware, Openstack. Access Key for EC2.</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"password","full_name":"compute_resource[password]","description":"<p>Password for Ovirt, EC2, Vmware, Openstack. Secret key for EC2</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"uuid","full_name":"compute_resource[uuid]","description":"<p>for Ovirt, Vmware Datacenter</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"region","full_name":"compute_resource[region]","description":"<p>for EC2 only</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"tenant","full_name":"compute_resource[tenant]","description":"<p>for Openstack only</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"server","full_name":"compute_resource[server]","description":"<p>for Vmware</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}]}],"examples":["POST /api/compute_resources\n{\n \"compute_resource\": {\n \"name\": \"special_compute\",\n \"user\": \"user@example.com\",\n \"provider\": \"EC2\",\n \"password\": \"secret\",\n \"region\": \"eu-west-1\"\n }\n}\n200\n{\n \"compute_resource\": {\n \"name\": \"special_compute\",\n \"url\": \"eu-west-1\",\n \"user\": \"user@example.com\",\n \"provider\": \"EC2\",\n \"id\": 980190963,\n \"description\": null,\n \"updated_at\": \"2012-12-18T15:24:44Z\",\n \"created_at\": \"2012-12-18T15:24:44Z\"\n }\n}"],"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."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"compute_resource","full_name":"compute_resource","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"name","full_name":"compute_resource[name]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"provider","full_name":"compute_resource[provider]","description":"<p>Providers include Libvirt, Ovirt, EC2, Vmware, Openstack, Rackspace</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"url","full_name":"compute_resource[url]","description":"<p>URL for Libvirt, Ovirt, and Openstack</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"description","full_name":"compute_resource[description]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"user","full_name":"compute_resource[user]","description":"<p>Username for Ovirt, EC2, Vmware, Openstack. Access Key for EC2.</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"password","full_name":"compute_resource[password]","description":"<p>Password for Ovirt, EC2, Vmware, Openstack. Secret key for EC2</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"uuid","full_name":"compute_resource[uuid]","description":"<p>for Ovirt, Vmware Datacenter</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"region","full_name":"compute_resource[region]","description":"<p>for EC2 only</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"tenant","full_name":"compute_resource[tenant]","description":"<p>for Openstack only</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"server","full_name":"compute_resource[server]","description":"<p>for Vmware</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}]}],"examples":["PUT /api/compute_resources/367690737-mycompute\n{\n \"compute_resource\": {\n \"description\": \"new_description\"\n }\n}\n200\n{\n \"compute_resource\": {\n \"url\": \"test:///default\",\n \"name\": \"mycompute\",\n \"user\": \"MyString\",\n \"id\": 367690737,\n \"uuid\": \"mycompute\",\n \"updated_at\": \"2012-12-18T15:24:45Z\",\n \"description\": \"new_description\",\n \"attrs\": {},\n \"created_at\": \"2012-12-18T15:24:42Z\"\n }\n}"],"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."}],"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"}],"examples":["DELETE /api/compute_resources/932571420\n200\n{\n \"compute_resource\": {\n \"url\": \"test:///default\",\n \"name\": \"yourcompute\",\n \"user\": \"MyString\",\n \"id\": 932571420,\n \"uuid\": \"yourcompute\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"description\": \"yourcompute\",\n \"attrs\": null,\n \"created_at\": \"2012-12-18T15:24:42Z\"\n }\n}"],"see":[]}]},"ptables":{"doc_url":"/apidoc/v2/ptables","api_url":"/api","name":"Ptables","short_description":null,"full_description":null,"version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/ptables/index","name":"index","apis":[{"api_url":"/api/ptables","http_method":"GET","short_description":"List all ptables."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"<p>filter results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"order","full_name":"order","description":"<p>sort results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"page","full_name":"page","description":"<p>paginate results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"per_page","full_name":"per_page","description":"<p>number of entries per request</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["GET /api/ptables\n200\n[\n {\n \"ptable\": {\n \"name\": \"default\",\n \"id\": 980190962,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"created_at\": \"2012-12-18T15:24:43Z\"\n }\n },\n {\n \"ptable\": {\n \"name\": \"four\",\n \"id\": 281110143,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"created_at\": \"2012-12-18T15:24:43Z\"\n }\n },\n {\n \"ptable\": {\n \"name\": \"suse default\",\n \"id\": 859751735,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"created_at\": \"2012-12-18T15:24:43Z\"\n }\n },\n {\n \"ptable\": {\n \"name\": \"ubuntu default\",\n \"id\": 1011586618,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"created_at\": \"2012-12-18T15:24:43Z\"\n }\n }\n]"],"see":[]},{"doc_url":"/apidoc/v2/ptables/show","name":"show","apis":[{"api_url":"/api/ptables/:id","http_method":"GET","short_description":"Show a ptable."}],"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"}],"examples":["GET /api/ptables/980190962\n200\n{\n \"ptable\": {\n \"name\": \"default\",\n \"id\": 980190962,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"created_at\": \"2012-12-18T15:24:43Z\"\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/ptables/create","name":"create","apis":[{"api_url":"/api/ptables","http_method":"POST","short_description":"Create a ptable."}],"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","params":[{"name":"name","full_name":"ptable[name]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"layout","full_name":"ptable[layout]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"os_family","full_name":"ptable[os_family]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}]}],"examples":["POST /api/ptables\n{\n \"ptable\": {\n \"name\": \"ptable_test\",\n \"layout\": \"d-i partman-auto/disk\"\n }\n}\n201\n{\n \"ptable\": {\n \"name\": \"ptable_test\",\n \"id\": 1011586619\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/ptables/update","name":"update","apis":[{"api_url":"/api/ptables/:id","http_method":"PUT","short_description":"Update a ptable."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"ptable","full_name":"ptable","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"name","full_name":"ptable[name]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"layout","full_name":"ptable[layout]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"os_family","full_name":"ptable[os_family]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}]}],"examples":["PUT /api/ptables/980190962\n{\n \"ptable\": {}\n}\n200\n{\n \"ptable\": {\n \"name\": \"default\",\n \"id\": 980190962\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/ptables/destroy","name":"destroy","apis":[{"api_url":"/api/ptables/:id","http_method":"DELETE","short_description":"Delete a ptable."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["DELETE /api/ptables/980190962\n422\n{\n \"ptable\": {\n \"id\": 980190962,\n \"errors\": {\n \"base\": [\n \"default is used by temp01.yourdomain.net\",\n \"default is used by temp.yourdomain.net\",\n \"default is used by my5name.mydomain.net\",\n \"default is used by dhcp.mydomain.net\",\n \"default is used by sdhcp.mydomain.net\"\n ]\n },\n \"full_messages\": [\n \"default is used by temp01.yourdomain.net\",\n \"default is used by temp.yourdomain.net\",\n \"default is used by my5name.mydomain.net\",\n \"default is used by dhcp.mydomain.net\",\n \"default is used by sdhcp.mydomain.net\"\n ]\n }\n}"],"see":[]}]},"home":{"doc_url":"/apidoc/v2/home","api_url":"/api","name":"Home","short_description":null,"full_description":null,"version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/home/index","name":"index","apis":[{"api_url":"/api","http_method":"GET","short_description":"Show available links."}],"formats":null,"full_description":"","errors":[],"params":[],"examples":["GET /api\n200\n{\n \"links\": {\n \"List all hosts\": \"/api/hosts\",\n \"List all compute resources\": \"/api/compute_resources\",\n \"List of subnets\": \"/api/subnets\",\n \"List all fact values\": \"/api/fact_values\",\n \"List all authsource ldaps\": \"/api/auth_source_ldaps\",\n \"List all settings\": \"/api/settings\",\n \"List of domains\": \"/api/domains\",\n \"List all operating systems\": \"/api/operatingsystems\",\n \"List all images for compute resource\": \"/api/compute_resources/:compute_resource_id/images\",\n \"List all smart_proxies\": \"/api/smart_proxies\",\n \"List all models\": \"/api/models\",\n \"List templates\": \"/api/config_templates\",\n \"List all architectures\": \"/api/architectures\",\n \"List all hostgroups\": \"/api/hostgroups\",\n \"List all environments\": \"/api/environments\",\n \"List all ptables\": \"/api/ptables\",\n \"List all users\": \"/api/users\",\n \"List all usergroups\": \"/api/usergroups\",\n \"List all common parameters\": \"/api/common_parameters\",\n \"List all puppetclasses\": \"/api/puppetclasses\",\n \"Show status\": \"/api/status\",\n \"List all media\": \"/api/media\",\n \"List all bookmarks\": \"/api/bookmarks\",\n \"List all template kinds\": \"/api/template_kinds\",\n \"Get Dashboard results\": \"/api/dashboard\",\n \"List all reports\": \"/api/reports\",\n \"Show available links\": \"/api\",\n \"List all lookup_keys\": \"/api/lookup_keys\",\n \"List all roles\": \"/api/roles\",\n \"List all audits\": \"/api/audits\"\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/home/status","name":"status","apis":[{"api_url":"/api/status","http_method":"GET","short_description":"Show status."}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"see":[]}]},"organizations":{"doc_url":"/apidoc/v2/organizations","api_url":"/api","name":"Organizations","short_description":null,"full_description":null,"version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/organizations/index","name":"index","apis":[{"api_url":"/api/organizations","http_method":"GET","short_description":"List all organizations"}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/organizations/show","name":"show","apis":[{"api_url":"/api/organizations/:id","http_method":"GET","short_description":"Show an organization"}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/organizations/create","name":"create","apis":[{"api_url":"/api/organizations","http_method":"POST","short_description":"Create an organization"}],"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","params":[{"name":":name","full_name":"organization[:name]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"}]}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/organizations/update","name":"update","apis":[{"api_url":"/api/organizations/:id","http_method":"PUT","short_description":"Update an organization"}],"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","params":[{"name":":name","full_name":"organization[:name]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}]}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/organizations/destroy","name":"destroy","apis":[{"api_url":"/api/organizations/:id","http_method":"DELETE","short_description":"Delete an organization"}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"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,"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 puppetclass id's for hostgroup"}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"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 puppetclass to hostgroup"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"hostgroup_id","full_name":"hostgroup_id","description":"<p>id of hostgroup</p>","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"puppetclass_id","full_name":"puppetclass_id","description":"<p>id of puppetclass</p>","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":[],"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 puppetclass from hostgroup"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"hostgroup_id","full_name":"hostgroup_id","description":"<p>id of hostgroup</p>","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"puppetclass_id","full_name":"puppetclass_id","description":"<p>id of puppetclass</p>","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":[],"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,"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"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"config_template_id","full_name":"config_template_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"}],"examples":[],"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"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"config_template_id","full_name":"config_template_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"},{"name":"template_combination","full_name":"template_combination","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"environment_id","full_name":"template_combination[environment_id]","description":"<p>environment id</p>","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string"},{"name":"hostgroup_id","full_name":"template_combination[hostgroup_id]","description":"<p>hostgroup id</p>","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string"}]}],"examples":[],"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"}],"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"}],"examples":[],"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"}],"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"}],"examples":[],"see":[]}]},"locations":{"doc_url":"/apidoc/v2/locations","api_url":"/api","name":"Locations","short_description":null,"full_description":null,"version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/locations/index","name":"index","apis":[{"api_url":"/api/locations","http_method":"GET","short_description":"List all locations"}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/locations/show","name":"show","apis":[{"api_url":"/api/locations/:id","http_method":"GET","short_description":"Show a location"}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/locations/create","name":"create","apis":[{"api_url":"/api/locations","http_method":"POST","short_description":"Create a location"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"locations","full_name":"locations","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":":name","full_name":"locations[:name]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"}]}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/locations/update","name":"update","apis":[{"api_url":"/api/locations/:id","http_method":"PUT","short_description":"Update a location"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"locations","full_name":"locations","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":":name","full_name":"locations[:name]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}]}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/locations/destroy","name":"destroy","apis":[{"api_url":"/api/locations/:id","http_method":"DELETE","short_description":"Delete a location"}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"see":[]}]},"parameters":{"doc_url":"/apidoc/v2/parameters","api_url":"/api","name":"Parameters","short_description":null,"full_description":"<p>These API calls are related to <b>nested parameters for host, domain, hostgroup, operating system</b>. If you are looking for <a href='common_parameters.html'>global parameters</a>, go to <a href='common_parameters.html'>this link</a>.</p>","version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/parameters/index","name":"index","apis":[{"api_url":"/api/host/:host_id/parameters","http_method":"GET","short_description":"List all parameters for host"},{"api_url":"/api/hostgroup/:hostgroup_id/parameters","http_method":"GET","short_description":"List all parameters for hostgroup"},{"api_url":"/api/domain/:domain_id/parameters","http_method":"GET","short_description":"List all parameters for domain"},{"api_url":"/api/operatingsystem/:operatingsystem_id/parameters","http_method":"GET","short_description":"List all parameters for operating system"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"<p>id of host</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"<p>id of hostgroup</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"domain_id","full_name":"domain_id","description":"<p>id of domain</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"<p>id of operating system</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"page","full_name":"page","description":"<p>paginate results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"per_page","full_name":"per_page","description":"<p>number of entries per request</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/parameters/show","name":"show","apis":[{"api_url":"/api/host/:host_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for host"},{"api_url":"/api/hostgroup/:hostgroup_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for hostgroup"},{"api_url":"/api/domain/:domain_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for domain"},{"api_url":"/api/operatingsystem/:operatingsystem_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for operating system"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"<p>id of host</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"<p>id of hostgroup</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"domain_id","full_name":"domain_id","description":"<p>id of domain</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"<p>id of operating system</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"id","full_name":"id","description":"<p>id of parameter</p>","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/parameters/create","name":"create","apis":[{"api_url":"/api/host/:host_id/parameters/:id","http_method":"POST","short_description":"Create a nested parameter for host"},{"api_url":"/api/hostgroup/:hostgroup_id/parameters/:id","http_method":"POST","short_description":"Create a nested parameter for hostgroup"},{"api_url":"/api/domain/:domain_id/parameters/:id","http_method":"POST","short_description":"Create a nested parameter for domain"},{"api_url":"/api/operatingsystem/:operatingsystem_id/parameters/:id","http_method":"POST","short_description":"Create a nested parameter for operating system"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"<p>id of host</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"<p>id of hostgroup</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"domain_id","full_name":"domain_id","description":"<p>id of domain</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"<p>id of operating system</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"id","full_name":"id","description":"<p>id of parameter</p>","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"parameter","full_name":"parameter","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"name","full_name":"parameter[name]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"value","full_name":"parameter[value]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}]}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/parameters/update","name":"update","apis":[{"api_url":"/api/host/:host_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for host"},{"api_url":"/api/hostgroup/:hostgroup_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for hostgroup"},{"api_url":"/api/domain/:domain_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for domain"},{"api_url":"/api/operatingsystem/:operatingsystem_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for operating system"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"<p>id of host</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"<p>id of hostgroup</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"domain_id","full_name":"domain_id","description":"<p>id of domain</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"<p>id of operating system</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"id","full_name":"id","description":"<p>id of parameter</p>","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"parameter","full_name":"parameter","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"name","full_name":"parameter[name]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"value","full_name":"parameter[value]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}]}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/parameters/destroy","name":"destroy","apis":[{"api_url":"/api/host/:host_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for host"},{"api_url":"/api/hostgroup/:hostgroup_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for hostgroup"},{"api_url":"/api/domain/:domain_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for domain"},{"api_url":"/api/operatingsystem/:operatingsystem_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for operating system"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"<p>id of host</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"<p>id of hostgroup</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"domain_id","full_name":"domain_id","description":"<p>id of domain</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"<p>id of operating system</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"id","full_name":"id","description":"<p>id of parameter</p>","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/parameters/reset","name":"reset","apis":[{"api_url":"/api/host/:host_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameters for host"},{"api_url":"/api/hostgroup/:hostgroup_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameters for hostgroup"},{"api_url":"/api/domain/:domain_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameters for domain"},{"api_url":"/api/operatingsystem/:operatingsystem_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameters for operating system"}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"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,"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 puppetclass id's for host"}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"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 puppetclass to host"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"<p>id of host</p>","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"puppetclass_id","full_name":"puppetclass_id","description":"<p>id of puppetclass</p>","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":[],"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 puppetclass from host"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"<p>id of host</p>","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"id","full_name":"id","description":"<p>id of puppetclass</p>","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":[],"see":[]}]}}}}
1
+ {"docs":{"name":"Foreman","info":"Another API description","copyright":"","doc_url":"/apidoc/v2","api_url":"/api","resources":{"roles":{"doc_url":"/apidoc/v2/roles","api_url":"/api","name":"Roles","short_description":null,"full_description":null,"version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/roles/index","name":"index","apis":[{"api_url":"/api/roles","http_method":"GET","short_description":"List all roles."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"page","full_name":"page","description":"<p>paginate results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"per_page","full_name":"per_page","description":"<p>number of entries per request</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/roles/show","name":"show","apis":[{"api_url":"/api/roles/:id","http_method":"GET","short_description":"Show an role."}],"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"}],"examples":["GET /api/roles/1\n200\n{\n \"role\": {\n \"name\": \"Manager\",\n \"id\": 1,\n \"builtin\": 0,\n \"permissions\": [\n \"view_architectures\",\n \"create_architectures\",\n \"edit_architectures\",\n \"destroy_architectures\",\n \"view_authenticators\",\n \"create_authenticators\",\n \"edit_authenticators\",\n \"destroy_authenticators\",\n \"view_environments\",\n \"create_environments\",\n \"edit_environments\",\n \"destroy_environments\",\n \"import_environments\",\n \"view_external_variables\",\n \"create_external_variables\",\n \"edit_external_variables\",\n \"destroy_external_variables\",\n \"view_domains\",\n \"create_domain\",\n \"edit_domains\",\n \"destroy_domains\",\n \"view_globals\",\n \"create_globals\",\n \"edit_globals\",\n \"destroy_globals\",\n \"view_hostgroups\",\n \"create_hostgroups\",\n \"edit_hostgroups\",\n \"destroy_hostgroups\",\n \"view_hosts\",\n \"create_hosts\",\n \"edit_hosts\",\n \"destroy_hosts\",\n \"view_media\",\n \"create_media\",\n \"edit_media\",\n \"destroy_media\",\n \"view_models\",\n \"create_models\",\n \"edit_models\",\n \"destroy_models\",\n \"view_operatingsystems\",\n \"create_operatingsystems\",\n \"edit_operatingsystems\",\n \"destroy_operatingsystems\",\n \"view_ptables\",\n \"create_ptables\",\n \"edit_ptables\",\n \"destroy_ptables\",\n \"view_puppetclasses\",\n \"create_puppetclasses\",\n \"edit_puppetclasses\",\n \"destroy_puppetclasses\",\n \"import_puppetclasses\",\n \"view_usergroups\",\n \"create_usergroups\",\n \"edit_usergroups\",\n \"destroy_usergroups\",\n \"view_users\",\n \"create_users\",\n \"edit_users\",\n \"destroy_users\",\n \"access_settings\",\n \"access_dashboard\",\n \"view_reports\",\n \"destroy_reports\",\n \"view_facts\",\n \"view_audit_logs\",\n \"view_statistics\",\n \"view_locations\",\n \"edit_locations\",\n \"create_locations\",\n \"destroy_locations\",\n \"view_organizations\",\n \"edit_organizations\",\n \"create_organizations\",\n \"destroy_organizations\"\n ]\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/roles/create","name":"create","apis":[{"api_url":"/api/roles","http_method":"POST","short_description":"Create an role."}],"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","params":[{"name":"name","full_name":"role[name]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"}]}],"examples":["POST /api/roles\n{\n \"role\": {\n \"name\": \"staff\"\n }\n}\n200\n{\n \"role\": {\n \"name\": \"staff\",\n \"id\": 11,\n \"builtin\": 0,\n \"permissions\": []\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/roles/update","name":"update","apis":[{"api_url":"/api/roles/:id","http_method":"PUT","short_description":"Update an role."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"role","full_name":"role","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"name","full_name":"role[name]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}]}],"examples":["PUT /api/roles/1\n{\n \"role\": {}\n}\n200\n{\n \"role\": {\n \"name\": \"Manager\",\n \"id\": 1,\n \"builtin\": 0,\n \"permissions\": [\n \"view_architectures\",\n \"create_architectures\",\n \"edit_architectures\",\n \"destroy_architectures\",\n \"view_authenticators\",\n \"create_authenticators\",\n \"edit_authenticators\",\n \"destroy_authenticators\",\n \"view_environments\",\n \"create_environments\",\n \"edit_environments\",\n \"destroy_environments\",\n \"import_environments\",\n \"view_external_variables\",\n \"create_external_variables\",\n \"edit_external_variables\",\n \"destroy_external_variables\",\n \"view_domains\",\n \"create_domain\",\n \"edit_domains\",\n \"destroy_domains\",\n \"view_globals\",\n \"create_globals\",\n \"edit_globals\",\n \"destroy_globals\",\n \"view_hostgroups\",\n \"create_hostgroups\",\n \"edit_hostgroups\",\n \"destroy_hostgroups\",\n \"view_hosts\",\n \"create_hosts\",\n \"edit_hosts\",\n \"destroy_hosts\",\n \"view_media\",\n \"create_media\",\n \"edit_media\",\n \"destroy_media\",\n \"view_models\",\n \"create_models\",\n \"edit_models\",\n \"destroy_models\",\n \"view_operatingsystems\",\n \"create_operatingsystems\",\n \"edit_operatingsystems\",\n \"destroy_operatingsystems\",\n \"view_ptables\",\n \"create_ptables\",\n \"edit_ptables\",\n \"destroy_ptables\",\n \"view_puppetclasses\",\n \"create_puppetclasses\",\n \"edit_puppetclasses\",\n \"destroy_puppetclasses\",\n \"import_puppetclasses\",\n \"view_usergroups\",\n \"create_usergroups\",\n \"edit_usergroups\",\n \"destroy_usergroups\",\n \"view_users\",\n \"create_users\",\n \"edit_users\",\n \"destroy_users\",\n \"access_settings\",\n \"access_dashboard\",\n \"view_reports\",\n \"destroy_reports\",\n \"view_facts\",\n \"view_audit_logs\",\n \"view_statistics\",\n \"view_locations\",\n \"edit_locations\",\n \"create_locations\",\n \"destroy_locations\",\n \"view_organizations\",\n \"edit_organizations\",\n \"create_organizations\",\n \"destroy_organizations\"\n ]\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/roles/destroy","name":"destroy","apis":[{"api_url":"/api/roles/:id","http_method":"DELETE","short_description":"Delete an role."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["DELETE /api/roles/1\n200\n{\n \"role\": {\n \"name\": \"Manager\",\n \"id\": 1,\n \"builtin\": 0,\n \"permissions\": [\n \"view_architectures\",\n \"create_architectures\",\n \"edit_architectures\",\n \"destroy_architectures\",\n \"view_authenticators\",\n \"create_authenticators\",\n \"edit_authenticators\",\n \"destroy_authenticators\",\n \"view_environments\",\n \"create_environments\",\n \"edit_environments\",\n \"destroy_environments\",\n \"import_environments\",\n \"view_external_variables\",\n \"create_external_variables\",\n \"edit_external_variables\",\n \"destroy_external_variables\",\n \"view_domains\",\n \"create_domain\",\n \"edit_domains\",\n \"destroy_domains\",\n \"view_globals\",\n \"create_globals\",\n \"edit_globals\",\n \"destroy_globals\",\n \"view_hostgroups\",\n \"create_hostgroups\",\n \"edit_hostgroups\",\n \"destroy_hostgroups\",\n \"view_hosts\",\n \"create_hosts\",\n \"edit_hosts\",\n \"destroy_hosts\",\n \"view_media\",\n \"create_media\",\n \"edit_media\",\n \"destroy_media\",\n \"view_models\",\n \"create_models\",\n \"edit_models\",\n \"destroy_models\",\n \"view_operatingsystems\",\n \"create_operatingsystems\",\n \"edit_operatingsystems\",\n \"destroy_operatingsystems\",\n \"view_ptables\",\n \"create_ptables\",\n \"edit_ptables\",\n \"destroy_ptables\",\n \"view_puppetclasses\",\n \"create_puppetclasses\",\n \"edit_puppetclasses\",\n \"destroy_puppetclasses\",\n \"import_puppetclasses\",\n \"view_usergroups\",\n \"create_usergroups\",\n \"edit_usergroups\",\n \"destroy_usergroups\",\n \"view_users\",\n \"create_users\",\n \"edit_users\",\n \"destroy_users\",\n \"access_settings\",\n \"access_dashboard\",\n \"view_reports\",\n \"destroy_reports\",\n \"view_facts\",\n \"view_audit_logs\",\n \"view_statistics\",\n \"view_locations\",\n \"edit_locations\",\n \"create_locations\",\n \"destroy_locations\",\n \"view_organizations\",\n \"edit_organizations\",\n \"create_organizations\",\n \"destroy_organizations\"\n ]\n }\n}"],"see":[]}]},"images":{"doc_url":"/apidoc/v2/images","api_url":"/api","name":"Images","short_description":null,"full_description":null,"version":"v2","formats":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 compute resource"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"<p>filter results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"order","full_name":"order","description":"<p>sort results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"page","full_name":"page","description":"<p>paginate results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"per_page","full_name":"per_page","description":"<p>number of entries per request</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"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"}],"examples":["GET /api/compute_resources/980190962/images\n200\n[\n {\n \"image\": {\n \"name\": \"centos-2\",\n \"id\": 298486374,\n \"uuid\": \"MyString2\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"operatingsystem_id\": 309172073,\n \"username\": \"MyString\",\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"architecture_id\": 501905019,\n \"compute_resource_id\": 980190962\n }\n },\n {\n \"image\": {\n \"name\": \"centos-1\",\n \"id\": 980190962,\n \"uuid\": \"string-of-uuid\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"operatingsystem_id\": 309172073,\n \"username\": \"root\",\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"architecture_id\": 501905019,\n \"compute_resource_id\": 980190962\n }\n }\n]"],"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"}],"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"},{"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"}],"examples":["GET /api/compute_resources/980190962/images/980190962\n200\n{\n \"image\": {\n \"name\": \"centos-1\",\n \"id\": 980190962,\n \"uuid\": \"string-of-uuid\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"operatingsystem_id\": 309172073,\n \"username\": \"root\",\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"architecture_id\": 501905019,\n \"compute_resource_id\": 980190962\n }\n}"],"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 a image"}],"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"},{"name":"image","full_name":"image","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"name","full_name":"image[name]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"username","full_name":"image[username]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"uuid","full_name":"image[uuid]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"compute_resource_id","full_name":"image[compute_resource_id]","description":"","required":true,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"architecture_id","full_name":"image[architecture_id]","description":"","required":true,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"operatingsystem_id","full_name":"image[operatingsystem_id]","description":"","required":true,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"}]}],"examples":["POST /api/compute_resources/980190962/images\n{\n \"image\": {\n \"name\": \"TestImage\",\n \"uuid\": \"abcdef\",\n \"username\": \"ec2-user\",\n \"operatingsystem_id\": 309172073,\n \"compute_resource_id\": 367690737,\n \"architecture_id\": 381564594\n }\n}\n201\n{\n \"compute_resource\": {\n \"url\": \"qemu://stam/system\",\n \"name\": \"MyString\",\n \"user\": \"MyString\",\n \"id\": 980190962,\n \"uuid\": \"MyString\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"description\": \"MyString\",\n \"attrs\": null,\n \"created_at\": \"2012-12-18T15:24:42Z\"\n }\n}"],"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 a image."}],"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"},{"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"},{"name":"image","full_name":"image","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"name","full_name":"image[name]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"username","full_name":"image[username]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"uuid","full_name":"image[uuid]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"compute_resource_id","full_name":"image[compute_resource_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"architecture_id","full_name":"image[architecture_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"operatingsystem_id","full_name":"image[operatingsystem_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"}]}],"examples":["PUT /api/compute_resources/980190962/images/980190962\n{\n \"image\": {}\n}\n200\n{\n \"image\": {\n \"name\": \"centos-1\",\n \"id\": 980190962,\n \"uuid\": \"string-of-uuid\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"username\": \"root\",\n \"operatingsystem_id\": 309172073,\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"compute_resource_id\": 980190962,\n \"architecture_id\": 501905019\n }\n}"],"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."}],"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"},{"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"}],"examples":["DELETE /api/compute_resources/980190962/images/980190962\n200\n{\n \"image\": {\n \"name\": \"centos-1\",\n \"id\": 980190962,\n \"uuid\": \"string-of-uuid\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"username\": \"root\",\n \"operatingsystem_id\": 309172073,\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"compute_resource_id\": 980190962,\n \"architecture_id\": 501905019\n }\n}"],"see":[]}]},"reports":{"doc_url":"/apidoc/v2/reports","api_url":"/api","name":"Reports","short_description":null,"full_description":null,"version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/reports/index","name":"index","apis":[{"api_url":"/api/reports","http_method":"GET","short_description":"List all reports."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"<p>filter results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"order","full_name":"order","description":"<p>sort results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"page","full_name":"page","description":"<p>paginate results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"per_page","full_name":"per_page","description":"<p>number of entries per request</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["GET /api/reports\n200\n[\n {\n \"report\": {\n \"summary\": \"Success\",\n \"status\": {\n \"skipped\": 0,\n \"failed_restarts\": 0,\n \"failed\": 0,\n \"pending\": 0,\n \"restarted\": 0,\n \"applied\": 0\n },\n \"id\": 70219655,\n \"reported_at\": \"2012-12-11T15:24:42Z\",\n \"metrics\": {\n \"events\": {\n \"total\": 0\n },\n \"time\": {\n \"package\": 0.003989,\n \"schedule\": 0.00083,\n \"cron\": 0.000419,\n \"exec\": 0.000299,\n \"service\": 0.149739,\n \"config_retrieval\": 16.3637869358063,\n \"file\": 0.007025,\n \"filebucket\": 0.000171,\n \"mailalias\": 0.000283\n },\n \"resources\": {\n \"total\": 33\n },\n \"changes\": {}\n },\n \"logs\": []\n }\n }\n]"],"see":[]},{"doc_url":"/apidoc/v2/reports/show","name":"show","apis":[{"api_url":"/api/reports/:id","http_method":"GET","short_description":"Show a report."}],"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"}],"examples":["GET /api/reports/70219655\n200\n{\n \"report\": {\n \"summary\": \"Success\",\n \"status\": {\n \"skipped\": 0,\n \"failed_restarts\": 0,\n \"failed\": 0,\n \"pending\": 0,\n \"restarted\": 0,\n \"applied\": 0\n },\n \"id\": 70219655,\n \"reported_at\": \"2012-12-11T15:24:42Z\",\n \"metrics\": {\n \"events\": {\n \"total\": 0\n },\n \"time\": {\n \"package\": 0.003989,\n \"schedule\": 0.00083,\n \"cron\": 0.000419,\n \"exec\": 0.000299,\n \"service\": 0.149739,\n \"config_retrieval\": 16.3637869358063,\n \"file\": 0.007025,\n \"filebucket\": 0.000171,\n \"mailalias\": 0.000283\n },\n \"resources\": {\n \"total\": 33\n },\n \"changes\": {}\n },\n \"logs\": []\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/reports/destroy","name":"destroy","apis":[{"api_url":"/api/ptables/:id","http_method":"DELETE","short_description":"Delete a report."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["DELETE /api/reports/70219655\n200\n{\n \"report\": {\n \"summary\": \"Success\",\n \"status\": {\n \"skipped\": 0,\n \"failed_restarts\": 0,\n \"failed\": 0,\n \"pending\": 0,\n \"restarted\": 0,\n \"applied\": 0\n },\n \"id\": 70219655,\n \"host\": \"my5name.mydomain.net\",\n \"reported_at\": \"2012-12-11T15:24:42Z\",\n \"logs\": [],\n \"metrics\": {\n \"events\": {\n \"total\": 0\n },\n \"time\": {\n \"package\": 0.003989,\n \"schedule\": 0.00083,\n \"cron\": 0.000419,\n \"service\": 0.149739,\n \"exec\": 0.000299,\n \"config_retrieval\": 16.3637869358063,\n \"file\": 0.007025,\n \"mailalias\": 0.000283,\n \"filebucket\": 0.000171\n },\n \"changes\": {},\n \"resources\": {\n \"total\": 33\n }\n }\n }\n}"],"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 given host."}],"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"}],"examples":["GET /api/reports/last\n200\n{\n \"report\": {\n \"summary\": \"Success\",\n \"status\": {\n \"skipped\": 0,\n \"failed_restarts\": 0,\n \"failed\": 0,\n \"pending\": 0,\n \"restarted\": 0,\n \"applied\": 0\n },\n \"id\": 70219655,\n \"reported_at\": \"2012-12-11T15:24:42Z\",\n \"metrics\": {\n \"events\": {\n \"total\": 0\n },\n \"time\": {\n \"package\": 0.003989,\n \"schedule\": 0.00083,\n \"cron\": 0.000419,\n \"exec\": 0.000299,\n \"service\": 0.149739,\n \"config_retrieval\": 16.3637869358063,\n \"file\": 0.007025,\n \"filebucket\": 0.000171,\n \"mailalias\": 0.000283\n },\n \"resources\": {\n \"total\": 33\n },\n \"changes\": {}\n },\n \"logs\": []\n }\n}"],"see":[]}]},"hosts":{"doc_url":"/apidoc/v2/hosts","api_url":"/api","name":"Hosts","short_description":null,"full_description":null,"version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/hosts/index","name":"index","apis":[{"api_url":"/api/hosts","http_method":"GET","short_description":"List all hosts."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"<p>Filter results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"order","full_name":"order","description":"<p>Sort results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"page","full_name":"page","description":"<p>paginate results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"per_page","full_name":"per_page","description":"<p>number of entries per request</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["GET /api/hosts\n200\n[\n {\n \"host\": {\n \"name\": \"anotherfullhost\",\n \"id\": 55602819,\n \"operatingsystem_id\": 1073012828,\n \"hostgroup_id\": null\n }\n },\n {\n \"host\": {\n \"name\": \"dhcp.mydomain.net\",\n \"id\": 219245707,\n \"operatingsystem_id\": 1073012828,\n \"hostgroup_id\": null\n }\n },\n {\n \"host\": {\n \"name\": \"my5name.mydomain.net\",\n \"id\": 980190962,\n \"operatingsystem_id\": 1073012828,\n \"hostgroup_id\": null\n }\n },\n {\n \"host\": {\n \"name\": \"myfullname.mydomain.net\",\n \"id\": 1053842695,\n \"operatingsystem_id\": 309172073,\n \"hostgroup_id\": null\n }\n },\n {\n \"host\": {\n \"name\": \"otherfullhost\",\n \"id\": 661942085,\n \"operatingsystem_id\": 1073012828,\n \"hostgroup_id\": null\n }\n },\n {\n \"host\": {\n \"name\": \"sdhcp.mydomain.net\",\n \"id\": 500757383,\n \"operatingsystem_id\": 1073012828,\n \"hostgroup_id\": null\n }\n },\n {\n \"host\": {\n \"name\": \"sol10host\",\n \"id\": 715054938,\n \"operatingsystem_id\": 442321401,\n \"hostgroup_id\": null\n }\n },\n {\n \"host\": {\n \"name\": \"suse01.yourdomain.net\",\n \"id\": 859751735,\n \"operatingsystem_id\": 859751735,\n \"hostgroup_id\": null\n }\n },\n {\n \"host\": {\n \"name\": \"temp-01.yourdomain.net\",\n \"id\": 1011586618,\n \"operatingsystem_id\": 331303656,\n \"hostgroup_id\": null\n }\n },\n {\n \"host\": {\n \"name\": \"temp01.yourdomain.net\",\n \"id\": 1073012828,\n \"operatingsystem_id\": 1073012828,\n \"hostgroup_id\": null\n }\n },\n {\n \"host\": {\n \"name\": \"temp-02.useless.net\",\n \"id\": 3666571,\n \"operatingsystem_id\": 331303656,\n \"hostgroup_id\": null\n }\n },\n {\n \"host\": {\n \"name\": \"temp.yourdomain.net\",\n \"id\": 298486374,\n \"operatingsystem_id\": 309172073,\n \"hostgroup_id\": null\n }\n }\n]"],"see":[]},{"doc_url":"/apidoc/v2/hosts/show","name":"show","apis":[{"api_url":"/api/hosts/:id","http_method":"GET","short_description":"Show a host."}],"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"}],"examples":["GET /api/hosts/my5name.mydomain.net\n200\n{\n \"host\": {\n \"host_parameters\": [\n {\n \"host_parameter\": {\n \"priority\": 4,\n \"name\": \"host1\",\n \"value\": \"host1\",\n \"id\": 254219264,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"reference_id\": 980190962,\n \"created_at\": \"2012-12-18T15:24:43Z\"\n }\n }\n ],\n \"name\": \"my5name.mydomain.net\",\n \"installed_at\": null,\n \"sp_ip\": \"\",\n \"image_file\": \"\",\n \"sp_name\": \"\",\n \"last_report\": null,\n \"enabled\": true,\n \"ip\": \"2.3.4.1\",\n \"id\": 980190962,\n \"puppet_ca_proxy_id\": null,\n \"certname\": \"my5name.mydomain.net\",\n \"medium_id\": null,\n \"sp_mac\": \"\",\n \"model_id\": null,\n \"comment\": null,\n \"uuid\": null,\n \"mac\": \"aabbCCddeeee\",\n \"use_image\": null,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"operatingsystem_id\": 1073012828,\n \"owner_id\": null,\n \"environment_id\": 334344675,\n \"build\": false,\n \"subnet_id\": 980190962,\n \"domain_id\": 22495316,\n \"environment\": {\n \"environment\": {\n \"name\": \"production\",\n \"id\": 334344675\n }\n },\n \"sp_subnet_id\": null,\n \"hostgroup_id\": null,\n \"puppet_proxy_id\": 182953976,\n \"owner_type\": null,\n \"ptable_id\": 980190962,\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"disk\": null,\n \"managed\": true,\n \"architecture_id\": 501905019,\n \"image_id\": null,\n \"compute_resource_id\": 980190962\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/hosts/create","name":"create","apis":[{"api_url":"/api/hosts","http_method":"POST","short_description":"Create a host."}],"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","params":[{"name":"name","full_name":"host[name]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"environment_id","full_name":"host[environment_id]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"ip","full_name":"host[ip]","description":"<p>not required if using a subnet with dhcp proxy</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"mac","full_name":"host[mac]","description":"<p>not required if its a virtual machine</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"architecture_id","full_name":"host[architecture_id]","description":"","required":true,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"domain_id","full_name":"host[domain_id]","description":"","required":true,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"puppet_proxy_id","full_name":"host[puppet_proxy_id]","description":"","required":true,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"operatingsystem_id","full_name":"host[operatingsystem_id]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"medium_id","full_name":"host[medium_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"ptable_id","full_name":"host[ptable_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"subnet_id","full_name":"host[subnet_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"sp_subnet_id","full_name":"host[sp_subnet_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"model_id_id","full_name":"host[model_id_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"hostgroup_id","full_name":"host[hostgroup_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"owner_id","full_name":"host[owner_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"puppet_ca_proxy_id","full_name":"host[puppet_ca_proxy_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"image_id","full_name":"host[image_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"host_parameters_attributes","full_name":"host[host_parameters_attributes]","description":"","required":false,"allow_nil":false,"validator":"Must be Array","expected_type":"array"}]}],"examples":["POST /api/hosts\n{\n \"host\": {\n \"name\": \"testhost11\",\n \"ip\": \"10.0.0.20\",\n \"mac\": \"52:53:00:1e:85:93\",\n \"operatingsystem_id\": 1073012828,\n \"environment_id\": 334344675,\n \"domain_id\": 22495316,\n \"puppet_proxy_id\": 7,\n \"architecture_id\": 501905019\n }\n}\n200\n{\n \"host\": {\n \"name\": \"testhost11.mydomain.net\",\n \"host_parameters\": [],\n \"installed_at\": null,\n \"sp_ip\": \"\",\n \"sp_name\": \"\",\n \"image_file\": \"\",\n \"last_report\": null,\n \"enabled\": true,\n \"id\": 1073012829,\n \"ip\": \"10.0.0.20\",\n \"puppet_ca_proxy_id\": null,\n \"certname\": \"fcfce82c-33d1-4565-843a-4f58ff8e371a\",\n \"medium_id\": null,\n \"sp_mac\": \"\",\n \"model_id\": null,\n \"comment\": null,\n \"uuid\": null,\n \"mac\": \"52:53:00:1e:85:93\",\n \"updated_at\": \"2012-12-18T15:24:48Z\",\n \"use_image\": null,\n \"operatingsystem_id\": 1073012828,\n \"owner_id\": 886836129,\n \"environment_id\": 334344675,\n \"build\": false,\n \"subnet_id\": null,\n \"environment\": {\n \"environment\": {\n \"name\": \"production\",\n \"id\": 334344675\n }\n },\n \"domain_id\": 22495316,\n \"sp_subnet_id\": null,\n \"hostgroup_id\": null,\n \"puppet_proxy_id\": 7,\n \"owner_type\": \"User\",\n \"ptable_id\": null,\n \"created_at\": \"2012-12-18T15:24:48Z\",\n \"disk\": null,\n \"managed\": true,\n \"architecture_id\": 501905019,\n \"compute_resource_id\": null,\n \"image_id\": null\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/hosts/update","name":"update","apis":[{"api_url":"/api/hosts/:id","http_method":"PUT","short_description":"Update a host."}],"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"},{"name":"host","full_name":"host","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"name","full_name":"host[name]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"environment_id","full_name":"host[environment_id]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"ip","full_name":"host[ip]","description":"<p>not required if using a subnet with dhcp proxy</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"mac","full_name":"host[mac]","description":"<p>not required if its a virtual machine</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"architecture_id","full_name":"host[architecture_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"domain_id","full_name":"host[domain_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"puppet_proxy_id","full_name":"host[puppet_proxy_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"operatingsystem_id","full_name":"host[operatingsystem_id]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"medium_id","full_name":"host[medium_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"ptable_id","full_name":"host[ptable_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"subnet_id","full_name":"host[subnet_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"sp_subnet_id","full_name":"host[sp_subnet_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"model_id_id","full_name":"host[model_id_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"hostgroup_id","full_name":"host[hostgroup_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"owner_id","full_name":"host[owner_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"puppet_ca_proxy_id","full_name":"host[puppet_ca_proxy_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"image_id","full_name":"host[image_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"host_parameters_attributes","full_name":"host[host_parameters_attributes]","description":"","required":false,"allow_nil":false,"validator":"Must be Array","expected_type":"array"}]}],"examples":["PUT /api/hosts/temp.yourdomain.net\n{\n \"host\": {}\n}\n200\n{\n \"host\": {\n \"sp_name\": \"\",\n \"sp_ip\": \"\",\n \"serial\": null,\n \"name\": \"temp.yourdomain.net\",\n \"installed_at\": null,\n \"image_file\": \"\",\n \"last_report\": null,\n \"enabled\": true,\n \"sp_mac\": \"\",\n \"puppet_ca_proxy_id\": null,\n \"medium_id\": 980190962,\n \"ip\": \"2.3.4.5\",\n \"id\": 298486374,\n \"certname\": \"temp.yourdomain.net\",\n \"uuid\": null,\n \"use_image\": null,\n \"updated_at\": \"2012-12-18T15:24:48Z\",\n \"root_pass\": \"xybxa6JUkz63w\",\n \"model_id\": null,\n \"mac\": \"aa:bb:cc:dd:ee:ff\",\n \"last_compile\": null,\n \"comment\": null,\n \"owner_id\": 886836129,\n \"operatingsystem_id\": 309172073,\n \"location_id\": null,\n \"organization_id\": null,\n \"environment_id\": 334344675,\n \"build\": false,\n \"subnet_id\": 980190962,\n \"sp_subnet_id\": null,\n \"hostgroup_id\": null,\n \"environment\": {\n \"environment\": {\n \"name\": \"production\",\n \"id\": 334344675\n }\n },\n \"domain_id\": 589326610,\n \"source_file_id\": null,\n \"puppet_proxy_id\": 182953976,\n \"ptable_id\": 980190962,\n \"owner_type\": \"User\",\n \"puppet_status\": 0,\n \"disk\": null,\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"managed\": null,\n \"last_freshcheck\": null,\n \"image_id\": null,\n \"compute_resource_id\": 980190962,\n \"architecture_id\": 501905019\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/hosts/destroy","name":"destroy","apis":[{"api_url":"/api/hosts/:id","http_method":"DELETE","short_description":"Delete an host."}],"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"}],"examples":["DELETE /api/hosts/my5name.mydomain.net\n200\n{\n \"host\": {\n \"sp_name\": \"\",\n \"sp_ip\": \"\",\n \"serial\": null,\n \"name\": \"my5name.mydomain.net\",\n \"installed_at\": null,\n \"image_file\": \"\",\n \"last_report\": null,\n \"enabled\": true,\n \"sp_mac\": \"\",\n \"puppet_ca_proxy_id\": null,\n \"medium_id\": null,\n \"ip\": \"2.3.4.1\",\n \"id\": 980190962,\n \"certname\": \"my5name.mydomain.net\",\n \"uuid\": null,\n \"use_image\": null,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"root_pass\": \"xybxa6JUkz63w\",\n \"model_id\": null,\n \"mac\": \"aabbCCddeeee\",\n \"last_compile\": null,\n \"comment\": null,\n \"owner_id\": null,\n \"operatingsystem_id\": 1073012828,\n \"location_id\": null,\n \"organization_id\": null,\n \"environment_id\": 334344675,\n \"build\": false,\n \"subnet_id\": 980190962,\n \"sp_subnet_id\": null,\n \"hostgroup_id\": null,\n \"environment\": {\n \"environment\": {\n \"name\": \"production\",\n \"id\": 334344675\n }\n },\n \"domain_id\": 22495316,\n \"source_file_id\": null,\n \"puppet_proxy_id\": 182953976,\n \"ptable_id\": 980190962,\n \"owner_type\": null,\n \"puppet_status\": 0,\n \"disk\": null,\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"managed\": true,\n \"last_freshcheck\": null,\n \"image_id\": null,\n \"compute_resource_id\": 980190962,\n \"architecture_id\": 501905019\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/hosts/status","name":"status","apis":[{"api_url":"/api/hosts/:id/status","http_method":"GET","short_description":"Get status of host"}],"formats":null,"full_description":"<p>Return value may either be one of the following:</p>\n\n<ul>\n<li>missing</li>\n\n<li>failed</li>\n\n<li>pending</li>\n\n<li>changed</li>\n\n<li>unchanged</li>\n\n<li>unreported</li>\n</ul>","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"}],"examples":["GET /api/hosts/my5name.mydomain.net/status\n200\n{\n \"status\": \"missing\"\n}"],"see":[]},{"doc_url":"/apidoc/v2/hosts/puppetrun","name":"puppetrun","apis":[{"api_url":"/api/hosts/:id/puppetrun","http_method":"GET","short_description":"Force a puppet run on the agent."}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"see":[]}]},"architectures":{"doc_url":"/apidoc/v2/architectures","api_url":"/api","name":"Architectures","short_description":null,"full_description":null,"version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/architectures/index","name":"index","apis":[{"api_url":"/api/architectures","http_method":"GET","short_description":"List all architectures."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"<p>filter results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"order","full_name":"order","description":"<p>sort results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"page","full_name":"page","description":"<p>paginate results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"per_page","full_name":"per_page","description":"<p>number of entries per request</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["GET /api/architectures\n200\n[\n {\n \"architecture\": {\n \"name\": \"s390\",\n \"id\": 381564594,\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"operatingsystem_ids\": [],\n \"created_at\": \"2012-12-18T15:24:42Z\"\n }\n },\n {\n \"architecture\": {\n \"name\": \"sparc\",\n \"id\": 331892513,\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"operatingsystem_ids\": [\n 442321401\n ],\n \"created_at\": \"2012-12-18T15:24:42Z\"\n }\n },\n {\n \"architecture\": {\n \"name\": \"x86_64\",\n \"id\": 501905019,\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"operatingsystem_ids\": [\n 331303656,\n 309172073,\n 1073012828\n ],\n \"created_at\": \"2012-12-18T15:24:42Z\"\n }\n }\n]"],"see":[]},{"doc_url":"/apidoc/v2/architectures/show","name":"show","apis":[{"api_url":"/api/architectures/:id","http_method":"GET","short_description":"Show an architecture."}],"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"}],"examples":["GET /api/architectures/x86_64\n200\n{\n \"architecture\": {\n \"name\": \"x86_64\",\n \"id\": 501905019,\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"operatingsystem_ids\": [\n 309172073,\n 1073012828,\n 331303656\n ],\n \"created_at\": \"2012-12-18T15:24:42Z\"\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/architectures/create","name":"create","apis":[{"api_url":"/api/architectures","http_method":"POST","short_description":"Create an architecture."}],"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","params":[{"name":"name","full_name":"architecture[name]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"operatingsystem_ids","full_name":"architecture[operatingsystem_ids]","description":"<p>Operatingsystem ID&#8217;s</p>","required":false,"allow_nil":false,"validator":"Must be Array","expected_type":"array"}]}],"examples":["POST /api/architectures\n{\n \"architecture\": {\n \"name\": \"i386\"\n }\n}\n200\n{\n \"architecture\": {\n \"name\": \"i386\",\n \"id\": 501905020,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"operatingsystem_ids\": [],\n \"created_at\": \"2012-12-18T15:24:43Z\"\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/architectures/update","name":"update","apis":[{"api_url":"/api/architectures/:id","http_method":"PUT","short_description":"Update an architecture."}],"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"},{"name":"architecture","full_name":"architecture","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"name","full_name":"architecture[name]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"operatingsystem_ids","full_name":"architecture[operatingsystem_ids]","description":"<p>Operatingsystem ID&#8217;s</p>","required":false,"allow_nil":false,"validator":"Must be Array","expected_type":"array"}]}],"examples":["PUT /api/architectures/x86_64\n{\n \"architecture\": {}\n}\n200\n{\n \"architecture\": {\n \"name\": \"x86_64\",\n \"id\": 501905019\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/architectures/destroy","name":"destroy","apis":[{"api_url":"/api/architectures/:id","http_method":"DELETE","short_description":"Delete an architecture."}],"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"}],"examples":["DELETE /api/architectures/s390\n200\n{\n \"architecture\": {\n \"name\": \"s390\",\n \"id\": 381564594\n }\n}"],"see":[]}]},"operatingsystems":{"doc_url":"/apidoc/v2/operatingsystems","api_url":"/api","name":"Operating systems","short_description":null,"full_description":"","version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/operatingsystems/index","name":"index","apis":[{"api_url":"/api/operatingsystems","http_method":"GET","short_description":"List all operating systems."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"<p>filter results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"order","full_name":"order","description":"<p>for example, name ASC, or name DESC</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"page","full_name":"page","description":"<p>paginate results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"per_page","full_name":"per_page","description":"<p>number of entries per request</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/operatingsystems/show","name":"show","apis":[{"api_url":"/api/operatingsystems/:id","http_method":"GET","short_description":"Show an OS."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["GET /api/operatingsystems/1073012828\n200\n{\n \"operatingsystem\": {\n \"name\": \"Redhat\",\n \"minor\": \"1\",\n \"id\": 1073012828,\n \"family\": \"Redhat\",\n \"ptables\": [\n {\n \"ptable\": {\n \"name\": \"default\",\n \"id\": 980190962\n }\n }\n ],\n \"os_default_templates\": [],\n \"architectures\": [\n {\n \"architecture\": {\n \"name\": \"x86_64\",\n \"id\": 501905019\n }\n }\n ],\n \"config_templates\": [\n {\n \"config_template\": {\n \"name\": \"centos5_3_pxelinux\",\n \"id\": 1007981701\n }\n },\n {\n \"config_template\": {\n \"name\": \"MyFinish\",\n \"id\": 104314179\n }\n },\n {\n \"config_template\": {\n \"name\": \"MyScript\",\n \"id\": 981457253\n }\n },\n {\n \"config_template\": {\n \"name\": \"MyString\",\n \"id\": 943779058\n }\n },\n {\n \"config_template\": {\n \"name\": \"MyString2\",\n \"id\": 269958254\n }\n },\n {\n \"config_template\": {\n \"name\": \"PXE Default File\",\n \"id\": 352050261\n }\n },\n {\n \"config_template\": {\n \"name\": \"PXE Localboot Default\",\n \"id\": 821548108\n }\n }\n ],\n \"release_name\": null,\n \"major\": \"6\",\n \"media\": [\n {\n \"medium\": {\n \"name\": \"CentOS 5.4\",\n \"id\": 980190962\n }\n }\n ]\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/operatingsystems/create","name":"create","apis":[{"api_url":"/api/operatingsystems","http_method":"POST","short_description":"Create an OS."}],"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","params":[{"name":"name","full_name":"operatingsystem[name]","description":"","required":true,"allow_nil":false,"validator":"Must match regular expression /\\A(\\S+)\\Z/.","expected_type":"string"},{"name":"major","full_name":"operatingsystem[major]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"minor","full_name":"operatingsystem[minor]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"family","full_name":"operatingsystem[family]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"release_name","full_name":"operatingsystem[release_name]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}]}],"examples":["POST /api/operatingsystems\n{\n \"operatingsystem\": {\n \"minor\": \"2\",\n \"name\": \"awsome_os\",\n \"major\": \"1\"\n }\n}\n200\n{\n \"operatingsystem\": {\n \"name\": \"awsome_os\",\n \"minor\": \"2\",\n \"id\": 1073012829,\n \"family\": null,\n \"ptables\": [],\n \"os_default_templates\": [],\n \"release_name\": null,\n \"config_templates\": [],\n \"architectures\": [],\n \"major\": \"1\",\n \"media\": []\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/operatingsystems/update","name":"update","apis":[{"api_url":"/api/operatingsystems/:id","http_method":"PUT","short_description":"Update an OS."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"operatingsystem","full_name":"operatingsystem","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"name","full_name":"operatingsystem[name]","description":"","required":false,"allow_nil":false,"validator":"Must match regular expression /\\A(\\S+)\\Z/.","expected_type":"string"},{"name":"major","full_name":"operatingsystem[major]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"minor","full_name":"operatingsystem[minor]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"family","full_name":"operatingsystem[family]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"release_name","full_name":"operatingsystem[release_name]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}]}],"examples":["PUT /api/operatingsystems/1073012828\n{\n \"operatingsystem\": {\n \"name\": \"new_name\"\n }\n}\n200\n{\n \"operatingsystem\": {\n \"name\": \"new_name\",\n \"minor\": \"1\",\n \"id\": 1073012828,\n \"family\": \"Redhat\",\n \"ptables\": [\n {\n \"ptable\": {\n \"name\": \"default\",\n \"id\": 980190962\n }\n }\n ],\n \"os_default_templates\": [],\n \"config_templates\": [\n {\n \"config_template\": {\n \"name\": \"centos5_3_pxelinux\",\n \"id\": 1007981701\n }\n },\n {\n \"config_template\": {\n \"name\": \"MyFinish\",\n \"id\": 104314179\n }\n },\n {\n \"config_template\": {\n \"name\": \"MyScript\",\n \"id\": 981457253\n }\n },\n {\n \"config_template\": {\n \"name\": \"MyString\",\n \"id\": 943779058\n }\n },\n {\n \"config_template\": {\n \"name\": \"MyString2\",\n \"id\": 269958254\n }\n },\n {\n \"config_template\": {\n \"name\": \"PXE Default File\",\n \"id\": 352050261\n }\n },\n {\n \"config_template\": {\n \"name\": \"PXE Localboot Default\",\n \"id\": 821548108\n }\n }\n ],\n \"architectures\": [\n {\n \"architecture\": {\n \"name\": \"x86_64\",\n \"id\": 501905019\n }\n }\n ],\n \"release_name\": null,\n \"media\": [\n {\n \"medium\": {\n \"name\": \"CentOS 5.4\",\n \"id\": 980190962\n }\n }\n ],\n \"major\": \"6\"\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/operatingsystems/destroy","name":"destroy","apis":[{"api_url":"/api/operatingsystems/:id","http_method":"DELETE","short_description":"Delete an OS."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["DELETE /api/operatingsystems/775246587\n200\n{\n \"operatingsystem\": {\n \"name\": \"NoHosts 1.1\",\n \"id\": 775246587,\n \"ptables\": [],\n \"architectures\": [],\n \"config_templates\": [],\n \"media\": []\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/operatingsystems/bootfiles","name":"bootfiles","apis":[{"api_url":"/api/operatingsystems/:id/bootfiles","http_method":"GET","short_description":"List boot files an OS."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"medium","full_name":"medium","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"architecture","full_name":"architecture","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":[],"see":[]}]},"puppetclasses":{"doc_url":"/apidoc/v2/puppetclasses","api_url":"/api","name":"Puppetclasses","short_description":null,"full_description":null,"version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/puppetclasses/index","name":"index","apis":[{"api_url":"/api/puppetclasses","http_method":"GET","short_description":"List all puppetclasses."},{"api_url":"/api/hosts/:host_id/puppetclasses","http_method":"GET","short_description":"List all puppetclasses for host"},{"api_url":"/api/hostgroups/:hostgroup_id/puppetclasses","http_method":"GET","short_description":"List all puppetclasses for hostgroup"},{"api_url":"/api/environments/:environment_id/puppetclasses","http_method":"GET","short_description":"List all puppetclasses for environment"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"<p>id of nested host</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"<p>id of nested hostgroup</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"environment_id","full_name":"environment_id","description":"<p>id of nested environment</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["GET /api/puppetclasses\n200\n{\n \"base\": [\n {\n \"puppetclass\": {\n \"name\": \"base\",\n \"id\": 980190962,\n \"lookup_keys\": [\n {\n \"id\": 298486374\n }\n ]\n }\n }\n ],\n \"apache\": [\n {\n \"puppetclass\": {\n \"name\": \"apache\",\n \"id\": 298486374,\n \"lookup_keys\": []\n }\n }\n ]\n}"],"see":[]},{"doc_url":"/apidoc/v2/puppetclasses/show","name":"show","apis":[{"api_url":"/api/puppetclasses/:id","http_method":"GET","short_description":"Show a puppetclass"},{"api_url":"/api/hosts/:host_id/puppetclasses/:id","http_method":"GET","short_description":"Show a puppetclass for host"},{"api_url":"/api/hostgroups/:hostgroup_id/puppetclasses/:id","http_method":"GET","short_description":"Show a puppetclass for hostgroup"},{"api_url":"/api/environments/:environment_id/puppetclasses/:id","http_method":"GET","short_description":"Show a puppetclass for environment"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"<p>id of nested host</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"<p>id of nested hostgroup</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"environment_id","full_name":"environment_id","description":"<p>id of nested environment</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"id","full_name":"id","description":"<p>id of puppetclass</p>","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["GET /api/puppetclasses/base\n200\n{\n \"puppetclass\": {\n \"name\": \"base\",\n \"id\": 980190962,\n \"lookup_keys\": [\n {\n \"lookup_key\": {\n \"required\": false,\n \"id\": 298486374,\n \"description\": null,\n \"key\": \"ssl_port\",\n \"is_param\": false,\n \"override\": false,\n \"default_value\": \"443\"\n }\n }\n ]\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/puppetclasses/create","name":"create","apis":[{"api_url":"/api/puppetclasses","http_method":"POST","short_description":"Create a puppetclass."}],"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","params":[{"name":"name","full_name":"puppetclass[name]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"}]}],"examples":["POST /api/puppetclasses\n{\n \"puppetclass\": {\n \"name\": \"test_puppetclass\"\n }\n}\n201\n{\n \"puppetclass\": {\n \"name\": \"test_puppetclass\",\n \"id\": 980190963,\n \"lookup_keys\": []\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/puppetclasses/update","name":"update","apis":[{"api_url":"/api/puppetclasses/:id","http_method":"PUT","short_description":"Update a puppetclass."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"puppetclass","full_name":"puppetclass","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"name","full_name":"puppetclass[name]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}]}],"examples":["PUT /api/puppetclasses/base\n{\n \"puppetclass\": {}\n}\n200\n{\n \"puppetclass\": {\n \"name\": \"base\",\n \"id\": 980190962,\n \"lookup_keys\": [\n {\n \"id\": 298486374\n }\n ]\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/puppetclasses/destroy","name":"destroy","apis":[{"api_url":"/api/puppetclasses/:id","http_method":"DELETE","short_description":"Delete a puppetclass."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["DELETE /api/puppetclasses/base\n200\n{\n \"puppetclass\": {\n \"name\": \"base\",\n \"id\": 980190962,\n \"lookup_keys\": [\n {\n \"id\": 298486374\n }\n ]\n }\n}"],"see":[]}]},"audits":{"doc_url":"/apidoc/v2/audits","api_url":"/api","name":"Audits","short_description":null,"full_description":null,"version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/audits/index","name":"index","apis":[{"api_url":"/api/audits","http_method":"GET","short_description":"List all audits."},{"api_url":"/api/hosts/:host_id/audits","http_method":"GET","short_description":"List all audits for a given host."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"<p>filter results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"order","full_name":"order","description":"<p>sort results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"page","full_name":"page","description":"<p>paginate results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"per_page","full_name":"per_page","description":"<p>number of entries per request</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["GET /api/audits\n200\n[\n {\n \"audit\": {\n \"auditable_name\": null,\n \"user_id\": null,\n \"associated_id\": 272,\n \"associated_name\": null,\n \"id\": 1,\n \"comment\": null,\n \"auditable_id\": 0,\n \"auditable_type\": \"Host\",\n \"associated_type\": \"Host\",\n \"remote_address\": null,\n \"action\": \"update\",\n \"audited_changes\": {\n \"architecture_id\": [\n 10463,\n 10466\n ]\n },\n \"user_type\": null,\n \"version\": 1,\n \"created_at\": \"2009-12-14T08:01:17Z\"\n }\n }\n]"],"see":[]},{"doc_url":"/apidoc/v2/audits/show","name":"show","apis":[{"api_url":"/api/audits/:id","http_method":"GET","short_description":"Show an audit"}],"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"}],"examples":["GET /api/audits/1\n200\n{\n \"audit\": {\n \"auditable_name\": null,\n \"user_id\": null,\n \"associated_id\": 272,\n \"associated_name\": null,\n \"id\": 1,\n \"comment\": null,\n \"auditable_id\": 0,\n \"auditable_type\": \"Host\",\n \"associated_type\": \"Host\",\n \"remote_address\": null,\n \"action\": \"update\",\n \"audited_changes\": {\n \"architecture_id\": [\n 10463,\n 10466\n ]\n },\n \"user_type\": null,\n \"version\": 1,\n \"created_at\": \"2009-12-14T08:01:17Z\"\n }\n}"],"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,"methods":[{"doc_url":"/apidoc/v2/smart_proxies/index","name":"index","apis":[{"api_url":"/api/smart_proxies","http_method":"GET","short_description":"List all smart_proxies."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"type","full_name":"type","description":"<p>filter by type</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"page","full_name":"page","description":"<p>paginate results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"per_page","full_name":"per_page","description":"<p>number of entries per request</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["GET /api/smart_proxies?type=unknown_type\n500\n{\n \"error\": {\n \"message\": \"Invalid feature type. Select one of: TFTP, BMC, DNS, DHCP, Puppetca, Puppet.\"\n }\n}"],"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."}],"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"}],"examples":["GET /api/smart_proxies/980190962-dhcp-proxy\n200\n{\n \"smart_proxy\": {\n \"name\": \"DHCP Proxy\",\n \"features\": [],\n \"url\": \"https://somewhere.net:8443\",\n \"id\": 980190962,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"created_at\": \"2012-12-18T15:24:43Z\"\n }\n}"],"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."}],"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","params":[{"name":"name","full_name":"smart_proxy[name]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"url","full_name":"smart_proxy[url]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"}]}],"examples":["POST /api/smart_proxies\n{\n \"smart_proxy\": {\n \"url\": \"http://server:8443\",\n \"name\": \"master02\"\n }\n}\n201\n{\n \"smart_proxy\": {\n \"url\": \"http://server:8443\",\n \"name\": \"master02\",\n \"id\": 980190963,\n \"updated_at\": \"2012-12-18T15:24:52Z\",\n \"created_at\": \"2012-12-18T15:24:52Z\"\n }\n}"],"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."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"smart_proxy","full_name":"smart_proxy","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"name","full_name":"smart_proxy[name]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"url","full_name":"smart_proxy[url]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}]}],"examples":["PUT /api/smart_proxies/980190962-dhcp-proxy\n{\n \"smart_proxy\": {}\n}\n200\n{\n \"smart_proxy\": {\n \"url\": \"https://somewhere.net:8443\",\n \"name\": \"DHCP Proxy\",\n \"id\": 980190962,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"created_at\": \"2012-12-18T15:24:43Z\"\n }\n}"],"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."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["DELETE /api/smart_proxies/281110143-unused-proxy\n200\n{\n \"smart_proxy\": {\n \"url\": \"http://else.where:4567\",\n \"name\": \"Unused Proxy\",\n \"id\": 281110143,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"created_at\": \"2012-12-18T15:24:43Z\"\n }\n}"],"see":[]}]},"settings":{"doc_url":"/apidoc/v2/settings","api_url":"/api","name":"Settings","short_description":null,"full_description":null,"version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/settings/index","name":"index","apis":[{"api_url":"/api/settings","http_method":"GET","short_description":"List all settings."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"<p>Filter results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"order","full_name":"order","description":"<p>Sort results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"page","full_name":"page","description":"<p>paginate results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"per_page","full_name":"per_page","description":"<p>number of entries per request</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/settings/show","name":"show","apis":[{"api_url":"/api/settings/:id","http_method":"GET","short_description":"Show an setting."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["GET /api/settings/333972760\n200\n{\n \"setting\": {\n \"name\": \"administrator\",\n \"value\": \"root@some.host.fqdn\",\n \"id\": 333972760,\n \"description\": \"The Default administrator email address\",\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"category\": \"General\",\n \"settings_type\": null,\n \"default\": \"root@some.host.fqdn\",\n \"created_at\": \"2012-12-18T15:24:43Z\"\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/settings/update","name":"update","apis":[{"api_url":"/api/settings/:id","http_method":"PUT","short_description":"Update a setting."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"setting","full_name":"setting","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"value","full_name":"setting[value]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}]}],"examples":["PUT /api/settings/333972760\n{\n \"setting\": {}\n}\n200\n{\n \"setting\": {\n \"name\": \"administrator\",\n \"value\": \"root@some.host.fqdn\",\n \"id\": 333972760,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"description\": \"The Default administrator email address\",\n \"settings_type\": null,\n \"category\": \"General\",\n \"default\": \"root@some.host.fqdn\",\n \"created_at\": \"2012-12-18T15:24:43Z\"\n }\n}"],"see":[]}]},"models":{"doc_url":"/apidoc/v2/models","api_url":"/api","name":"Models","short_description":null,"full_description":null,"version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/models/index","name":"index","apis":[{"api_url":"/api/models","http_method":"GET","short_description":"List all models."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"<p>filter results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"order","full_name":"order","description":"<p>sort results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"page","full_name":"page","description":"<p>paginate results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"per_page","full_name":"per_page","description":"<p>number of entries per request</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["GET /api/models\n200\n[\n {\n \"model\": {\n \"name\": \"KVM\",\n \"id\": 980190962,\n \"vendor_class\": null,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"info\": \"Virtual Machine\",\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"hardware_model\": null\n }\n },\n {\n \"model\": {\n \"name\": \"SUN V210\",\n \"id\": 139037058,\n \"vendor_class\": \"Sun-Fire-V210\",\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"info\": null,\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"hardware_model\": \"SUN4U\"\n }\n }\n]"],"see":[]},{"doc_url":"/apidoc/v2/models/show","name":"show","apis":[{"api_url":"/api/models/:id","http_method":"GET","short_description":"Show a model."}],"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"}],"examples":["GET /api/models/980190962\n200\n{\n \"model\": {\n \"name\": \"KVM\",\n \"id\": 980190962,\n \"vendor_class\": null,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"info\": \"Virtual Machine\",\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"hardware_model\": null\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/models/create","name":"create","apis":[{"api_url":"/api/models","http_method":"POST","short_description":"Create a model."}],"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","params":[{"name":"name","full_name":"model[name]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"info","full_name":"model[info]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"vendor_class","full_name":"model[vendor_class]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"hardware_model","full_name":"model[hardware_model]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}]}],"examples":["POST /api/models\n{\n \"model\": {\n \"name\": \"new model\"\n }\n}\n201\n{\n \"model\": {\n \"name\": \"new model\",\n \"vendor_class\": null,\n \"id\": 980190963,\n \"updated_at\": \"2012-12-18T15:24:49Z\",\n \"info\": null,\n \"created_at\": \"2012-12-18T15:24:49Z\",\n \"hardware_model\": null\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/models/update","name":"update","apis":[{"api_url":"/api/models/:id","http_method":"PUT","short_description":"Update a model."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"model","full_name":"model","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"name","full_name":"model[name]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"info","full_name":"model[info]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"vendor_class","full_name":"model[vendor_class]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"hardware_model","full_name":"model[hardware_model]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}]}],"examples":["PUT /api/models/980190962\n{\n \"name\": \"KVM\"\n}\n200\n{\n \"model\": {\n \"name\": \"KVM\",\n \"vendor_class\": null,\n \"id\": 980190962,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"info\": \"Virtual Machine\",\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"hardware_model\": null\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/models/destroy","name":"destroy","apis":[{"api_url":"/api/models/:id","http_method":"DELETE","short_description":"Delete a model."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["DELETE /api/models/980190962\n200\n{\n \"model\": {\n \"name\": \"KVM\",\n \"vendor_class\": null,\n \"id\": 980190962,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"info\": \"Virtual Machine\",\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"hardware_model\": null\n }\n}"],"see":[]}]},"hostgroups":{"doc_url":"/apidoc/v2/hostgroups","api_url":"/api","name":"Hostgroups","short_description":null,"full_description":null,"version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/hostgroups/index","name":"index","apis":[{"api_url":"/api/hostgroups","http_method":"GET","short_description":"List all hostgroups."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"<p>filter results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"order","full_name":"order","description":"<p>sort results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"page","full_name":"page","description":"<p>paginate results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"per_page","full_name":"per_page","description":"<p>number of entries per request</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["GET /api/hostgroups\n200\n[\n {\n \"hostgroup\": {\n \"name\": \"db\",\n \"label\": \"db\",\n \"id\": 603241515,\n \"operatingsystem_id\": 309172073,\n \"ancestry\": null,\n \"environment_id\": 334344675,\n \"parameters\": {},\n \"subnet_id\": null,\n \"domain_id\": null,\n \"puppetclass_ids\": []\n }\n },\n {\n \"hostgroup\": {\n \"name\": \"Common\",\n \"label\": \"Common\",\n \"id\": 636252244,\n \"operatingsystem_id\": 309172073,\n \"ancestry\": null,\n \"environment_id\": 334344675,\n \"parameters\": {\n \"group1\": \"group1\"\n },\n \"subnet_id\": null,\n \"domain_id\": 22495316,\n \"puppetclass_ids\": [\n 980190962\n ]\n }\n },\n {\n \"hostgroup\": {\n \"name\": \"Unusual\",\n \"label\": \"Unusual\",\n \"id\": 866317115,\n \"operatingsystem_id\": null,\n \"ancestry\": null,\n \"environment_id\": null,\n \"parameters\": {},\n \"subnet_id\": null,\n \"domain_id\": null,\n \"puppetclass_ids\": []\n }\n }\n]"],"see":[]},{"doc_url":"/apidoc/v2/hostgroups/show","name":"show","apis":[{"api_url":"/api/hostgroups/:id","http_method":"GET","short_description":"Show a hostgroup."}],"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"}],"examples":["GET /api/hostgroups/636252244-common\n200\n{\n \"hostgroup\": {\n \"name\": \"Common\",\n \"label\": \"Common\",\n \"id\": 636252244,\n \"operatingsystem_id\": 309172073,\n \"ancestry\": null,\n \"environment_id\": 334344675,\n \"parameters\": {\n \"group1\": \"group1\"\n },\n \"subnet_id\": null,\n \"domain_id\": 22495316,\n \"puppetclass_ids\": [\n 980190962\n ]\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/hostgroups/create","name":"create","apis":[{"api_url":"/api/hostgroups","http_method":"POST","short_description":"Create an hostgroup."}],"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","params":[{"name":"name","full_name":"hostgroup[name]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"parent_id","full_name":"hostgroup[parent_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"environment_id","full_name":"hostgroup[environment_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"operatingsystem_id","full_name":"hostgroup[operatingsystem_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"architecture_id","full_name":"hostgroup[architecture_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"medium_id","full_name":"hostgroup[medium_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"ptable_id","full_name":"hostgroup[ptable_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"puppet_ca_proxy_id","full_name":"hostgroup[puppet_ca_proxy_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"subnet_id","full_name":"hostgroup[subnet_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"domain_id","full_name":"hostgroup[domain_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"puppet_proxy_id","full_name":"hostgroup[puppet_proxy_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"}]}],"examples":["POST /api/hostgroups\n{\n \"hostgroup\": {\n \"name\": \"TestHostgroup\"\n }\n}\n200\n{\n \"hostgroup\": {\n \"name\": \"TestHostgroup\",\n \"label\": \"TestHostgroup\",\n \"id\": 866317116,\n \"operatingsystem_id\": null,\n \"ancestry\": null,\n \"environment_id\": null,\n \"parameters\": {},\n \"subnet_id\": null,\n \"domain_id\": null,\n \"puppetclass_ids\": []\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/hostgroups/update","name":"update","apis":[{"api_url":"/api/hostgroups/:id","http_method":"PUT","short_description":"Update an hostgroup."}],"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"},{"name":"hostgroup","full_name":"hostgroup","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"name","full_name":"hostgroup[name]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"parent_id","full_name":"hostgroup[parent_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"environment_id","full_name":"hostgroup[environment_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"operatingsystem_id","full_name":"hostgroup[operatingsystem_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"architecture_id","full_name":"hostgroup[architecture_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"medium_id","full_name":"hostgroup[medium_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"ptable_id","full_name":"hostgroup[ptable_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"puppet_ca_proxy_id","full_name":"hostgroup[puppet_ca_proxy_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"subnet_id","full_name":"hostgroup[subnet_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"domain_id","full_name":"hostgroup[domain_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"puppet_proxy_id","full_name":"hostgroup[puppet_proxy_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"}]}],"examples":["PUT /api/hostgroups/636252244-common\n{\n \"hostgroup\": {}\n}\n200\n{\n \"hostgroup\": {\n \"name\": \"Common\",\n \"label\": \"Common\",\n \"id\": 636252244,\n \"operatingsystem_id\": 309172073,\n \"ancestry\": null,\n \"parameters\": {\n \"group1\": \"group1\"\n },\n \"environment_id\": 334344675,\n \"subnet_id\": null,\n \"domain_id\": 22495316,\n \"puppetclass_ids\": [\n 980190962\n ]\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/hostgroups/destroy","name":"destroy","apis":[{"api_url":"/api/hostgroups/:id","http_method":"DELETE","short_description":"Delete an hostgroup."}],"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"}],"examples":["DELETE /api/hostgroups/636252244-common\n200\n{\n \"hostgroup\": {\n \"name\": \"Common\",\n \"label\": \"Common\",\n \"id\": 636252244,\n \"operatingsystem_id\": 309172073,\n \"ancestry\": null,\n \"parameters\": {},\n \"environment_id\": 334344675,\n \"subnet_id\": null,\n \"domain_id\": 22495316,\n \"puppetclass_ids\": []\n }\n}"],"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,"methods":[{"doc_url":"/apidoc/v2/common_parameters/index","name":"index","apis":[{"api_url":"/api/common_parameters","http_method":"GET","short_description":"List all common parameters."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"<p>filter results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"order","full_name":"order","description":"<p>sort results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"page","full_name":"page","description":"<p>paginate results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"per_page","full_name":"per_page","description":"<p>number of entries per request</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["GET /api/common_parameters\n200\n[\n {\n \"common_parameter\": {\n \"name\": \"test\",\n \"value\": \"myvalue\",\n \"id\": 636252244\n }\n }\n]"],"see":[]},{"doc_url":"/apidoc/v2/common_parameters/show","name":"show","apis":[{"api_url":"/api/common_parameters/:id","http_method":"GET","short_description":"Show a common parameter."}],"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"}],"examples":["GET /api/common_parameters/636252244\n200\n{\n \"common_parameter\": {\n \"name\": \"test\",\n \"value\": \"myvalue\",\n \"id\": 636252244\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/common_parameters/create","name":"create","apis":[{"api_url":"/api/common_parameters","http_method":"POST","short_description":"Create a common_parameter"}],"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","params":[{"name":"name","full_name":"common_parameter[name]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"value","full_name":"common_parameter[value]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"}]}],"examples":["POST /api/common_parameters\n{\n \"common_parameter\": {\n \"name\": \"special_key\",\n \"value\": \"123\"\n }\n}\n200\n{\n \"common_parameter\": {\n \"name\": \"special_key\",\n \"value\": \"123\",\n \"id\": 767575239\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/common_parameters/update","name":"update","apis":[{"api_url":"/api/common_parameters/:id","http_method":"PUT","short_description":"Update a common_parameter"}],"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"},{"name":"common_parameter","full_name":"common_parameter","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"name","full_name":"common_parameter[name]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"value","full_name":"common_parameter[value]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}]}],"examples":["PUT /api/common_parameters/636252244\n{\n \"common_parameter\": {}\n}\n200\n{\n \"common_parameter\": {\n \"name\": \"test\",\n \"value\": \"myvalue\",\n \"id\": 636252244\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/common_parameters/destroy","name":"destroy","apis":[{"api_url":"/api/common_parameters/:id","http_method":"DELETE","short_description":"Delete a common_parameter"}],"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"}],"examples":["DELETE /api/common_parameters/636252244\n200\n{\n \"common_parameter\": {\n \"name\": \"test\",\n \"value\": \"myvalue\",\n \"id\": 636252244\n }\n}"],"see":[]}]},"dashboard":{"doc_url":"/apidoc/v2/dashboard","api_url":"/api","name":"Dashboard","short_description":null,"full_description":null,"version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/dashboard/index","name":"index","apis":[{"api_url":"/api/dashboard","http_method":"GET","short_description":"Get Dashboard results"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"<p>filter results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["GET /api/dashboard\n200\n{\n \"disabled_hosts\": 0,\n \"ok_hosts\": 0,\n \"good_hosts\": 0,\n \"active_hosts_ok\": 0,\n \"pending_hosts_enabled\": 0,\n \"active_hosts_ok_enabled\": 0,\n \"good_hosts_enabled\": 0,\n \"active_hosts\": 0,\n \"percentage\": 0,\n \"out_of_sync_hosts\": 0,\n \"total_hosts\": 12,\n \"bad_hosts\": 0,\n \"out_of_sync_hosts_enabled\": 0,\n \"pending_hosts\": 0,\n \"bad_hosts_enabled\": 0,\n \"ok_hosts_enabled\": 0,\n \"reports_missing\": 12\n}"],"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,"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."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"page","full_name":"page","description":"<p>paginate results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"per_page","full_name":"per_page","description":"<p>number of entries per request</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["GET /api/template_kinds\n200\n[\n {\n \"template_kind\": {\n \"name\": \"PXELinux\",\n \"id\": 452984334\n }\n },\n {\n \"template_kind\": {\n \"name\": \"script\",\n \"id\": 478250810\n }\n },\n {\n \"template_kind\": {\n \"name\": \"gPXE\",\n \"id\": 158998239\n }\n },\n {\n \"template_kind\": {\n \"name\": \"finish\",\n \"id\": 550103832\n }\n },\n {\n \"template_kind\": {\n \"name\": \"provision\",\n \"id\": 983253650\n }\n }\n]"],"see":[]}]},"bookmarks":{"doc_url":"/apidoc/v2/bookmarks","api_url":"/api","name":"Bookmarks","short_description":null,"full_description":null,"version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/bookmarks/index","name":"index","apis":[{"api_url":"/api/bookmarks","http_method":"GET","short_description":"List all bookmarks."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"page","full_name":"page","description":"<p>paginate results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"per_page","full_name":"per_page","description":"<p>number of entries per request</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["GET /api/bookmarks\n200\n[\n {\n \"bookmark\": {\n \"name\": \"bar\",\n \"query\": \"bar=car\",\n \"id\": 298486374,\n \"owner_id\": null,\n \"public\": false,\n \"controller\": \"hosts\",\n \"owner_type\": null\n }\n },\n {\n \"bookmark\": {\n \"name\": \"foo\",\n \"query\": \"foo=boo\",\n \"id\": 980190962,\n \"owner_id\": null,\n \"public\": true,\n \"controller\": \"hosts\",\n \"owner_type\": null\n }\n }\n]"],"see":[]},{"doc_url":"/apidoc/v2/bookmarks/show","name":"show","apis":[{"api_url":"/api/bookmarks/:id","http_method":"GET","short_description":"Show a bookmark."}],"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"}],"examples":["GET /api/bookmarks/foo\n200\n{\n \"bookmark\": {\n \"name\": \"foo\",\n \"query\": \"foo=boo\",\n \"id\": 980190962,\n \"owner_id\": null,\n \"public\": true,\n \"controller\": \"hosts\",\n \"owner_type\": null\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/bookmarks/create","name":"create","apis":[{"api_url":"/api/bookmarks","http_method":"POST","short_description":"Create a bookmark."}],"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","params":[{"name":"name","full_name":"bookmark[name]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"controller","full_name":"bookmark[controller]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"query","full_name":"bookmark[query]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"public","full_name":"bookmark[public]","description":"","required":false,"allow_nil":false,"validator":"Must be 'true' or 'false'","expected_type":"string"}]}],"examples":["POST /api/bookmarks\n{\n \"bookmark\": {\n \"query\": \"bar\",\n \"name\": \"foo-bar\",\n \"public\": false,\n \"controller\": \"hosts\"\n }\n}\n200\n{\n \"bookmark\": {\n \"name\": \"foo-bar\",\n \"query\": \"bar\",\n \"id\": 980190963,\n \"owner_id\": 886836129,\n \"public\": false,\n \"controller\": \"hosts\",\n \"owner_type\": \"User\"\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/bookmarks/update","name":"update","apis":[{"api_url":"/api/bookmarks/:id","http_method":"PUT","short_description":"Update a bookmark."}],"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"},{"name":"bookmark","full_name":"bookmark","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"name","full_name":"bookmark[name]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"controller","full_name":"bookmark[controller]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"query","full_name":"bookmark[query]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"public","full_name":"bookmark[public]","description":"","required":false,"allow_nil":false,"validator":"Must be 'true' or 'false'","expected_type":"string"}]}],"examples":["PUT /api/bookmarks/foo\n{\n \"bookmark\": {}\n}\n200\n{\n \"bookmark\": {\n \"name\": \"foo\",\n \"query\": \"foo=boo\",\n \"user\": {\n \"name\": \"apiadmin User\",\n \"login\": \"apiadmin\",\n \"email\": \"apiadmin@someware.com\"\n },\n \"id\": 980190962,\n \"public\": true,\n \"controller\": \"hosts\"\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/bookmarks/destroy","name":"destroy","apis":[{"api_url":"/api/bookmarks/:id","http_method":"DELETE","short_description":"Delete a bookmark."}],"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"}],"examples":["DELETE /api/bookmarks/foo\n200\n{\n \"bookmark\": {\n \"query\": \"foo=boo\",\n \"name\": \"foo\",\n \"id\": 980190962,\n \"public\": true,\n \"owner_id\": null,\n \"controller\": \"hosts\",\n \"owner_type\": null\n }\n}"],"see":[]}]},"users":{"doc_url":"/apidoc/v2/users","api_url":"/api","name":"Users","short_description":null,"full_description":null,"version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/users/index","name":"index","apis":[{"api_url":"/api/users","http_method":"GET","short_description":"List all users."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"<p>filter results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"order","full_name":"order","description":"<p>sort results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"page","full_name":"page","description":"<p>paginate results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"per_page","full_name":"per_page","description":"<p>number of entries per request</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["GET /api/users\n200\n[\n {\n \"user\": {\n \"domains_andor\": \"or\",\n \"filter_on_owner\": null,\n \"role_id\": null,\n \"mail\": \"admin@someware.com\",\n \"id\": 135138680,\n \"hostgroups_andor\": \"or\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"compute_resources_andor\": \"or\",\n \"admin\": true,\n \"last_login_on\": \"2009-10-12T21:50:04Z\",\n \"lastname\": \"User\",\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"login\": \"admin\",\n \"firstname\": \"Admin\",\n \"facts_andor\": \"or\",\n \"auth_source_id\": 980190962\n }\n },\n {\n \"user\": {\n \"domains_andor\": \"or\",\n \"filter_on_owner\": null,\n \"role_id\": null,\n \"mail\": \"apiadmin@someware.com\",\n \"id\": 886836129,\n \"hostgroups_andor\": \"or\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"compute_resources_andor\": \"or\",\n \"admin\": true,\n \"last_login_on\": \"2009-10-12T21:50:04Z\",\n \"lastname\": \"User\",\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"login\": \"apiadmin\",\n \"firstname\": \"apiadmin\",\n \"facts_andor\": \"or\",\n \"auth_source_id\": 200482051\n }\n },\n {\n \"user\": {\n \"domains_andor\": \"or\",\n \"filter_on_owner\": null,\n \"role_id\": null,\n \"mail\": \"userone@someware.com\",\n \"id\": 980190962,\n \"hostgroups_andor\": \"or\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"compute_resources_andor\": \"or\",\n \"admin\": false,\n \"last_login_on\": \"2009-10-12T21:50:04Z\",\n \"lastname\": \"User\",\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"login\": \"one\",\n \"firstname\": \"One\",\n \"facts_andor\": \"or\",\n \"auth_source_id\": 980190962\n }\n },\n {\n \"user\": {\n \"domains_andor\": \"or\",\n \"filter_on_owner\": null,\n \"role_id\": null,\n \"mail\": \"testuser@someware.com\",\n \"id\": 200482051,\n \"hostgroups_andor\": \"or\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"compute_resources_andor\": \"or\",\n \"admin\": false,\n \"last_login_on\": \"2009-10-12T21:50:04Z\",\n \"lastname\": \"User\",\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"login\": \"test\",\n \"firstname\": \"test\",\n \"facts_andor\": \"or\",\n \"auth_source_id\": 200482051\n }\n },\n {\n \"user\": {\n \"domains_andor\": \"or\",\n \"filter_on_owner\": null,\n \"role_id\": null,\n \"mail\": \"usertwo@someware.com\",\n \"id\": 298486374,\n \"hostgroups_andor\": \"or\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"compute_resources_andor\": \"or\",\n \"admin\": false,\n \"last_login_on\": \"2009-10-12T21:50:04Z\",\n \"lastname\": \"User\",\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"login\": \"two\",\n \"firstname\": \"Two\",\n \"facts_andor\": \"or\",\n \"auth_source_id\": 980190962\n }\n }\n]"],"see":[]},{"doc_url":"/apidoc/v2/users/show","name":"show","apis":[{"api_url":"/api/users/:id","http_method":"GET","short_description":"Show an user."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["GET /api/users/980190962-one\n200\n{\n \"user\": {\n \"domains_andor\": \"or\",\n \"filter_on_owner\": null,\n \"roles\": [\n {\n \"role\": {\n \"name\": \"Viewer\",\n \"id\": 5,\n \"builtin\": 0,\n \"permissions\": [\n \"view_architectures\",\n \"view_audit_logs\",\n \"view_authenticators\",\n \"access_dashboard\",\n \"view_domains\",\n \"view_environments\",\n \"view_external_variables\",\n \"view_facts\",\n \"view_globals\",\n \"view_hostgroups\",\n \"view_hosts\",\n \"view_locations\",\n \"view_media\",\n \"view_models\",\n \"view_operatingsystems\",\n \"view_ptables\",\n \"view_puppetclasses\",\n \"view_reports\",\n \"access_settings\",\n \"view_statistics\",\n \"view_organizations\",\n \"view_usergroups\",\n \"view_users\"\n ]\n }\n },\n {\n \"role\": {\n \"name\": \"Anonymous\",\n \"id\": 7,\n \"builtin\": 2,\n \"permissions\": [\n \"view_hosts\"\n ]\n }\n }\n ],\n \"role_id\": null,\n \"auth_source_ldap\": {\n \"name\": \"ldap\",\n \"tls\": true,\n \"attr_login\": \"uid\",\n \"attr_firstname\": \"givenName\",\n \"port\": 123,\n \"attr_lastname\": \"sn\",\n \"id\": 980190962,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"attr_mail\": \"mail\",\n \"base_dn\": \"dn=x,dn=y\",\n \"host\": \"ldap\",\n \"account\": null,\n \"type\": \"AuthSourceLdap\",\n \"onthefly_register\": true,\n \"created_at\": \"2012-12-18T15:24:43Z\"\n },\n \"mail\": \"userone@someware.com\",\n \"id\": 980190962,\n \"hostgroups_andor\": \"or\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"compute_resources_andor\": \"or\",\n \"admin\": false,\n \"last_login_on\": \"2009-10-12T21:50:04Z\",\n \"lastname\": \"User\",\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"login\": \"one\",\n \"firstname\": \"One\",\n \"facts_andor\": \"or\",\n \"auth_source_id\": 980190962\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/users/create","name":"create","apis":[{"api_url":"/api/users","http_method":"POST","short_description":"Create an user."}],"formats":null,"full_description":"<p>Adds role &#8216;Anonymous&#8217; to the user by default</p>","errors":[],"params":[{"name":"user","full_name":"user","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"login","full_name":"user[login]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"firstname","full_name":"user[firstname]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"lastname","full_name":"user[lastname]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"mail","full_name":"user[mail]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"admin","full_name":"user[admin]","description":"<p>Is an admin account?</p>","required":false,"allow_nil":false,"validator":"Must be 'true' or 'false'","expected_type":"string"},{"name":"password","full_name":"user[password]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"auth_source_id","full_name":"user[auth_source_id]","description":"","required":true,"allow_nil":false,"validator":"Must be Integer","expected_type":"numeric"}]}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/users/update","name":"update","apis":[{"api_url":"/api/users/:id","http_method":"PUT","short_description":"Update an user."}],"formats":null,"full_description":"<p>Adds role &#8216;Anonymous&#8217; to the user if it is not already present. Only admin can set admin account.</p>","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"user","full_name":"user","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"login","full_name":"user[login]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"firstname","full_name":"user[firstname]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string"},{"name":"lastname","full_name":"user[lastname]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string"},{"name":"mail","full_name":"user[mail]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"admin","full_name":"user[admin]","description":"<p>Is an admin account?</p>","required":false,"allow_nil":false,"validator":"Must be 'true' or 'false'","expected_type":"string"},{"name":"password","full_name":"user[password]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}]}],"examples":["PUT /api/users/980190963\n{\n \"user\": {\n \"password_confirmation\": \"DUMMY\",\n \"password\": \"dummy\",\n \"login\": \"johnsmith\"\n }\n}\n422\n{\n \"user\": {\n \"id\": 980190963,\n \"errors\": {\n \"password\": [\n \"doesn't match confirmation\"\n ]\n },\n \"full_messages\": [\n \"Password doesn't match confirmation\"\n ]\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/users/destroy","name":"destroy","apis":[{"api_url":"/api/users/:id","http_method":"DELETE","short_description":"Delete an user."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["DELETE /api/users/980190962\n200\n{\n \"user\": {\n \"filter_on_owner\": null,\n \"domains_andor\": \"or\",\n \"role_id\": null,\n \"organizations_andor\": \"or\",\n \"mail\": \"userone@someware.com\",\n \"id\": 980190962,\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"hostgroups_andor\": \"or\",\n \"compute_resources_andor\": \"or\",\n \"admin\": false,\n \"password_hash\": null,\n \"last_login_on\": \"2009-10-12T21:50:04Z\",\n \"locations_andor\": \"or\",\n \"lastname\": \"User\",\n \"password_salt\": null,\n \"login\": \"one\",\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"firstname\": \"One\",\n \"facts_andor\": \"or\",\n \"auth_source_id\": 980190962\n }\n}"],"see":[]}]},"environments":{"doc_url":"/apidoc/v2/environments","api_url":"/api","name":"Environments","short_description":null,"full_description":null,"version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/environments/index","name":"index","apis":[{"api_url":"/api/environments","http_method":"GET","short_description":"List all environments."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"<p>Filter results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"order","full_name":"order","description":"<p>Sort results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"page","full_name":"page","description":"<p>paginate results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"per_page","full_name":"per_page","description":"<p>number of entries per request</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["GET /api/environments\n200\n[\n {\n \"environment\": {\n \"name\": \"global_puppetmaster\",\n \"id\": 153855663,\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"created_at\": \"2012-12-18T15:24:42Z\"\n }\n },\n {\n \"environment\": {\n \"name\": \"production\",\n \"id\": 334344675,\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"created_at\": \"2012-12-18T15:24:42Z\"\n }\n },\n {\n \"environment\": {\n \"name\": \"testing\",\n \"id\": 687036937,\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"created_at\": \"2012-12-18T15:24:42Z\"\n }\n }\n]"],"see":[]},{"doc_url":"/apidoc/v2/environments/show","name":"show","apis":[{"api_url":"/api/environments/:id","http_method":"GET","short_description":"Show an environment."}],"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"}],"examples":["GET /api/environments/production\n200\n{\n \"environment\": {\n \"name\": \"production\",\n \"id\": 334344675,\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"created_at\": \"2012-12-18T15:24:42Z\"\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/environments/create","name":"create","apis":[{"api_url":"/api/environments","http_method":"POST","short_description":"Create an environment."}],"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","params":[{"name":"name","full_name":"environment[name]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"}]}],"examples":["POST /api/environments\n{\n \"environment\": {\n \"name\": \"Development\"\n }\n}\n200\n{\n \"environment\": {\n \"name\": \"Development\",\n \"id\": 687036938,\n \"updated_at\": \"2012-12-18T15:24:46Z\",\n \"created_at\": \"2012-12-18T15:24:46Z\"\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/environments/update","name":"update","apis":[{"api_url":"/api/environments/:id","http_method":"PUT","short_description":"Update an environment."}],"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"},{"name":"environment","full_name":"environment","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"name","full_name":"environment[name]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}]}],"examples":["PUT /api/environments/production\n{\n \"environment\": {}\n}\n200\n{\n \"environment\": {\n \"name\": \"production\",\n \"id\": 334344675\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/environments/destroy","name":"destroy","apis":[{"api_url":"/api/environments/:id","http_method":"DELETE","short_description":"Delete an environment."}],"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"}],"examples":["DELETE /api/environments/testing\n200\n{\n \"environment\": {\n \"name\": \"testing\",\n \"id\": 687036937\n }\n}"],"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,"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 authsource ldaps"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"page","full_name":"page","description":"<p>paginate results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"per_page","full_name":"per_page","description":"<p>number of entries per request</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["GET /api/auth_source_ldaps\n200\n[\n {\n \"auth_source_ldap\": {\n \"name\": \"ldap\",\n \"attr_lastname\": \"sn\",\n \"port\": 123,\n \"attr_firstname\": \"givenName\",\n \"attr_login\": \"uid\",\n \"tls\": true,\n \"id\": 980190962,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"host\": \"ldap\",\n \"base_dn\": \"dn=x,dn=y\",\n \"attr_mail\": \"mail\",\n \"account\": null,\n \"type\": \"AuthSourceLdap\",\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"onthefly_register\": true\n }\n }\n]"],"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 authsource ldap."}],"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"}],"examples":["GET /api/auth_source_ldaps/980190962\n200\n{\n \"auth_source_ldap\": {\n \"name\": \"ldap\",\n \"attr_lastname\": \"sn\",\n \"attr_firstname\": \"givenName\",\n \"port\": 123,\n \"attr_login\": \"uid\",\n \"tls\": true,\n \"id\": 980190962,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"host\": \"ldap\",\n \"base_dn\": \"dn=x,dn=y\",\n \"attr_mail\": \"mail\",\n \"account\": null,\n \"type\": \"AuthSourceLdap\",\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"onthefly_register\": true\n }\n}"],"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 auth_source_ldap."}],"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","params":[{"name":"name","full_name":"auth_source_ldap[name]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"host","full_name":"auth_source_ldap[host]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"port","full_name":"auth_source_ldap[port]","description":"<p>defaults to 389</p>","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"account","full_name":"auth_source_ldap[account]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"base_dn","full_name":"auth_source_ldap[base_dn]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"account_password","full_name":"auth_source_ldap[account_password]","description":"<p>required if onthefly_register is true</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"attr_login","full_name":"auth_source_ldap[attr_login]","description":"<p>required if onthefly_register is true</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"attr_firstname","full_name":"auth_source_ldap[attr_firstname]","description":"<p>required if onthefly_register is true</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"attr_lastname","full_name":"auth_source_ldap[attr_lastname]","description":"<p>required if onthefly_register is true</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"attr_mail","full_name":"auth_source_ldap[attr_mail]","description":"<p>required if onthefly_register is true</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"onthefly_register","full_name":"auth_source_ldap[onthefly_register]","description":"","required":false,"allow_nil":false,"validator":"Must be 'true' or 'false'","expected_type":"string"},{"name":"tls","full_name":"auth_source_ldap[tls]","description":"","required":false,"allow_nil":false,"validator":"Must be 'true' or 'false'","expected_type":"string"}]}],"examples":["POST /api/auth_source_ldaps\n{\n \"auth_source_ldap\": {\n \"name\": \"ldap2\",\n \"host\": \"ldap2\"\n }\n}\n201\n{\n \"auth_source_ldap\": {\n \"name\": \"ldap2\",\n \"tls\": false,\n \"port\": 389,\n \"attr_login\": null,\n \"attr_lastname\": null,\n \"attr_firstname\": null,\n \"id\": 980190963,\n \"updated_at\": \"2012-12-18T15:24:44Z\",\n \"host\": \"ldap2\",\n \"base_dn\": null,\n \"attr_mail\": null,\n \"account_password\": null,\n \"account\": null,\n \"onthefly_register\": false,\n \"created_at\": \"2012-12-18T15:24:44Z\"\n }\n}"],"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 auth_source_ldap."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"auth_source_ldap","full_name":"auth_source_ldap","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"name","full_name":"auth_source_ldap[name]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"host","full_name":"auth_source_ldap[host]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"port","full_name":"auth_source_ldap[port]","description":"<p>defaults to 389</p>","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"account","full_name":"auth_source_ldap[account]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"base_dn","full_name":"auth_source_ldap[base_dn]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"account_password","full_name":"auth_source_ldap[account_password]","description":"<p>required if onthefly_register is true</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"attr_login","full_name":"auth_source_ldap[attr_login]","description":"<p>required if onthefly_register is true</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"attr_firstname","full_name":"auth_source_ldap[attr_firstname]","description":"<p>required if onthefly_register is true</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"attr_lastname","full_name":"auth_source_ldap[attr_lastname]","description":"<p>required if onthefly_register is true</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"attr_mail","full_name":"auth_source_ldap[attr_mail]","description":"<p>required if onthefly_register is true</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"onthefly_register","full_name":"auth_source_ldap[onthefly_register]","description":"","required":false,"allow_nil":false,"validator":"Must be 'true' or 'false'","expected_type":"string"},{"name":"tls","full_name":"auth_source_ldap[tls]","description":"","required":false,"allow_nil":false,"validator":"Must be 'true' or 'false'","expected_type":"string"}]}],"examples":["PUT /api/auth_source_ldaps/980190962\n{\n \"auth_source_ldap\": {}\n}\n200\n{\n \"auth_source_ldap\": {\n \"name\": \"ldap\",\n \"tls\": true,\n \"port\": 123,\n \"attr_login\": \"uid\",\n \"attr_lastname\": \"sn\",\n \"attr_firstname\": \"givenName\",\n \"id\": 980190962,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"host\": \"ldap\",\n \"base_dn\": \"dn=x,dn=y\",\n \"attr_mail\": \"mail\",\n \"account_password\": null,\n \"account\": null,\n \"onthefly_register\": true,\n \"created_at\": \"2012-12-18T15:24:43Z\"\n }\n}"],"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 auth_source_ldap."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["DELETE /api/auth_source_ldaps/980190962\n200\n{\n \"auth_source_ldap\": {\n \"name\": \"ldap\",\n \"tls\": true,\n \"port\": 123,\n \"attr_login\": \"uid\",\n \"attr_lastname\": \"sn\",\n \"attr_firstname\": \"givenName\",\n \"id\": 980190962,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"host\": \"ldap\",\n \"base_dn\": \"dn=x,dn=y\",\n \"attr_mail\": \"mail\",\n \"account_password\": null,\n \"account\": null,\n \"onthefly_register\": true,\n \"created_at\": \"2012-12-18T15:24:43Z\"\n }\n}"],"see":[]}]},"media":{"doc_url":"/apidoc/v2/media","api_url":"/api","name":"Media","short_description":null,"full_description":null,"version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/media/index","name":"index","apis":[{"api_url":"/api/media","http_method":"GET","short_description":"List all media."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"<p>filter results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"order","full_name":"order","description":"<p>for example, name ASC, or name DESC</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"page","full_name":"page","description":"<p>paginate results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"per_page","full_name":"per_page","description":"<p>number of entries per request</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["GET /api/media\n200\n[\n {\n \"medium\": {\n \"name\": \"CentOS 5.4\",\n \"id\": 980190962,\n \"path\": \"http://mirror.averse.net/centos/6.0/os/$arch\"\n }\n },\n {\n \"medium\": {\n \"name\": \"OpenSuse Mirror\",\n \"id\": 859751735,\n \"path\": \"http://mirror.isoc.org.il/pub/opensuse/distribution/$major.$minor/repo/oss\"\n }\n },\n {\n \"medium\": {\n \"name\": \"Solaris 10\",\n \"id\": 442321401,\n \"path\": \"http://brsla01/vol/solgi_5.10/sol$minor_$release_$arch\"\n }\n },\n {\n \"medium\": {\n \"name\": \"Ubuntu Mirror\",\n \"id\": 1011586618,\n \"path\": \"http://sg.archive.ubuntu.com\"\n }\n },\n {\n \"medium\": {\n \"name\": \"unused\",\n \"id\": 338446587,\n \"path\": \"http://nothing.intersting.com\"\n }\n }\n]"],"see":[]},{"doc_url":"/apidoc/v2/media/show","name":"show","apis":[{"api_url":"/api/media/:id","http_method":"GET","short_description":"Show a medium."}],"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"}],"examples":["GET /api/media/980190962\n200\n{\n \"medium\": {\n \"name\": \"CentOS 5.4\",\n \"id\": 980190962,\n \"path\": \"http://mirror.averse.net/centos/6.0/os/$arch\"\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/media/create","name":"create","apis":[{"api_url":"/api/media","http_method":"POST","short_description":"Create a medium."}],"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","params":[{"name":"name","full_name":"medium[name]","description":"<p>Name of media</p>","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"path","full_name":"medium[path]","description":"<p>The path to the medium, can be a URL or a valid NFS server (exclusive of the architecture).</p>\n\n<p>for example http://mirror.averse.net/centos/$version/os/$arch where $arch will be substituted for the host&#8217;s actual OS architecture and $version, $major and $minor will be substituted for the version of the operating system.</p>\n\n<p>Solaris and Debian media may also use $release.</p>","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"os_family","full_name":"medium[os_family]","description":"<p>The family that the operating system belongs to.</p>\n\n<p>Available families:</p>\n\n<ul>\n<li>Archlinux</li>\n\n<li>Debian</li>\n\n<li>Gentoo</li>\n\n<li>Redhat</li>\n\n<li>Solaris</li>\n\n<li>Suse</li>\n\n<li>Windows</li>\n</ul>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}]}],"examples":["POST /api/media\n{\n \"medium\": {\n \"name\": \"new medium\",\n \"path\": \"http://www.newmedium.com/\"\n }\n}\n201\n{\n \"medium\": {\n \"name\": \"new medium\",\n \"id\": 1011586619\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/media/update","name":"update","apis":[{"api_url":"/api/media/:id","http_method":"PUT","short_description":"Update a medium."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"medium","full_name":"medium","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"name","full_name":"medium[name]","description":"<p>Name of media</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"path","full_name":"medium[path]","description":"<p>The path to the medium, can be a URL or a valid NFS server (exclusive of the architecture).</p>\n\n<p>for example http://mirror.averse.net/centos/$version/os/$arch where $arch will be substituted for the host&#8217;s actual OS architecture and $version, $major and $minor will be substituted for the version of the operating system.</p>\n\n<p>Solaris and Debian media may also use $release.</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"os_family","full_name":"medium[os_family]","description":"<p>The family that the operating system belongs to.</p>\n\n<p>Available families:</p>\n\n<ul>\n<li>Archlinux</li>\n\n<li>Debian</li>\n\n<li>Gentoo</li>\n\n<li>Redhat</li>\n\n<li>Solaris</li>\n\n<li>Suse</li>\n\n<li>Windows</li>\n</ul>","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string"}]}],"examples":["PUT /api/media/980190962\n{\n \"name\": \"CentOS 5.4\"\n}\n200\n{\n \"medium\": {\n \"name\": \"CentOS 5.4\",\n \"id\": 980190962\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/media/destroy","name":"destroy","apis":[{"api_url":"/api/media/:id","http_method":"DELETE","short_description":"Delete a medium."}],"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"}],"examples":["DELETE /api/media/338446587\n200\n{\n \"medium\": {\n \"name\": \"unused\",\n \"id\": 338446587\n }\n}"],"see":[]}]},"lookup_keys":{"doc_url":"/apidoc/v2/lookup_keys","api_url":"/api","name":"Lookup keys","short_description":null,"full_description":null,"version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/lookup_keys/index","name":"index","apis":[{"api_url":"/api/smart_variables","http_method":"GET","short_description":"List all smart variables (smart parameters and smart class parameters)."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"<p>filter results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"order","full_name":"order","description":"<p>sort results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"page","full_name":"page","description":"<p>paginate results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"per_page","full_name":"per_page","description":"<p>number of entries per request</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["GET /api/lookup_keys\n200\n[\n {\n \"lookup_key\": {\n \"id\": 980190962,\n \"required\": false,\n \"description\": null,\n \"key\": \"port\",\n \"is_param\": true,\n \"override\": false,\n \"default_value\": \"80\"\n }\n },\n {\n \"lookup_key\": {\n \"id\": 113629430,\n \"required\": false,\n \"description\": null,\n \"key\": \"ssl\",\n \"is_param\": true,\n \"override\": true,\n \"default_value\": \"t\"\n }\n },\n {\n \"lookup_key\": {\n \"id\": 298486374,\n \"required\": false,\n \"description\": null,\n \"key\": \"ssl_port\",\n \"is_param\": false,\n \"override\": false,\n \"default_value\": \"443\"\n }\n }\n]"],"see":[]},{"doc_url":"/apidoc/v2/lookup_keys/show","name":"show","apis":[{"api_url":"/api/smart_variables/:id","http_method":"GET","short_description":"Show a smart variable (smart parameter or smart class parameter)."}],"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"}],"examples":["GET /api/lookup_keys/980190962-port\n200\n{\n \"lookup_key\": {\n \"id\": 980190962,\n \"required\": false,\n \"description\": null,\n \"key\": \"port\",\n \"is_param\": true,\n \"override\": false,\n \"default_value\": \"80\"\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/lookup_keys/create","name":"create","apis":[{"api_url":"/api/smart_variables","http_method":"POST","short_description":"Create a smart variable."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"lookup_key","full_name":"lookup_key","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"key","full_name":"lookup_key[key]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"puppetclass_id","full_name":"lookup_key[puppetclass_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"default_value","full_name":"lookup_key[default_value]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"path","full_name":"lookup_key[path]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"description","full_name":"lookup_key[description]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"validator_type","full_name":"lookup_key[validator_type]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"validator_rule","full_name":"lookup_key[validator_rule]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"is_param","full_name":"lookup_key[is_param]","description":"","required":false,"allow_nil":false,"validator":"Must be 'true' or 'false'","expected_type":"string"},{"name":"key_type","full_name":"lookup_key[key_type]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"override","full_name":"lookup_key[override]","description":"","required":false,"allow_nil":false,"validator":"Must be 'true' or 'false'","expected_type":"string"},{"name":"required","full_name":"lookup_key[required]","description":"","required":false,"allow_nil":false,"validator":"Must be 'true' or 'false'","expected_type":"string"}]}],"examples":["POST /api/lookup_keys\n{\n \"lookup_key\": {\n \"is_param\": true,\n \"key\": \"testkey\"\n }\n}\n201\n{\n \"lookup_key\": {\n \"required\": false,\n \"id\": 980190963,\n \"description\": null,\n \"key\": \"testkey\",\n \"is_param\": true,\n \"override\": false,\n \"default_value\": null\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/lookup_keys/update","name":"update","apis":[{"api_url":"/api/smart_variables/:id","http_method":"PUT","short_description":"Update a smart variable."}],"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"},{"name":"lookup_key","full_name":"lookup_key","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"key","full_name":"lookup_key[key]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"puppetclass_id","full_name":"lookup_key[puppetclass_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"default_value","full_name":"lookup_key[default_value]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"path","full_name":"lookup_key[path]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"description","full_name":"lookup_key[description]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"validator_type","full_name":"lookup_key[validator_type]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"validator_rule","full_name":"lookup_key[validator_rule]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"is_param","full_name":"lookup_key[is_param]","description":"","required":false,"allow_nil":false,"validator":"Must be 'true' or 'false'","expected_type":"string"},{"name":"key_type","full_name":"lookup_key[key_type]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"override","full_name":"lookup_key[override]","description":"","required":false,"allow_nil":false,"validator":"Must be 'true' or 'false'","expected_type":"string"},{"name":"required","full_name":"lookup_key[required]","description":"","required":false,"allow_nil":false,"validator":"Must be 'true' or 'false'","expected_type":"string"}]}],"examples":["PUT /api/lookup_keys/980190962-port\n{\n \"lookup_key\": {\n \"default_value\": 8080\n }\n}\n200\n{\n \"lookup_key\": {\n \"required\": false,\n \"id\": 980190962,\n \"description\": null,\n \"key\": \"port\",\n \"is_param\": true,\n \"override\": false,\n \"default_value\": 8080\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/lookup_keys/destroy","name":"destroy","apis":[{"api_url":"/api/smart_variables/:id","http_method":"DELETE","short_description":"Delete a smart variable."}],"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"}],"examples":["DELETE /api/lookup_keys/980190962-port\n200\n{\n \"lookup_key\": {\n \"required\": false,\n \"id\": 980190962,\n \"description\": null,\n \"key\": \"port\",\n \"is_param\": true,\n \"override\": false,\n \"default_value\": \"80\"\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/lookup_keys/host_or_hostgroup_smart_parameters","name":"host_or_hostgroup_smart_parameters","apis":[{"api_url":"/api/hosts/:host_id/smart_parameters","http_method":"GET","short_description":"List of smart parameters for a specific host"},{"api_url":"/api/hostgroups/:hostgroup_id/smart_parameters","http_method":"GET","short_description":"List of smart parameters for a specific hostgroup"}],"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"},{"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"},{"name":"page","full_name":"page","description":"<p>paginate results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"per_page","full_name":"per_page","description":"<p>number of entries per request</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/lookup_keys/host_or_hostgroup_smart_class_parameters","name":"host_or_hostgroup_smart_class_parameters","apis":[{"api_url":"/api/hosts/:host_id/smart_class_parameters","http_method":"GET","short_description":"List of smart class parameters for a specific host"},{"api_url":"/api/hostgroups/:hostgroup_id/smart_class_parameters","http_method":"GET","short_description":"List of smart class parameters for a specific hostgroup"}],"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"},{"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"},{"name":"page","full_name":"page","description":"<p>paginate results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"per_page","full_name":"per_page","description":"<p>number of entries per request</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/lookup_keys/puppet_smart_parameters","name":"puppet_smart_parameters","apis":[{"api_url":"/api/puppetclasses/:puppetclass_id/smart_parameters","http_method":"GET","short_description":"List of smart parameters for a specific puppetclass"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"puppetclass_id","full_name":"puppetclass_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"},{"name":"order","full_name":"order","description":"<p>sort results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"page","full_name":"page","description":"<p>paginate results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"per_page","full_name":"per_page","description":"<p>number of entries per request</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/lookup_keys/puppet_smart_class_parameters","name":"puppet_smart_class_parameters","apis":[{"api_url":"/api/puppetclasses/:puppetclass_id/environments/:environment_id/smart_class_parameters","http_method":"GET","short_description":"List of smart class parameters for a specific puppetclass and environment"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"puppetclass_id","full_name":"puppetclass_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"},{"name":"environment_id","full_name":"environment_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"},{"name":"order","full_name":"order","description":"<p>sort results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"page","full_name":"page","description":"<p>paginate results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"per_page","full_name":"per_page","description":"<p>number of entries per request</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":[],"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,"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."},{"api_url":"/api/hosts/:host_id/facts","http_method":"GET","short_description":"List all fact values of a given host."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"<p>filter results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"order","full_name":"order","description":"<p>sort results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"page","full_name":"page","description":"<p>paginate results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"per_page","full_name":"per_page","description":"<p>number of entries per request</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["GET /api/hosts/my5name.mydomain.net/facts\n200\n{\n \"my5name.mydomain.net\": {\n \"ipaddress\": \"10.0.19.33\",\n \"kernelversion\": \"2.6.9\"\n }\n}"],"see":[]}]},"domains":{"doc_url":"/apidoc/v2/domains","api_url":"/api","name":"Domains","short_description":null,"full_description":"<p>Foreman 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 <i>hostname</i>.<b>somewhere.com</b> then the domain is <b>somewhere.com</b>. 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.</p>","version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/domains/index","name":"index","apis":[{"api_url":"/api/domains","http_method":"GET","short_description":"List of domains"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"<p>Filter results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"order","full_name":"order","description":"<p>Sort results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"page","full_name":"page","description":"<p>paginate results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"per_page","full_name":"per_page","description":"<p>number of entries per request</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["GET /api/domains\n200\n[\n {\n \"domain\": {\n \"name\": \"mydomain.net\",\n \"id\": 22495316,\n \"dns_id\": 113629430,\n \"fullname\": null,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"created_at\": \"2012-12-18T15:24:43Z\"\n }\n },\n {\n \"domain\": {\n \"name\": \"unused.net\",\n \"id\": 759776763,\n \"dns_id\": 113629430,\n \"fullname\": \"somewhare that is never used\",\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"created_at\": \"2012-12-18T15:24:43Z\"\n }\n },\n {\n \"domain\": {\n \"name\": \"useless.net\",\n \"id\": 229305443,\n \"dns_id\": null,\n \"fullname\": null,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"created_at\": \"2012-12-18T15:24:43Z\"\n }\n },\n {\n \"domain\": {\n \"name\": \"yourdomain.net\",\n \"id\": 589326610,\n \"dns_id\": 113629430,\n \"fullname\": \"somewhere in yourdomain\",\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"created_at\": \"2012-12-18T15:24:43Z\"\n }\n }\n]"],"see":[]},{"doc_url":"/apidoc/v2/domains/show","name":"show","apis":[{"api_url":"/api/domains/:id","http_method":"GET","short_description":"Show a domain."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"<p>May be numerical id or domain name</p>","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"}],"examples":["GET /api/domains/mydomain.net\n200\n{\n \"domain\": {\n \"name\": \"mydomain.net\",\n \"id\": 22495316,\n \"dns_id\": 113629430,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"fullname\": null,\n \"created_at\": \"2012-12-18T15:24:43Z\"\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/domains/create","name":"create","apis":[{"api_url":"/api/domains","http_method":"POST","short_description":"Create a domain."}],"formats":null,"full_description":"<p>The <b>fullname</b> field is used for human readability in reports and other pages that refer to domains, and also available as an external node parameter</p>","errors":[],"params":[{"name":"domain","full_name":"domain","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"name","full_name":"domain[name]","description":"<p>The full DNS Domain name</p>","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"fullname","full_name":"domain[fullname]","description":"<p>Full name describing the domain</p>","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string"},{"name":"dns_id","full_name":"domain[dns_id]","description":"<p>DNS Proxy to use within this domain</p>","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string"},{"name":"domain_parameters_attributes","full_name":"domain[domain_parameters_attributes]","description":"<p>Array of parameters (name, value)</p>","required":false,"allow_nil":false,"validator":"Must be Array","expected_type":"array"}]}],"examples":["POST /api/domains\n{\n \"domain\": {\n \"name\": \"domain.net\"\n }\n}\n201\n{\n \"domain\": {\n \"name\": \"domain.net\",\n \"id\": 759776764\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/domains/update","name":"update","apis":[{"api_url":"/api/domains/:id","http_method":"PUT","short_description":"Update a domain."}],"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"},{"name":"domain","full_name":"domain","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"name","full_name":"domain[name]","description":"<p>The full DNS Domain name</p>","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string"},{"name":"fullname","full_name":"domain[fullname]","description":"<p>Full name describing the domain</p>","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string"},{"name":"dns_id","full_name":"domain[dns_id]","description":"<p>DNS Proxy to use within this domain</p>","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string"},{"name":"domain_parameters_attributes","full_name":"domain[domain_parameters_attributes]","description":"<p>Array of parameters (name, value)</p>","required":false,"allow_nil":false,"validator":"Must be Array","expected_type":"array"}]}],"examples":["PUT /api/domains/mydomain.net\n{\n \"domain\": {\n \"name\": \"\"\n }\n}\n422\n{\n \"domain\": {\n \"id\": 22495316,\n \"errors\": {\n \"name\": [\n \"can't be blank\"\n ]\n },\n \"full_messages\": [\n \"Name can't be blank\"\n ]\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/domains/destroy","name":"destroy","apis":[{"api_url":"/api/domains/:id","http_method":"DELETE","short_description":"Delete a domain."}],"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"}],"examples":["DELETE /api/domains/mydomain.net\n200\n{\n \"domain\": {\n \"name\": \"mydomain.net\",\n \"id\": 22495316\n }\n}"],"see":[]}]},"usergroups":{"doc_url":"/apidoc/v2/usergroups","api_url":"/api","name":"Usergroups","short_description":null,"full_description":null,"version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/usergroups/index","name":"index","apis":[{"api_url":"/api/usergroups","http_method":"GET","short_description":"List all usergroups."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"page","full_name":"page","description":"<p>paginate results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"per_page","full_name":"per_page","description":"<p>number of entries per request</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"search","full_name":"search","description":"<p>filter results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"order","full_name":"order","description":"<p>sort results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["GET /api/usergroups\n200\n[\n {\n \"usergroup\": {\n \"name\": \"MyString\",\n \"id\": 980190962,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"created_at\": \"2012-12-18T15:24:43Z\"\n }\n },\n {\n \"usergroup\": {\n \"name\": \"MyString2\",\n \"id\": 298486374,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"created_at\": \"2012-12-18T15:24:43Z\"\n }\n }\n]"],"see":[]},{"doc_url":"/apidoc/v2/usergroups/show","name":"show","apis":[{"api_url":"/api/usergroups/:id","http_method":"GET","short_description":"Show a usergroup."}],"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"}],"examples":["GET /api/usergroups/980190962\n200\n{\n \"usergroup\": {\n \"name\": \"MyString\",\n \"id\": 980190962,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"created_at\": \"2012-12-18T15:24:43Z\"\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/usergroups/create","name":"create","apis":[{"api_url":"/api/usergroups","http_method":"POST","short_description":"Create a usergroup."}],"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","params":[{"name":"name","full_name":"usergroup[name]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"}]}],"examples":["POST /api/usergroups\n{\n \"usergroup\": {\n \"name\": \"test_usergroup\"\n }\n}\n201\n{\n \"usergroup\": {\n \"name\": \"test_usergroup\",\n \"id\": 980190963\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/usergroups/update","name":"update","apis":[{"api_url":"/api/usergroups/:id","http_method":"PUT","short_description":"Update a usergroup."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"usergroup","full_name":"usergroup","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"name","full_name":"usergroup[name]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}]}],"examples":["PUT /api/usergroups/980190962\n{\n \"usergroup\": {}\n}\n200\n{\n \"usergroup\": {\n \"name\": \"MyString\",\n \"id\": 980190962\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/usergroups/destroy","name":"destroy","apis":[{"api_url":"/api/usergroups/:id","http_method":"DELETE","short_description":"Delete a usergroup."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["DELETE /api/usergroups/980190962\n200\n{\n \"usergroup\": {\n \"name\": \"MyString\",\n \"id\": 980190962\n }\n}"],"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,"methods":[{"doc_url":"/apidoc/v2/config_templates/index","name":"index","apis":[{"api_url":"/api/config_templates","http_method":"GET","short_description":"List templates"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"<p>filter results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"order","full_name":"order","description":"<p>sort results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"page","full_name":"page","description":"<p>paginate results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"per_page","full_name":"per_page","description":"<p>number of entries per request</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["GET /api/config_templates\n200\n[\n {\n \"config_template\": {\n \"name\": \"centos5_3_pxelinux\",\n \"audit_comment\": null,\n \"id\": 1007981701,\n \"snippet\": null,\n \"template\": \"default linux~label linux~kernel <%= @kernel %>~append initrd=<%= @initrd %> ks=<%= foreman_url(\\\"kickstart\\\")%> ksdevice=bootif network kssendmac\",\n \"template_kind\": {\n \"name\": \"PXELinux\",\n \"id\": 452984334\n }\n }\n },\n {\n \"config_template\": {\n \"name\": \"MyFinish\",\n \"audit_comment\": null,\n \"id\": 104314179,\n \"snippet\": null,\n \"template\": \"MyFinish\",\n \"template_kind\": {\n \"name\": \"finish\",\n \"id\": 550103832\n }\n }\n },\n {\n \"config_template\": {\n \"name\": \"MyScript\",\n \"audit_comment\": null,\n \"id\": 981457253,\n \"snippet\": null,\n \"template\": \"MyText\",\n \"template_kind\": {\n \"name\": \"script\",\n \"id\": 478250810\n }\n }\n },\n {\n \"config_template\": {\n \"name\": \"MyString\",\n \"audit_comment\": null,\n \"id\": 943779058,\n \"snippet\": null,\n \"template\": \"MyText\",\n \"template_kind\": {\n \"name\": \"gPXE\",\n \"id\": 158998239\n }\n }\n },\n {\n \"config_template\": {\n \"name\": \"MyString2\",\n \"audit_comment\": null,\n \"id\": 269958254,\n \"snippet\": null,\n \"template\": \"MyText\",\n \"template_kind\": {\n \"name\": \"provision\",\n \"id\": 983253650\n }\n }\n },\n {\n \"config_template\": {\n \"name\": \"PXE Default File\",\n \"audit_comment\": null,\n \"id\": 352050261,\n \"snippet\": null,\n \"template\": \"default linux~label linux~kernel <%= @kernel %>~append initrd=<%= @initrd %> ksdevice=bootif network kssendmac\",\n \"template_kind\": {\n \"name\": \"PXELinux\",\n \"id\": 452984334\n }\n }\n },\n {\n \"config_template\": {\n \"name\": \"PXE Default Menu\",\n \"audit_comment\": null,\n \"id\": 684651467,\n \"\": null,\n \"snippet\": null,\n \"template\": \"FOO\"\n }\n },\n {\n \"config_template\": {\n \"name\": \"PXE Localboot Default\",\n \"audit_comment\": null,\n \"id\": 821548108,\n \"snippet\": null,\n \"template\": \"DEFAULT menu~PROMPT 0~MENU TITLE PXE Menu~TIMEOUT 200~TOTALTIMEOUT 6000~ONTIMEOUT local~~LABEL local~MENU LABEL (local)~MENU DEFAULT~LOCALBOOT 0\",\n \"template_kind\": {\n \"name\": \"PXELinux\",\n \"id\": 452984334\n }\n }\n }\n]"],"see":[]},{"doc_url":"/apidoc/v2/config_templates/show","name":"show","apis":[{"api_url":"/api/config_templates/:id","http_method":"GET","short_description":"Show template details"}],"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"}],"examples":["GET /api/config_templates/centos5_3_pxelinux\n200\n{\n \"config_template\": {\n \"name\": \"centos5_3_pxelinux\",\n \"id\": 1007981701,\n \"audit_comment\": null,\n \"snippet\": null,\n \"template\": \"default linux~label linux~kernel <%= @kernel %>~append initrd=<%= @initrd %> ks=<%= foreman_url(\\\"kickstart\\\")%> ksdevice=bootif network kssendmac\",\n \"template_kind\": {\n \"name\": \"PXELinux\",\n \"id\": 452984334\n }\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/config_templates/create","name":"create","apis":[{"api_url":"/api/config_templates","http_method":"POST","short_description":"Create a template"}],"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","params":[{"name":"name","full_name":"config_template[name]","description":"<p>template name</p>","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"template","full_name":"config_template[template]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"snippet","full_name":"config_template[snippet]","description":"","required":false,"allow_nil":true,"validator":"Must be 'true' or 'false'","expected_type":"string"},{"name":"audit_comment","full_name":"config_template[audit_comment]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string"},{"name":"template_kind_id","full_name":"config_template[template_kind_id]","description":"<p>not relevant for snippet</p>","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string"},{"name":"template_combinations_attributes","full_name":"config_template[template_combinations_attributes]","description":"<p>Array of template combinations (hostgroup_id, environment_id)</p>","required":false,"allow_nil":false,"validator":"Must be Array","expected_type":"array"},{"name":"operatingsystem_ids","full_name":"config_template[operatingsystem_ids]","description":"<p>Array of operating systems ID to associate the template with</p>","required":false,"allow_nil":false,"validator":"Must be Array","expected_type":"array"}]}],"examples":["POST /api/config_templates\n{\n \"config_template\": {\n \"name\": \"RandomName\",\n \"template\": \"This is a test template\",\n \"template_kind_id\": 1\n }\n}\n200\n{\n \"config_template\": {\n \"name\": \"RandomName\",\n \"audit_comment\": null,\n \"id\": 1007981702,\n \"\": null,\n \"snippet\": null,\n \"template\": \"This is a test template\"\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/config_templates/update","name":"update","apis":[{"api_url":"/api/config_templates/:id","http_method":"PUT","short_description":"Update a template"}],"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"},{"name":"config_template","full_name":"config_template","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"name","full_name":"config_template[name]","description":"<p>template name</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"template","full_name":"config_template[template]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"snippet","full_name":"config_template[snippet]","description":"","required":false,"allow_nil":false,"validator":"Must be 'true' or 'false'","expected_type":"string"},{"name":"audit_comment","full_name":"config_template[audit_comment]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string"},{"name":"template_kind_id","full_name":"config_template[template_kind_id]","description":"<p>not relevant for snippet</p>","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string"},{"name":"template_combinations_attributes","full_name":"config_template[template_combinations_attributes]","description":"<p>Array of template combinations (hostgroup_id, environment_id)</p>","required":false,"allow_nil":false,"validator":"Must be Array","expected_type":"array"},{"name":"operatingsystem_ids","full_name":"config_template[operatingsystem_ids]","description":"<p>Array of operating systems ID to associate the template with</p>","required":false,"allow_nil":false,"validator":"Must be Array","expected_type":"array"}]}],"examples":["PUT /api/config_templates/centos5_3_pxelinux\n{\n \"config_template\": {\n \"audit_comment\": \"aha\",\n \"template\": \"tmp\"\n }\n}\n200\n{\n \"config_template\": {\n \"name\": \"centos5_3_pxelinux\",\n \"id\": 1007981701,\n \"template\": \"tmp\",\n \"snippet\": null,\n \"template_kind\": {\n \"name\": \"PXELinux\",\n \"id\": 452984334\n }\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/config_templates/revision","name":"revision","apis":[{"api_url":"/api/config_templates/revision","http_method":"GET","short_description":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"version","full_name":"version","description":"<p>template version</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/config_templates/destroy","name":"destroy","apis":[{"api_url":"/api/config_templates/:id","http_method":"DELETE","short_description":"Delete a template"}],"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"}],"examples":["DELETE /api/config_templates/centos5_3_pxelinux\n200\n{\n \"config_template\": {\n \"name\": \"centos5_3_pxelinux\",\n \"id\": 1007981701,\n \"template\": \"default linux~label linux~kernel <%= @kernel %>~append initrd=<%= @initrd %> ks=<%= foreman_url(\\\"kickstart\\\")%> ksdevice=bootif network kssendmac\",\n \"snippet\": null,\n \"template_kind\": {\n \"name\": \"PXELinux\",\n \"id\": 452984334\n }\n }\n}"],"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":"GET","short_description":"Change the default PXE menu on all configured TFTP servers"}],"formats":null,"full_description":"","errors":[],"params":[],"examples":["GET /api/config_templates/build_pxe_default\n200\nPXE Default file has been deployed to all Smart Proxies"],"see":[]}]},"subnets":{"doc_url":"/apidoc/v2/subnets","api_url":"/api","name":"Subnets","short_description":null,"full_description":null,"version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/subnets/index","name":"index","apis":[{"api_url":"/api/subnets","http_method":"GET","short_description":"List of subnets"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"<p>Filter results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"order","full_name":"order","description":"<p>Sort results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"page","full_name":"page","description":"<p>paginate results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"per_page","full_name":"per_page","description":"<p>number of entries per request</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["GET /api/subnets\n200\n[\n {\n \"subnet\": {\n \"priority\": null,\n \"name\": \"one\",\n \"network\": \"2.3.4.0\",\n \"dns_secondary\": null,\n \"domain_ids\": [\n 822172901\n ],\n \"tftp_id\": 298486374,\n \"id\": 980190962,\n \"dhcp_id\": 980190962,\n \"dns_id\": 113629430,\n \"dns_primary\": null,\n \"vlanid\": \"41\",\n \"mask\": \"255.255.255.0\",\n \"from\": null,\n \"gateway\": null,\n \"to\": null\n }\n },\n {\n \"subnet\": {\n \"priority\": null,\n \"name\": \"two\",\n \"network\": \"3.3.4.0\",\n \"dns_secondary\": null,\n \"domain_ids\": [\n 534821992\n ],\n \"tftp_id\": 298486374,\n \"id\": 298486374,\n \"dhcp_id\": 980190962,\n \"dns_id\": null,\n \"dns_primary\": null,\n \"vlanid\": \"42\",\n \"mask\": \"255.255.255.0\",\n \"from\": null,\n \"gateway\": null,\n \"to\": null\n }\n },\n {\n \"subnet\": {\n \"priority\": null,\n \"name\": \"three\",\n \"network\": \"3.3.4.3\",\n \"dns_secondary\": null,\n \"domain_ids\": [],\n \"tftp_id\": 298486374,\n \"id\": 113629430,\n \"dhcp_id\": 980190962,\n \"dns_id\": null,\n \"dns_primary\": null,\n \"vlanid\": \"43\",\n \"mask\": \"255.255.255.0\",\n \"from\": null,\n \"gateway\": null,\n \"to\": null\n }\n }\n]"],"see":[]},{"doc_url":"/apidoc/v2/subnets/show","name":"show","apis":[{"api_url":"/api/subnets/:id","http_method":"GET","short_description":"Show a subnet."}],"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"}],"examples":["GET /api/subnets/980190962\n200\n{\n \"subnet\": {\n \"priority\": null,\n \"name\": \"one\",\n \"network\": \"2.3.4.0\",\n \"dns\": {\n \"url\": \"http://else.where:4567\",\n \"name\": \"DNS Proxy\",\n \"id\": 113629430\n },\n \"dns_secondary\": null,\n \"domain_ids\": [\n 822172901\n ],\n \"tftp_id\": 298486374,\n \"id\": 980190962,\n \"dhcp_id\": 980190962,\n \"dns_id\": 113629430,\n \"dhcp\": {\n \"url\": \"https://somewhere.net:8443\",\n \"name\": \"DHCP Proxy\",\n \"id\": 980190962\n },\n \"dns_primary\": null,\n \"vlanid\": \"41\",\n \"mask\": \"255.255.255.0\",\n \"tftp\": {\n \"url\": \"http://somewhere.else\",\n \"name\": \"TFTP Proxy\",\n \"id\": 298486374\n },\n \"from\": null,\n \"gateway\": null,\n \"to\": null\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/subnets/create","name":"create","apis":[{"api_url":"/api/subnets","http_method":"POST","short_description":"Create a subnet"}],"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","params":[{"name":"name","full_name":"subnet[name]","description":"<p>Subnet name</p>","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"network","full_name":"subnet[network]","description":"<p>Subnet network</p>","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"mask","full_name":"subnet[mask]","description":"<p>Netmask for this subnet</p>","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"gateway","full_name":"subnet[gateway]","description":"<p>Primary DNS for this subnet</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"dns_primary","full_name":"subnet[dns_primary]","description":"<p>Primary DNS for this subnet</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"dns_secondary","full_name":"subnet[dns_secondary]","description":"<p>Secondary DNS for this subnet</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"from","full_name":"subnet[from]","description":"<p>Starting IP Address for IP auto suggestion</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"to","full_name":"subnet[to]","description":"<p>Ending IP Address for IP auto suggestion</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"vlanid","full_name":"subnet[vlanid]","description":"<p>VLAN ID for this subnet</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"domain_ids","full_name":"subnet[domain_ids]","description":"<p>Domains in which this subnet is part</p>","required":false,"allow_nil":false,"validator":"Must be Array","expected_type":"array"},{"name":"dhcp_id","full_name":"subnet[dhcp_id]","description":"<p>DHCP Proxy to use within this subnet</p>","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"tftp_id","full_name":"subnet[tftp_id]","description":"<p>TFTP Proxy to use within this subnet</p>","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"dns_id","full_name":"subnet[dns_id]","description":"<p>DNS Proxy to use within this subnet</p>","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"}]}],"examples":["POST /api/subnets\n{\n \"subnet\": {\n \"name\": \"QA2\",\n \"network\": \"10.35.2.27\",\n \"mask\": \"255.255.255.0\"\n }\n}\n200\n{\n \"subnet\": {\n \"priority\": null,\n \"name\": \"QA2\",\n \"dns\": null,\n \"network\": \"10.35.2.27\",\n \"dns_secondary\": null,\n \"domain_ids\": [],\n \"id\": 980190963,\n \"tftp_id\": null,\n \"dhcp_id\": null,\n \"dns_id\": null,\n \"dhcp\": null,\n \"dns_primary\": null,\n \"vlanid\": null,\n \"mask\": \"255.255.255.0\",\n \"tftp\": null,\n \"gateway\": null,\n \"from\": null,\n \"to\": null\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/subnets/update","name":"update","apis":[{"api_url":"/api/subnets/:id","http_method":"PUT","short_description":"Update a subnet"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"<p>Subnet numeric identifier</p>","required":true,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"},{"name":"subnet","full_name":"subnet","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"name","full_name":"subnet[name]","description":"<p>Subnet name</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"network","full_name":"subnet[network]","description":"<p>Subnet network</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"mask","full_name":"subnet[mask]","description":"<p>Netmask for this subnet</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"gateway","full_name":"subnet[gateway]","description":"<p>Primary DNS for this subnet</p>","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string"},{"name":"dns_primary","full_name":"subnet[dns_primary]","description":"<p>Primary DNS for this subnet</p>","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string"},{"name":"dns_secondary","full_name":"subnet[dns_secondary]","description":"<p>Secondary DNS for this subnet</p>","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string"},{"name":"from","full_name":"subnet[from]","description":"<p>Starting IP Address for IP auto suggestion</p>","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string"},{"name":"to","full_name":"subnet[to]","description":"<p>Ending IP Address for IP auto suggestion</p>","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string"},{"name":"vlanid","full_name":"subnet[vlanid]","description":"<p>VLAN ID for this subnet</p>","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string"},{"name":"domain_ids","full_name":"subnet[domain_ids]","description":"<p>Domains in which this subnet is part</p>","required":false,"allow_nil":true,"validator":"Must be Array","expected_type":"array"},{"name":"dhcp_id","full_name":"subnet[dhcp_id]","description":"<p>DHCP Proxy to use within this subnet</p>","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string"},{"name":"tftp_id","full_name":"subnet[tftp_id]","description":"<p>TFTP Proxy to use within this subnet</p>","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string"},{"name":"dns_id","full_name":"subnet[dns_id]","description":"<p>DNS Proxy to use within this subnet</p>","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string"}]}],"examples":["PUT /api/subnets/980190962\n{\n \"subnet\": {}\n}\n200\n{\n \"subnet\": {\n \"priority\": null,\n \"name\": \"one\",\n \"dns\": {\n \"url\": \"http://else.where:4567\",\n \"name\": \"DNS Proxy\",\n \"id\": 113629430\n },\n \"network\": \"2.3.4.0\",\n \"dns_secondary\": null,\n \"domain_ids\": [\n 822172901\n ],\n \"id\": 980190962,\n \"tftp_id\": 298486374,\n \"dhcp_id\": 980190962,\n \"dns_id\": 113629430,\n \"dhcp\": {\n \"url\": \"https://somewhere.net:8443\",\n \"name\": \"DHCP Proxy\",\n \"id\": 980190962\n },\n \"dns_primary\": null,\n \"vlanid\": \"41\",\n \"mask\": \"255.255.255.0\",\n \"tftp\": {\n \"url\": \"http://somewhere.else\",\n \"name\": \"TFTP Proxy\",\n \"id\": 298486374\n },\n \"gateway\": null,\n \"from\": null,\n \"to\": null\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/subnets/destroy","name":"destroy","apis":[{"api_url":"/api/subnets/:id","http_method":"DELETE","short_description":"Delete a subnet"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"<p>Subnet numeric identifier</p>","required":true,"allow_nil":false,"validator":"Must be a number.","expected_type":"string"}],"examples":["DELETE /api/subnets/980190962\n422\n{\n \"subnet\": {\n \"id\": 980190962,\n \"errors\": {\n \"base\": [\n \"2.3.4.0/24 is used by temp-01.yourdomain.net\",\n \"2.3.4.0/24 is used by suse01.yourdomain.net\",\n \"2.3.4.0/24 is used by temp01.yourdomain.net\",\n \"2.3.4.0/24 is used by anotherfullhost\",\n \"2.3.4.0/24 is used by temp.yourdomain.net\",\n \"2.3.4.0/24 is used by my5name.mydomain.net\",\n \"2.3.4.0/24 is used by dhcp.mydomain.net\",\n \"2.3.4.0/24 is used by otherfullhost\",\n \"2.3.4.0/24 is used by sdhcp.mydomain.net\",\n \"2.3.4.0/24 is used by sol10host\",\n \"2.3.4.0/24 is used by sdhcp.mydomain.net\"\n ]\n },\n \"full_messages\": [\n \"2.3.4.0/24 is used by temp-01.yourdomain.net\",\n \"2.3.4.0/24 is used by suse01.yourdomain.net\",\n \"2.3.4.0/24 is used by temp01.yourdomain.net\",\n \"2.3.4.0/24 is used by anotherfullhost\",\n \"2.3.4.0/24 is used by temp.yourdomain.net\",\n \"2.3.4.0/24 is used by my5name.mydomain.net\",\n \"2.3.4.0/24 is used by dhcp.mydomain.net\",\n \"2.3.4.0/24 is used by otherfullhost\",\n \"2.3.4.0/24 is used by sdhcp.mydomain.net\",\n \"2.3.4.0/24 is used by sol10host\",\n \"2.3.4.0/24 is used by sdhcp.mydomain.net\"\n ]\n }\n}"],"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,"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."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"<p>filter results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"order","full_name":"order","description":"<p>sort results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"page","full_name":"page","description":"<p>paginate results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"per_page","full_name":"per_page","description":"<p>number of entries per request</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["GET /api/compute_resources\n200\n[\n {\n \"compute_resource\": {\n \"name\": \"mycompute\",\n \"url\": \"test:///default\",\n \"user\": \"MyString\",\n \"provider\": \"Libvirt\",\n \"id\": 367690737,\n \"description\": \"mycompute\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"created_at\": \"2012-12-18T15:24:42Z\"\n }\n },\n {\n \"compute_resource\": {\n \"name\": \"MyString\",\n \"url\": \"qemu://stam/system\",\n \"user\": \"MyString\",\n \"provider\": \"Libvirt\",\n \"id\": 980190962,\n \"description\": \"MyString\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"created_at\": \"2012-12-18T15:24:42Z\"\n }\n },\n {\n \"compute_resource\": {\n \"name\": \"yourcompute\",\n \"url\": \"test:///default\",\n \"user\": \"MyString\",\n \"provider\": \"Libvirt\",\n \"id\": 932571420,\n \"description\": \"yourcompute\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"created_at\": \"2012-12-18T15:24:42Z\"\n }\n }\n]"],"see":[]},{"doc_url":"/apidoc/v2/compute_resources/show","name":"show","apis":[{"api_url":"/api/compute_resources/:id","http_method":"GET","short_description":"Show an compute resource."}],"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"}],"examples":["GET /api/compute_resources/980190962-mystring\n200\n{\n \"compute_resource\": {\n \"name\": \"MyString\",\n \"url\": \"qemu://stam/system\",\n \"user\": \"MyString\",\n \"provider\": \"Libvirt\",\n \"id\": 980190962,\n \"description\": \"MyString\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"created_at\": \"2012-12-18T15:24:42Z\"\n }\n}"],"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."}],"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","params":[{"name":"name","full_name":"compute_resource[name]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"provider","full_name":"compute_resource[provider]","description":"<p>Providers include Libvirt, Ovirt, EC2, Vmware, Openstack, Rackspace</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"url","full_name":"compute_resource[url]","description":"<p>URL for Libvirt, Ovirt, and Openstack</p>","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"description","full_name":"compute_resource[description]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"user","full_name":"compute_resource[user]","description":"<p>Username for Ovirt, EC2, Vmware, Openstack. Access Key for EC2.</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"password","full_name":"compute_resource[password]","description":"<p>Password for Ovirt, EC2, Vmware, Openstack. Secret key for EC2</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"uuid","full_name":"compute_resource[uuid]","description":"<p>for Ovirt, Vmware Datacenter</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"region","full_name":"compute_resource[region]","description":"<p>for EC2 only</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"tenant","full_name":"compute_resource[tenant]","description":"<p>for Openstack only</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"server","full_name":"compute_resource[server]","description":"<p>for Vmware</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}]}],"examples":["POST /api/compute_resources\n{\n \"compute_resource\": {\n \"name\": \"special_compute\",\n \"user\": \"user@example.com\",\n \"provider\": \"EC2\",\n \"password\": \"secret\",\n \"region\": \"eu-west-1\"\n }\n}\n200\n{\n \"compute_resource\": {\n \"name\": \"special_compute\",\n \"url\": \"eu-west-1\",\n \"user\": \"user@example.com\",\n \"provider\": \"EC2\",\n \"id\": 980190963,\n \"description\": null,\n \"updated_at\": \"2012-12-18T15:24:44Z\",\n \"created_at\": \"2012-12-18T15:24:44Z\"\n }\n}"],"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."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"compute_resource","full_name":"compute_resource","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"name","full_name":"compute_resource[name]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"provider","full_name":"compute_resource[provider]","description":"<p>Providers include Libvirt, Ovirt, EC2, Vmware, Openstack, Rackspace</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"url","full_name":"compute_resource[url]","description":"<p>URL for Libvirt, Ovirt, and Openstack</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"description","full_name":"compute_resource[description]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"user","full_name":"compute_resource[user]","description":"<p>Username for Ovirt, EC2, Vmware, Openstack. Access Key for EC2.</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"password","full_name":"compute_resource[password]","description":"<p>Password for Ovirt, EC2, Vmware, Openstack. Secret key for EC2</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"uuid","full_name":"compute_resource[uuid]","description":"<p>for Ovirt, Vmware Datacenter</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"region","full_name":"compute_resource[region]","description":"<p>for EC2 only</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"tenant","full_name":"compute_resource[tenant]","description":"<p>for Openstack only</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"server","full_name":"compute_resource[server]","description":"<p>for Vmware</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}]}],"examples":["PUT /api/compute_resources/367690737-mycompute\n{\n \"compute_resource\": {\n \"description\": \"new_description\"\n }\n}\n200\n{\n \"compute_resource\": {\n \"url\": \"test:///default\",\n \"name\": \"mycompute\",\n \"user\": \"MyString\",\n \"id\": 367690737,\n \"uuid\": \"mycompute\",\n \"updated_at\": \"2012-12-18T15:24:45Z\",\n \"description\": \"new_description\",\n \"attrs\": {},\n \"created_at\": \"2012-12-18T15:24:42Z\"\n }\n}"],"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."}],"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"}],"examples":["DELETE /api/compute_resources/932571420\n200\n{\n \"compute_resource\": {\n \"url\": \"test:///default\",\n \"name\": \"yourcompute\",\n \"user\": \"MyString\",\n \"id\": 932571420,\n \"uuid\": \"yourcompute\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"description\": \"yourcompute\",\n \"attrs\": null,\n \"created_at\": \"2012-12-18T15:24:42Z\"\n }\n}"],"see":[]}]},"ptables":{"doc_url":"/apidoc/v2/ptables","api_url":"/api","name":"Ptables","short_description":null,"full_description":null,"version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/ptables/index","name":"index","apis":[{"api_url":"/api/ptables","http_method":"GET","short_description":"List all ptables."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"<p>filter results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"order","full_name":"order","description":"<p>sort results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"page","full_name":"page","description":"<p>paginate results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"per_page","full_name":"per_page","description":"<p>number of entries per request</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["GET /api/ptables\n200\n[\n {\n \"ptable\": {\n \"name\": \"default\",\n \"id\": 980190962,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"created_at\": \"2012-12-18T15:24:43Z\"\n }\n },\n {\n \"ptable\": {\n \"name\": \"four\",\n \"id\": 281110143,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"created_at\": \"2012-12-18T15:24:43Z\"\n }\n },\n {\n \"ptable\": {\n \"name\": \"suse default\",\n \"id\": 859751735,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"created_at\": \"2012-12-18T15:24:43Z\"\n }\n },\n {\n \"ptable\": {\n \"name\": \"ubuntu default\",\n \"id\": 1011586618,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"created_at\": \"2012-12-18T15:24:43Z\"\n }\n }\n]"],"see":[]},{"doc_url":"/apidoc/v2/ptables/show","name":"show","apis":[{"api_url":"/api/ptables/:id","http_method":"GET","short_description":"Show a ptable."}],"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"}],"examples":["GET /api/ptables/980190962\n200\n{\n \"ptable\": {\n \"name\": \"default\",\n \"id\": 980190962,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"created_at\": \"2012-12-18T15:24:43Z\"\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/ptables/create","name":"create","apis":[{"api_url":"/api/ptables","http_method":"POST","short_description":"Create a ptable."}],"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","params":[{"name":"name","full_name":"ptable[name]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"layout","full_name":"ptable[layout]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"os_family","full_name":"ptable[os_family]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}]}],"examples":["POST /api/ptables\n{\n \"ptable\": {\n \"name\": \"ptable_test\",\n \"layout\": \"d-i partman-auto/disk\"\n }\n}\n201\n{\n \"ptable\": {\n \"name\": \"ptable_test\",\n \"id\": 1011586619\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/ptables/update","name":"update","apis":[{"api_url":"/api/ptables/:id","http_method":"PUT","short_description":"Update a ptable."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"ptable","full_name":"ptable","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"name","full_name":"ptable[name]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"layout","full_name":"ptable[layout]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"os_family","full_name":"ptable[os_family]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}]}],"examples":["PUT /api/ptables/980190962\n{\n \"ptable\": {}\n}\n200\n{\n \"ptable\": {\n \"name\": \"default\",\n \"id\": 980190962\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/ptables/destroy","name":"destroy","apis":[{"api_url":"/api/ptables/:id","http_method":"DELETE","short_description":"Delete a ptable."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":["DELETE /api/ptables/980190962\n422\n{\n \"ptable\": {\n \"id\": 980190962,\n \"errors\": {\n \"base\": [\n \"default is used by temp01.yourdomain.net\",\n \"default is used by temp.yourdomain.net\",\n \"default is used by my5name.mydomain.net\",\n \"default is used by dhcp.mydomain.net\",\n \"default is used by sdhcp.mydomain.net\"\n ]\n },\n \"full_messages\": [\n \"default is used by temp01.yourdomain.net\",\n \"default is used by temp.yourdomain.net\",\n \"default is used by my5name.mydomain.net\",\n \"default is used by dhcp.mydomain.net\",\n \"default is used by sdhcp.mydomain.net\"\n ]\n }\n}"],"see":[]}]},"home":{"doc_url":"/apidoc/v2/home","api_url":"/api","name":"Home","short_description":null,"full_description":null,"version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/home/index","name":"index","apis":[{"api_url":"/api","http_method":"GET","short_description":"Show available links."}],"formats":null,"full_description":"","errors":[],"params":[],"examples":["GET /api\n200\n{\n \"links\": {\n \"List all hosts\": \"/api/hosts\",\n \"List all compute resources\": \"/api/compute_resources\",\n \"List of subnets\": \"/api/subnets\",\n \"List all fact values\": \"/api/fact_values\",\n \"List all authsource ldaps\": \"/api/auth_source_ldaps\",\n \"List all settings\": \"/api/settings\",\n \"List of domains\": \"/api/domains\",\n \"List all operating systems\": \"/api/operatingsystems\",\n \"List all images for compute resource\": \"/api/compute_resources/:compute_resource_id/images\",\n \"List all smart_proxies\": \"/api/smart_proxies\",\n \"List all models\": \"/api/models\",\n \"List templates\": \"/api/config_templates\",\n \"List all architectures\": \"/api/architectures\",\n \"List all hostgroups\": \"/api/hostgroups\",\n \"List all environments\": \"/api/environments\",\n \"List all ptables\": \"/api/ptables\",\n \"List all users\": \"/api/users\",\n \"List all usergroups\": \"/api/usergroups\",\n \"List all common parameters\": \"/api/common_parameters\",\n \"List all puppetclasses\": \"/api/puppetclasses\",\n \"Show status\": \"/api/status\",\n \"List all media\": \"/api/media\",\n \"List all bookmarks\": \"/api/bookmarks\",\n \"List all template kinds\": \"/api/template_kinds\",\n \"Get Dashboard results\": \"/api/dashboard\",\n \"List all reports\": \"/api/reports\",\n \"Show available links\": \"/api\",\n \"List all lookup_keys\": \"/api/lookup_keys\",\n \"List all roles\": \"/api/roles\",\n \"List all audits\": \"/api/audits\"\n }\n}"],"see":[]},{"doc_url":"/apidoc/v2/home/status","name":"status","apis":[{"api_url":"/api/status","http_method":"GET","short_description":"Show status."}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"see":[]}]},"organizations":{"doc_url":"/apidoc/v2/organizations","api_url":"/api","name":"Organizations","short_description":null,"full_description":null,"version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/organizations/index","name":"index","apis":[{"api_url":"/api/organizations","http_method":"GET","short_description":"List all organizations"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"<p>filter results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"order","full_name":"order","description":"<p>sort results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"page","full_name":"page","description":"<p>paginate results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"per_page","full_name":"per_page","description":"<p>number of entries per request</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/organizations/show","name":"show","apis":[{"api_url":"/api/organizations/:id","http_method":"GET","short_description":"Show an organization"}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/organizations/create","name":"create","apis":[{"api_url":"/api/organizations","http_method":"POST","short_description":"Create an organization"}],"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","params":[{"name":"name","full_name":"organization[name]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"}]}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/organizations/update","name":"update","apis":[{"api_url":"/api/organizations/:id","http_method":"PUT","short_description":"Update an organization"}],"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","params":[{"name":"name","full_name":"organization[name]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}]}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/organizations/destroy","name":"destroy","apis":[{"api_url":"/api/organizations/:id","http_method":"DELETE","short_description":"Delete an organization"}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"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,"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 puppetclass id's for hostgroup"}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"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 puppetclass to hostgroup"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"hostgroup_id","full_name":"hostgroup_id","description":"<p>id of hostgroup</p>","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"puppetclass_id","full_name":"puppetclass_id","description":"<p>id of puppetclass</p>","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":[],"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 puppetclass from hostgroup"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"hostgroup_id","full_name":"hostgroup_id","description":"<p>id of hostgroup</p>","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"puppetclass_id","full_name":"puppetclass_id","description":"<p>id of puppetclass</p>","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":[],"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,"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"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"config_template_id","full_name":"config_template_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"}],"examples":[],"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"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"config_template_id","full_name":"config_template_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"},{"name":"template_combination","full_name":"template_combination","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"environment_id","full_name":"template_combination[environment_id]","description":"<p>environment id</p>","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string"},{"name":"hostgroup_id","full_name":"template_combination[hostgroup_id]","description":"<p>hostgroup id</p>","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string"}]}],"examples":[],"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"}],"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"}],"examples":[],"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"}],"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"}],"examples":[],"see":[]}]},"locations":{"doc_url":"/apidoc/v2/locations","api_url":"/api","name":"Locations","short_description":null,"full_description":null,"version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/locations/index","name":"index","apis":[{"api_url":"/api/locations","http_method":"GET","short_description":"List all locations"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"<p>filter results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"order","full_name":"order","description":"<p>sort results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"page","full_name":"page","description":"<p>paginate results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"per_page","full_name":"per_page","description":"<p>number of entries per request</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/locations/show","name":"show","apis":[{"api_url":"/api/locations/:id","http_method":"GET","short_description":"Show a location"}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/locations/create","name":"create","apis":[{"api_url":"/api/locations","http_method":"POST","short_description":"Create a location"}],"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","params":[{"name":"name","full_name":"location[name]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"}]}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/locations/update","name":"update","apis":[{"api_url":"/api/locations/:id","http_method":"PUT","short_description":"Update a location"}],"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","params":[{"name":"name","full_name":"location[name]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}]}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/locations/destroy","name":"destroy","apis":[{"api_url":"/api/locations/:id","http_method":"DELETE","short_description":"Delete a location"}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"see":[]}]},"parameters":{"doc_url":"/apidoc/v2/parameters","api_url":"/api","name":"Parameters","short_description":null,"full_description":"<p>These API calls are related to <b>nested parameters for host, domain, hostgroup, operating system</b>. If you are looking for <a href='common_parameters.html'>global parameters</a>, go to <a href='common_parameters.html'>this link</a>.</p>","version":"v2","formats":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 host"},{"api_url":"/api/hostgroups/:hostgroup_id/parameters","http_method":"GET","short_description":"List all parameters for hostgroup"},{"api_url":"/api/domains/:domain_id/parameters","http_method":"GET","short_description":"List all parameters for domain"},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters","http_method":"GET","short_description":"List all parameters for operating system"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"<p>id of host</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"<p>id of hostgroup</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"domain_id","full_name":"domain_id","description":"<p>id of domain</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"<p>id of operating system</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"page","full_name":"page","description":"<p>paginate results</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"per_page","full_name":"per_page","description":"<p>number of entries per request</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":[],"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 host"},{"api_url":"/api/hostgroups/:hostgroup_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for hostgroup"},{"api_url":"/api/domains/:domain_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for domain"},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for operating system"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"<p>id of host</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"<p>id of hostgroup</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"domain_id","full_name":"domain_id","description":"<p>id of domain</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"<p>id of operating system</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"id","full_name":"id","description":"<p>id of parameter</p>","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":[],"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 host"},{"api_url":"/api/hostgroups/:hostgroup_id/parameters","http_method":"POST","short_description":"Create a nested parameter for hostgroup"},{"api_url":"/api/domains/:domain_id/parameters","http_method":"POST","short_description":"Create a nested parameter for domain"},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters","http_method":"POST","short_description":"Create a nested parameter for operating system"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"<p>id of host</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"<p>id of hostgroup</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"domain_id","full_name":"domain_id","description":"<p>id of domain</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"<p>id of operating system</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"parameter","full_name":"parameter","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"name","full_name":"parameter[name]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"value","full_name":"parameter[value]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}]}],"examples":[],"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 host"},{"api_url":"/api/hostgroups/:hostgroup_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for hostgroup"},{"api_url":"/api/domains/:domain_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for domain"},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for operating system"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"<p>id of host</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"<p>id of hostgroup</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"domain_id","full_name":"domain_id","description":"<p>id of domain</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"<p>id of operating system</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"id","full_name":"id","description":"<p>id of parameter</p>","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"parameter","full_name":"parameter","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","params":[{"name":"name","full_name":"parameter[name]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"value","full_name":"parameter[value]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"}]}],"examples":[],"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 host"},{"api_url":"/api/hostgroups/:hostgroup_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for hostgroup"},{"api_url":"/api/domains/:domain_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for domain"},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for operating system"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"<p>id of host</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"<p>id of hostgroup</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"domain_id","full_name":"domain_id","description":"<p>id of domain</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"<p>id of operating system</p>","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"id","full_name":"id","description":"<p>id of parameter</p>","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":[],"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 host"},{"api_url":"/api/hostgroups/:hostgroup_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameters for hostgroup"},{"api_url":"/api/domains/:domain_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameters for domain"},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameters for operating system"}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"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,"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 puppetclass id's for host"}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"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 puppetclass to host"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"<p>id of host</p>","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"puppetclass_id","full_name":"puppetclass_id","description":"<p>id of puppetclass</p>","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":[],"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 puppetclass from host"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"<p>id of host</p>","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"},{"name":"id","full_name":"id","description":"<p>id of puppetclass</p>","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string"}],"examples":[],"see":[]}]}}}}
data/lib/foreman_api/resources/architecture.rb CHANGED
@@ -29,7 +29,7 @@ module ForemanApi
29
29
  # @param [Hash] params a hash of params to be passed to the service
30
30
  # @option params [Hash] architecture
31
31
  # allowed keys are:
32
- # * operatingsystem_ids [String] Operatingsystem id&#8217;s
32
+ # * operatingsystem_ids [Array] Operatingsystem id’s
33
33
  # * name [String]
34
34
  #
35
35
  # @param [Hash] headers additional http headers
@@ -42,7 +42,7 @@ module ForemanApi
42
42
  # @option params [String] id
43
43
  # @option params [Hash] architecture
44
44
  # allowed keys are:
45
- # * operatingsystem_ids [String] Operatingsystem id&#8217;s
45
+ # * operatingsystem_ids [Array] Operatingsystem id’s
46
46
  # * name [String]
47
47
  #
48
48
  # @param [Hash] headers additional http headers
data/lib/foreman_api/resources/config_template.rb CHANGED
@@ -29,13 +29,13 @@ module ForemanApi
29
29
  # @param [Hash] params a hash of params to be passed to the service
30
30
  # @option params [Hash] config_template
31
31
  # allowed keys are:
32
- # * operatingsystem_ids [String] Array of operating systems id to associate the template with
32
+ # * operatingsystem_ids [Array] Array of operating systems id to associate the template with
33
33
  # * template_kind_id [String, nil] Not relevant for snippet
34
34
  # * audit_comment [String, nil]
35
35
  # * name [String] Template name
36
36
  # * snippet [String, nil]
37
37
  # * template [String]
38
- # * template_combinations_attributes [String] Array of template combinations (hostgroup_id, environment_id)
38
+ # * template_combinations_attributes [Array] Array of template combinations (hostgroup_id, environment_id)
39
39
  #
40
40
  # @param [Hash] headers additional http headers
41
41
  # @return [Array] First item: parsed data; second item: raw body
@@ -47,13 +47,13 @@ module ForemanApi
47
47
  # @option params [String] id
48
48
  # @option params [Hash] config_template
49
49
  # allowed keys are:
50
- # * operatingsystem_ids [String] Array of operating systems id to associate the template with
50
+ # * operatingsystem_ids [Array] Array of operating systems id to associate the template with
51
51
  # * template_kind_id [String, nil] Not relevant for snippet
52
52
  # * audit_comment [String, nil]
53
53
  # * name [String] Template name
54
54
  # * snippet [String]
55
55
  # * template [String]
56
- # * template_combinations_attributes [String] Array of template combinations (hostgroup_id, environment_id)
56
+ # * template_combinations_attributes [Array] Array of template combinations (hostgroup_id, environment_id)
57
57
  #
58
58
  # @param [Hash] headers additional http headers
59
59
  # @return [Array] First item: parsed data; second item: raw body
data/lib/foreman_api/resources/domain.rb CHANGED
@@ -30,7 +30,7 @@ module ForemanApi
30
30
  # @option params [Hash] domain
31
31
  # allowed keys are:
32
32
  # * dns_id [String, nil] Dns proxy to use within this domain
33
- # * domain_parameters_attributes [String] Array of parameters (name, value)
33
+ # * domain_parameters_attributes [Array] Array of parameters (name, value)
34
34
  # * fullname [String, nil] Full name describing the domain
35
35
  # * name [String] The full dns domain name
36
36
  #
@@ -45,7 +45,7 @@ module ForemanApi
45
45
  # @option params [Hash] domain
46
46
  # allowed keys are:
47
47
  # * dns_id [String, nil] Dns proxy to use within this domain
48
- # * domain_parameters_attributes [String] Array of parameters (name, value)
48
+ # * domain_parameters_attributes [Array] Array of parameters (name, value)
49
49
  # * fullname [String, nil] Full name describing the domain
50
50
  # * name [String, nil] The full dns domain name
51
51
  #
data/lib/foreman_api/resources/host.rb CHANGED
@@ -43,7 +43,7 @@ module ForemanApi
43
43
  # * puppet_proxy_id [String]
44
44
  # * sp_subnet_id [String]
45
45
  # * subnet_id [String]
46
- # * host_parameters_attributes [String]
46
+ # * host_parameters_attributes [Array]
47
47
  # * ip [String] Not required if using a subnet with dhcp proxy
48
48
  # * mac [String] Not required if its a virtual machine
49
49
  # * name [String]
@@ -72,7 +72,7 @@ module ForemanApi
72
72
  # * puppet_proxy_id [String]
73
73
  # * sp_subnet_id [String]
74
74
  # * subnet_id [String]
75
- # * host_parameters_attributes [String]
75
+ # * host_parameters_attributes [Array]
76
76
  # * ip [String] Not required if using a subnet with dhcp proxy
77
77
  # * mac [String] Not required if its a virtual machine
78
78
  # * name [String]
data/lib/foreman_api/resources/hostgroup.rb CHANGED
@@ -34,6 +34,7 @@ module ForemanApi
34
34
  # * environment_id [String]
35
35
  # * medium_id [String]
36
36
  # * operatingsystem_id [String]
37
+ # * parent_id [String]
37
38
  # * ptable_id [String]
38
39
  # * puppet_ca_proxy_id [String]
39
40
  # * puppet_proxy_id [String]
@@ -55,6 +56,7 @@ module ForemanApi
55
56
  # * environment_id [String]
56
57
  # * medium_id [String]
57
58
  # * operatingsystem_id [String]
59
+ # * parent_id [String]
58
60
  # * ptable_id [String]
59
61
  # * puppet_ca_proxy_id [String]
60
62
  # * puppet_proxy_id [String]
data/lib/foreman_api/resources/location.rb CHANGED
@@ -6,6 +6,10 @@ module ForemanApi
6
6
  end
7
7
 
8
8
  # @param [Hash] params a hash of params to be passed to the service
9
+ # @option params [String] order Sort results
10
+ # @option params [String] page Paginate results
11
+ # @option params [String] per_page Number of entries per request
12
+ # @option params [String] search Filter results
9
13
  #
10
14
  # @param [Hash] headers additional http headers
11
15
  # @return [Array] First item: parsed data; second item: raw body
@@ -23,9 +27,9 @@ module ForemanApi
23
27
  end
24
28
 
25
29
  # @param [Hash] params a hash of params to be passed to the service
26
- # @option params [Hash] locations
30
+ # @option params [Hash] location
27
31
  # allowed keys are:
28
- # * :name [String]
32
+ # * name [String]
29
33
  #
30
34
  # @param [Hash] headers additional http headers
31
35
  # @return [Array] First item: parsed data; second item: raw body
@@ -35,9 +39,9 @@ module ForemanApi
35
39
 
36
40
  # @param [Hash] params a hash of params to be passed to the service
37
41
  # @option params [Object] id Part of +/api/locations/:id+ path
38
- # @option params [Hash] locations
42
+ # @option params [Hash] location
39
43
  # allowed keys are:
40
- # * :name [String]
44
+ # * name [String]
41
45
  #
42
46
  # @param [Hash] headers additional http headers
43
47
  # @return [Array] First item: parsed data; second item: raw body
data/lib/foreman_api/resources/lookup_key.rb CHANGED
@@ -6,7 +6,6 @@ module ForemanApi
6
6
  end
7
7
 
8
8
  # @param [Hash] params a hash of params to be passed to the service
9
- # @option params [Object] host_id Part of +/api/hosts/:host_id/lookup_keys+ path
10
9
  # @option params [String] order Sort results
11
10
  # @option params [String] page Paginate results
12
11
  # @option params [String] per_page Number of entries per request
@@ -33,9 +32,14 @@ module ForemanApi
33
32
  # * puppetclass_id [String]
34
33
  # * default_value [String]
35
34
  # * description [String]
35
+ # * is_param [String]
36
36
  # * key [String]
37
- # * lookup_values_count [String]
37
+ # * key_type [String]
38
+ # * override [String]
38
39
  # * path [String]
40
+ # * required [String]
41
+ # * validator_rule [String]
42
+ # * validator_type [String]
39
43
  #
40
44
  # @param [Hash] headers additional http headers
41
45
  # @return [Array] First item: parsed data; second item: raw body
@@ -50,9 +54,14 @@ module ForemanApi
50
54
  # * puppetclass_id [String]
51
55
  # * default_value [String]
52
56
  # * description [String]
57
+ # * is_param [String]
53
58
  # * key [String]
54
- # * lookup_values_count [String]
59
+ # * key_type [String]
60
+ # * override [String]
55
61
  # * path [String]
62
+ # * required [String]
63
+ # * validator_rule [String]
64
+ # * validator_type [String]
56
65
  #
57
66
  # @param [Hash] headers additional http headers
58
67
  # @return [Array] First item: parsed data; second item: raw body
@@ -69,6 +78,55 @@ module ForemanApi
69
78
  perform_call(__method__, params, headers)
70
79
  end
71
80
 
81
+ # @param [Hash] params a hash of params to be passed to the service
82
+ # @option params [String] host_id
83
+ # @option params [String] hostgroup_id
84
+ # @option params [String] page Paginate results
85
+ # @option params [String] per_page Number of entries per request
86
+ #
87
+ # @param [Hash] headers additional http headers
88
+ # @return [Array] First item: parsed data; second item: raw body
89
+ def host_or_hostgroup_smart_parameters(params = {}, headers = {})
90
+ perform_call(__method__, params, headers)
91
+ end
92
+
93
+ # @param [Hash] params a hash of params to be passed to the service
94
+ # @option params [String] host_id
95
+ # @option params [String] hostgroup_id
96
+ # @option params [String] page Paginate results
97
+ # @option params [String] per_page Number of entries per request
98
+ #
99
+ # @param [Hash] headers additional http headers
100
+ # @return [Array] First item: parsed data; second item: raw body
101
+ def host_or_hostgroup_smart_class_parameters(params = {}, headers = {})
102
+ perform_call(__method__, params, headers)
103
+ end
104
+
105
+ # @param [Hash] params a hash of params to be passed to the service
106
+ # @option params [String] puppetclass_id
107
+ # @option params [String] order Sort results
108
+ # @option params [String] page Paginate results
109
+ # @option params [String] per_page Number of entries per request
110
+ #
111
+ # @param [Hash] headers additional http headers
112
+ # @return [Array] First item: parsed data; second item: raw body
113
+ def puppet_smart_parameters(params = {}, headers = {})
114
+ perform_call(__method__, params, headers)
115
+ end
116
+
117
+ # @param [Hash] params a hash of params to be passed to the service
118
+ # @option params [String] environment_id
119
+ # @option params [String] puppetclass_id
120
+ # @option params [String] order Sort results
121
+ # @option params [String] page Paginate results
122
+ # @option params [String] per_page Number of entries per request
123
+ #
124
+ # @param [Hash] headers additional http headers
125
+ # @return [Array] First item: parsed data; second item: raw body
126
+ def puppet_smart_class_parameters(params = {}, headers = {})
127
+ perform_call(__method__, params, headers)
128
+ end
129
+
72
130
  end
73
131
  end
74
132
  end
data/lib/foreman_api/resources/medium.rb CHANGED
@@ -31,7 +31,7 @@ module ForemanApi
31
31
  # allowed keys are:
32
32
  # * name [String] Name of media
33
33
  # * os_family [String] The family that the operating system belongs to. available families: archlinux debian gentoo redhat solaris suse windows
34
- # * path [String] The path to the medium, can be a url or a valid nfs server (exclusive of the architecture). for example http://mirror.averse.net/centos/$version/os/$arch where $arch will be substituted for the host&#8217;s actual os architecture and $version, $major and $minor will be substituted for the version of the operating system. solaris and debian media may also use $release.
34
+ # * path [String] The path to the medium, can be a url or a valid nfs server (exclusive of the architecture). for example http://mirror.averse.net/centos/$version/os/$arch where $arch will be substituted for the host’s actual os architecture and $version, $major and $minor will be substituted for the version of the operating system. solaris and debian media may also use $release.
35
35
  #
36
36
  # @param [Hash] headers additional http headers
37
37
  # @return [Array] First item: parsed data; second item: raw body
@@ -45,7 +45,7 @@ module ForemanApi
45
45
  # allowed keys are:
46
46
  # * name [String] Name of media
47
47
  # * os_family [String, nil] The family that the operating system belongs to. available families: archlinux debian gentoo redhat solaris suse windows
48
- # * path [String] The path to the medium, can be a url or a valid nfs server (exclusive of the architecture). for example http://mirror.averse.net/centos/$version/os/$arch where $arch will be substituted for the host&#8217;s actual os architecture and $version, $major and $minor will be substituted for the version of the operating system. solaris and debian media may also use $release.
48
+ # * path [String] The path to the medium, can be a url or a valid nfs server (exclusive of the architecture). for example http://mirror.averse.net/centos/$version/os/$arch where $arch will be substituted for the host’s actual os architecture and $version, $major and $minor will be substituted for the version of the operating system. solaris and debian media may also use $release.
49
49
  #
50
50
  # @param [Hash] headers additional http headers
51
51
  # @return [Array] First item: parsed data; second item: raw body
data/lib/foreman_api/resources/organization.rb CHANGED
@@ -6,6 +6,10 @@ module ForemanApi
6
6
  end
7
7
 
8
8
  # @param [Hash] params a hash of params to be passed to the service
9
+ # @option params [String] order Sort results
10
+ # @option params [String] page Paginate results
11
+ # @option params [String] per_page Number of entries per request
12
+ # @option params [String] search Filter results
9
13
  #
10
14
  # @param [Hash] headers additional http headers
11
15
  # @return [Array] First item: parsed data; second item: raw body
@@ -25,7 +29,7 @@ module ForemanApi
25
29
  # @param [Hash] params a hash of params to be passed to the service
26
30
  # @option params [Hash] organization
27
31
  # allowed keys are:
28
- # * :name [String]
32
+ # * name [String]
29
33
  #
30
34
  # @param [Hash] headers additional http headers
31
35
  # @return [Array] First item: parsed data; second item: raw body
@@ -37,7 +41,7 @@ module ForemanApi
37
41
  # @option params [Object] id Part of +/api/organizations/:id+ path
38
42
  # @option params [Hash] organization
39
43
  # allowed keys are:
40
- # * :name [String]
44
+ # * name [String]
41
45
  #
42
46
  # @param [Hash] headers additional http headers
43
47
  # @return [Array] First item: parsed data; second item: raw body
data/lib/foreman_api/resources/parameter.rb CHANGED
@@ -33,7 +33,6 @@ module ForemanApi
33
33
  end
34
34
 
35
35
  # @param [Hash] params a hash of params to be passed to the service
36
- # @option params [String] id Id of parameter
37
36
  # @option params [String] domain_id Id of domain
38
37
  # @option params [String] host_id Id of host
39
38
  # @option params [String] hostgroup_id Id of hostgroup
@@ -80,10 +79,10 @@ module ForemanApi
80
79
  end
81
80
 
82
81
  # @param [Hash] params a hash of params to be passed to the service
83
- # @option params [Object] domain_id Part of +/api/domain/:domain_id/parameters+ path
84
- # @option params [Object] host_id Part of +/api/host/:host_id/parameters+ path
85
- # @option params [Object] hostgroup_id Part of +/api/hostgroup/:hostgroup_id/parameters+ path
86
- # @option params [Object] operatingsystem_id Part of +/api/operatingsystem/:operatingsystem_id/parameters+ path
82
+ # @option params [Object] domain_id Part of +/api/domains/:domain_id/parameters+ path
83
+ # @option params [Object] host_id Part of +/api/hosts/:host_id/parameters+ path
84
+ # @option params [Object] hostgroup_id Part of +/api/hostgroups/:hostgroup_id/parameters+ path
85
+ # @option params [Object] operatingsystem_id Part of +/api/operatingsystems/:operatingsystem_id/parameters+ path
87
86
  #
88
87
  # @param [Hash] headers additional http headers
89
88
  # @return [Array] First item: parsed data; second item: raw body
data/lib/foreman_api/resources/subnet.rb CHANGED
@@ -31,7 +31,7 @@ module ForemanApi
31
31
  # allowed keys are:
32
32
  # * dhcp_id [String] Dhcp proxy to use within this subnet
33
33
  # * dns_id [String] Dns proxy to use within this subnet
34
- # * domain_ids [String] Domains in which this subnet is part
34
+ # * domain_ids [Array] Domains in which this subnet is part
35
35
  # * tftp_id [String] Tftp proxy to use within this subnet
36
36
  # * dns_primary [String] Primary dns for this subnet
37
37
  # * dns_secondary [String] Secondary dns for this subnet
@@ -55,7 +55,7 @@ module ForemanApi
55
55
  # allowed keys are:
56
56
  # * dhcp_id [String, nil] Dhcp proxy to use within this subnet
57
57
  # * dns_id [String, nil] Dns proxy to use within this subnet
58
- # * domain_ids [String, nil] Domains in which this subnet is part
58
+ # * domain_ids [Array, nil] Domains in which this subnet is part
59
59
  # * tftp_id [String, nil] Tftp proxy to use within this subnet
60
60
  # * dns_primary [String, nil] Primary dns for this subnet
61
61
  # * dns_secondary [String, nil] Secondary dns for this subnet
data/lib/foreman_api/version.rb CHANGED
@@ -1,3 +1,3 @@
1
1
  module ForemanApi
2
- VERSION = "0.1.4"
2
+ VERSION = "0.1.5"
3
3
  end
metadata CHANGED
@@ -1,62 +1,55 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: foreman_api
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.4
5
- prerelease:
4
+ version: 0.1.5
6
5
  platform: ruby
7
6
  authors:
8
7
  - Martin Bačovský
9
8
  autorequire:
10
9
  bindir: bin
11
10
  cert_chain: []
12
- date: 2013-06-20 00:00:00.000000000 Z
11
+ date: 2013-07-30 00:00:00.000000000 Z
13
12
  dependencies:
14
13
  - !ruby/object:Gem::Dependency
15
14
  name: json
16
15
  requirement: !ruby/object:Gem::Requirement
17
- none: false
18
16
  requirements:
19
- - - ! '>='
17
+ - - '>='
20
18
  - !ruby/object:Gem::Version
21
19
  version: '0'
22
20
  type: :runtime
23
21
  prerelease: false
24
22
  version_requirements: !ruby/object:Gem::Requirement
25
- none: false
26
23
  requirements:
27
- - - ! '>='
24
+ - - '>='
28
25
  - !ruby/object:Gem::Version
29
26
  version: '0'
30
27
  - !ruby/object:Gem::Dependency
31
28
  name: rest-client
32
29
  requirement: !ruby/object:Gem::Requirement
33
- none: false
34
30
  requirements:
35
- - - ! '>='
31
+ - - '>='
36
32
  - !ruby/object:Gem::Version
37
33
  version: 1.6.1
38
34
  type: :runtime
39
35
  prerelease: false
40
36
  version_requirements: !ruby/object:Gem::Requirement
41
- none: false
42
37
  requirements:
43
- - - ! '>='
38
+ - - '>='
44
39
  - !ruby/object:Gem::Version
45
40
  version: 1.6.1
46
41
  - !ruby/object:Gem::Dependency
47
42
  name: oauth
48
43
  requirement: !ruby/object:Gem::Requirement
49
- none: false
50
44
  requirements:
51
- - - ! '>='
45
+ - - '>='
52
46
  - !ruby/object:Gem::Version
53
47
  version: '0'
54
48
  type: :runtime
55
49
  prerelease: false
56
50
  version_requirements: !ruby/object:Gem::Requirement
57
- none: false
58
51
  requirements:
59
- - - ! '>='
52
+ - - '>='
60
53
  - !ruby/object:Gem::Version
61
54
  version: '0'
62
55
  description: Helps you to use Foreman's API calls from your app
@@ -168,27 +161,26 @@ files:
168
161
  - lib/foreman_api/version.rb
169
162
  homepage: http://github.com/mbacovsky/foreman_api
170
163
  licenses: []
164
+ metadata: {}
171
165
  post_install_message:
172
166
  rdoc_options: []
173
167
  require_paths:
174
168
  - lib
175
169
  required_ruby_version: !ruby/object:Gem::Requirement
176
- none: false
177
170
  requirements:
178
- - - ! '>='
171
+ - - '>='
179
172
  - !ruby/object:Gem::Version
180
173
  version: '0'
181
174
  required_rubygems_version: !ruby/object:Gem::Requirement
182
- none: false
183
175
  requirements:
184
- - - ! '>='
176
+ - - '>='
185
177
  - !ruby/object:Gem::Version
186
178
  version: '0'
187
179
  requirements: []
188
180
  rubyforge_project:
189
- rubygems_version: 1.8.25
181
+ rubygems_version: 2.0.3
190
182
  signing_key:
191
- specification_version: 3
183
+ specification_version: 4
192
184
  summary: Ruby bindings for Forman's rest API
193
185
  test_files: []
194
186
  has_rdoc: