foreman_api 0.1.5 → 0.1.6

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 (48) hide show
  1. checksums.yaml +4 -4
  2. data/doc/ForemanApi/Resources/Architecture.html +1 -1
  3. data/doc/ForemanApi/Resources/Audit.html +1 -1
  4. data/doc/ForemanApi/Resources/AuthSourceLdap.html +1 -1
  5. data/doc/ForemanApi/Resources/Bookmark.html +1 -1
  6. data/doc/ForemanApi/Resources/CommonParameter.html +1 -1
  7. data/doc/ForemanApi/Resources/ComputeResource.html +1 -1
  8. data/doc/ForemanApi/Resources/ConfigTemplate.html +1 -1
  9. data/doc/ForemanApi/Resources/Dashboard.html +1 -1
  10. data/doc/ForemanApi/Resources/Domain.html +1 -1
  11. data/doc/ForemanApi/Resources/Environment.html +1 -1
  12. data/doc/ForemanApi/Resources/FactValue.html +1 -1
  13. data/doc/ForemanApi/Resources/Home.html +1 -1
  14. data/doc/ForemanApi/Resources/Host.html +57 -23
  15. data/doc/ForemanApi/Resources/HostClass.html +1 -1
  16. data/doc/ForemanApi/Resources/Hostgroup.html +1 -1
  17. data/doc/ForemanApi/Resources/HostgroupClass.html +1 -1
  18. data/doc/ForemanApi/Resources/Image.html +1 -1
  19. data/doc/ForemanApi/Resources/Location.html +1 -1
  20. data/doc/ForemanApi/Resources/LookupKey.html +1 -1
  21. data/doc/ForemanApi/Resources/Medium.html +16 -12
  22. data/doc/ForemanApi/Resources/Model.html +1 -1
  23. data/doc/ForemanApi/Resources/OperatingSystem.html +1 -1
  24. data/doc/ForemanApi/Resources/Organization.html +1 -1
  25. data/doc/ForemanApi/Resources/Parameter.html +1 -1
  26. data/doc/ForemanApi/Resources/Ptable.html +1 -1
  27. data/doc/ForemanApi/Resources/Puppetclass.html +1 -1
  28. data/doc/ForemanApi/Resources/Report.html +1 -1
  29. data/doc/ForemanApi/Resources/Role.html +1 -1
  30. data/doc/ForemanApi/Resources/Setting.html +1 -1
  31. data/doc/ForemanApi/Resources/SmartProxy.html +1 -1
  32. data/doc/ForemanApi/Resources/Subnet.html +1 -1
  33. data/doc/ForemanApi/Resources/TemplateCombination.html +1 -1
  34. data/doc/ForemanApi/Resources/TemplateKind.html +1 -1
  35. data/doc/ForemanApi/Resources/User.html +1 -1
  36. data/doc/ForemanApi/Resources/Usergroup.html +1 -1
  37. data/doc/ForemanApi/Resources.html +1 -1
  38. data/doc/ForemanApi.html +1 -1
  39. data/doc/_index.html +1 -1
  40. data/doc/file.MIT-LICENSE.html +1 -1
  41. data/doc/file.README.html +1 -1
  42. data/doc/index.html +1 -1
  43. data/doc/top-level-namespace.html +1 -1
  44. data/lib/foreman_api/documentation.json +1 -1
  45. data/lib/foreman_api/resources/host.rb +19 -2
  46. data/lib/foreman_api/resources/medium.rb +2 -0
  47. data/lib/foreman_api/version.rb +1 -1
  48. metadata +3 -3
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":"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":[]}]}}}}
1
+ {"docs":{"api_url":"/api","resources":{"fact_values":{"api_url":"/api","full_description":null,"version":"v2","methods":[{"full_description":"","params":[{"validator":"Must be String","required":false,"full_name":"search","expected_type":"string","allow_nil":false,"description":"<p>filter results</p>","name":"search"},{"validator":"Must be String","required":false,"full_name":"order","expected_type":"string","allow_nil":false,"description":"<p>sort results</p>","name":"order"},{"validator":"Must be String","required":false,"full_name":"page","expected_type":"string","allow_nil":false,"description":"<p>paginate results</p>","name":"page"},{"validator":"Must be String","required":false,"full_name":"per_page","expected_type":"string","allow_nil":false,"description":"<p>number of entries per request</p>","name":"per_page"}],"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}"],"apis":[{"api_url":"/api/fact_values","short_description":"List all fact values.","http_method":"GET"},{"api_url":"/api/hosts/:host_id/facts","short_description":"List all fact values of a given host.","http_method":"GET"}],"errors":[],"see":[],"name":"index","formats":null,"doc_url":"/apidoc/v2/fact_values/index"}],"short_description":null,"name":"Fact values","doc_url":"/apidoc/v2/fact_values","formats":null},"template_kinds":{"api_url":"/api","full_description":null,"version":"v2","methods":[{"full_description":"","params":[{"validator":"Must be String","required":false,"full_name":"page","expected_type":"string","allow_nil":false,"description":"<p>paginate results</p>","name":"page"},{"validator":"Must be String","required":false,"full_name":"per_page","expected_type":"string","allow_nil":false,"description":"<p>number of entries per request</p>","name":"per_page"}],"examples":["GET /api/template_kinds\n200\n[\n {\n \"template_kind\": {\n \"id\": 452984334,\n \"name\": \"PXELinux\"\n }\n },\n {\n \"template_kind\": {\n \"id\": 478250810,\n \"name\": \"script\"\n }\n },\n {\n \"template_kind\": {\n \"id\": 158998239,\n \"name\": \"gPXE\"\n }\n },\n {\n \"template_kind\": {\n \"id\": 550103832,\n \"name\": \"finish\"\n }\n },\n {\n \"template_kind\": {\n \"id\": 983253650,\n \"name\": \"provision\"\n }\n }\n]"],"apis":[{"api_url":"/api/template_kinds","short_description":"List all template kinds.","http_method":"GET"}],"errors":[],"see":[],"name":"index","formats":null,"doc_url":"/apidoc/v2/template_kinds/index"}],"short_description":null,"name":"Template kinds","doc_url":"/apidoc/v2/template_kinds","formats":null},"home":{"api_url":"/api","full_description":null,"version":"v2","methods":[{"full_description":"","params":[],"examples":["GET /api\n200\n{\n \"links\": {\n \"List of domains\": \"/api/domains\",\n \"List all audits\": \"/api/audits\",\n \"List all puppetclasses\": \"/api/puppetclasses\",\n \"List all fact values\": \"/api/fact_values\",\n \"List all hosts\": \"/api/hosts\",\n \"List all roles\": \"/api/roles\",\n \"List all architectures\": \"/api/architectures\",\n \"List all settings\": \"/api/settings\",\n \"List all lookup_keys\": \"/api/lookup_keys\",\n \"Show available links\": \"/api\",\n \"List all bookmarks\": \"/api/bookmarks\",\n \"List all usergroups\": \"/api/usergroups\",\n \"List all reports\": \"/api/reports\",\n \"List all users\": \"/api/users\",\n \"List all smart_proxies\": \"/api/smart_proxies\",\n \"List all operating systems\": \"/api/operatingsystems\",\n \"List all authsource ldaps\": \"/api/auth_source_ldaps\",\n \"Get Dashboard results\": \"/api/dashboard\",\n \"List all media\": \"/api/media\",\n \"List all ptables\": \"/api/ptables\",\n \"List all hostgroups\": \"/api/hostgroups\",\n \"List of subnets\": \"/api/subnets\",\n \"List all compute resources\": \"/api/compute_resources\",\n \"Show status\": \"/api/status\",\n \"List templates\": \"/api/config_templates\",\n \"List all models\": \"/api/models\",\n \"List all environments\": \"/api/environments\",\n \"List all template kinds\": \"/api/template_kinds\",\n \"List all common parameters\": \"/api/common_parameters\",\n \"List all images for compute resource\": \"/api/compute_resources/:compute_resource_id/images\"\n }\n}"],"apis":[{"api_url":"/api","short_description":"Show available links.","http_method":"GET"}],"errors":[],"see":[],"name":"index","formats":null,"doc_url":"/apidoc/v2/home/index"},{"full_description":"","params":[],"examples":[],"apis":[{"api_url":"/api/status","short_description":"Show status.","http_method":"GET"}],"errors":[],"see":[],"name":"status","formats":null,"doc_url":"/apidoc/v2/home/status"}],"short_description":null,"name":"Home","doc_url":"/apidoc/v2/home","formats":null},"locations":{"api_url":"/api","full_description":null,"version":"v2","methods":[{"full_description":"","params":[{"validator":"Must be String","required":false,"full_name":"search","expected_type":"string","allow_nil":false,"description":"<p>filter results</p>","name":"search"},{"validator":"Must be String","required":false,"full_name":"order","expected_type":"string","allow_nil":false,"description":"<p>sort results</p>","name":"order"},{"validator":"Must be String","required":false,"full_name":"page","expected_type":"string","allow_nil":false,"description":"<p>paginate results</p>","name":"page"},{"validator":"Must be String","required":false,"full_name":"per_page","expected_type":"string","allow_nil":false,"description":"<p>number of entries per request</p>","name":"per_page"}],"examples":[],"apis":[{"api_url":"/api/location_id","short_description":"List all location_id","http_method":"GET"}],"errors":[],"see":[],"name":"index","formats":null,"doc_url":"/apidoc/v2/locations/index"},{"full_description":"","params":[],"examples":[],"apis":[{"api_url":"/api/location_id/:id","short_description":"Show a location","http_method":"GET"}],"errors":[],"see":[],"name":"show","formats":null,"doc_url":"/apidoc/v2/locations/show"},{"full_description":"","params":[{"validator":"Must be a Hash","required":true,"full_name":"location","params":[{"full_name":"location[name]","required":true,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"name"}],"expected_type":"hash","allow_nil":false,"description":"","name":"location"}],"examples":[],"apis":[{"api_url":"/api/location_id","short_description":"Create a location","http_method":"POST"}],"errors":[],"see":[],"name":"create","formats":null,"doc_url":"/apidoc/v2/locations/create"},{"full_description":"","params":[{"validator":"Must be a Hash","required":true,"full_name":"location","params":[{"full_name":"location[name]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"name"}],"expected_type":"hash","allow_nil":false,"description":"","name":"location"}],"examples":[],"apis":[{"api_url":"/api/location_id/:id","short_description":"Update a location","http_method":"PUT"}],"errors":[],"see":[],"name":"update","formats":null,"doc_url":"/apidoc/v2/locations/update"},{"full_description":"","params":[],"examples":[],"apis":[{"api_url":"/api/location_id/:id","short_description":"Delete a location","http_method":"DELETE"}],"errors":[],"see":[],"name":"destroy","formats":null,"doc_url":"/apidoc/v2/locations/destroy"}],"short_description":null,"name":"Locations","doc_url":"/apidoc/v2/locations","formats":null},"reports":{"api_url":"/api","full_description":null,"version":"v2","methods":[{"full_description":"","params":[{"validator":"Must be String","required":false,"full_name":"search","expected_type":"string","allow_nil":false,"description":"<p>filter results</p>","name":"search"},{"validator":"Must be String","required":false,"full_name":"order","expected_type":"string","allow_nil":false,"description":"<p>sort results</p>","name":"order"},{"validator":"Must be String","required":false,"full_name":"page","expected_type":"string","allow_nil":false,"description":"<p>paginate results</p>","name":"page"},{"validator":"Must be String","required":false,"full_name":"per_page","expected_type":"string","allow_nil":false,"description":"<p>number of entries per request</p>","name":"per_page"}],"examples":["GET /api/reports\n200\n[\n {\n \"report\": {\n \"logs\": [],\n \"reported_at\": \"2012-12-11T15:24:42Z\",\n \"summary\": \"Success\",\n \"status\": {\n \"restarted\": 0,\n \"applied\": 0,\n \"failed_restarts\": 0,\n \"pending\": 0,\n \"skipped\": 0,\n \"failed\": 0\n },\n \"metrics\": {\n \"changes\": {},\n \"resources\": {\n \"total\": 33\n },\n \"time\": {\n \"cron\": 0.000419,\n \"config_retrieval\": 16.3637869358063,\n \"service\": 0.149739,\n \"exec\": 0.000299,\n \"schedule\": 0.00083,\n \"package\": 0.003989,\n \"filebucket\": 0.000171,\n \"file\": 0.007025,\n \"mailalias\": 0.000283\n },\n \"events\": {\n \"total\": 0\n }\n },\n \"id\": 70219655\n }\n }\n]"],"apis":[{"api_url":"/api/reports","short_description":"List all reports.","http_method":"GET"}],"errors":[],"see":[],"name":"index","formats":null,"doc_url":"/apidoc/v2/reports/index"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["GET /api/reports/70219655\n200\n{\n \"report\": {\n \"logs\": [],\n \"reported_at\": \"2012-12-11T15:24:42Z\",\n \"summary\": \"Success\",\n \"status\": {\n \"restarted\": 0,\n \"applied\": 0,\n \"failed_restarts\": 0,\n \"pending\": 0,\n \"skipped\": 0,\n \"failed\": 0\n },\n \"metrics\": {\n \"changes\": {},\n \"resources\": {\n \"total\": 33\n },\n \"time\": {\n \"cron\": 0.000419,\n \"config_retrieval\": 16.3637869358063,\n \"service\": 0.149739,\n \"exec\": 0.000299,\n \"schedule\": 0.00083,\n \"package\": 0.003989,\n \"filebucket\": 0.000171,\n \"file\": 0.007025,\n \"mailalias\": 0.000283\n },\n \"events\": {\n \"total\": 0\n }\n },\n \"id\": 70219655\n }\n}"],"apis":[{"api_url":"/api/reports/:id","short_description":"Show a report.","http_method":"GET"}],"errors":[],"see":[],"name":"show","formats":null,"doc_url":"/apidoc/v2/reports/show"},{"full_description":"","params":[{"validator":"Must be String","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["DELETE /api/reports/70219655\n200\n{\n \"report\": {\n \"host\": \"my5name.mydomain.net\",\n \"logs\": [],\n \"reported_at\": \"2012-12-11T15:24:42Z\",\n \"summary\": \"Success\",\n \"status\": {\n \"restarted\": 0,\n \"applied\": 0,\n \"failed_restarts\": 0,\n \"pending\": 0,\n \"skipped\": 0,\n \"failed\": 0\n },\n \"metrics\": {\n \"resources\": {\n \"total\": 33\n },\n \"changes\": {},\n \"time\": {\n \"cron\": 0.000419,\n \"config_retrieval\": 16.3637869358063,\n \"service\": 0.149739,\n \"exec\": 0.000299,\n \"schedule\": 0.00083,\n \"package\": 0.003989,\n \"filebucket\": 0.000171,\n \"file\": 0.007025,\n \"mailalias\": 0.000283\n },\n \"events\": {\n \"total\": 0\n }\n },\n \"id\": 70219655\n }\n}"],"apis":[{"api_url":"/api/ptables/:id","short_description":"Delete a report.","http_method":"DELETE"}],"errors":[],"see":[],"name":"destroy","formats":null,"doc_url":"/apidoc/v2/reports/destroy"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["GET /api/reports/last\n200\n{\n \"report\": {\n \"logs\": [],\n \"reported_at\": \"2012-12-11T15:24:42Z\",\n \"summary\": \"Success\",\n \"status\": {\n \"restarted\": 0,\n \"applied\": 0,\n \"failed_restarts\": 0,\n \"pending\": 0,\n \"skipped\": 0,\n \"failed\": 0\n },\n \"metrics\": {\n \"changes\": {},\n \"resources\": {\n \"total\": 33\n },\n \"time\": {\n \"cron\": 0.000419,\n \"config_retrieval\": 16.3637869358063,\n \"service\": 0.149739,\n \"exec\": 0.000299,\n \"schedule\": 0.00083,\n \"package\": 0.003989,\n \"filebucket\": 0.000171,\n \"file\": 0.007025,\n \"mailalias\": 0.000283\n },\n \"events\": {\n \"total\": 0\n }\n },\n \"id\": 70219655\n }\n}"],"apis":[{"api_url":"/api/hosts/:host_id/reports/last","short_description":"Show the last report for a given host.","http_method":"GET"}],"errors":[],"see":[],"name":"last","formats":null,"doc_url":"/apidoc/v2/reports/last"}],"short_description":null,"name":"Reports","doc_url":"/apidoc/v2/reports","formats":null},"operatingsystems":{"api_url":"/api","full_description":"","version":"v2","methods":[{"full_description":"","params":[{"validator":"Must be String","required":false,"full_name":"search","expected_type":"string","allow_nil":false,"description":"<p>filter results</p>","name":"search"},{"validator":"Must be String","required":false,"full_name":"order","expected_type":"string","allow_nil":false,"description":"<p>for example, name ASC, or name DESC</p>","name":"order"},{"validator":"Must be String","required":false,"full_name":"page","expected_type":"string","allow_nil":false,"description":"<p>paginate results</p>","name":"page"},{"validator":"Must be String","required":false,"full_name":"per_page","expected_type":"string","allow_nil":false,"description":"<p>number of entries per request</p>","name":"per_page"}],"examples":[],"apis":[{"api_url":"/api/operatingsystems","short_description":"List all operating systems.","http_method":"GET"}],"errors":[],"see":[],"name":"index","formats":null,"doc_url":"/apidoc/v2/operatingsystems/index"},{"full_description":"","params":[{"validator":"Must be String","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["GET /api/operatingsystems/1073012828\n200\n{\n \"operatingsystem\": {\n \"ptables\": [\n {\n \"ptable\": {\n \"id\": 980190962,\n \"name\": \"default\"\n }\n }\n ],\n \"media\": [\n {\n \"medium\": {\n \"id\": 980190962,\n \"name\": \"CentOS 5.4\"\n }\n }\n ],\n \"release_name\": null,\n \"minor\": \"1\",\n \"os_default_templates\": [],\n \"config_templates\": [\n {\n \"config_template\": {\n \"id\": 1007981701,\n \"name\": \"centos5_3_pxelinux\"\n }\n },\n {\n \"config_template\": {\n \"id\": 104314179,\n \"name\": \"MyFinish\"\n }\n },\n {\n \"config_template\": {\n \"id\": 981457253,\n \"name\": \"MyScript\"\n }\n },\n {\n \"config_template\": {\n \"id\": 943779058,\n \"name\": \"MyString\"\n }\n },\n {\n \"config_template\": {\n \"id\": 269958254,\n \"name\": \"MyString2\"\n }\n },\n {\n \"config_template\": {\n \"id\": 352050261,\n \"name\": \"PXE Default File\"\n }\n },\n {\n \"config_template\": {\n \"id\": 821548108,\n \"name\": \"PXE Localboot Default\"\n }\n }\n ],\n \"major\": \"6\",\n \"family\": \"Redhat\",\n \"id\": 1073012828,\n \"name\": \"Redhat\",\n \"architectures\": [\n {\n \"architecture\": {\n \"id\": 501905019,\n \"name\": \"x86_64\"\n }\n }\n ]\n }\n}"],"apis":[{"api_url":"/api/operatingsystems/:id","short_description":"Show an OS.","http_method":"GET"}],"errors":[],"see":[],"name":"show","formats":null,"doc_url":"/apidoc/v2/operatingsystems/show"},{"full_description":"","params":[{"validator":"Must be a Hash","required":true,"full_name":"operatingsystem","params":[{"full_name":"operatingsystem[name]","required":true,"validator":"Must match regular expression /\\A(\\S+)\\Z/.","expected_type":"string","allow_nil":false,"description":"","name":"name"},{"full_name":"operatingsystem[major]","required":true,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"major"},{"full_name":"operatingsystem[minor]","required":true,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"minor"},{"full_name":"operatingsystem[family]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"family"},{"full_name":"operatingsystem[release_name]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"release_name"}],"expected_type":"hash","allow_nil":false,"description":"","name":"operatingsystem"}],"examples":["POST /api/operatingsystems\n{\n \"operatingsystem\": {\n \"minor\": \"2\",\n \"major\": \"1\",\n \"name\": \"awsome_os\"\n }\n}\n200\n{\n \"operatingsystem\": {\n \"ptables\": [],\n \"media\": [],\n \"release_name\": null,\n \"minor\": \"2\",\n \"os_default_templates\": [],\n \"config_templates\": [],\n \"major\": \"1\",\n \"family\": null,\n \"id\": 1073012829,\n \"name\": \"awsome_os\",\n \"architectures\": []\n }\n}"],"apis":[{"api_url":"/api/operatingsystems","short_description":"Create an OS.","http_method":"POST"}],"errors":[],"see":[],"name":"create","formats":null,"doc_url":"/apidoc/v2/operatingsystems/create"},{"full_description":"","params":[{"validator":"Must be String","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"},{"validator":"Must be a Hash","required":true,"full_name":"operatingsystem","params":[{"full_name":"operatingsystem[name]","required":false,"validator":"Must match regular expression /\\A(\\S+)\\Z/.","expected_type":"string","allow_nil":false,"description":"","name":"name"},{"full_name":"operatingsystem[major]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"major"},{"full_name":"operatingsystem[minor]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"minor"},{"full_name":"operatingsystem[family]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"family"},{"full_name":"operatingsystem[release_name]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"release_name"}],"expected_type":"hash","allow_nil":false,"description":"","name":"operatingsystem"}],"examples":["PUT /api/operatingsystems/1073012828\n{\n \"operatingsystem\": {\n \"name\": \"new_name\"\n }\n}\n200\n{\n \"operatingsystem\": {\n \"ptables\": [\n {\n \"ptable\": {\n \"id\": 980190962,\n \"name\": \"default\"\n }\n }\n ],\n \"media\": [\n {\n \"medium\": {\n \"id\": 980190962,\n \"name\": \"CentOS 5.4\"\n }\n }\n ],\n \"release_name\": null,\n \"minor\": \"1\",\n \"os_default_templates\": [],\n \"config_templates\": [\n {\n \"config_template\": {\n \"id\": 1007981701,\n \"name\": \"centos5_3_pxelinux\"\n }\n },\n {\n \"config_template\": {\n \"id\": 104314179,\n \"name\": \"MyFinish\"\n }\n },\n {\n \"config_template\": {\n \"id\": 981457253,\n \"name\": \"MyScript\"\n }\n },\n {\n \"config_template\": {\n \"id\": 943779058,\n \"name\": \"MyString\"\n }\n },\n {\n \"config_template\": {\n \"id\": 269958254,\n \"name\": \"MyString2\"\n }\n },\n {\n \"config_template\": {\n \"id\": 352050261,\n \"name\": \"PXE Default File\"\n }\n },\n {\n \"config_template\": {\n \"id\": 821548108,\n \"name\": \"PXE Localboot Default\"\n }\n }\n ],\n \"major\": \"6\",\n \"family\": \"Redhat\",\n \"id\": 1073012828,\n \"name\": \"new_name\",\n \"architectures\": [\n {\n \"architecture\": {\n \"id\": 501905019,\n \"name\": \"x86_64\"\n }\n }\n ]\n }\n}"],"apis":[{"api_url":"/api/operatingsystems/:id","short_description":"Update an OS.","http_method":"PUT"}],"errors":[],"see":[],"name":"update","formats":null,"doc_url":"/apidoc/v2/operatingsystems/update"},{"full_description":"","params":[{"validator":"Must be String","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["DELETE /api/operatingsystems/775246587\n200\n{\n \"operatingsystem\": {\n \"ptables\": [],\n \"media\": [],\n \"config_templates\": [],\n \"id\": 775246587,\n \"name\": \"NoHosts 1.1\",\n \"architectures\": []\n }\n}"],"apis":[{"api_url":"/api/operatingsystems/:id","short_description":"Delete an OS.","http_method":"DELETE"}],"errors":[],"see":[],"name":"destroy","formats":null,"doc_url":"/apidoc/v2/operatingsystems/destroy"},{"full_description":"","params":[{"validator":"Must be String","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"},{"validator":"Must be String","required":false,"full_name":"medium","expected_type":"string","allow_nil":false,"description":"","name":"medium"},{"validator":"Must be String","required":false,"full_name":"architecture","expected_type":"string","allow_nil":false,"description":"","name":"architecture"}],"examples":[],"apis":[{"api_url":"/api/operatingsystems/:id/bootfiles","short_description":"List boot files an OS.","http_method":"GET"}],"errors":[],"see":[],"name":"bootfiles","formats":null,"doc_url":"/apidoc/v2/operatingsystems/bootfiles"}],"short_description":null,"name":"Operating systems","doc_url":"/apidoc/v2/operatingsystems","formats":null},"dashboard":{"api_url":"/api","full_description":null,"version":"v2","methods":[{"full_description":"","params":[{"validator":"Must be String","required":false,"full_name":"search","expected_type":"string","allow_nil":false,"description":"<p>filter results</p>","name":"search"}],"examples":["GET /api/dashboard\n200\n{\n \"ok_hosts\": 0,\n \"reports_missing\": 12,\n \"out_of_sync_hosts\": 0,\n \"percentage\": 0,\n \"bad_hosts\": 0,\n \"pending_hosts\": 0,\n \"pending_hosts_enabled\": 0,\n \"good_hosts\": 0,\n \"total_hosts\": 12,\n \"active_hosts\": 0,\n \"ok_hosts_enabled\": 0,\n \"disabled_hosts\": 0,\n \"out_of_sync_hosts_enabled\": 0,\n \"good_hosts_enabled\": 0,\n \"bad_hosts_enabled\": 0,\n \"active_hosts_ok_enabled\": 0,\n \"active_hosts_ok\": 0\n}"],"apis":[{"api_url":"/api/dashboard","short_description":"Get Dashboard results","http_method":"GET"}],"errors":[],"see":[],"name":"index","formats":null,"doc_url":"/apidoc/v2/dashboard/index"}],"short_description":null,"name":"Dashboard","doc_url":"/apidoc/v2/dashboard","formats":null},"hostgroups":{"api_url":"/api","full_description":null,"version":"v2","methods":[{"full_description":"","params":[{"validator":"Must be String","required":false,"full_name":"search","expected_type":"string","allow_nil":false,"description":"<p>filter results</p>","name":"search"},{"validator":"Must be String","required":false,"full_name":"order","expected_type":"string","allow_nil":false,"description":"<p>sort results</p>","name":"order"},{"validator":"Must be String","required":false,"full_name":"page","expected_type":"string","allow_nil":false,"description":"<p>paginate results</p>","name":"page"},{"validator":"Must be String","required":false,"full_name":"per_page","expected_type":"string","allow_nil":false,"description":"<p>number of entries per request</p>","name":"per_page"}],"examples":["GET /api/hostgroups\n200\n[\n {\n \"hostgroup\": {\n \"domain_id\": null,\n \"subnet_id\": null,\n \"environment_id\": 334344675,\n \"puppetclass_ids\": [],\n \"label\": \"db\",\n \"parameters\": {},\n \"ancestry\": null,\n \"id\": 603241515,\n \"name\": \"db\",\n \"operatingsystem_id\": 309172073\n }\n },\n {\n \"hostgroup\": {\n \"domain_id\": 22495316,\n \"subnet_id\": null,\n \"environment_id\": 334344675,\n \"puppetclass_ids\": [\n 980190962\n ],\n \"label\": \"Common\",\n \"parameters\": {\n \"group1\": \"group1\"\n },\n \"ancestry\": null,\n \"id\": 636252244,\n \"name\": \"Common\",\n \"operatingsystem_id\": 309172073\n }\n },\n {\n \"hostgroup\": {\n \"domain_id\": null,\n \"subnet_id\": null,\n \"environment_id\": null,\n \"puppetclass_ids\": [],\n \"label\": \"Unusual\",\n \"parameters\": {},\n \"ancestry\": null,\n \"id\": 866317115,\n \"name\": \"Unusual\",\n \"operatingsystem_id\": null\n }\n }\n]"],"apis":[{"api_url":"/api/hostgroups","short_description":"List all hostgroups.","http_method":"GET"}],"errors":[],"see":[],"name":"index","formats":null,"doc_url":"/apidoc/v2/hostgroups/index"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["GET /api/hostgroups/636252244-common\n200\n{\n \"hostgroup\": {\n \"domain_id\": 22495316,\n \"subnet_id\": null,\n \"environment_id\": 334344675,\n \"puppetclass_ids\": [\n 980190962\n ],\n \"label\": \"Common\",\n \"parameters\": {\n \"group1\": \"group1\"\n },\n \"ancestry\": null,\n \"id\": 636252244,\n \"name\": \"Common\",\n \"operatingsystem_id\": 309172073\n }\n}"],"apis":[{"api_url":"/api/hostgroups/:id","short_description":"Show a hostgroup.","http_method":"GET"}],"errors":[],"see":[],"name":"show","formats":null,"doc_url":"/apidoc/v2/hostgroups/show"},{"full_description":"","params":[{"validator":"Must be a Hash","required":true,"full_name":"hostgroup","params":[{"full_name":"hostgroup[name]","required":true,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"name"},{"full_name":"hostgroup[parent_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"parent_id"},{"full_name":"hostgroup[environment_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"environment_id"},{"full_name":"hostgroup[operatingsystem_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"operatingsystem_id"},{"full_name":"hostgroup[architecture_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"architecture_id"},{"full_name":"hostgroup[medium_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"medium_id"},{"full_name":"hostgroup[ptable_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"ptable_id"},{"full_name":"hostgroup[puppet_ca_proxy_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"puppet_ca_proxy_id"},{"full_name":"hostgroup[subnet_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"subnet_id"},{"full_name":"hostgroup[domain_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"domain_id"},{"full_name":"hostgroup[puppet_proxy_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"puppet_proxy_id"}],"expected_type":"hash","allow_nil":false,"description":"","name":"hostgroup"}],"examples":["POST /api/hostgroups\n{\n \"hostgroup\": {\n \"name\": \"TestHostgroup\"\n }\n}\n200\n{\n \"hostgroup\": {\n \"domain_id\": null,\n \"subnet_id\": null,\n \"environment_id\": null,\n \"puppetclass_ids\": [],\n \"label\": \"TestHostgroup\",\n \"parameters\": {},\n \"ancestry\": null,\n \"id\": 866317116,\n \"name\": \"TestHostgroup\",\n \"operatingsystem_id\": null\n }\n}"],"apis":[{"api_url":"/api/hostgroups","short_description":"Create an hostgroup.","http_method":"POST"}],"errors":[],"see":[],"name":"create","formats":null,"doc_url":"/apidoc/v2/hostgroups/create"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"},{"validator":"Must be a Hash","required":true,"full_name":"hostgroup","params":[{"full_name":"hostgroup[name]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"name"},{"full_name":"hostgroup[parent_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"parent_id"},{"full_name":"hostgroup[environment_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"environment_id"},{"full_name":"hostgroup[operatingsystem_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"operatingsystem_id"},{"full_name":"hostgroup[architecture_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"architecture_id"},{"full_name":"hostgroup[medium_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"medium_id"},{"full_name":"hostgroup[ptable_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"ptable_id"},{"full_name":"hostgroup[puppet_ca_proxy_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"puppet_ca_proxy_id"},{"full_name":"hostgroup[subnet_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"subnet_id"},{"full_name":"hostgroup[domain_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"domain_id"},{"full_name":"hostgroup[puppet_proxy_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"puppet_proxy_id"}],"expected_type":"hash","allow_nil":false,"description":"","name":"hostgroup"}],"examples":["PUT /api/hostgroups/636252244-common\n{\n \"hostgroup\": {}\n}\n200\n{\n \"hostgroup\": {\n \"domain_id\": 22495316,\n \"subnet_id\": null,\n \"environment_id\": 334344675,\n \"puppetclass_ids\": [\n 980190962\n ],\n \"label\": \"Common\",\n \"parameters\": {\n \"group1\": \"group1\"\n },\n \"ancestry\": null,\n \"id\": 636252244,\n \"name\": \"Common\",\n \"operatingsystem_id\": 309172073\n }\n}"],"apis":[{"api_url":"/api/hostgroups/:id","short_description":"Update an hostgroup.","http_method":"PUT"}],"errors":[],"see":[],"name":"update","formats":null,"doc_url":"/apidoc/v2/hostgroups/update"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["DELETE /api/hostgroups/636252244-common\n200\n{\n \"hostgroup\": {\n \"domain_id\": 22495316,\n \"subnet_id\": null,\n \"environment_id\": 334344675,\n \"puppetclass_ids\": [],\n \"label\": \"Common\",\n \"parameters\": {},\n \"ancestry\": null,\n \"id\": 636252244,\n \"name\": \"Common\",\n \"operatingsystem_id\": 309172073\n }\n}"],"apis":[{"api_url":"/api/hostgroups/:id","short_description":"Delete an hostgroup.","http_method":"DELETE"}],"errors":[],"see":[],"name":"destroy","formats":null,"doc_url":"/apidoc/v2/hostgroups/destroy"}],"short_description":null,"name":"Hostgroups","doc_url":"/apidoc/v2/hostgroups","formats":null},"subnets":{"api_url":"/api","full_description":null,"version":"v2","methods":[{"full_description":"","params":[{"validator":"Must be String","required":false,"full_name":"search","expected_type":"string","allow_nil":false,"description":"<p>Filter results</p>","name":"search"},{"validator":"Must be String","required":false,"full_name":"order","expected_type":"string","allow_nil":false,"description":"<p>Sort results</p>","name":"order"},{"validator":"Must be String","required":false,"full_name":"page","expected_type":"string","allow_nil":false,"description":"<p>paginate results</p>","name":"page"},{"validator":"Must be String","required":false,"full_name":"per_page","expected_type":"string","allow_nil":false,"description":"<p>number of entries per request</p>","name":"per_page"}],"examples":["GET /api/subnets\n200\n[\n {\n \"subnet\": {\n \"vlanid\": \"41\",\n \"gateway\": null,\n \"dhcp_id\": 980190962,\n \"tftp_id\": 298486374,\n \"mask\": \"255.255.255.0\",\n \"dns_primary\": null,\n \"dns_id\": 113629430,\n \"to\": null,\n \"from\": null,\n \"id\": 980190962,\n \"domain_ids\": [\n 822172901\n ],\n \"dns_secondary\": null,\n \"network\": \"2.3.4.0\",\n \"name\": \"one\",\n \"priority\": null\n }\n },\n {\n \"subnet\": {\n \"vlanid\": \"42\",\n \"gateway\": null,\n \"dhcp_id\": 980190962,\n \"tftp_id\": 298486374,\n \"mask\": \"255.255.255.0\",\n \"dns_primary\": null,\n \"dns_id\": null,\n \"to\": null,\n \"from\": null,\n \"id\": 298486374,\n \"domain_ids\": [\n 534821992\n ],\n \"dns_secondary\": null,\n \"network\": \"3.3.4.0\",\n \"name\": \"two\",\n \"priority\": null\n }\n },\n {\n \"subnet\": {\n \"vlanid\": \"43\",\n \"gateway\": null,\n \"dhcp_id\": 980190962,\n \"tftp_id\": 298486374,\n \"mask\": \"255.255.255.0\",\n \"dns_primary\": null,\n \"dns_id\": null,\n \"to\": null,\n \"from\": null,\n \"id\": 113629430,\n \"domain_ids\": [],\n \"dns_secondary\": null,\n \"network\": \"3.3.4.3\",\n \"name\": \"three\",\n \"priority\": null\n }\n }\n]"],"apis":[{"api_url":"/api/subnets","short_description":"List of subnets","http_method":"GET"}],"errors":[],"see":[],"name":"index","formats":null,"doc_url":"/apidoc/v2/subnets/index"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["GET /api/subnets/980190962\n200\n{\n \"subnet\": {\n \"dns\": {\n \"url\": \"http://else.where:4567\",\n \"id\": 113629430,\n \"name\": \"DNS Proxy\"\n },\n \"vlanid\": \"41\",\n \"gateway\": null,\n \"dhcp_id\": 980190962,\n \"tftp_id\": 298486374,\n \"mask\": \"255.255.255.0\",\n \"dns_primary\": null,\n \"dns_id\": 113629430,\n \"to\": null,\n \"from\": null,\n \"id\": 980190962,\n \"domain_ids\": [\n 822172901\n ],\n \"dns_secondary\": null,\n \"network\": \"2.3.4.0\",\n \"name\": \"one\",\n \"tftp\": {\n \"url\": \"http://somewhere.else\",\n \"id\": 298486374,\n \"name\": \"TFTP Proxy\"\n },\n \"dhcp\": {\n \"url\": \"https://somewhere.net:8443\",\n \"id\": 980190962,\n \"name\": \"DHCP Proxy\"\n },\n \"priority\": null\n }\n}"],"apis":[{"api_url":"/api/subnets/:id","short_description":"Show a subnet.","http_method":"GET"}],"errors":[],"see":[],"name":"show","formats":null,"doc_url":"/apidoc/v2/subnets/show"},{"full_description":"","params":[{"validator":"Must be a Hash","required":true,"full_name":"subnet","params":[{"full_name":"subnet[name]","required":true,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"<p>Subnet name</p>","name":"name"},{"full_name":"subnet[network]","required":true,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"<p>Subnet network</p>","name":"network"},{"full_name":"subnet[mask]","required":true,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"<p>Netmask for this subnet</p>","name":"mask"},{"full_name":"subnet[gateway]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"<p>Primary DNS for this subnet</p>","name":"gateway"},{"full_name":"subnet[dns_primary]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"<p>Primary DNS for this subnet</p>","name":"dns_primary"},{"full_name":"subnet[dns_secondary]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"<p>Secondary DNS for this subnet</p>","name":"dns_secondary"},{"full_name":"subnet[from]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"<p>Starting IP Address for IP auto suggestion</p>","name":"from"},{"full_name":"subnet[to]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"<p>Ending IP Address for IP auto suggestion</p>","name":"to"},{"full_name":"subnet[vlanid]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"<p>VLAN ID for this subnet</p>","name":"vlanid"},{"full_name":"subnet[domain_ids]","required":false,"validator":"Must be Array","expected_type":"array","allow_nil":false,"description":"<p>Domains in which this subnet is part</p>","name":"domain_ids"},{"full_name":"subnet[dhcp_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"<p>DHCP Proxy to use within this subnet</p>","name":"dhcp_id"},{"full_name":"subnet[tftp_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"<p>TFTP Proxy to use within this subnet</p>","name":"tftp_id"},{"full_name":"subnet[dns_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"<p>DNS Proxy to use within this subnet</p>","name":"dns_id"}],"expected_type":"hash","allow_nil":false,"description":"","name":"subnet"}],"examples":["POST /api/subnets\n{\n \"subnet\": {\n \"mask\": \"255.255.255.0\",\n \"network\": \"10.35.2.27\",\n \"name\": \"QA2\"\n }\n}\n200\n{\n \"subnet\": {\n \"dns\": null,\n \"vlanid\": null,\n \"gateway\": null,\n \"dhcp_id\": null,\n \"tftp_id\": null,\n \"mask\": \"255.255.255.0\",\n \"dns_primary\": null,\n \"dns_id\": null,\n \"to\": null,\n \"from\": null,\n \"id\": 980190963,\n \"domain_ids\": [],\n \"dns_secondary\": null,\n \"network\": \"10.35.2.27\",\n \"name\": \"QA2\",\n \"tftp\": null,\n \"dhcp\": null,\n \"priority\": null\n }\n}"],"apis":[{"api_url":"/api/subnets","short_description":"Create a subnet","http_method":"POST"}],"errors":[],"see":[],"name":"create","formats":null,"doc_url":"/apidoc/v2/subnets/create"},{"full_description":"","params":[{"validator":"Must be a number.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"<p>Subnet numeric identifier</p>","name":"id"},{"validator":"Must be a Hash","required":true,"full_name":"subnet","params":[{"full_name":"subnet[name]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"<p>Subnet name</p>","name":"name"},{"full_name":"subnet[network]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"<p>Subnet network</p>","name":"network"},{"full_name":"subnet[mask]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"<p>Netmask for this subnet</p>","name":"mask"},{"full_name":"subnet[gateway]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":true,"description":"<p>Primary DNS for this subnet</p>","name":"gateway"},{"full_name":"subnet[dns_primary]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":true,"description":"<p>Primary DNS for this subnet</p>","name":"dns_primary"},{"full_name":"subnet[dns_secondary]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":true,"description":"<p>Secondary DNS for this subnet</p>","name":"dns_secondary"},{"full_name":"subnet[from]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":true,"description":"<p>Starting IP Address for IP auto suggestion</p>","name":"from"},{"full_name":"subnet[to]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":true,"description":"<p>Ending IP Address for IP auto suggestion</p>","name":"to"},{"full_name":"subnet[vlanid]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":true,"description":"<p>VLAN ID for this subnet</p>","name":"vlanid"},{"full_name":"subnet[domain_ids]","required":false,"validator":"Must be Array","expected_type":"array","allow_nil":true,"description":"<p>Domains in which this subnet is part</p>","name":"domain_ids"},{"full_name":"subnet[dhcp_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":true,"description":"<p>DHCP Proxy to use within this subnet</p>","name":"dhcp_id"},{"full_name":"subnet[tftp_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":true,"description":"<p>TFTP Proxy to use within this subnet</p>","name":"tftp_id"},{"full_name":"subnet[dns_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":true,"description":"<p>DNS Proxy to use within this subnet</p>","name":"dns_id"}],"expected_type":"hash","allow_nil":false,"description":"","name":"subnet"}],"examples":["PUT /api/subnets/980190962\n{\n \"subnet\": {}\n}\n200\n{\n \"subnet\": {\n \"dns\": {\n \"url\": \"http://else.where:4567\",\n \"id\": 113629430,\n \"name\": \"DNS Proxy\"\n },\n \"vlanid\": \"41\",\n \"gateway\": null,\n \"dhcp_id\": 980190962,\n \"tftp_id\": 298486374,\n \"mask\": \"255.255.255.0\",\n \"dns_primary\": null,\n \"dns_id\": 113629430,\n \"to\": null,\n \"from\": null,\n \"id\": 980190962,\n \"domain_ids\": [\n 822172901\n ],\n \"dns_secondary\": null,\n \"network\": \"2.3.4.0\",\n \"name\": \"one\",\n \"tftp\": {\n \"url\": \"http://somewhere.else\",\n \"id\": 298486374,\n \"name\": \"TFTP Proxy\"\n },\n \"dhcp\": {\n \"url\": \"https://somewhere.net:8443\",\n \"id\": 980190962,\n \"name\": \"DHCP Proxy\"\n },\n \"priority\": null\n }\n}"],"apis":[{"api_url":"/api/subnets/:id","short_description":"Update a subnet","http_method":"PUT"}],"errors":[],"see":[],"name":"update","formats":null,"doc_url":"/apidoc/v2/subnets/update"},{"full_description":"","params":[{"validator":"Must be a number.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"<p>Subnet numeric identifier</p>","name":"id"}],"examples":["DELETE /api/subnets/980190962\n422\n{\n \"subnet\": {\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 \"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 \"id\": 980190962\n }\n}"],"apis":[{"api_url":"/api/subnets/:id","short_description":"Delete a subnet","http_method":"DELETE"}],"errors":[],"see":[],"name":"destroy","formats":null,"doc_url":"/apidoc/v2/subnets/destroy"}],"short_description":null,"name":"Subnets","doc_url":"/apidoc/v2/subnets","formats":null},"roles":{"api_url":"/api","full_description":null,"version":"v2","methods":[{"full_description":"","params":[{"validator":"Must be String","required":false,"full_name":"page","expected_type":"string","allow_nil":false,"description":"<p>paginate results</p>","name":"page"},{"validator":"Must be String","required":false,"full_name":"per_page","expected_type":"string","allow_nil":false,"description":"<p>number of entries per request</p>","name":"per_page"}],"examples":[],"apis":[{"api_url":"/api/roles","short_description":"List all roles.","http_method":"GET"}],"errors":[],"see":[],"name":"index","formats":null,"doc_url":"/apidoc/v2/roles/index"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["GET /api/roles/1\n200\n{\n \"role\": {\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 \"id\": 1,\n \"name\": \"Manager\"\n }\n}"],"apis":[{"api_url":"/api/roles/:id","short_description":"Show an role.","http_method":"GET"}],"errors":[],"see":[],"name":"show","formats":null,"doc_url":"/apidoc/v2/roles/show"},{"full_description":"","params":[{"validator":"Must be a Hash","required":true,"full_name":"role","params":[{"full_name":"role[name]","required":true,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"name"}],"expected_type":"hash","allow_nil":false,"description":"","name":"role"}],"examples":["POST /api/roles\n{\n \"role\": {\n \"name\": \"staff\"\n }\n}\n200\n{\n \"role\": {\n \"builtin\": 0,\n \"permissions\": [],\n \"id\": 11,\n \"name\": \"staff\"\n }\n}"],"apis":[{"api_url":"/api/roles","short_description":"Create an role.","http_method":"POST"}],"errors":[],"see":[],"name":"create","formats":null,"doc_url":"/apidoc/v2/roles/create"},{"full_description":"","params":[{"validator":"Must be String","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"},{"validator":"Must be a Hash","required":true,"full_name":"role","params":[{"full_name":"role[name]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"name"}],"expected_type":"hash","allow_nil":false,"description":"","name":"role"}],"examples":["PUT /api/roles/1\n{\n \"role\": {}\n}\n200\n{\n \"role\": {\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 \"id\": 1,\n \"name\": \"Manager\"\n }\n}"],"apis":[{"api_url":"/api/roles/:id","short_description":"Update an role.","http_method":"PUT"}],"errors":[],"see":[],"name":"update","formats":null,"doc_url":"/apidoc/v2/roles/update"},{"full_description":"","params":[{"validator":"Must be String","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["DELETE /api/roles/1\n200\n{\n \"role\": {\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 \"id\": 1,\n \"name\": \"Manager\"\n }\n}"],"apis":[{"api_url":"/api/roles/:id","short_description":"Delete an role.","http_method":"DELETE"}],"errors":[],"see":[],"name":"destroy","formats":null,"doc_url":"/apidoc/v2/roles/destroy"}],"short_description":null,"name":"Roles","doc_url":"/apidoc/v2/roles","formats":null},"auth_source_ldaps":{"api_url":"/api","full_description":null,"version":"v2","methods":[{"full_description":"","params":[{"validator":"Must be String","required":false,"full_name":"page","expected_type":"string","allow_nil":false,"description":"<p>paginate results</p>","name":"page"},{"validator":"Must be String","required":false,"full_name":"per_page","expected_type":"string","allow_nil":false,"description":"<p>number of entries per request</p>","name":"per_page"}],"examples":["GET /api/auth_source_ldaps\n200\n[\n {\n \"auth_source_ldap\": {\n \"host\": \"ldap\",\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"account\": null,\n \"attr_mail\": \"mail\",\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"tls\": true,\n \"onthefly_register\": true,\n \"attr_login\": \"uid\",\n \"attr_lastname\": \"sn\",\n \"base_dn\": \"dn=x,dn=y\",\n \"port\": 123,\n \"type\": \"AuthSourceLdap\",\n \"id\": 980190962,\n \"name\": \"ldap\",\n \"attr_firstname\": \"givenName\"\n }\n }\n]"],"apis":[{"api_url":"/api/auth_source_ldaps","short_description":"List all authsource ldaps","http_method":"GET"}],"errors":[],"see":[],"name":"index","formats":null,"doc_url":"/apidoc/v2/auth_source_ldaps/index"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["GET /api/auth_source_ldaps/980190962\n200\n{\n \"auth_source_ldap\": {\n \"host\": \"ldap\",\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"account\": null,\n \"attr_mail\": \"mail\",\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"tls\": true,\n \"onthefly_register\": true,\n \"attr_login\": \"uid\",\n \"attr_lastname\": \"sn\",\n \"base_dn\": \"dn=x,dn=y\",\n \"port\": 123,\n \"type\": \"AuthSourceLdap\",\n \"id\": 980190962,\n \"name\": \"ldap\",\n \"attr_firstname\": \"givenName\"\n }\n}"],"apis":[{"api_url":"/api/auth_source_ldaps/:id","short_description":"Show an authsource ldap.","http_method":"GET"}],"errors":[],"see":[],"name":"show","formats":null,"doc_url":"/apidoc/v2/auth_source_ldaps/show"},{"full_description":"","params":[{"validator":"Must be a Hash","required":true,"full_name":"auth_source_ldap","params":[{"full_name":"auth_source_ldap[name]","required":true,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"name"},{"full_name":"auth_source_ldap[host]","required":true,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"host"},{"full_name":"auth_source_ldap[port]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"<p>defaults to 389</p>","name":"port"},{"full_name":"auth_source_ldap[account]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"account"},{"full_name":"auth_source_ldap[base_dn]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"base_dn"},{"full_name":"auth_source_ldap[account_password]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"<p>required if onthefly_register is true</p>","name":"account_password"},{"full_name":"auth_source_ldap[attr_login]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"<p>required if onthefly_register is true</p>","name":"attr_login"},{"full_name":"auth_source_ldap[attr_firstname]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"<p>required if onthefly_register is true</p>","name":"attr_firstname"},{"full_name":"auth_source_ldap[attr_lastname]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"<p>required if onthefly_register is true</p>","name":"attr_lastname"},{"full_name":"auth_source_ldap[attr_mail]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"<p>required if onthefly_register is true</p>","name":"attr_mail"},{"full_name":"auth_source_ldap[onthefly_register]","required":false,"validator":"Must be 'true' or 'false'","expected_type":"string","allow_nil":false,"description":"","name":"onthefly_register"},{"full_name":"auth_source_ldap[tls]","required":false,"validator":"Must be 'true' or 'false'","expected_type":"string","allow_nil":false,"description":"","name":"tls"}],"expected_type":"hash","allow_nil":false,"description":"","name":"auth_source_ldap"}],"examples":["POST /api/auth_source_ldaps\n{\n \"auth_source_ldap\": {\n \"host\": \"ldap2\",\n \"name\": \"ldap2\"\n }\n}\n201\n{\n \"auth_source_ldap\": {\n \"host\": \"ldap2\",\n \"created_at\": \"2012-12-18T15:24:44Z\",\n \"account\": null,\n \"attr_mail\": null,\n \"updated_at\": \"2012-12-18T15:24:44Z\",\n \"tls\": false,\n \"onthefly_register\": false,\n \"attr_lastname\": null,\n \"attr_login\": null,\n \"base_dn\": null,\n \"port\": 389,\n \"account_password\": null,\n \"id\": 980190963,\n \"name\": \"ldap2\",\n \"attr_firstname\": null\n }\n}"],"apis":[{"api_url":"/api/auth_source_ldaps","short_description":"Create an auth_source_ldap.","http_method":"POST"}],"errors":[],"see":[],"name":"create","formats":null,"doc_url":"/apidoc/v2/auth_source_ldaps/create"},{"full_description":"","params":[{"validator":"Must be String","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"},{"validator":"Must be a Hash","required":true,"full_name":"auth_source_ldap","params":[{"full_name":"auth_source_ldap[name]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"name"},{"full_name":"auth_source_ldap[host]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"host"},{"full_name":"auth_source_ldap[port]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"<p>defaults to 389</p>","name":"port"},{"full_name":"auth_source_ldap[account]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"account"},{"full_name":"auth_source_ldap[base_dn]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"base_dn"},{"full_name":"auth_source_ldap[account_password]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"<p>required if onthefly_register is true</p>","name":"account_password"},{"full_name":"auth_source_ldap[attr_login]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"<p>required if onthefly_register is true</p>","name":"attr_login"},{"full_name":"auth_source_ldap[attr_firstname]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"<p>required if onthefly_register is true</p>","name":"attr_firstname"},{"full_name":"auth_source_ldap[attr_lastname]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"<p>required if onthefly_register is true</p>","name":"attr_lastname"},{"full_name":"auth_source_ldap[attr_mail]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"<p>required if onthefly_register is true</p>","name":"attr_mail"},{"full_name":"auth_source_ldap[onthefly_register]","required":false,"validator":"Must be 'true' or 'false'","expected_type":"string","allow_nil":false,"description":"","name":"onthefly_register"},{"full_name":"auth_source_ldap[tls]","required":false,"validator":"Must be 'true' or 'false'","expected_type":"string","allow_nil":false,"description":"","name":"tls"}],"expected_type":"hash","allow_nil":false,"description":"","name":"auth_source_ldap"}],"examples":["PUT /api/auth_source_ldaps/980190962\n{\n \"auth_source_ldap\": {}\n}\n200\n{\n \"auth_source_ldap\": {\n \"host\": \"ldap\",\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"account\": null,\n \"attr_mail\": \"mail\",\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"tls\": true,\n \"onthefly_register\": true,\n \"attr_lastname\": \"sn\",\n \"attr_login\": \"uid\",\n \"base_dn\": \"dn=x,dn=y\",\n \"port\": 123,\n \"account_password\": null,\n \"id\": 980190962,\n \"name\": \"ldap\",\n \"attr_firstname\": \"givenName\"\n }\n}"],"apis":[{"api_url":"/api/auth_source_ldaps/:id","short_description":"Update an auth_source_ldap.","http_method":"PUT"}],"errors":[],"see":[],"name":"update","formats":null,"doc_url":"/apidoc/v2/auth_source_ldaps/update"},{"full_description":"","params":[{"validator":"Must be String","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["DELETE /api/auth_source_ldaps/980190962\n200\n{\n \"auth_source_ldap\": {\n \"host\": \"ldap\",\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"account\": null,\n \"attr_mail\": \"mail\",\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"tls\": true,\n \"onthefly_register\": true,\n \"attr_lastname\": \"sn\",\n \"attr_login\": \"uid\",\n \"base_dn\": \"dn=x,dn=y\",\n \"port\": 123,\n \"account_password\": null,\n \"id\": 980190962,\n \"name\": \"ldap\",\n \"attr_firstname\": \"givenName\"\n }\n}"],"apis":[{"api_url":"/api/auth_source_ldaps/:id","short_description":"Delete an auth_source_ldap.","http_method":"DELETE"}],"errors":[],"see":[],"name":"destroy","formats":null,"doc_url":"/apidoc/v2/auth_source_ldaps/destroy"}],"short_description":null,"name":"Auth source ldaps","doc_url":"/apidoc/v2/auth_source_ldaps","formats":null},"domains":{"api_url":"/api","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","methods":[{"full_description":"","params":[{"validator":"Must be String","required":false,"full_name":"search","expected_type":"string","allow_nil":false,"description":"<p>Filter results</p>","name":"search"},{"validator":"Must be String","required":false,"full_name":"order","expected_type":"string","allow_nil":false,"description":"<p>Sort results</p>","name":"order"},{"validator":"Must be String","required":false,"full_name":"page","expected_type":"string","allow_nil":false,"description":"<p>paginate results</p>","name":"page"},{"validator":"Must be String","required":false,"full_name":"per_page","expected_type":"string","allow_nil":false,"description":"<p>number of entries per request</p>","name":"per_page"}],"examples":["GET /api/domains\n200\n[\n {\n \"domain\": {\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"fullname\": null,\n \"dns_id\": 113629430,\n \"id\": 22495316,\n \"name\": \"mydomain.net\"\n }\n },\n {\n \"domain\": {\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"fullname\": \"somewhare that is never used\",\n \"dns_id\": 113629430,\n \"id\": 759776763,\n \"name\": \"unused.net\"\n }\n },\n {\n \"domain\": {\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"fullname\": null,\n \"dns_id\": null,\n \"id\": 229305443,\n \"name\": \"useless.net\"\n }\n },\n {\n \"domain\": {\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"fullname\": \"somewhere in yourdomain\",\n \"dns_id\": 113629430,\n \"id\": 589326610,\n \"name\": \"yourdomain.net\"\n }\n }\n]"],"apis":[{"api_url":"/api/domains","short_description":"List of domains","http_method":"GET"}],"errors":[],"see":[],"name":"index","formats":null,"doc_url":"/apidoc/v2/domains/index"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"<p>May be numerical id or domain name</p>","name":"id"}],"examples":["GET /api/domains/mydomain.net\n200\n{\n \"domain\": {\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"fullname\": null,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"dns_id\": 113629430,\n \"id\": 22495316,\n \"name\": \"mydomain.net\"\n }\n}"],"apis":[{"api_url":"/api/domains/:id","short_description":"Show a domain.","http_method":"GET"}],"errors":[],"see":[],"name":"show","formats":null,"doc_url":"/apidoc/v2/domains/show"},{"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>","params":[{"validator":"Must be a Hash","required":true,"full_name":"domain","params":[{"full_name":"domain[name]","required":true,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"<p>The full DNS Domain name</p>","name":"name"},{"full_name":"domain[fullname]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":true,"description":"<p>Full name describing the domain</p>","name":"fullname"},{"full_name":"domain[dns_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":true,"description":"<p>DNS Proxy to use within this domain</p>","name":"dns_id"},{"full_name":"domain[domain_parameters_attributes]","required":false,"validator":"Must be Array","expected_type":"array","allow_nil":false,"description":"<p>Array of parameters (name, value)</p>","name":"domain_parameters_attributes"}],"expected_type":"hash","allow_nil":false,"description":"","name":"domain"}],"examples":["POST /api/domains\n{\n \"domain\": {\n \"name\": \"domain.net\"\n }\n}\n201\n{\n \"domain\": {\n \"id\": 759776764,\n \"name\": \"domain.net\"\n }\n}"],"apis":[{"api_url":"/api/domains","short_description":"Create a domain.","http_method":"POST"}],"errors":[],"see":[],"name":"create","formats":null,"doc_url":"/apidoc/v2/domains/create"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"},{"validator":"Must be a Hash","required":true,"full_name":"domain","params":[{"full_name":"domain[name]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":true,"description":"<p>The full DNS Domain name</p>","name":"name"},{"full_name":"domain[fullname]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":true,"description":"<p>Full name describing the domain</p>","name":"fullname"},{"full_name":"domain[dns_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":true,"description":"<p>DNS Proxy to use within this domain</p>","name":"dns_id"},{"full_name":"domain[domain_parameters_attributes]","required":false,"validator":"Must be Array","expected_type":"array","allow_nil":false,"description":"<p>Array of parameters (name, value)</p>","name":"domain_parameters_attributes"}],"expected_type":"hash","allow_nil":false,"description":"","name":"domain"}],"examples":["PUT /api/domains/mydomain.net\n{\n \"domain\": {\n \"name\": \"\"\n }\n}\n422\n{\n \"domain\": {\n \"full_messages\": [\n \"Name can't be blank\"\n ],\n \"errors\": {\n \"name\": [\n \"can't be blank\"\n ]\n },\n \"id\": 22495316\n }\n}"],"apis":[{"api_url":"/api/domains/:id","short_description":"Update a domain.","http_method":"PUT"}],"errors":[],"see":[],"name":"update","formats":null,"doc_url":"/apidoc/v2/domains/update"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["DELETE /api/domains/mydomain.net\n200\n{\n \"domain\": {\n \"id\": 22495316,\n \"name\": \"mydomain.net\"\n }\n}"],"apis":[{"api_url":"/api/domains/:id","short_description":"Delete a domain.","http_method":"DELETE"}],"errors":[],"see":[],"name":"destroy","formats":null,"doc_url":"/apidoc/v2/domains/destroy"}],"short_description":null,"name":"Domains","doc_url":"/apidoc/v2/domains","formats":null},"images":{"api_url":"/api","full_description":null,"version":"v2","methods":[{"full_description":"","params":[{"validator":"Must be String","required":false,"full_name":"search","expected_type":"string","allow_nil":false,"description":"<p>filter results</p>","name":"search"},{"validator":"Must be String","required":false,"full_name":"order","expected_type":"string","allow_nil":false,"description":"<p>sort results</p>","name":"order"},{"validator":"Must be String","required":false,"full_name":"page","expected_type":"string","allow_nil":false,"description":"<p>paginate results</p>","name":"page"},{"validator":"Must be String","required":false,"full_name":"per_page","expected_type":"string","allow_nil":false,"description":"<p>number of entries per request</p>","name":"per_page"},{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"compute_resource_id","expected_type":"string","allow_nil":false,"description":"","name":"compute_resource_id"}],"examples":["GET /api/compute_resources/980190962/images\n200\n[\n {\n \"image\": {\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"username\": \"MyString\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"architecture_id\": 501905019,\n \"uuid\": \"MyString2\",\n \"compute_resource_id\": 980190962,\n \"id\": 298486374,\n \"name\": \"centos-2\",\n \"operatingsystem_id\": 309172073\n }\n },\n {\n \"image\": {\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"username\": \"root\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"architecture_id\": 501905019,\n \"uuid\": \"string-of-uuid\",\n \"compute_resource_id\": 980190962,\n \"id\": 980190962,\n \"name\": \"centos-1\",\n \"operatingsystem_id\": 309172073\n }\n }\n]"],"apis":[{"api_url":"/api/compute_resources/:compute_resource_id/images","short_description":"List all images for compute resource","http_method":"GET"}],"errors":[],"see":[],"name":"index","formats":null,"doc_url":"/apidoc/v2/images/index"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"},{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"compute_resource_id","expected_type":"string","allow_nil":false,"description":"","name":"compute_resource_id"}],"examples":["GET /api/compute_resources/980190962/images/980190962\n200\n{\n \"image\": {\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"username\": \"root\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"architecture_id\": 501905019,\n \"uuid\": \"string-of-uuid\",\n \"compute_resource_id\": 980190962,\n \"id\": 980190962,\n \"name\": \"centos-1\",\n \"operatingsystem_id\": 309172073\n }\n}"],"apis":[{"api_url":"/api/compute_resources/:compute_resource_id/images/:id","short_description":"Show an image","http_method":"GET"}],"errors":[],"see":[],"name":"show","formats":null,"doc_url":"/apidoc/v2/images/show"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"compute_resource_id","expected_type":"string","allow_nil":false,"description":"","name":"compute_resource_id"},{"validator":"Must be a Hash","required":true,"full_name":"image","params":[{"full_name":"image[name]","required":true,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"name"},{"full_name":"image[username]","required":true,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"username"},{"full_name":"image[uuid]","required":true,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"uuid"},{"full_name":"image[compute_resource_id]","required":true,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"compute_resource_id"},{"full_name":"image[architecture_id]","required":true,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"architecture_id"},{"full_name":"image[operatingsystem_id]","required":true,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"operatingsystem_id"}],"expected_type":"hash","allow_nil":false,"description":"","name":"image"}],"examples":["POST /api/compute_resources/980190962/images\n{\n \"image\": {\n \"username\": \"ec2-user\",\n \"architecture_id\": 381564594,\n \"uuid\": \"abcdef\",\n \"compute_resource_id\": 367690737,\n \"name\": \"TestImage\",\n \"operatingsystem_id\": 309172073\n }\n}\n201\n{\n \"compute_resource\": {\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"attrs\": null,\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"url\": \"qemu://stam/system\",\n \"uuid\": \"MyString\",\n \"user\": \"MyString\",\n \"description\": \"MyString\",\n \"id\": 980190962,\n \"name\": \"MyString\"\n }\n}"],"apis":[{"api_url":"/api/compute_resources/:compute_resource_id/images","short_description":"Create a image","http_method":"POST"}],"errors":[],"see":[],"name":"create","formats":null,"doc_url":"/apidoc/v2/images/create"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"compute_resource_id","expected_type":"string","allow_nil":false,"description":"","name":"compute_resource_id"},{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"},{"validator":"Must be a Hash","required":true,"full_name":"image","params":[{"full_name":"image[name]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"name"},{"full_name":"image[username]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"username"},{"full_name":"image[uuid]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"uuid"},{"full_name":"image[compute_resource_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"compute_resource_id"},{"full_name":"image[architecture_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"architecture_id"},{"full_name":"image[operatingsystem_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"operatingsystem_id"}],"expected_type":"hash","allow_nil":false,"description":"","name":"image"}],"examples":["PUT /api/compute_resources/980190962/images/980190962\n{\n \"image\": {}\n}\n200\n{\n \"image\": {\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"username\": \"root\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"architecture_id\": 501905019,\n \"uuid\": \"string-of-uuid\",\n \"compute_resource_id\": 980190962,\n \"id\": 980190962,\n \"name\": \"centos-1\",\n \"operatingsystem_id\": 309172073\n }\n}"],"apis":[{"api_url":"/api/compute_resources/:compute_resource_id/images/:id","short_description":"Update a image.","http_method":"PUT"}],"errors":[],"see":[],"name":"update","formats":null,"doc_url":"/apidoc/v2/images/update"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"compute_resource_id","expected_type":"string","allow_nil":false,"description":"","name":"compute_resource_id"},{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["DELETE /api/compute_resources/980190962/images/980190962\n200\n{\n \"image\": {\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"username\": \"root\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"architecture_id\": 501905019,\n \"uuid\": \"string-of-uuid\",\n \"compute_resource_id\": 980190962,\n \"id\": 980190962,\n \"name\": \"centos-1\",\n \"operatingsystem_id\": 309172073\n }\n}"],"apis":[{"api_url":"/api/compute_resources/:compute_resource_id/images/:id","short_description":"Delete an image.","http_method":"DELETE"}],"errors":[],"see":[],"name":"destroy","formats":null,"doc_url":"/apidoc/v2/images/destroy"}],"short_description":null,"name":"Images","doc_url":"/apidoc/v2/images","formats":null},"ptables":{"api_url":"/api","full_description":null,"version":"v2","methods":[{"full_description":"","params":[{"validator":"Must be String","required":false,"full_name":"search","expected_type":"string","allow_nil":false,"description":"<p>filter results</p>","name":"search"},{"validator":"Must be String","required":false,"full_name":"order","expected_type":"string","allow_nil":false,"description":"<p>sort results</p>","name":"order"},{"validator":"Must be String","required":false,"full_name":"page","expected_type":"string","allow_nil":false,"description":"<p>paginate results</p>","name":"page"},{"validator":"Must be String","required":false,"full_name":"per_page","expected_type":"string","allow_nil":false,"description":"<p>number of entries per request</p>","name":"per_page"}],"examples":["GET /api/ptables\n200\n[\n {\n \"ptable\": {\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"id\": 980190962,\n \"name\": \"default\"\n }\n },\n {\n \"ptable\": {\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"id\": 281110143,\n \"name\": \"four\"\n }\n },\n {\n \"ptable\": {\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"id\": 859751735,\n \"name\": \"suse default\"\n }\n },\n {\n \"ptable\": {\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"id\": 1011586618,\n \"name\": \"ubuntu default\"\n }\n }\n]"],"apis":[{"api_url":"/api/ptables","short_description":"List all ptables.","http_method":"GET"}],"errors":[],"see":[],"name":"index","formats":null,"doc_url":"/apidoc/v2/ptables/index"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["GET /api/ptables/980190962\n200\n{\n \"ptable\": {\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"id\": 980190962,\n \"name\": \"default\"\n }\n}"],"apis":[{"api_url":"/api/ptables/:id","short_description":"Show a ptable.","http_method":"GET"}],"errors":[],"see":[],"name":"show","formats":null,"doc_url":"/apidoc/v2/ptables/show"},{"full_description":"","params":[{"validator":"Must be a Hash","required":true,"full_name":"ptable","params":[{"full_name":"ptable[name]","required":true,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"name"},{"full_name":"ptable[layout]","required":true,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"layout"},{"full_name":"ptable[os_family]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"os_family"}],"expected_type":"hash","allow_nil":false,"description":"","name":"ptable"}],"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 \"id\": 1011586619,\n \"name\": \"ptable_test\"\n }\n}"],"apis":[{"api_url":"/api/ptables","short_description":"Create a ptable.","http_method":"POST"}],"errors":[],"see":[],"name":"create","formats":null,"doc_url":"/apidoc/v2/ptables/create"},{"full_description":"","params":[{"validator":"Must be String","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"},{"validator":"Must be a Hash","required":true,"full_name":"ptable","params":[{"full_name":"ptable[name]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"name"},{"full_name":"ptable[layout]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"layout"},{"full_name":"ptable[os_family]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"os_family"}],"expected_type":"hash","allow_nil":false,"description":"","name":"ptable"}],"examples":["PUT /api/ptables/980190962\n{\n \"ptable\": {}\n}\n200\n{\n \"ptable\": {\n \"id\": 980190962,\n \"name\": \"default\"\n }\n}"],"apis":[{"api_url":"/api/ptables/:id","short_description":"Update a ptable.","http_method":"PUT"}],"errors":[],"see":[],"name":"update","formats":null,"doc_url":"/apidoc/v2/ptables/update"},{"full_description":"","params":[{"validator":"Must be String","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["DELETE /api/ptables/980190962\n422\n{\n \"ptable\": {\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 \"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 \"id\": 980190962\n }\n}"],"apis":[{"api_url":"/api/ptables/:id","short_description":"Delete a ptable.","http_method":"DELETE"}],"errors":[],"see":[],"name":"destroy","formats":null,"doc_url":"/apidoc/v2/ptables/destroy"}],"short_description":null,"name":"Ptables","doc_url":"/apidoc/v2/ptables","formats":null},"organizations":{"api_url":"/api","full_description":null,"version":"v2","methods":[{"full_description":"","params":[{"validator":"Must be String","required":false,"full_name":"search","expected_type":"string","allow_nil":false,"description":"<p>filter results</p>","name":"search"},{"validator":"Must be String","required":false,"full_name":"order","expected_type":"string","allow_nil":false,"description":"<p>sort results</p>","name":"order"},{"validator":"Must be String","required":false,"full_name":"page","expected_type":"string","allow_nil":false,"description":"<p>paginate results</p>","name":"page"},{"validator":"Must be String","required":false,"full_name":"per_page","expected_type":"string","allow_nil":false,"description":"<p>number of entries per request</p>","name":"per_page"}],"examples":[],"apis":[{"api_url":"/api/organization_id","short_description":"List all organization_id","http_method":"GET"}],"errors":[],"see":[],"name":"index","formats":null,"doc_url":"/apidoc/v2/organizations/index"},{"full_description":"","params":[],"examples":[],"apis":[{"api_url":"/api/organization_id/:id","short_description":"Show an organization","http_method":"GET"}],"errors":[],"see":[],"name":"show","formats":null,"doc_url":"/apidoc/v2/organizations/show"},{"full_description":"","params":[{"validator":"Must be a Hash","required":true,"full_name":"organization","params":[{"full_name":"organization[name]","required":true,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"name"}],"expected_type":"hash","allow_nil":false,"description":"","name":"organization"}],"examples":[],"apis":[{"api_url":"/api/organization_id","short_description":"Create an organization","http_method":"POST"}],"errors":[],"see":[],"name":"create","formats":null,"doc_url":"/apidoc/v2/organizations/create"},{"full_description":"","params":[{"validator":"Must be a Hash","required":true,"full_name":"organization","params":[{"full_name":"organization[name]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"name"}],"expected_type":"hash","allow_nil":false,"description":"","name":"organization"}],"examples":[],"apis":[{"api_url":"/api/organization_id/:id","short_description":"Update an organization","http_method":"PUT"}],"errors":[],"see":[],"name":"update","formats":null,"doc_url":"/apidoc/v2/organizations/update"},{"full_description":"","params":[],"examples":[],"apis":[{"api_url":"/api/organization_id/:id","short_description":"Delete an organization","http_method":"DELETE"}],"errors":[],"see":[],"name":"destroy","formats":null,"doc_url":"/apidoc/v2/organizations/destroy"}],"short_description":null,"name":"Organizations","doc_url":"/apidoc/v2/organizations","formats":null},"lookup_keys":{"api_url":"/api","full_description":null,"version":"v2","methods":[{"full_description":"","params":[{"validator":"Must be String","required":false,"full_name":"search","expected_type":"string","allow_nil":false,"description":"<p>filter results</p>","name":"search"},{"validator":"Must be String","required":false,"full_name":"order","expected_type":"string","allow_nil":false,"description":"<p>sort results</p>","name":"order"},{"validator":"Must be String","required":false,"full_name":"page","expected_type":"string","allow_nil":false,"description":"<p>paginate results</p>","name":"page"},{"validator":"Must be String","required":false,"full_name":"per_page","expected_type":"string","allow_nil":false,"description":"<p>number of entries per request</p>","name":"per_page"}],"examples":["GET /api/lookup_keys\n200\n[\n {\n \"lookup_key\": {\n \"required\": false,\n \"override\": false,\n \"key\": \"port\",\n \"default_value\": \"80\",\n \"description\": null,\n \"id\": 980190962,\n \"is_param\": true\n }\n },\n {\n \"lookup_key\": {\n \"required\": false,\n \"override\": true,\n \"key\": \"ssl\",\n \"default_value\": \"t\",\n \"description\": null,\n \"id\": 113629430,\n \"is_param\": true\n }\n },\n {\n \"lookup_key\": {\n \"required\": false,\n \"override\": false,\n \"key\": \"ssl_port\",\n \"default_value\": \"443\",\n \"description\": null,\n \"id\": 298486374,\n \"is_param\": false\n }\n }\n]"],"apis":[{"api_url":"/api/smart_variables","short_description":"List all smart variables (smart parameters and smart class parameters).","http_method":"GET"}],"errors":[],"see":[],"name":"index","formats":null,"doc_url":"/apidoc/v2/lookup_keys/index"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["GET /api/lookup_keys/980190962-port\n200\n{\n \"lookup_key\": {\n \"required\": false,\n \"override\": false,\n \"key\": \"port\",\n \"default_value\": \"80\",\n \"description\": null,\n \"id\": 980190962,\n \"is_param\": true\n }\n}"],"apis":[{"api_url":"/api/smart_variables/:id","short_description":"Show a smart variable (smart parameter or smart class parameter).","http_method":"GET"}],"errors":[],"see":[],"name":"show","formats":null,"doc_url":"/apidoc/v2/lookup_keys/show"},{"full_description":"","params":[{"validator":"Must be a Hash","required":true,"full_name":"lookup_key","params":[{"full_name":"lookup_key[key]","required":true,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"key"},{"full_name":"lookup_key[puppetclass_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"puppetclass_id"},{"full_name":"lookup_key[default_value]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"default_value"},{"full_name":"lookup_key[path]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"path"},{"full_name":"lookup_key[description]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"description"},{"full_name":"lookup_key[validator_type]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"validator_type"},{"full_name":"lookup_key[validator_rule]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"validator_rule"},{"full_name":"lookup_key[is_param]","required":false,"validator":"Must be 'true' or 'false'","expected_type":"string","allow_nil":false,"description":"","name":"is_param"},{"full_name":"lookup_key[key_type]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"key_type"},{"full_name":"lookup_key[override]","required":false,"validator":"Must be 'true' or 'false'","expected_type":"string","allow_nil":false,"description":"","name":"override"},{"full_name":"lookup_key[required]","required":false,"validator":"Must be 'true' or 'false'","expected_type":"string","allow_nil":false,"description":"","name":"required"}],"expected_type":"hash","allow_nil":false,"description":"","name":"lookup_key"}],"examples":["POST /api/lookup_keys\n{\n \"lookup_key\": {\n \"key\": \"testkey\",\n \"is_param\": true\n }\n}\n201\n{\n \"lookup_key\": {\n \"required\": false,\n \"override\": false,\n \"key\": \"testkey\",\n \"default_value\": null,\n \"description\": null,\n \"id\": 980190963,\n \"is_param\": true\n }\n}"],"apis":[{"api_url":"/api/smart_variables","short_description":"Create a smart variable.","http_method":"POST"}],"errors":[],"see":[],"name":"create","formats":null,"doc_url":"/apidoc/v2/lookup_keys/create"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"},{"validator":"Must be a Hash","required":true,"full_name":"lookup_key","params":[{"full_name":"lookup_key[key]","required":true,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"key"},{"full_name":"lookup_key[puppetclass_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"puppetclass_id"},{"full_name":"lookup_key[default_value]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"default_value"},{"full_name":"lookup_key[path]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"path"},{"full_name":"lookup_key[description]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"description"},{"full_name":"lookup_key[validator_type]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"validator_type"},{"full_name":"lookup_key[validator_rule]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"validator_rule"},{"full_name":"lookup_key[is_param]","required":false,"validator":"Must be 'true' or 'false'","expected_type":"string","allow_nil":false,"description":"","name":"is_param"},{"full_name":"lookup_key[key_type]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"key_type"},{"full_name":"lookup_key[override]","required":false,"validator":"Must be 'true' or 'false'","expected_type":"string","allow_nil":false,"description":"","name":"override"},{"full_name":"lookup_key[required]","required":false,"validator":"Must be 'true' or 'false'","expected_type":"string","allow_nil":false,"description":"","name":"required"}],"expected_type":"hash","allow_nil":false,"description":"","name":"lookup_key"}],"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 \"override\": false,\n \"key\": \"port\",\n \"default_value\": 8080,\n \"description\": null,\n \"id\": 980190962,\n \"is_param\": true\n }\n}"],"apis":[{"api_url":"/api/smart_variables/:id","short_description":"Update a smart variable.","http_method":"PUT"}],"errors":[],"see":[],"name":"update","formats":null,"doc_url":"/apidoc/v2/lookup_keys/update"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["DELETE /api/lookup_keys/980190962-port\n200\n{\n \"lookup_key\": {\n \"required\": false,\n \"override\": false,\n \"key\": \"port\",\n \"default_value\": \"80\",\n \"description\": null,\n \"id\": 980190962,\n \"is_param\": true\n }\n}"],"apis":[{"api_url":"/api/smart_variables/:id","short_description":"Delete a smart variable.","http_method":"DELETE"}],"errors":[],"see":[],"name":"destroy","formats":null,"doc_url":"/apidoc/v2/lookup_keys/destroy"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":false,"full_name":"host_id","expected_type":"string","allow_nil":false,"description":"","name":"host_id"},{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":false,"full_name":"hostgroup_id","expected_type":"string","allow_nil":false,"description":"","name":"hostgroup_id"},{"validator":"Must be String","required":false,"full_name":"page","expected_type":"string","allow_nil":false,"description":"<p>paginate results</p>","name":"page"},{"validator":"Must be String","required":false,"full_name":"per_page","expected_type":"string","allow_nil":false,"description":"<p>number of entries per request</p>","name":"per_page"}],"examples":[],"apis":[{"api_url":"/api/hosts/:host_id/smart_parameters","short_description":"List of smart parameters for a specific host","http_method":"GET"},{"api_url":"/api/hostgroups/:hostgroup_id/smart_parameters","short_description":"List of smart parameters for a specific hostgroup","http_method":"GET"}],"errors":[],"see":[],"name":"host_or_hostgroup_smart_parameters","formats":null,"doc_url":"/apidoc/v2/lookup_keys/host_or_hostgroup_smart_parameters"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":false,"full_name":"host_id","expected_type":"string","allow_nil":false,"description":"","name":"host_id"},{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":false,"full_name":"hostgroup_id","expected_type":"string","allow_nil":false,"description":"","name":"hostgroup_id"},{"validator":"Must be String","required":false,"full_name":"page","expected_type":"string","allow_nil":false,"description":"<p>paginate results</p>","name":"page"},{"validator":"Must be String","required":false,"full_name":"per_page","expected_type":"string","allow_nil":false,"description":"<p>number of entries per request</p>","name":"per_page"}],"examples":[],"apis":[{"api_url":"/api/hosts/:host_id/smart_class_parameters","short_description":"List of smart class parameters for a specific host","http_method":"GET"},{"api_url":"/api/hostgroups/:hostgroup_id/smart_class_parameters","short_description":"List of smart class parameters for a specific hostgroup","http_method":"GET"}],"errors":[],"see":[],"name":"host_or_hostgroup_smart_class_parameters","formats":null,"doc_url":"/apidoc/v2/lookup_keys/host_or_hostgroup_smart_class_parameters"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"puppetclass_id","expected_type":"string","allow_nil":false,"description":"","name":"puppetclass_id"},{"validator":"Must be String","required":false,"full_name":"order","expected_type":"string","allow_nil":false,"description":"<p>sort results</p>","name":"order"},{"validator":"Must be String","required":false,"full_name":"page","expected_type":"string","allow_nil":false,"description":"<p>paginate results</p>","name":"page"},{"validator":"Must be String","required":false,"full_name":"per_page","expected_type":"string","allow_nil":false,"description":"<p>number of entries per request</p>","name":"per_page"}],"examples":[],"apis":[{"api_url":"/api/puppetclasses/:puppetclass_id/smart_parameters","short_description":"List of smart parameters for a specific puppetclass","http_method":"GET"}],"errors":[],"see":[],"name":"puppet_smart_parameters","formats":null,"doc_url":"/apidoc/v2/lookup_keys/puppet_smart_parameters"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"puppetclass_id","expected_type":"string","allow_nil":false,"description":"","name":"puppetclass_id"},{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"environment_id","expected_type":"string","allow_nil":false,"description":"","name":"environment_id"},{"validator":"Must be String","required":false,"full_name":"order","expected_type":"string","allow_nil":false,"description":"<p>sort results</p>","name":"order"},{"validator":"Must be String","required":false,"full_name":"page","expected_type":"string","allow_nil":false,"description":"<p>paginate results</p>","name":"page"},{"validator":"Must be String","required":false,"full_name":"per_page","expected_type":"string","allow_nil":false,"description":"<p>number of entries per request</p>","name":"per_page"}],"examples":[],"apis":[{"api_url":"/api/puppetclasses/:puppetclass_id/environments/:environment_id/smart_class_parameters","short_description":"List of smart class parameters for a specific puppetclass and environment","http_method":"GET"}],"errors":[],"see":[],"name":"puppet_smart_class_parameters","formats":null,"doc_url":"/apidoc/v2/lookup_keys/puppet_smart_class_parameters"}],"short_description":null,"name":"Lookup keys","doc_url":"/apidoc/v2/lookup_keys","formats":null},"media":{"api_url":"/api","full_description":null,"version":"v2","methods":[{"full_description":"","params":[{"validator":"Must be String","required":false,"full_name":"search","expected_type":"string","allow_nil":false,"description":"<p>filter results</p>","name":"search"},{"validator":"Must be String","required":false,"full_name":"order","expected_type":"string","allow_nil":false,"description":"<p>for example, name ASC, or name DESC</p>","name":"order"},{"validator":"Must be String","required":false,"full_name":"page","expected_type":"string","allow_nil":false,"description":"<p>paginate results</p>","name":"page"},{"validator":"Must be String","required":false,"full_name":"per_page","expected_type":"string","allow_nil":false,"description":"<p>number of entries per request</p>","name":"per_page"}],"examples":["GET /api/media\n200\n[\n {\n \"medium\": {\n \"path\": \"http://mirror.averse.net/centos/6.0/os/$arch\",\n \"id\": 980190962,\n \"name\": \"CentOS 5.4\"\n }\n },\n {\n \"medium\": {\n \"path\": \"http://mirror.isoc.org.il/pub/opensuse/distribution/$major.$minor/repo/oss\",\n \"id\": 859751735,\n \"name\": \"OpenSuse Mirror\"\n }\n },\n {\n \"medium\": {\n \"path\": \"http://brsla01/vol/solgi_5.10/sol$minor_$release_$arch\",\n \"id\": 442321401,\n \"name\": \"Solaris 10\"\n }\n },\n {\n \"medium\": {\n \"path\": \"http://sg.archive.ubuntu.com\",\n \"id\": 1011586618,\n \"name\": \"Ubuntu Mirror\"\n }\n },\n {\n \"medium\": {\n \"path\": \"http://nothing.intersting.com\",\n \"id\": 338446587,\n \"name\": \"unused\"\n }\n }\n]"],"apis":[{"api_url":"/api/media","short_description":"List all media.","http_method":"GET"}],"errors":[],"see":[],"name":"index","formats":null,"doc_url":"/apidoc/v2/media/index"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["GET /api/media/980190962\n200\n{\n \"medium\": {\n \"path\": \"http://mirror.averse.net/centos/6.0/os/$arch\",\n \"id\": 980190962,\n \"name\": \"CentOS 5.4\"\n }\n}"],"apis":[{"api_url":"/api/media/:id","short_description":"Show a medium.","http_method":"GET"}],"errors":[],"see":[],"name":"show","formats":null,"doc_url":"/apidoc/v2/media/show"},{"full_description":"","params":[{"validator":"Must be a Hash","required":true,"full_name":"medium","params":[{"full_name":"medium[name]","required":true,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"<p>Name of media</p>","name":"name"},{"full_name":"medium[path]","required":true,"validator":"Must be String","expected_type":"string","allow_nil":false,"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>","name":"path"},{"full_name":"medium[os_family]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"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>","name":"os_family"},{"full_name":"medium[operatingsystem_ids]","required":false,"validator":"Must be Array","expected_type":"array","allow_nil":false,"description":"","name":"operatingsystem_ids"}],"expected_type":"hash","allow_nil":false,"description":"","name":"medium"}],"examples":["POST /api/media\n{\n \"medium\": {\n \"path\": \"http://www.newmedium.com/\",\n \"name\": \"new medium\"\n }\n}\n201\n{\n \"medium\": {\n \"id\": 1011586619,\n \"name\": \"new medium\"\n }\n}"],"apis":[{"api_url":"/api/media","short_description":"Create a medium.","http_method":"POST"}],"errors":[],"see":[],"name":"create","formats":null,"doc_url":"/apidoc/v2/media/create"},{"full_description":"","params":[{"validator":"Must be String","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"},{"validator":"Must be a Hash","required":true,"full_name":"medium","params":[{"full_name":"medium[name]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"<p>Name of media</p>","name":"name"},{"full_name":"medium[path]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"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>","name":"path"},{"full_name":"medium[os_family]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":true,"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>","name":"os_family"},{"full_name":"medium[operatingsystem_ids]","required":false,"validator":"Must be Array","expected_type":"array","allow_nil":false,"description":"","name":"operatingsystem_ids"}],"expected_type":"hash","allow_nil":false,"description":"","name":"medium"}],"examples":["PUT /api/media/980190962\n{\n \"name\": \"CentOS 5.4\"\n}\n200\n{\n \"medium\": {\n \"id\": 980190962,\n \"name\": \"CentOS 5.4\"\n }\n}"],"apis":[{"api_url":"/api/media/:id","short_description":"Update a medium.","http_method":"PUT"}],"errors":[],"see":[],"name":"update","formats":null,"doc_url":"/apidoc/v2/media/update"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["DELETE /api/media/338446587\n200\n{\n \"medium\": {\n \"id\": 338446587,\n \"name\": \"unused\"\n }\n}"],"apis":[{"api_url":"/api/media/:id","short_description":"Delete a medium.","http_method":"DELETE"}],"errors":[],"see":[],"name":"destroy","formats":null,"doc_url":"/apidoc/v2/media/destroy"}],"short_description":null,"name":"Media","doc_url":"/apidoc/v2/media","formats":null},"hosts":{"api_url":"/api","full_description":null,"version":"v2","methods":[{"full_description":"","params":[{"validator":"Must be String","required":false,"full_name":"search","expected_type":"string","allow_nil":false,"description":"<p>Filter results</p>","name":"search"},{"validator":"Must be String","required":false,"full_name":"order","expected_type":"string","allow_nil":false,"description":"<p>Sort results</p>","name":"order"},{"validator":"Must be String","required":false,"full_name":"page","expected_type":"string","allow_nil":false,"description":"<p>paginate results</p>","name":"page"},{"validator":"Must be String","required":false,"full_name":"per_page","expected_type":"string","allow_nil":false,"description":"<p>number of entries per request</p>","name":"per_page"}],"examples":["GET /api/hosts\n200\n[\n {\n \"host\": {\n \"hostgroup_id\": null,\n \"id\": 55602819,\n \"name\": \"anotherfullhost\",\n \"operatingsystem_id\": 1073012828\n }\n },\n {\n \"host\": {\n \"hostgroup_id\": null,\n \"id\": 219245707,\n \"name\": \"dhcp.mydomain.net\",\n \"operatingsystem_id\": 1073012828\n }\n },\n {\n \"host\": {\n \"hostgroup_id\": null,\n \"id\": 980190962,\n \"name\": \"my5name.mydomain.net\",\n \"operatingsystem_id\": 1073012828\n }\n },\n {\n \"host\": {\n \"hostgroup_id\": null,\n \"id\": 1053842695,\n \"name\": \"myfullname.mydomain.net\",\n \"operatingsystem_id\": 309172073\n }\n },\n {\n \"host\": {\n \"hostgroup_id\": null,\n \"id\": 661942085,\n \"name\": \"otherfullhost\",\n \"operatingsystem_id\": 1073012828\n }\n },\n {\n \"host\": {\n \"hostgroup_id\": null,\n \"id\": 500757383,\n \"name\": \"sdhcp.mydomain.net\",\n \"operatingsystem_id\": 1073012828\n }\n },\n {\n \"host\": {\n \"hostgroup_id\": null,\n \"id\": 715054938,\n \"name\": \"sol10host\",\n \"operatingsystem_id\": 442321401\n }\n },\n {\n \"host\": {\n \"hostgroup_id\": null,\n \"id\": 859751735,\n \"name\": \"suse01.yourdomain.net\",\n \"operatingsystem_id\": 859751735\n }\n },\n {\n \"host\": {\n \"hostgroup_id\": null,\n \"id\": 1011586618,\n \"name\": \"temp-01.yourdomain.net\",\n \"operatingsystem_id\": 331303656\n }\n },\n {\n \"host\": {\n \"hostgroup_id\": null,\n \"id\": 1073012828,\n \"name\": \"temp01.yourdomain.net\",\n \"operatingsystem_id\": 1073012828\n }\n },\n {\n \"host\": {\n \"hostgroup_id\": null,\n \"id\": 3666571,\n \"name\": \"temp-02.useless.net\",\n \"operatingsystem_id\": 331303656\n }\n },\n {\n \"host\": {\n \"hostgroup_id\": null,\n \"id\": 298486374,\n \"name\": \"temp.yourdomain.net\",\n \"operatingsystem_id\": 309172073\n }\n }\n]"],"apis":[{"api_url":"/api/hosts","short_description":"List all hosts.","http_method":"GET"}],"errors":[],"see":[],"name":"index","formats":null,"doc_url":"/apidoc/v2/hosts/index"},{"full_description":"","params":[{"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.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["GET /api/hosts/my5name.mydomain.net\n200\n{\n \"host\": {\n \"ptable_id\": 980190962,\n \"sp_subnet_id\": null,\n \"domain_id\": 22495316,\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"sp_ip\": \"\",\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"sp_name\": \"\",\n \"image_file\": \"\",\n \"puppet_proxy_id\": 182953976,\n \"environment\": {\n \"environment\": {\n \"id\": 334344675,\n \"name\": \"production\"\n }\n },\n \"subnet_id\": 980190962,\n \"architecture_id\": 501905019,\n \"environment_id\": 334344675,\n \"use_image\": null,\n \"last_report\": null,\n \"uuid\": null,\n \"sp_mac\": \"\",\n \"image_id\": null,\n \"hostgroup_id\": null,\n \"build\": false,\n \"host_parameters\": [\n {\n \"host_parameter\": {\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"reference_id\": 980190962,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"value\": \"host1\",\n \"id\": 254219264,\n \"name\": \"host1\",\n \"priority\": 4\n }\n }\n ],\n \"model_id\": null,\n \"managed\": true,\n \"disk\": null,\n \"comment\": null,\n \"medium_id\": null,\n \"certname\": \"my5name.mydomain.net\",\n \"installed_at\": null,\n \"compute_resource_id\": 980190962,\n \"owner_type\": null,\n \"puppet_ca_proxy_id\": null,\n \"id\": 980190962,\n \"ip\": \"2.3.4.1\",\n \"enabled\": true,\n \"name\": \"my5name.mydomain.net\",\n \"owner_id\": null,\n \"operatingsystem_id\": 1073012828,\n \"mac\": \"aabbCCddeeee\"\n }\n}"],"apis":[{"api_url":"/api/hosts/:id","short_description":"Show a host.","http_method":"GET"}],"errors":[],"see":[],"name":"show","formats":null,"doc_url":"/apidoc/v2/hosts/show"},{"full_description":"","params":[{"validator":"Must be a Hash","required":true,"full_name":"host","params":[{"full_name":"host[name]","required":true,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"name"},{"full_name":"host[environment_id]","required":true,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"environment_id"},{"full_name":"host[ip]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"<p>not required if using a subnet with dhcp proxy</p>","name":"ip"},{"full_name":"host[mac]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"<p>not required if its a virtual machine</p>","name":"mac"},{"full_name":"host[architecture_id]","required":true,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"architecture_id"},{"full_name":"host[domain_id]","required":true,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"domain_id"},{"full_name":"host[puppet_proxy_id]","required":true,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"puppet_proxy_id"},{"full_name":"host[puppet_class_ids]","required":false,"validator":"Must be Array","expected_type":"array","allow_nil":false,"description":"","name":"puppet_class_ids"},{"full_name":"host[operatingsystem_id]","required":true,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"operatingsystem_id"},{"full_name":"host[medium_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"medium_id"},{"full_name":"host[ptable_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"ptable_id"},{"full_name":"host[subnet_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"subnet_id"},{"full_name":"host[compute_resource_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"compute_resource_id"},{"full_name":"host[sp_subnet_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"sp_subnet_id"},{"full_name":"host[model_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"model_id"},{"full_name":"host[hostgroup_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"hostgroup_id"},{"full_name":"host[owner_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"owner_id"},{"full_name":"host[puppet_ca_proxy_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"puppet_ca_proxy_id"},{"full_name":"host[image_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"image_id"},{"full_name":"host[host_parameters_attributes]","required":false,"validator":"Must be Array","expected_type":"array","allow_nil":false,"description":"","name":"host_parameters_attributes"},{"full_name":"host[build]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"build"},{"full_name":"host[enabled]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"enabled"},{"full_name":"host[provision_method]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"provision_method"},{"full_name":"host[managed]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"managed"},{"full_name":"host[capabilities]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"capabilities"},{"full_name":"host[compute_attributes]","required":false,"validator":"Must be a Hash","params":[{"validator":"Must be a number.","required":false,"full_name":"host[compute_attributes][flavour_ref]","expected_type":"string","allow_nil":false,"description":"","name":"flavour_ref"},{"validator":"Must be String","required":false,"full_name":"host[compute_attributes][image_ref]","expected_type":"string","allow_nil":false,"description":"","name":"image_ref"},{"validator":"Must be String","required":false,"full_name":"host[compute_attributes][tenant_id]","expected_type":"string","allow_nil":false,"description":"","name":"tenant_id"},{"validator":"Must be String","required":false,"full_name":"host[compute_attributes][security_groups]","expected_type":"string","allow_nil":false,"description":"","name":"security_groups"},{"validator":"Must be String","required":false,"full_name":"host[compute_attributes][network]","expected_type":"string","allow_nil":false,"description":"","name":"network"},{"validator":"Must be a number.","required":false,"full_name":"host[compute_attributes][cpus]","expected_type":"string","allow_nil":false,"description":"","name":"cpus"},{"validator":"Must be a number.","required":false,"full_name":"host[compute_attributes][memory]","expected_type":"string","allow_nil":false,"description":"","name":"memory"},{"validator":"Must be a number.","required":false,"full_name":"host[compute_attributes][start]","expected_type":"string","allow_nil":false,"description":"","name":"start"}],"expected_type":"hash","allow_nil":false,"description":"","name":"compute_attributes"},{"full_name":"host[interfaces_attributes]","required":false,"validator":"Must be a Hash","params":[{"validator":"Must be a Hash","required":false,"full_name":"host[interfaces_attributes][new_interfaces]","params":[{"full_name":"host[interfaces_attributes][new_interfaces][provider]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"provider"},{"full_name":"host[interfaces_attributes][new_interfaces][type]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"type"}],"expected_type":"hash","allow_nil":false,"description":"","name":"new_interfaces"}],"expected_type":"hash","allow_nil":false,"description":"","name":"interfaces_attributes"}],"expected_type":"hash","allow_nil":false,"description":"","name":"host"}],"examples":["POST /api/hosts\n{\n \"host\": {\n \"domain_id\": 22495316,\n \"puppet_proxy_id\": 7,\n \"architecture_id\": 501905019,\n \"environment_id\": 334344675,\n \"ip\": \"10.0.0.20\",\n \"name\": \"testhost11\",\n \"operatingsystem_id\": 1073012828,\n \"mac\": \"52:53:00:1e:85:93\"\n }\n}\n200\n{\n \"host\": {\n \"ptable_id\": null,\n \"sp_subnet_id\": null,\n \"domain_id\": 22495316,\n \"created_at\": \"2012-12-18T15:24:48Z\",\n \"sp_ip\": \"\",\n \"updated_at\": \"2012-12-18T15:24:48Z\",\n \"image_file\": \"\",\n \"sp_name\": \"\",\n \"puppet_proxy_id\": 7,\n \"environment\": {\n \"environment\": {\n \"id\": 334344675,\n \"name\": \"production\"\n }\n },\n \"subnet_id\": null,\n \"architecture_id\": 501905019,\n \"environment_id\": 334344675,\n \"use_image\": null,\n \"last_report\": null,\n \"uuid\": null,\n \"sp_mac\": \"\",\n \"image_id\": null,\n \"hostgroup_id\": null,\n \"build\": false,\n \"host_parameters\": [],\n \"model_id\": null,\n \"managed\": true,\n \"disk\": null,\n \"comment\": null,\n \"medium_id\": null,\n \"certname\": \"fcfce82c-33d1-4565-843a-4f58ff8e371a\",\n \"installed_at\": null,\n \"compute_resource_id\": null,\n \"owner_type\": \"User\",\n \"puppet_ca_proxy_id\": null,\n \"ip\": \"10.0.0.20\",\n \"id\": 1073012829,\n \"enabled\": true,\n \"name\": \"testhost11.mydomain.net\",\n \"owner_id\": 886836129,\n \"operatingsystem_id\": 1073012828,\n \"mac\": \"52:53:00:1e:85:93\"\n }\n}"],"apis":[{"api_url":"/api/hosts","short_description":"Create a host.","http_method":"POST"}],"errors":[],"see":[],"name":"create","formats":null,"doc_url":"/apidoc/v2/hosts/create"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"},{"validator":"Must be a Hash","required":true,"full_name":"host","params":[{"full_name":"host[name]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"name"},{"full_name":"host[environment_id]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"environment_id"},{"full_name":"host[ip]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"<p>not required if using a subnet with dhcp proxy</p>","name":"ip"},{"full_name":"host[mac]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"<p>not required if its a virtual machine</p>","name":"mac"},{"full_name":"host[architecture_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"architecture_id"},{"full_name":"host[domain_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"domain_id"},{"full_name":"host[puppet_proxy_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"puppet_proxy_id"},{"full_name":"host[operatingsystem_id]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"operatingsystem_id"},{"full_name":"host[puppet_class_ids]","required":false,"validator":"Must be Array","expected_type":"array","allow_nil":false,"description":"","name":"puppet_class_ids"},{"full_name":"host[medium_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"medium_id"},{"full_name":"host[ptable_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"ptable_id"},{"full_name":"host[subnet_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"subnet_id"},{"full_name":"host[compute_resource_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"compute_resource_id"},{"full_name":"host[sp_subnet_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"sp_subnet_id"},{"full_name":"host[model_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"model_id"},{"full_name":"host[hostgroup_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"hostgroup_id"},{"full_name":"host[owner_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"owner_id"},{"full_name":"host[puppet_ca_proxy_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"puppet_ca_proxy_id"},{"full_name":"host[image_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"image_id"},{"full_name":"host[host_parameters_attributes]","required":false,"validator":"Must be Array","expected_type":"array","allow_nil":false,"description":"","name":"host_parameters_attributes"},{"full_name":"host[build]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"build"},{"full_name":"host[enabled]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"enabled"},{"full_name":"host[provision_method]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"provision_method"},{"full_name":"host[managed]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"managed"},{"full_name":"host[capabilities]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"capabilities"},{"full_name":"host[compute_attributes]","required":false,"validator":"Must be a Hash","params":[{"validator":"Must be a number.","required":false,"full_name":"host[compute_attributes][flavour_ref]","expected_type":"string","allow_nil":false,"description":"","name":"flavour_ref"},{"validator":"Must be String","required":false,"full_name":"host[compute_attributes][image_ref]","expected_type":"string","allow_nil":false,"description":"","name":"image_ref"},{"validator":"Must be String","required":false,"full_name":"host[compute_attributes][tenant_id]","expected_type":"string","allow_nil":false,"description":"","name":"tenant_id"},{"validator":"Must be String","required":false,"full_name":"host[compute_attributes][security_groups]","expected_type":"string","allow_nil":false,"description":"","name":"security_groups"},{"validator":"Must be String","required":false,"full_name":"host[compute_attributes][network]","expected_type":"string","allow_nil":false,"description":"","name":"network"},{"validator":"Must be a number.","required":false,"full_name":"host[compute_attributes][cpus]","expected_type":"string","allow_nil":false,"description":"","name":"cpus"},{"validator":"Must be a number.","required":false,"full_name":"host[compute_attributes][memory]","expected_type":"string","allow_nil":false,"description":"","name":"memory"},{"validator":"Must be a number.","required":false,"full_name":"host[compute_attributes][start]","expected_type":"string","allow_nil":false,"description":"","name":"start"}],"expected_type":"hash","allow_nil":false,"description":"","name":"compute_attributes"}],"expected_type":"hash","allow_nil":false,"description":"","name":"host"}],"examples":["PUT /api/hosts/temp.yourdomain.net\n{\n \"host\": {}\n}\n200\n{\n \"host\": {\n \"ptable_id\": 980190962,\n \"domain_id\": 589326610,\n \"sp_subnet_id\": null,\n \"last_compile\": null,\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"sp_ip\": \"\",\n \"puppet_status\": 0,\n \"location_id\": null,\n \"root_pass\": \"xybxa6JUkz63w\",\n \"updated_at\": \"2012-12-18T15:24:48Z\",\n \"image_file\": \"\",\n \"sp_name\": \"\",\n \"last_freshcheck\": null,\n \"puppet_proxy_id\": 182953976,\n \"environment\": {\n \"environment\": {\n \"id\": 334344675,\n \"name\": \"production\"\n }\n },\n \"subnet_id\": 980190962,\n \"architecture_id\": 501905019,\n \"environment_id\": 334344675,\n \"use_image\": null,\n \"last_report\": null,\n \"organization_id\": null,\n \"uuid\": null,\n \"sp_mac\": \"\",\n \"image_id\": null,\n \"hostgroup_id\": null,\n \"build\": false,\n \"serial\": null,\n \"model_id\": null,\n \"managed\": null,\n \"disk\": null,\n \"comment\": null,\n \"certname\": \"temp.yourdomain.net\",\n \"medium_id\": 980190962,\n \"installed_at\": null,\n \"compute_resource_id\": 980190962,\n \"owner_type\": \"User\",\n \"id\": 298486374,\n \"ip\": \"2.3.4.5\",\n \"puppet_ca_proxy_id\": null,\n \"enabled\": true,\n \"name\": \"temp.yourdomain.net\",\n \"source_file_id\": null,\n \"operatingsystem_id\": 309172073,\n \"owner_id\": 886836129,\n \"mac\": \"aa:bb:cc:dd:ee:ff\"\n }\n}"],"apis":[{"api_url":"/api/hosts/:id","short_description":"Update a host.","http_method":"PUT"}],"errors":[],"see":[],"name":"update","formats":null,"doc_url":"/apidoc/v2/hosts/update"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["DELETE /api/hosts/my5name.mydomain.net\n200\n{\n \"host\": {\n \"ptable_id\": 980190962,\n \"domain_id\": 22495316,\n \"sp_subnet_id\": null,\n \"last_compile\": null,\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"sp_ip\": \"\",\n \"puppet_status\": 0,\n \"location_id\": null,\n \"root_pass\": \"xybxa6JUkz63w\",\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"image_file\": \"\",\n \"sp_name\": \"\",\n \"last_freshcheck\": null,\n \"puppet_proxy_id\": 182953976,\n \"environment\": {\n \"environment\": {\n \"id\": 334344675,\n \"name\": \"production\"\n }\n },\n \"subnet_id\": 980190962,\n \"architecture_id\": 501905019,\n \"environment_id\": 334344675,\n \"use_image\": null,\n \"last_report\": null,\n \"organization_id\": null,\n \"uuid\": null,\n \"sp_mac\": \"\",\n \"image_id\": null,\n \"hostgroup_id\": null,\n \"build\": false,\n \"serial\": null,\n \"model_id\": null,\n \"managed\": true,\n \"disk\": null,\n \"comment\": null,\n \"certname\": \"my5name.mydomain.net\",\n \"medium_id\": null,\n \"installed_at\": null,\n \"compute_resource_id\": 980190962,\n \"owner_type\": null,\n \"id\": 980190962,\n \"ip\": \"2.3.4.1\",\n \"puppet_ca_proxy_id\": null,\n \"enabled\": true,\n \"name\": \"my5name.mydomain.net\",\n \"source_file_id\": null,\n \"operatingsystem_id\": 1073012828,\n \"owner_id\": null,\n \"mac\": \"aabbCCddeeee\"\n }\n}"],"apis":[{"api_url":"/api/hosts/:id","short_description":"Delete an host.","http_method":"DELETE"}],"errors":[],"see":[],"name":"destroy","formats":null,"doc_url":"/apidoc/v2/hosts/destroy"},{"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>","params":[{"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.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["GET /api/hosts/my5name.mydomain.net/status\n200\n{\n \"status\": \"missing\"\n}"],"apis":[{"api_url":"/api/hosts/:id/status","short_description":"Get status of host","http_method":"GET"}],"errors":[],"see":[],"name":"status","formats":null,"doc_url":"/apidoc/v2/hosts/status"},{"full_description":"","params":[],"examples":[],"apis":[{"api_url":"/api/hosts/:id/puppetrun","short_description":"Force a puppet run on the agent.","http_method":"GET"}],"errors":[],"see":[],"name":"puppetrun","formats":null,"doc_url":"/apidoc/v2/hosts/puppetrun"}],"short_description":null,"name":"Hosts","doc_url":"/apidoc/v2/hosts","formats":null},"bookmarks":{"api_url":"/api","full_description":null,"version":"v2","methods":[{"full_description":"","params":[{"validator":"Must be String","required":false,"full_name":"page","expected_type":"string","allow_nil":false,"description":"<p>paginate results</p>","name":"page"},{"validator":"Must be String","required":false,"full_name":"per_page","expected_type":"string","allow_nil":false,"description":"<p>number of entries per request</p>","name":"per_page"}],"examples":["GET /api/bookmarks\n200\n[\n {\n \"bookmark\": {\n \"controller\": \"hosts\",\n \"query\": \"bar=car\",\n \"public\": false,\n \"owner_type\": null,\n \"id\": 298486374,\n \"name\": \"bar\",\n \"owner_id\": null\n }\n },\n {\n \"bookmark\": {\n \"controller\": \"hosts\",\n \"query\": \"foo=boo\",\n \"public\": true,\n \"owner_type\": null,\n \"id\": 980190962,\n \"name\": \"foo\",\n \"owner_id\": null\n }\n }\n]"],"apis":[{"api_url":"/api/bookmarks","short_description":"List all bookmarks.","http_method":"GET"}],"errors":[],"see":[],"name":"index","formats":null,"doc_url":"/apidoc/v2/bookmarks/index"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["GET /api/bookmarks/foo\n200\n{\n \"bookmark\": {\n \"controller\": \"hosts\",\n \"query\": \"foo=boo\",\n \"public\": true,\n \"owner_type\": null,\n \"id\": 980190962,\n \"name\": \"foo\",\n \"owner_id\": null\n }\n}"],"apis":[{"api_url":"/api/bookmarks/:id","short_description":"Show a bookmark.","http_method":"GET"}],"errors":[],"see":[],"name":"show","formats":null,"doc_url":"/apidoc/v2/bookmarks/show"},{"full_description":"","params":[{"validator":"Must be a Hash","required":true,"full_name":"bookmark","params":[{"full_name":"bookmark[name]","required":true,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"name"},{"full_name":"bookmark[controller]","required":true,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"controller"},{"full_name":"bookmark[query]","required":true,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"query"},{"full_name":"bookmark[public]","required":false,"validator":"Must be 'true' or 'false'","expected_type":"string","allow_nil":false,"description":"","name":"public"}],"expected_type":"hash","allow_nil":false,"description":"","name":"bookmark"}],"examples":["POST /api/bookmarks\n{\n \"bookmark\": {\n \"controller\": \"hosts\",\n \"query\": \"bar\",\n \"public\": false,\n \"name\": \"foo-bar\"\n }\n}\n200\n{\n \"bookmark\": {\n \"controller\": \"hosts\",\n \"query\": \"bar\",\n \"public\": false,\n \"owner_type\": \"User\",\n \"id\": 980190963,\n \"name\": \"foo-bar\",\n \"owner_id\": 886836129\n }\n}"],"apis":[{"api_url":"/api/bookmarks","short_description":"Create a bookmark.","http_method":"POST"}],"errors":[],"see":[],"name":"create","formats":null,"doc_url":"/apidoc/v2/bookmarks/create"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"},{"validator":"Must be a Hash","required":true,"full_name":"bookmark","params":[{"full_name":"bookmark[name]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"name"},{"full_name":"bookmark[controller]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"controller"},{"full_name":"bookmark[query]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"query"},{"full_name":"bookmark[public]","required":false,"validator":"Must be 'true' or 'false'","expected_type":"string","allow_nil":false,"description":"","name":"public"}],"expected_type":"hash","allow_nil":false,"description":"","name":"bookmark"}],"examples":["PUT /api/bookmarks/foo\n{\n \"bookmark\": {}\n}\n200\n{\n \"bookmark\": {\n \"controller\": \"hosts\",\n \"query\": \"foo=boo\",\n \"public\": true,\n \"user\": {\n \"login\": \"apiadmin\",\n \"email\": \"apiadmin@someware.com\",\n \"name\": \"apiadmin User\"\n },\n \"id\": 980190962,\n \"name\": \"foo\"\n }\n}"],"apis":[{"api_url":"/api/bookmarks/:id","short_description":"Update a bookmark.","http_method":"PUT"}],"errors":[],"see":[],"name":"update","formats":null,"doc_url":"/apidoc/v2/bookmarks/update"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["DELETE /api/bookmarks/foo\n200\n{\n \"bookmark\": {\n \"controller\": \"hosts\",\n \"query\": \"foo=boo\",\n \"public\": true,\n \"owner_type\": null,\n \"id\": 980190962,\n \"name\": \"foo\",\n \"owner_id\": null\n }\n}"],"apis":[{"api_url":"/api/bookmarks/:id","short_description":"Delete a bookmark.","http_method":"DELETE"}],"errors":[],"see":[],"name":"destroy","formats":null,"doc_url":"/apidoc/v2/bookmarks/destroy"}],"short_description":null,"name":"Bookmarks","doc_url":"/apidoc/v2/bookmarks","formats":null},"usergroups":{"api_url":"/api","full_description":null,"version":"v2","methods":[{"full_description":"","params":[{"validator":"Must be String","required":false,"full_name":"page","expected_type":"string","allow_nil":false,"description":"<p>paginate results</p>","name":"page"},{"validator":"Must be String","required":false,"full_name":"per_page","expected_type":"string","allow_nil":false,"description":"<p>number of entries per request</p>","name":"per_page"},{"validator":"Must be String","required":false,"full_name":"search","expected_type":"string","allow_nil":false,"description":"<p>filter results</p>","name":"search"},{"validator":"Must be String","required":false,"full_name":"order","expected_type":"string","allow_nil":false,"description":"<p>sort results</p>","name":"order"}],"examples":["GET /api/usergroups\n200\n[\n {\n \"usergroup\": {\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"id\": 980190962,\n \"name\": \"MyString\"\n }\n },\n {\n \"usergroup\": {\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"id\": 298486374,\n \"name\": \"MyString2\"\n }\n }\n]"],"apis":[{"api_url":"/api/usergroups","short_description":"List all usergroups.","http_method":"GET"}],"errors":[],"see":[],"name":"index","formats":null,"doc_url":"/apidoc/v2/usergroups/index"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["GET /api/usergroups/980190962\n200\n{\n \"usergroup\": {\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"id\": 980190962,\n \"name\": \"MyString\"\n }\n}"],"apis":[{"api_url":"/api/usergroups/:id","short_description":"Show a usergroup.","http_method":"GET"}],"errors":[],"see":[],"name":"show","formats":null,"doc_url":"/apidoc/v2/usergroups/show"},{"full_description":"","params":[{"validator":"Must be a Hash","required":true,"full_name":"usergroup","params":[{"full_name":"usergroup[name]","required":true,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"name"}],"expected_type":"hash","allow_nil":false,"description":"","name":"usergroup"}],"examples":["POST /api/usergroups\n{\n \"usergroup\": {\n \"name\": \"test_usergroup\"\n }\n}\n201\n{\n \"usergroup\": {\n \"id\": 980190963,\n \"name\": \"test_usergroup\"\n }\n}"],"apis":[{"api_url":"/api/usergroups","short_description":"Create a usergroup.","http_method":"POST"}],"errors":[],"see":[],"name":"create","formats":null,"doc_url":"/apidoc/v2/usergroups/create"},{"full_description":"","params":[{"validator":"Must be String","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"},{"validator":"Must be a Hash","required":true,"full_name":"usergroup","params":[{"full_name":"usergroup[name]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"name"}],"expected_type":"hash","allow_nil":false,"description":"","name":"usergroup"}],"examples":["PUT /api/usergroups/980190962\n{\n \"usergroup\": {}\n}\n200\n{\n \"usergroup\": {\n \"id\": 980190962,\n \"name\": \"MyString\"\n }\n}"],"apis":[{"api_url":"/api/usergroups/:id","short_description":"Update a usergroup.","http_method":"PUT"}],"errors":[],"see":[],"name":"update","formats":null,"doc_url":"/apidoc/v2/usergroups/update"},{"full_description":"","params":[{"validator":"Must be String","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["DELETE /api/usergroups/980190962\n200\n{\n \"usergroup\": {\n \"id\": 980190962,\n \"name\": \"MyString\"\n }\n}"],"apis":[{"api_url":"/api/usergroups/:id","short_description":"Delete a usergroup.","http_method":"DELETE"}],"errors":[],"see":[],"name":"destroy","formats":null,"doc_url":"/apidoc/v2/usergroups/destroy"}],"short_description":null,"name":"Usergroups","doc_url":"/apidoc/v2/usergroups","formats":null},"compute_resources":{"api_url":"/api","full_description":null,"version":"v2","methods":[{"full_description":"","params":[{"validator":"Must be String","required":false,"full_name":"search","expected_type":"string","allow_nil":false,"description":"<p>filter results</p>","name":"search"},{"validator":"Must be String","required":false,"full_name":"order","expected_type":"string","allow_nil":false,"description":"<p>sort results</p>","name":"order"},{"validator":"Must be String","required":false,"full_name":"page","expected_type":"string","allow_nil":false,"description":"<p>paginate results</p>","name":"page"},{"validator":"Must be String","required":false,"full_name":"per_page","expected_type":"string","allow_nil":false,"description":"<p>number of entries per request</p>","name":"per_page"}],"examples":["GET /api/compute_resources\n200\n[\n {\n \"compute_resource\": {\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"url\": \"test:///default\",\n \"provider\": \"Libvirt\",\n \"user\": \"MyString\",\n \"description\": \"mycompute\",\n \"id\": 367690737,\n \"name\": \"mycompute\"\n }\n },\n {\n \"compute_resource\": {\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"url\": \"qemu://stam/system\",\n \"provider\": \"Libvirt\",\n \"user\": \"MyString\",\n \"description\": \"MyString\",\n \"id\": 980190962,\n \"name\": \"MyString\"\n }\n },\n {\n \"compute_resource\": {\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"url\": \"test:///default\",\n \"provider\": \"Libvirt\",\n \"user\": \"MyString\",\n \"description\": \"yourcompute\",\n \"id\": 932571420,\n \"name\": \"yourcompute\"\n }\n }\n]"],"apis":[{"api_url":"/api/compute_resources","short_description":"List all compute resources.","http_method":"GET"}],"errors":[],"see":[],"name":"index","formats":null,"doc_url":"/apidoc/v2/compute_resources/index"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["GET /api/compute_resources/980190962-mystring\n200\n{\n \"compute_resource\": {\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"url\": \"qemu://stam/system\",\n \"provider\": \"Libvirt\",\n \"user\": \"MyString\",\n \"description\": \"MyString\",\n \"id\": 980190962,\n \"name\": \"MyString\"\n }\n}"],"apis":[{"api_url":"/api/compute_resources/:id","short_description":"Show an compute resource.","http_method":"GET"}],"errors":[],"see":[],"name":"show","formats":null,"doc_url":"/apidoc/v2/compute_resources/show"},{"full_description":"","params":[{"validator":"Must be a Hash","required":true,"full_name":"compute_resource","params":[{"full_name":"compute_resource[name]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"name"},{"full_name":"compute_resource[provider]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"<p>Providers include Libvirt, Ovirt, EC2, Vmware, Openstack, Rackspace</p>","name":"provider"},{"full_name":"compute_resource[url]","required":true,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"<p>URL for Libvirt, Ovirt, and Openstack</p>","name":"url"},{"full_name":"compute_resource[description]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"description"},{"full_name":"compute_resource[user]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"<p>Username for Ovirt, EC2, Vmware, Openstack. Access Key for EC2.</p>","name":"user"},{"full_name":"compute_resource[password]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"<p>Password for Ovirt, EC2, Vmware, Openstack. Secret key for EC2</p>","name":"password"},{"full_name":"compute_resource[uuid]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"<p>for Ovirt, Vmware Datacenter</p>","name":"uuid"},{"full_name":"compute_resource[region]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"<p>for EC2 only</p>","name":"region"},{"full_name":"compute_resource[tenant]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"<p>for Openstack only</p>","name":"tenant"},{"full_name":"compute_resource[server]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"<p>for Vmware</p>","name":"server"}],"expected_type":"hash","allow_nil":false,"description":"","name":"compute_resource"}],"examples":["POST /api/compute_resources\n{\n \"compute_resource\": {\n \"password\": \"secret\",\n \"provider\": \"EC2\",\n \"user\": \"user@example.com\",\n \"region\": \"eu-west-1\",\n \"name\": \"special_compute\"\n }\n}\n200\n{\n \"compute_resource\": {\n \"created_at\": \"2012-12-18T15:24:44Z\",\n \"updated_at\": \"2012-12-18T15:24:44Z\",\n \"url\": \"eu-west-1\",\n \"provider\": \"EC2\",\n \"user\": \"user@example.com\",\n \"description\": null,\n \"id\": 980190963,\n \"name\": \"special_compute\"\n }\n}"],"apis":[{"api_url":"/api/compute_resources","short_description":"Create a compute resource.","http_method":"POST"}],"errors":[],"see":[],"name":"create","formats":null,"doc_url":"/apidoc/v2/compute_resources/create"},{"full_description":"","params":[{"validator":"Must be String","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"},{"validator":"Must be a Hash","required":true,"full_name":"compute_resource","params":[{"full_name":"compute_resource[name]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"name"},{"full_name":"compute_resource[provider]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"<p>Providers include Libvirt, Ovirt, EC2, Vmware, Openstack, Rackspace</p>","name":"provider"},{"full_name":"compute_resource[url]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"<p>URL for Libvirt, Ovirt, and Openstack</p>","name":"url"},{"full_name":"compute_resource[description]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"description"},{"full_name":"compute_resource[user]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"<p>Username for Ovirt, EC2, Vmware, Openstack. Access Key for EC2.</p>","name":"user"},{"full_name":"compute_resource[password]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"<p>Password for Ovirt, EC2, Vmware, Openstack. Secret key for EC2</p>","name":"password"},{"full_name":"compute_resource[uuid]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"<p>for Ovirt, Vmware Datacenter</p>","name":"uuid"},{"full_name":"compute_resource[region]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"<p>for EC2 only</p>","name":"region"},{"full_name":"compute_resource[tenant]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"<p>for Openstack only</p>","name":"tenant"},{"full_name":"compute_resource[server]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"<p>for Vmware</p>","name":"server"}],"expected_type":"hash","allow_nil":false,"description":"","name":"compute_resource"}],"examples":["PUT /api/compute_resources/367690737-mycompute\n{\n \"compute_resource\": {\n \"description\": \"new_description\"\n }\n}\n200\n{\n \"compute_resource\": {\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"attrs\": {},\n \"updated_at\": \"2012-12-18T15:24:45Z\",\n \"url\": \"test:///default\",\n \"uuid\": \"mycompute\",\n \"user\": \"MyString\",\n \"description\": \"new_description\",\n \"id\": 367690737,\n \"name\": \"mycompute\"\n }\n}"],"apis":[{"api_url":"/api/compute_resources/:id","short_description":"Update a compute resource.","http_method":"PUT"}],"errors":[],"see":[],"name":"update","formats":null,"doc_url":"/apidoc/v2/compute_resources/update"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["DELETE /api/compute_resources/932571420\n200\n{\n \"compute_resource\": {\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"attrs\": null,\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"url\": \"test:///default\",\n \"uuid\": \"yourcompute\",\n \"user\": \"MyString\",\n \"description\": \"yourcompute\",\n \"id\": 932571420,\n \"name\": \"yourcompute\"\n }\n}"],"apis":[{"api_url":"/api/compute_resources/:id","short_description":"Delete a compute resource.","http_method":"DELETE"}],"errors":[],"see":[],"name":"destroy","formats":null,"doc_url":"/apidoc/v2/compute_resources/destroy"}],"short_description":null,"name":"Compute resources","doc_url":"/apidoc/v2/compute_resources","formats":null},"template_combinations":{"api_url":"/api","full_description":null,"version":"v2","methods":[{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"config_template_id","expected_type":"string","allow_nil":false,"description":"","name":"config_template_id"}],"examples":[],"apis":[{"api_url":"/api/config_templates/:config_template_id/template_combinations","short_description":"List Template Combination","http_method":"GET"}],"errors":[],"see":[],"name":"index","formats":null,"doc_url":"/apidoc/v2/template_combinations/index"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"config_template_id","expected_type":"string","allow_nil":false,"description":"","name":"config_template_id"},{"validator":"Must be a Hash","required":true,"full_name":"template_combination","params":[{"full_name":"template_combination[environment_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":true,"description":"<p>environment id</p>","name":"environment_id"},{"full_name":"template_combination[hostgroup_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":true,"description":"<p>hostgroup id</p>","name":"hostgroup_id"}],"expected_type":"hash","allow_nil":false,"description":"","name":"template_combination"}],"examples":[],"apis":[{"api_url":"/api/config_templates/:config_template_id/template_combinations","short_description":"Add a Template Combination","http_method":"POST"}],"errors":[],"see":[],"name":"create","formats":null,"doc_url":"/apidoc/v2/template_combinations/create"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":[],"apis":[{"api_url":"/api/template_combinations/:id","short_description":"Show Template Combination","http_method":"GET"}],"errors":[],"see":[],"name":"show","formats":null,"doc_url":"/apidoc/v2/template_combinations/show"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":[],"apis":[{"api_url":"/api/template_combinations/:id","short_description":"Delete a template","http_method":"DELETE"}],"errors":[],"see":[],"name":"destroy","formats":null,"doc_url":"/apidoc/v2/template_combinations/destroy"}],"short_description":null,"name":"Template combinations","doc_url":"/apidoc/v2/template_combinations","formats":null},"parameters":{"api_url":"/api","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","methods":[{"full_description":"","params":[{"validator":"Must be String","required":false,"full_name":"host_id","expected_type":"string","allow_nil":false,"description":"<p>id of host</p>","name":"host_id"},{"validator":"Must be String","required":false,"full_name":"hostgroup_id","expected_type":"string","allow_nil":false,"description":"<p>id of hostgroup</p>","name":"hostgroup_id"},{"validator":"Must be String","required":false,"full_name":"domain_id","expected_type":"string","allow_nil":false,"description":"<p>id of domain</p>","name":"domain_id"},{"validator":"Must be String","required":false,"full_name":"operatingsystem_id","expected_type":"string","allow_nil":false,"description":"<p>id of operating system</p>","name":"operatingsystem_id"},{"validator":"Must be String","required":false,"full_name":"page","expected_type":"string","allow_nil":false,"description":"<p>paginate results</p>","name":"page"},{"validator":"Must be String","required":false,"full_name":"per_page","expected_type":"string","allow_nil":false,"description":"<p>number of entries per request</p>","name":"per_page"}],"examples":[],"apis":[{"api_url":"/api/hosts/:host_id/parameters","short_description":"List all parameters for host","http_method":"GET"},{"api_url":"/api/hostgroups/:hostgroup_id/parameters","short_description":"List all parameters for hostgroup","http_method":"GET"},{"api_url":"/api/domains/:domain_id/parameters","short_description":"List all parameters for domain","http_method":"GET"},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters","short_description":"List all parameters for operating system","http_method":"GET"}],"errors":[],"see":[],"name":"index","formats":null,"doc_url":"/apidoc/v2/parameters/index"},{"full_description":"","params":[{"validator":"Must be String","required":false,"full_name":"host_id","expected_type":"string","allow_nil":false,"description":"<p>id of host</p>","name":"host_id"},{"validator":"Must be String","required":false,"full_name":"hostgroup_id","expected_type":"string","allow_nil":false,"description":"<p>id of hostgroup</p>","name":"hostgroup_id"},{"validator":"Must be String","required":false,"full_name":"domain_id","expected_type":"string","allow_nil":false,"description":"<p>id of domain</p>","name":"domain_id"},{"validator":"Must be String","required":false,"full_name":"operatingsystem_id","expected_type":"string","allow_nil":false,"description":"<p>id of operating system</p>","name":"operatingsystem_id"},{"validator":"Must be String","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"<p>id of parameter</p>","name":"id"}],"examples":[],"apis":[{"api_url":"/api/hosts/:host_id/parameters/:id","short_description":"Show a nested parameter for host","http_method":"GET"},{"api_url":"/api/hostgroups/:hostgroup_id/parameters/:id","short_description":"Show a nested parameter for hostgroup","http_method":"GET"},{"api_url":"/api/domains/:domain_id/parameters/:id","short_description":"Show a nested parameter for domain","http_method":"GET"},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters/:id","short_description":"Show a nested parameter for operating system","http_method":"GET"}],"errors":[],"see":[],"name":"show","formats":null,"doc_url":"/apidoc/v2/parameters/show"},{"full_description":"","params":[{"validator":"Must be String","required":false,"full_name":"host_id","expected_type":"string","allow_nil":false,"description":"<p>id of host</p>","name":"host_id"},{"validator":"Must be String","required":false,"full_name":"hostgroup_id","expected_type":"string","allow_nil":false,"description":"<p>id of hostgroup</p>","name":"hostgroup_id"},{"validator":"Must be String","required":false,"full_name":"domain_id","expected_type":"string","allow_nil":false,"description":"<p>id of domain</p>","name":"domain_id"},{"validator":"Must be String","required":false,"full_name":"operatingsystem_id","expected_type":"string","allow_nil":false,"description":"<p>id of operating system</p>","name":"operatingsystem_id"},{"validator":"Must be a Hash","required":true,"full_name":"parameter","params":[{"full_name":"parameter[name]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"name"},{"full_name":"parameter[value]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"value"}],"expected_type":"hash","allow_nil":false,"description":"","name":"parameter"}],"examples":[],"apis":[{"api_url":"/api/hosts/:host_id/parameters","short_description":"Create a nested parameter for host","http_method":"POST"},{"api_url":"/api/hostgroups/:hostgroup_id/parameters","short_description":"Create a nested parameter for hostgroup","http_method":"POST"},{"api_url":"/api/domains/:domain_id/parameters","short_description":"Create a nested parameter for domain","http_method":"POST"},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters","short_description":"Create a nested parameter for operating system","http_method":"POST"}],"errors":[],"see":[],"name":"create","formats":null,"doc_url":"/apidoc/v2/parameters/create"},{"full_description":"","params":[{"validator":"Must be String","required":false,"full_name":"host_id","expected_type":"string","allow_nil":false,"description":"<p>id of host</p>","name":"host_id"},{"validator":"Must be String","required":false,"full_name":"hostgroup_id","expected_type":"string","allow_nil":false,"description":"<p>id of hostgroup</p>","name":"hostgroup_id"},{"validator":"Must be String","required":false,"full_name":"domain_id","expected_type":"string","allow_nil":false,"description":"<p>id of domain</p>","name":"domain_id"},{"validator":"Must be String","required":false,"full_name":"operatingsystem_id","expected_type":"string","allow_nil":false,"description":"<p>id of operating system</p>","name":"operatingsystem_id"},{"validator":"Must be String","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"<p>id of parameter</p>","name":"id"},{"validator":"Must be a Hash","required":true,"full_name":"parameter","params":[{"full_name":"parameter[name]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"name"},{"full_name":"parameter[value]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"value"}],"expected_type":"hash","allow_nil":false,"description":"","name":"parameter"}],"examples":[],"apis":[{"api_url":"/api/hosts/:host_id/parameters/:id","short_description":"Update a nested parameter for host","http_method":"PUT"},{"api_url":"/api/hostgroups/:hostgroup_id/parameters/:id","short_description":"Update a nested parameter for hostgroup","http_method":"PUT"},{"api_url":"/api/domains/:domain_id/parameters/:id","short_description":"Update a nested parameter for domain","http_method":"PUT"},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters/:id","short_description":"Update a nested parameter for operating system","http_method":"PUT"}],"errors":[],"see":[],"name":"update","formats":null,"doc_url":"/apidoc/v2/parameters/update"},{"full_description":"","params":[{"validator":"Must be String","required":false,"full_name":"host_id","expected_type":"string","allow_nil":false,"description":"<p>id of host</p>","name":"host_id"},{"validator":"Must be String","required":false,"full_name":"hostgroup_id","expected_type":"string","allow_nil":false,"description":"<p>id of hostgroup</p>","name":"hostgroup_id"},{"validator":"Must be String","required":false,"full_name":"domain_id","expected_type":"string","allow_nil":false,"description":"<p>id of domain</p>","name":"domain_id"},{"validator":"Must be String","required":false,"full_name":"operatingsystem_id","expected_type":"string","allow_nil":false,"description":"<p>id of operating system</p>","name":"operatingsystem_id"},{"validator":"Must be String","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"<p>id of parameter</p>","name":"id"}],"examples":[],"apis":[{"api_url":"/api/hosts/:host_id/parameters/:id","short_description":"Delete a nested parameter for host","http_method":"DELETE"},{"api_url":"/api/hostgroups/:hostgroup_id/parameters/:id","short_description":"Delete a nested parameter for hostgroup","http_method":"DELETE"},{"api_url":"/api/domains/:domain_id/parameters/:id","short_description":"Delete a nested parameter for domain","http_method":"DELETE"},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters/:id","short_description":"Delete a nested parameter for operating system","http_method":"DELETE"}],"errors":[],"see":[],"name":"destroy","formats":null,"doc_url":"/apidoc/v2/parameters/destroy"},{"full_description":"","params":[],"examples":[],"apis":[{"api_url":"/api/hosts/:host_id/parameters","short_description":"Delete all nested parameters for host","http_method":"DELETE"},{"api_url":"/api/hostgroups/:hostgroup_id/parameters","short_description":"Delete all nested parameters for hostgroup","http_method":"DELETE"},{"api_url":"/api/domains/:domain_id/parameters","short_description":"Delete all nested parameters for domain","http_method":"DELETE"},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters","short_description":"Delete all nested parameters for operating system","http_method":"DELETE"}],"errors":[],"see":[],"name":"reset","formats":null,"doc_url":"/apidoc/v2/parameters/reset"}],"short_description":null,"name":"Parameters","doc_url":"/apidoc/v2/parameters","formats":null},"config_templates":{"api_url":"/api","full_description":null,"version":"v2","methods":[{"full_description":"","params":[{"validator":"Must be String","required":false,"full_name":"search","expected_type":"string","allow_nil":false,"description":"<p>filter results</p>","name":"search"},{"validator":"Must be String","required":false,"full_name":"order","expected_type":"string","allow_nil":false,"description":"<p>sort results</p>","name":"order"},{"validator":"Must be String","required":false,"full_name":"page","expected_type":"string","allow_nil":false,"description":"<p>paginate results</p>","name":"page"},{"validator":"Must be String","required":false,"full_name":"per_page","expected_type":"string","allow_nil":false,"description":"<p>number of entries per request</p>","name":"per_page"}],"examples":["GET /api/config_templates\n200\n[\n {\n \"config_template\": {\n \"audit_comment\": null,\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 \"id\": 452984334,\n \"name\": \"PXELinux\"\n },\n \"id\": 1007981701,\n \"name\": \"centos5_3_pxelinux\"\n }\n },\n {\n \"config_template\": {\n \"audit_comment\": null,\n \"template\": \"MyFinish\",\n \"snippet\": null,\n \"template_kind\": {\n \"id\": 550103832,\n \"name\": \"finish\"\n },\n \"id\": 104314179,\n \"name\": \"MyFinish\"\n }\n },\n {\n \"config_template\": {\n \"audit_comment\": null,\n \"template\": \"MyText\",\n \"snippet\": null,\n \"template_kind\": {\n \"id\": 478250810,\n \"name\": \"script\"\n },\n \"id\": 981457253,\n \"name\": \"MyScript\"\n }\n },\n {\n \"config_template\": {\n \"audit_comment\": null,\n \"template\": \"MyText\",\n \"snippet\": null,\n \"template_kind\": {\n \"id\": 158998239,\n \"name\": \"gPXE\"\n },\n \"id\": 943779058,\n \"name\": \"MyString\"\n }\n },\n {\n \"config_template\": {\n \"audit_comment\": null,\n \"template\": \"MyText\",\n \"snippet\": null,\n \"template_kind\": {\n \"id\": 983253650,\n \"name\": \"provision\"\n },\n \"id\": 269958254,\n \"name\": \"MyString2\"\n }\n },\n {\n \"config_template\": {\n \"audit_comment\": null,\n \"template\": \"default linux~label linux~kernel <%= @kernel %>~append initrd=<%= @initrd %> ksdevice=bootif network kssendmac\",\n \"snippet\": null,\n \"template_kind\": {\n \"id\": 452984334,\n \"name\": \"PXELinux\"\n },\n \"id\": 352050261,\n \"name\": \"PXE Default File\"\n }\n },\n {\n \"config_template\": {\n \"\": null,\n \"audit_comment\": null,\n \"template\": \"FOO\",\n \"snippet\": null,\n \"id\": 684651467,\n \"name\": \"PXE Default Menu\"\n }\n },\n {\n \"config_template\": {\n \"audit_comment\": 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 \"snippet\": null,\n \"template_kind\": {\n \"id\": 452984334,\n \"name\": \"PXELinux\"\n },\n \"id\": 821548108,\n \"name\": \"PXE Localboot Default\"\n }\n }\n]"],"apis":[{"api_url":"/api/config_templates","short_description":"List templates","http_method":"GET"}],"errors":[],"see":[],"name":"index","formats":null,"doc_url":"/apidoc/v2/config_templates/index"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["GET /api/config_templates/centos5_3_pxelinux\n200\n{\n \"config_template\": {\n \"audit_comment\": null,\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 \"id\": 452984334,\n \"name\": \"PXELinux\"\n },\n \"id\": 1007981701,\n \"name\": \"centos5_3_pxelinux\"\n }\n}"],"apis":[{"api_url":"/api/config_templates/:id","short_description":"Show template details","http_method":"GET"}],"errors":[],"see":[],"name":"show","formats":null,"doc_url":"/apidoc/v2/config_templates/show"},{"full_description":"","params":[{"validator":"Must be a Hash","required":true,"full_name":"config_template","params":[{"full_name":"config_template[name]","required":true,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"<p>template name</p>","name":"name"},{"full_name":"config_template[template]","required":true,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"template"},{"full_name":"config_template[snippet]","required":false,"validator":"Must be 'true' or 'false'","expected_type":"string","allow_nil":true,"description":"","name":"snippet"},{"full_name":"config_template[audit_comment]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":true,"description":"","name":"audit_comment"},{"full_name":"config_template[template_kind_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":true,"description":"<p>not relevant for snippet</p>","name":"template_kind_id"},{"full_name":"config_template[template_combinations_attributes]","required":false,"validator":"Must be Array","expected_type":"array","allow_nil":false,"description":"<p>Array of template combinations (hostgroup_id, environment_id)</p>","name":"template_combinations_attributes"},{"full_name":"config_template[operatingsystem_ids]","required":false,"validator":"Must be Array","expected_type":"array","allow_nil":false,"description":"<p>Array of operating systems ID to associate the template with</p>","name":"operatingsystem_ids"}],"expected_type":"hash","allow_nil":false,"description":"","name":"config_template"}],"examples":["POST /api/config_templates\n{\n \"config_template\": {\n \"template_kind_id\": 1,\n \"template\": \"This is a test template\",\n \"name\": \"RandomName\"\n }\n}\n200\n{\n \"config_template\": {\n \"\": null,\n \"audit_comment\": null,\n \"template\": \"This is a test template\",\n \"snippet\": null,\n \"id\": 1007981702,\n \"name\": \"RandomName\"\n }\n}"],"apis":[{"api_url":"/api/config_templates","short_description":"Create a template","http_method":"POST"}],"errors":[],"see":[],"name":"create","formats":null,"doc_url":"/apidoc/v2/config_templates/create"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"},{"validator":"Must be a Hash","required":true,"full_name":"config_template","params":[{"full_name":"config_template[name]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"<p>template name</p>","name":"name"},{"full_name":"config_template[template]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"template"},{"full_name":"config_template[snippet]","required":false,"validator":"Must be 'true' or 'false'","expected_type":"string","allow_nil":false,"description":"","name":"snippet"},{"full_name":"config_template[audit_comment]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":true,"description":"","name":"audit_comment"},{"full_name":"config_template[template_kind_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":true,"description":"<p>not relevant for snippet</p>","name":"template_kind_id"},{"full_name":"config_template[template_combinations_attributes]","required":false,"validator":"Must be Array","expected_type":"array","allow_nil":false,"description":"<p>Array of template combinations (hostgroup_id, environment_id)</p>","name":"template_combinations_attributes"},{"full_name":"config_template[operatingsystem_ids]","required":false,"validator":"Must be Array","expected_type":"array","allow_nil":false,"description":"<p>Array of operating systems ID to associate the template with</p>","name":"operatingsystem_ids"}],"expected_type":"hash","allow_nil":false,"description":"","name":"config_template"}],"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 \"snippet\": null,\n \"template\": \"tmp\",\n \"template_kind\": {\n \"id\": 452984334,\n \"name\": \"PXELinux\"\n },\n \"id\": 1007981701,\n \"name\": \"centos5_3_pxelinux\"\n }\n}"],"apis":[{"api_url":"/api/config_templates/:id","short_description":"Update a template","http_method":"PUT"}],"errors":[],"see":[],"name":"update","formats":null,"doc_url":"/apidoc/v2/config_templates/update"},{"full_description":"","params":[{"validator":"Must be String","required":false,"full_name":"version","expected_type":"string","allow_nil":false,"description":"<p>template version</p>","name":"version"}],"examples":[],"apis":[{"api_url":"/api/config_templates/revision","short_description":null,"http_method":"GET"}],"errors":[],"see":[],"name":"revision","formats":null,"doc_url":"/apidoc/v2/config_templates/revision"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["DELETE /api/config_templates/centos5_3_pxelinux\n200\n{\n \"config_template\": {\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 \"id\": 452984334,\n \"name\": \"PXELinux\"\n },\n \"id\": 1007981701,\n \"name\": \"centos5_3_pxelinux\"\n }\n}"],"apis":[{"api_url":"/api/config_templates/:id","short_description":"Delete a template","http_method":"DELETE"}],"errors":[],"see":[],"name":"destroy","formats":null,"doc_url":"/apidoc/v2/config_templates/destroy"},{"full_description":"","params":[],"examples":["GET /api/config_templates/build_pxe_default\n200\nPXE Default file has been deployed to all Smart Proxies"],"apis":[{"api_url":"/api/config_templates/build_pxe_default","short_description":"Change the default PXE menu on all configured TFTP servers","http_method":"GET"}],"errors":[],"see":[],"name":"build_pxe_default","formats":null,"doc_url":"/apidoc/v2/config_templates/build_pxe_default"}],"short_description":null,"name":"Config templates","doc_url":"/apidoc/v2/config_templates","formats":null},"audits":{"api_url":"/api","full_description":null,"version":"v2","methods":[{"full_description":"","params":[{"validator":"Must be String","required":false,"full_name":"search","expected_type":"string","allow_nil":false,"description":"<p>filter results</p>","name":"search"},{"validator":"Must be String","required":false,"full_name":"order","expected_type":"string","allow_nil":false,"description":"<p>sort results</p>","name":"order"},{"validator":"Must be String","required":false,"full_name":"page","expected_type":"string","allow_nil":false,"description":"<p>paginate results</p>","name":"page"},{"validator":"Must be String","required":false,"full_name":"per_page","expected_type":"string","allow_nil":false,"description":"<p>number of entries per request</p>","name":"per_page"}],"examples":["GET /api/audits\n200\n[\n {\n \"audit\": {\n \"action\": \"update\",\n \"created_at\": \"2009-12-14T08:01:17Z\",\n \"version\": 1,\n \"associated_type\": \"Host\",\n \"auditable_type\": \"Host\",\n \"remote_address\": null,\n \"auditable_id\": 0,\n \"user_id\": null,\n \"associated_name\": null,\n \"user_type\": null,\n \"audited_changes\": {\n \"architecture_id\": [\n 10463,\n 10466\n ]\n },\n \"comment\": null,\n \"id\": 1,\n \"auditable_name\": null,\n \"associated_id\": 272\n }\n }\n]"],"apis":[{"api_url":"/api/audits","short_description":"List all audits.","http_method":"GET"},{"api_url":"/api/hosts/:host_id/audits","short_description":"List all audits for a given host.","http_method":"GET"}],"errors":[],"see":[],"name":"index","formats":null,"doc_url":"/apidoc/v2/audits/index"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["GET /api/audits/1\n200\n{\n \"audit\": {\n \"action\": \"update\",\n \"created_at\": \"2009-12-14T08:01:17Z\",\n \"version\": 1,\n \"associated_type\": \"Host\",\n \"auditable_type\": \"Host\",\n \"remote_address\": null,\n \"auditable_id\": 0,\n \"user_id\": null,\n \"associated_name\": null,\n \"user_type\": null,\n \"audited_changes\": {\n \"architecture_id\": [\n 10463,\n 10466\n ]\n },\n \"comment\": null,\n \"id\": 1,\n \"auditable_name\": null,\n \"associated_id\": 272\n }\n}"],"apis":[{"api_url":"/api/audits/:id","short_description":"Show an audit","http_method":"GET"}],"errors":[],"see":[],"name":"show","formats":null,"doc_url":"/apidoc/v2/audits/show"}],"short_description":null,"name":"Audits","doc_url":"/apidoc/v2/audits","formats":null},"puppetclasses":{"api_url":"/api","full_description":null,"version":"v2","methods":[{"full_description":"","params":[{"validator":"Must be String","required":false,"full_name":"host_id","expected_type":"string","allow_nil":false,"description":"<p>id of nested host</p>","name":"host_id"},{"validator":"Must be String","required":false,"full_name":"hostgroup_id","expected_type":"string","allow_nil":false,"description":"<p>id of nested hostgroup</p>","name":"hostgroup_id"},{"validator":"Must be String","required":false,"full_name":"environment_id","expected_type":"string","allow_nil":false,"description":"<p>id of nested environment</p>","name":"environment_id"}],"examples":["GET /api/puppetclasses\n200\n{\n \"base\": [\n {\n \"puppetclass\": {\n \"lookup_keys\": [\n {\n \"id\": 298486374\n }\n ],\n \"id\": 980190962,\n \"name\": \"base\"\n }\n }\n ],\n \"apache\": [\n {\n \"puppetclass\": {\n \"lookup_keys\": [],\n \"id\": 298486374,\n \"name\": \"apache\"\n }\n }\n ]\n}"],"apis":[{"api_url":"/api/puppetclasses","short_description":"List all puppetclasses.","http_method":"GET"},{"api_url":"/api/hosts/:host_id/puppetclasses","short_description":"List all puppetclasses for host","http_method":"GET"},{"api_url":"/api/hostgroups/:hostgroup_id/puppetclasses","short_description":"List all puppetclasses for hostgroup","http_method":"GET"},{"api_url":"/api/environments/:environment_id/puppetclasses","short_description":"List all puppetclasses for environment","http_method":"GET"}],"errors":[],"see":[],"name":"index","formats":null,"doc_url":"/apidoc/v2/puppetclasses/index"},{"full_description":"","params":[{"validator":"Must be String","required":false,"full_name":"host_id","expected_type":"string","allow_nil":false,"description":"<p>id of nested host</p>","name":"host_id"},{"validator":"Must be String","required":false,"full_name":"hostgroup_id","expected_type":"string","allow_nil":false,"description":"<p>id of nested hostgroup</p>","name":"hostgroup_id"},{"validator":"Must be String","required":false,"full_name":"environment_id","expected_type":"string","allow_nil":false,"description":"<p>id of nested environment</p>","name":"environment_id"},{"validator":"Must be String","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"<p>id of puppetclass</p>","name":"id"}],"examples":["GET /api/puppetclasses/base\n200\n{\n \"puppetclass\": {\n \"lookup_keys\": [\n {\n \"lookup_key\": {\n \"required\": false,\n \"override\": false,\n \"key\": \"ssl_port\",\n \"default_value\": \"443\",\n \"description\": null,\n \"id\": 298486374,\n \"is_param\": false\n }\n }\n ],\n \"id\": 980190962,\n \"name\": \"base\"\n }\n}"],"apis":[{"api_url":"/api/puppetclasses/:id","short_description":"Show a puppetclass","http_method":"GET"},{"api_url":"/api/hosts/:host_id/puppetclasses/:id","short_description":"Show a puppetclass for host","http_method":"GET"},{"api_url":"/api/hostgroups/:hostgroup_id/puppetclasses/:id","short_description":"Show a puppetclass for hostgroup","http_method":"GET"},{"api_url":"/api/environments/:environment_id/puppetclasses/:id","short_description":"Show a puppetclass for environment","http_method":"GET"}],"errors":[],"see":[],"name":"show","formats":null,"doc_url":"/apidoc/v2/puppetclasses/show"},{"full_description":"","params":[{"validator":"Must be a Hash","required":true,"full_name":"puppetclass","params":[{"full_name":"puppetclass[name]","required":true,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"name"}],"expected_type":"hash","allow_nil":false,"description":"","name":"puppetclass"}],"examples":["POST /api/puppetclasses\n{\n \"puppetclass\": {\n \"name\": \"test_puppetclass\"\n }\n}\n201\n{\n \"puppetclass\": {\n \"lookup_keys\": [],\n \"id\": 980190963,\n \"name\": \"test_puppetclass\"\n }\n}"],"apis":[{"api_url":"/api/puppetclasses","short_description":"Create a puppetclass.","http_method":"POST"}],"errors":[],"see":[],"name":"create","formats":null,"doc_url":"/apidoc/v2/puppetclasses/create"},{"full_description":"","params":[{"validator":"Must be String","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"},{"validator":"Must be a Hash","required":true,"full_name":"puppetclass","params":[{"full_name":"puppetclass[name]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"name"}],"expected_type":"hash","allow_nil":false,"description":"","name":"puppetclass"}],"examples":["PUT /api/puppetclasses/base\n{\n \"puppetclass\": {}\n}\n200\n{\n \"puppetclass\": {\n \"lookup_keys\": [\n {\n \"id\": 298486374\n }\n ],\n \"id\": 980190962,\n \"name\": \"base\"\n }\n}"],"apis":[{"api_url":"/api/puppetclasses/:id","short_description":"Update a puppetclass.","http_method":"PUT"}],"errors":[],"see":[],"name":"update","formats":null,"doc_url":"/apidoc/v2/puppetclasses/update"},{"full_description":"","params":[{"validator":"Must be String","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["DELETE /api/puppetclasses/base\n200\n{\n \"puppetclass\": {\n \"lookup_keys\": [\n {\n \"id\": 298486374\n }\n ],\n \"id\": 980190962,\n \"name\": \"base\"\n }\n}"],"apis":[{"api_url":"/api/puppetclasses/:id","short_description":"Delete a puppetclass.","http_method":"DELETE"}],"errors":[],"see":[],"name":"destroy","formats":null,"doc_url":"/apidoc/v2/puppetclasses/destroy"}],"short_description":null,"name":"Puppetclasses","doc_url":"/apidoc/v2/puppetclasses","formats":null},"environments":{"api_url":"/api","full_description":null,"version":"v2","methods":[{"full_description":"","params":[{"validator":"Must be String","required":false,"full_name":"search","expected_type":"string","allow_nil":false,"description":"<p>Filter results</p>","name":"search"},{"validator":"Must be String","required":false,"full_name":"order","expected_type":"string","allow_nil":false,"description":"<p>Sort results</p>","name":"order"},{"validator":"Must be String","required":false,"full_name":"page","expected_type":"string","allow_nil":false,"description":"<p>paginate results</p>","name":"page"},{"validator":"Must be String","required":false,"full_name":"per_page","expected_type":"string","allow_nil":false,"description":"<p>number of entries per request</p>","name":"per_page"}],"examples":["GET /api/environments\n200\n[\n {\n \"environment\": {\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"id\": 153855663,\n \"name\": \"global_puppetmaster\"\n }\n },\n {\n \"environment\": {\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"id\": 334344675,\n \"name\": \"production\"\n }\n },\n {\n \"environment\": {\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"id\": 687036937,\n \"name\": \"testing\"\n }\n }\n]"],"apis":[{"api_url":"/api/environments","short_description":"List all environments.","http_method":"GET"}],"errors":[],"see":[],"name":"index","formats":null,"doc_url":"/apidoc/v2/environments/index"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["GET /api/environments/production\n200\n{\n \"environment\": {\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"id\": 334344675,\n \"name\": \"production\"\n }\n}"],"apis":[{"api_url":"/api/environments/:id","short_description":"Show an environment.","http_method":"GET"}],"errors":[],"see":[],"name":"show","formats":null,"doc_url":"/apidoc/v2/environments/show"},{"full_description":"","params":[{"validator":"Must be a Hash","required":true,"full_name":"environment","params":[{"full_name":"environment[name]","required":true,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"name"}],"expected_type":"hash","allow_nil":false,"description":"","name":"environment"}],"examples":["POST /api/environments\n{\n \"environment\": {\n \"name\": \"Development\"\n }\n}\n200\n{\n \"environment\": {\n \"created_at\": \"2012-12-18T15:24:46Z\",\n \"updated_at\": \"2012-12-18T15:24:46Z\",\n \"id\": 687036938,\n \"name\": \"Development\"\n }\n}"],"apis":[{"api_url":"/api/environments","short_description":"Create an environment.","http_method":"POST"}],"errors":[],"see":[],"name":"create","formats":null,"doc_url":"/apidoc/v2/environments/create"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"},{"validator":"Must be a Hash","required":true,"full_name":"environment","params":[{"full_name":"environment[name]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"name"}],"expected_type":"hash","allow_nil":false,"description":"","name":"environment"}],"examples":["PUT /api/environments/production\n{\n \"environment\": {}\n}\n200\n{\n \"environment\": {\n \"id\": 334344675,\n \"name\": \"production\"\n }\n}"],"apis":[{"api_url":"/api/environments/:id","short_description":"Update an environment.","http_method":"PUT"}],"errors":[],"see":[],"name":"update","formats":null,"doc_url":"/apidoc/v2/environments/update"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["DELETE /api/environments/testing\n200\n{\n \"environment\": {\n \"id\": 687036937,\n \"name\": \"testing\"\n }\n}"],"apis":[{"api_url":"/api/environments/:id","short_description":"Delete an environment.","http_method":"DELETE"}],"errors":[],"see":[],"name":"destroy","formats":null,"doc_url":"/apidoc/v2/environments/destroy"}],"short_description":null,"name":"Environments","doc_url":"/apidoc/v2/environments","formats":null},"hostgroup_classes":{"api_url":"/api","full_description":null,"version":"v2","methods":[{"full_description":"","params":[],"examples":[],"apis":[{"api_url":"/api/hostgroups/:hostgroup_id/puppetclass_ids","short_description":"List all puppetclass id's for hostgroup","http_method":"GET"}],"errors":[],"see":[],"name":"index","formats":null,"doc_url":"/apidoc/v2/hostgroup_classes/index"},{"full_description":"","params":[{"validator":"Must be String","required":true,"full_name":"hostgroup_id","expected_type":"string","allow_nil":false,"description":"<p>id of hostgroup</p>","name":"hostgroup_id"},{"validator":"Must be String","required":true,"full_name":"puppetclass_id","expected_type":"string","allow_nil":false,"description":"<p>id of puppetclass</p>","name":"puppetclass_id"}],"examples":[],"apis":[{"api_url":"/api/hostgroups/:hostgroup_id/puppetclass_ids","short_description":"Add a puppetclass to hostgroup","http_method":"POST"}],"errors":[],"see":[],"name":"create","formats":null,"doc_url":"/apidoc/v2/hostgroup_classes/create"},{"full_description":"","params":[{"validator":"Must be String","required":true,"full_name":"hostgroup_id","expected_type":"string","allow_nil":false,"description":"<p>id of hostgroup</p>","name":"hostgroup_id"},{"validator":"Must be String","required":true,"full_name":"puppetclass_id","expected_type":"string","allow_nil":false,"description":"<p>id of puppetclass</p>","name":"puppetclass_id"}],"examples":[],"apis":[{"api_url":"/api/hostgroups/:hostgroup_id/puppetclass_ids/:id","short_description":"Remove a puppetclass from hostgroup","http_method":"DELETE"}],"errors":[],"see":[],"name":"destroy","formats":null,"doc_url":"/apidoc/v2/hostgroup_classes/destroy"}],"short_description":null,"name":"Hostgroup classes","doc_url":"/apidoc/v2/hostgroup_classes","formats":null},"settings":{"api_url":"/api","full_description":null,"version":"v2","methods":[{"full_description":"","params":[{"validator":"Must be String","required":false,"full_name":"search","expected_type":"string","allow_nil":false,"description":"<p>Filter results</p>","name":"search"},{"validator":"Must be String","required":false,"full_name":"order","expected_type":"string","allow_nil":false,"description":"<p>Sort results</p>","name":"order"},{"validator":"Must be String","required":false,"full_name":"page","expected_type":"string","allow_nil":false,"description":"<p>paginate results</p>","name":"page"},{"validator":"Must be String","required":false,"full_name":"per_page","expected_type":"string","allow_nil":false,"description":"<p>number of entries per request</p>","name":"per_page"}],"examples":[],"apis":[{"api_url":"/api/settings","short_description":"List all settings.","http_method":"GET"}],"errors":[],"see":[],"name":"index","formats":null,"doc_url":"/apidoc/v2/settings/index"},{"full_description":"","params":[{"validator":"Must be String","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["GET /api/settings/333972760\n200\n{\n \"setting\": {\n \"category\": \"General\",\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"settings_type\": null,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"default\": \"root@some.host.fqdn\",\n \"value\": \"root@some.host.fqdn\",\n \"description\": \"The Default administrator email address\",\n \"id\": 333972760,\n \"name\": \"administrator\"\n }\n}"],"apis":[{"api_url":"/api/settings/:id","short_description":"Show an setting.","http_method":"GET"}],"errors":[],"see":[],"name":"show","formats":null,"doc_url":"/apidoc/v2/settings/show"},{"full_description":"","params":[{"validator":"Must be String","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"},{"validator":"Must be a Hash","required":true,"full_name":"setting","params":[{"full_name":"setting[value]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"value"}],"expected_type":"hash","allow_nil":false,"description":"","name":"setting"}],"examples":["PUT /api/settings/333972760\n{\n \"setting\": {}\n}\n200\n{\n \"setting\": {\n \"category\": \"General\",\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"settings_type\": null,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"default\": \"root@some.host.fqdn\",\n \"value\": \"root@some.host.fqdn\",\n \"description\": \"The Default administrator email address\",\n \"id\": 333972760,\n \"name\": \"administrator\"\n }\n}"],"apis":[{"api_url":"/api/settings/:id","short_description":"Update a setting.","http_method":"PUT"}],"errors":[],"see":[],"name":"update","formats":null,"doc_url":"/apidoc/v2/settings/update"}],"short_description":null,"name":"Settings","doc_url":"/apidoc/v2/settings","formats":null},"users":{"api_url":"/api","full_description":null,"version":"v2","methods":[{"full_description":"","params":[{"validator":"Must be String","required":false,"full_name":"search","expected_type":"string","allow_nil":false,"description":"<p>filter results</p>","name":"search"},{"validator":"Must be String","required":false,"full_name":"order","expected_type":"string","allow_nil":false,"description":"<p>sort results</p>","name":"order"},{"validator":"Must be String","required":false,"full_name":"page","expected_type":"string","allow_nil":false,"description":"<p>paginate results</p>","name":"page"},{"validator":"Must be String","required":false,"full_name":"per_page","expected_type":"string","allow_nil":false,"description":"<p>number of entries per request</p>","name":"per_page"}],"examples":["GET /api/users\n200\n[\n {\n \"user\": {\n \"filter_on_owner\": null,\n \"domains_andor\": \"or\",\n \"facts_andor\": \"or\",\n \"firstname\": \"Admin\",\n \"login\": \"admin\",\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"lastname\": \"User\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"auth_source_id\": 980190962,\n \"last_login_on\": \"2009-10-12T21:50:04Z\",\n \"admin\": true,\n \"mail\": \"admin@someware.com\",\n \"hostgroups_andor\": \"or\",\n \"role_id\": null,\n \"compute_resources_andor\": \"or\",\n \"id\": 135138680\n }\n },\n {\n \"user\": {\n \"filter_on_owner\": null,\n \"domains_andor\": \"or\",\n \"facts_andor\": \"or\",\n \"firstname\": \"apiadmin\",\n \"login\": \"apiadmin\",\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"lastname\": \"User\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"auth_source_id\": 200482051,\n \"last_login_on\": \"2009-10-12T21:50:04Z\",\n \"admin\": true,\n \"mail\": \"apiadmin@someware.com\",\n \"hostgroups_andor\": \"or\",\n \"role_id\": null,\n \"compute_resources_andor\": \"or\",\n \"id\": 886836129\n }\n },\n {\n \"user\": {\n \"filter_on_owner\": null,\n \"domains_andor\": \"or\",\n \"facts_andor\": \"or\",\n \"firstname\": \"One\",\n \"login\": \"one\",\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"lastname\": \"User\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"auth_source_id\": 980190962,\n \"last_login_on\": \"2009-10-12T21:50:04Z\",\n \"admin\": false,\n \"mail\": \"userone@someware.com\",\n \"hostgroups_andor\": \"or\",\n \"role_id\": null,\n \"compute_resources_andor\": \"or\",\n \"id\": 980190962\n }\n },\n {\n \"user\": {\n \"filter_on_owner\": null,\n \"domains_andor\": \"or\",\n \"facts_andor\": \"or\",\n \"firstname\": \"test\",\n \"login\": \"test\",\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"lastname\": \"User\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"auth_source_id\": 200482051,\n \"last_login_on\": \"2009-10-12T21:50:04Z\",\n \"admin\": false,\n \"mail\": \"testuser@someware.com\",\n \"hostgroups_andor\": \"or\",\n \"role_id\": null,\n \"compute_resources_andor\": \"or\",\n \"id\": 200482051\n }\n },\n {\n \"user\": {\n \"filter_on_owner\": null,\n \"domains_andor\": \"or\",\n \"facts_andor\": \"or\",\n \"firstname\": \"Two\",\n \"login\": \"two\",\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"lastname\": \"User\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"auth_source_id\": 980190962,\n \"last_login_on\": \"2009-10-12T21:50:04Z\",\n \"admin\": false,\n \"mail\": \"usertwo@someware.com\",\n \"hostgroups_andor\": \"or\",\n \"role_id\": null,\n \"compute_resources_andor\": \"or\",\n \"id\": 298486374\n }\n }\n]"],"apis":[{"api_url":"/api/users","short_description":"List all users.","http_method":"GET"}],"errors":[],"see":[],"name":"index","formats":null,"doc_url":"/apidoc/v2/users/index"},{"full_description":"","params":[{"validator":"Must be String","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["GET /api/users/980190962-one\n200\n{\n \"user\": {\n \"filter_on_owner\": null,\n \"domains_andor\": \"or\",\n \"facts_andor\": \"or\",\n \"firstname\": \"One\",\n \"login\": \"one\",\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"lastname\": \"User\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"auth_source_id\": 980190962,\n \"roles\": [\n {\n \"role\": {\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 \"id\": 5,\n \"name\": \"Viewer\"\n }\n },\n {\n \"role\": {\n \"builtin\": 2,\n \"permissions\": [\n \"view_hosts\"\n ],\n \"id\": 7,\n \"name\": \"Anonymous\"\n }\n }\n ],\n \"last_login_on\": \"2009-10-12T21:50:04Z\",\n \"admin\": false,\n \"auth_source_ldap\": {\n \"host\": \"ldap\",\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"account\": null,\n \"attr_mail\": \"mail\",\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"tls\": true,\n \"onthefly_register\": true,\n \"attr_lastname\": \"sn\",\n \"attr_login\": \"uid\",\n \"base_dn\": \"dn=x,dn=y\",\n \"port\": 123,\n \"type\": \"AuthSourceLdap\",\n \"id\": 980190962,\n \"name\": \"ldap\",\n \"attr_firstname\": \"givenName\"\n },\n \"mail\": \"userone@someware.com\",\n \"hostgroups_andor\": \"or\",\n \"role_id\": null,\n \"compute_resources_andor\": \"or\",\n \"id\": 980190962\n }\n}"],"apis":[{"api_url":"/api/users/:id","short_description":"Show an user.","http_method":"GET"}],"errors":[],"see":[],"name":"show","formats":null,"doc_url":"/apidoc/v2/users/show"},{"full_description":"<p>Adds role &#8216;Anonymous&#8217; to the user by default</p>","params":[{"validator":"Must be a Hash","required":true,"full_name":"user","params":[{"full_name":"user[login]","required":true,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"login"},{"full_name":"user[firstname]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"firstname"},{"full_name":"user[lastname]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"lastname"},{"full_name":"user[mail]","required":true,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"mail"},{"full_name":"user[admin]","required":false,"validator":"Must be 'true' or 'false'","expected_type":"string","allow_nil":false,"description":"<p>Is an admin account?</p>","name":"admin"},{"full_name":"user[password]","required":true,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"password"},{"full_name":"user[auth_source_id]","required":true,"validator":"Must be Integer","expected_type":"numeric","allow_nil":false,"description":"","name":"auth_source_id"}],"expected_type":"hash","allow_nil":false,"description":"","name":"user"}],"examples":[],"apis":[{"api_url":"/api/users","short_description":"Create an user.","http_method":"POST"}],"errors":[],"see":[],"name":"create","formats":null,"doc_url":"/apidoc/v2/users/create"},{"full_description":"<p>Adds role &#8216;Anonymous&#8217; to the user if it is not already present. Only admin can set admin account.</p>","params":[{"validator":"Must be String","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"},{"validator":"Must be a Hash","required":true,"full_name":"user","params":[{"full_name":"user[login]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"login"},{"full_name":"user[firstname]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":true,"description":"","name":"firstname"},{"full_name":"user[lastname]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":true,"description":"","name":"lastname"},{"full_name":"user[mail]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"mail"},{"full_name":"user[admin]","required":false,"validator":"Must be 'true' or 'false'","expected_type":"string","allow_nil":false,"description":"<p>Is an admin account?</p>","name":"admin"},{"full_name":"user[password]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"password"}],"expected_type":"hash","allow_nil":false,"description":"","name":"user"}],"examples":["PUT /api/users/980190963\n{\n \"user\": {\n \"password_confirmation\": \"DUMMY\",\n \"login\": \"johnsmith\",\n \"password\": \"dummy\"\n }\n}\n422\n{\n \"user\": {\n \"full_messages\": [\n \"Password doesn't match confirmation\"\n ],\n \"errors\": {\n \"password\": [\n \"doesn't match confirmation\"\n ]\n },\n \"id\": 980190963\n }\n}"],"apis":[{"api_url":"/api/users/:id","short_description":"Update an user.","http_method":"PUT"}],"errors":[],"see":[],"name":"update","formats":null,"doc_url":"/apidoc/v2/users/update"},{"full_description":"","params":[{"validator":"Must be String","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["DELETE /api/users/980190962\n200\n{\n \"user\": {\n \"domains_andor\": \"or\",\n \"filter_on_owner\": null,\n \"facts_andor\": \"or\",\n \"firstname\": \"One\",\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"login\": \"one\",\n \"locations_andor\": \"or\",\n \"lastname\": \"User\",\n \"password_hash\": null,\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"auth_source_id\": 980190962,\n \"password_salt\": null,\n \"last_login_on\": \"2009-10-12T21:50:04Z\",\n \"admin\": false,\n \"mail\": \"userone@someware.com\",\n \"hostgroups_andor\": \"or\",\n \"role_id\": null,\n \"compute_resources_andor\": \"or\",\n \"id\": 980190962,\n \"organizations_andor\": \"or\"\n }\n}"],"apis":[{"api_url":"/api/users/:id","short_description":"Delete an user.","http_method":"DELETE"}],"errors":[],"see":[],"name":"destroy","formats":null,"doc_url":"/apidoc/v2/users/destroy"}],"short_description":null,"name":"Users","doc_url":"/apidoc/v2/users","formats":null},"models":{"api_url":"/api","full_description":null,"version":"v2","methods":[{"full_description":"","params":[{"validator":"Must be String","required":false,"full_name":"search","expected_type":"string","allow_nil":false,"description":"<p>filter results</p>","name":"search"},{"validator":"Must be String","required":false,"full_name":"order","expected_type":"string","allow_nil":false,"description":"<p>sort results</p>","name":"order"},{"validator":"Must be String","required":false,"full_name":"page","expected_type":"string","allow_nil":false,"description":"<p>paginate results</p>","name":"page"},{"validator":"Must be String","required":false,"full_name":"per_page","expected_type":"string","allow_nil":false,"description":"<p>number of entries per request</p>","name":"per_page"}],"examples":["GET /api/models\n200\n[\n {\n \"model\": {\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"vendor_class\": null,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"hardware_model\": null,\n \"info\": \"Virtual Machine\",\n \"id\": 980190962,\n \"name\": \"KVM\"\n }\n },\n {\n \"model\": {\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"vendor_class\": \"Sun-Fire-V210\",\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"hardware_model\": \"SUN4U\",\n \"info\": null,\n \"id\": 139037058,\n \"name\": \"SUN V210\"\n }\n }\n]"],"apis":[{"api_url":"/api/models","short_description":"List all models.","http_method":"GET"}],"errors":[],"see":[],"name":"index","formats":null,"doc_url":"/apidoc/v2/models/index"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["GET /api/models/980190962\n200\n{\n \"model\": {\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"vendor_class\": null,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"hardware_model\": null,\n \"info\": \"Virtual Machine\",\n \"id\": 980190962,\n \"name\": \"KVM\"\n }\n}"],"apis":[{"api_url":"/api/models/:id","short_description":"Show a model.","http_method":"GET"}],"errors":[],"see":[],"name":"show","formats":null,"doc_url":"/apidoc/v2/models/show"},{"full_description":"","params":[{"validator":"Must be a Hash","required":true,"full_name":"model","params":[{"full_name":"model[name]","required":true,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"name"},{"full_name":"model[info]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"info"},{"full_name":"model[vendor_class]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"vendor_class"},{"full_name":"model[hardware_model]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"hardware_model"}],"expected_type":"hash","allow_nil":false,"description":"","name":"model"}],"examples":["POST /api/models\n{\n \"model\": {\n \"name\": \"new model\"\n }\n}\n201\n{\n \"model\": {\n \"created_at\": \"2012-12-18T15:24:49Z\",\n \"vendor_class\": null,\n \"updated_at\": \"2012-12-18T15:24:49Z\",\n \"hardware_model\": null,\n \"info\": null,\n \"id\": 980190963,\n \"name\": \"new model\"\n }\n}"],"apis":[{"api_url":"/api/models","short_description":"Create a model.","http_method":"POST"}],"errors":[],"see":[],"name":"create","formats":null,"doc_url":"/apidoc/v2/models/create"},{"full_description":"","params":[{"validator":"Must be String","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"},{"validator":"Must be a Hash","required":true,"full_name":"model","params":[{"full_name":"model[name]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"name"},{"full_name":"model[info]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"info"},{"full_name":"model[vendor_class]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"vendor_class"},{"full_name":"model[hardware_model]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"hardware_model"}],"expected_type":"hash","allow_nil":false,"description":"","name":"model"}],"examples":["PUT /api/models/980190962\n{\n \"name\": \"KVM\"\n}\n200\n{\n \"model\": {\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"vendor_class\": null,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"hardware_model\": null,\n \"info\": \"Virtual Machine\",\n \"id\": 980190962,\n \"name\": \"KVM\"\n }\n}"],"apis":[{"api_url":"/api/models/:id","short_description":"Update a model.","http_method":"PUT"}],"errors":[],"see":[],"name":"update","formats":null,"doc_url":"/apidoc/v2/models/update"},{"full_description":"","params":[{"validator":"Must be String","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["DELETE /api/models/980190962\n200\n{\n \"model\": {\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"vendor_class\": null,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"hardware_model\": null,\n \"info\": \"Virtual Machine\",\n \"id\": 980190962,\n \"name\": \"KVM\"\n }\n}"],"apis":[{"api_url":"/api/models/:id","short_description":"Delete a model.","http_method":"DELETE"}],"errors":[],"see":[],"name":"destroy","formats":null,"doc_url":"/apidoc/v2/models/destroy"}],"short_description":null,"name":"Models","doc_url":"/apidoc/v2/models","formats":null},"host_classes":{"api_url":"/api","full_description":null,"version":"v2","methods":[{"full_description":"","params":[],"examples":[],"apis":[{"api_url":"/api/hosts/:host_id/puppetclass_ids","short_description":"List all puppetclass id's for host","http_method":"GET"}],"errors":[],"see":[],"name":"index","formats":null,"doc_url":"/apidoc/v2/host_classes/index"},{"full_description":"","params":[{"validator":"Must be String","required":true,"full_name":"host_id","expected_type":"string","allow_nil":false,"description":"<p>id of host</p>","name":"host_id"},{"validator":"Must be String","required":true,"full_name":"puppetclass_id","expected_type":"string","allow_nil":false,"description":"<p>id of puppetclass</p>","name":"puppetclass_id"}],"examples":[],"apis":[{"api_url":"/api/hosts/:host_id/puppetclass_ids","short_description":"Add a puppetclass to host","http_method":"POST"}],"errors":[],"see":[],"name":"create","formats":null,"doc_url":"/apidoc/v2/host_classes/create"},{"full_description":"","params":[{"validator":"Must be String","required":true,"full_name":"host_id","expected_type":"string","allow_nil":false,"description":"<p>id of host</p>","name":"host_id"},{"validator":"Must be String","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"<p>id of puppetclass</p>","name":"id"}],"examples":[],"apis":[{"api_url":"/api/hosts/:host_id/puppetclass_ids/:id","short_description":"Remove a puppetclass from host","http_method":"DELETE"}],"errors":[],"see":[],"name":"destroy","formats":null,"doc_url":"/apidoc/v2/host_classes/destroy"}],"short_description":null,"name":"Host classes","doc_url":"/apidoc/v2/host_classes","formats":null},"smart_proxies":{"api_url":"/api","full_description":null,"version":"v2","methods":[{"full_description":"","params":[{"validator":"Must be String","required":false,"full_name":"type","expected_type":"string","allow_nil":false,"description":"<p>filter by type</p>","name":"type"},{"validator":"Must be String","required":false,"full_name":"page","expected_type":"string","allow_nil":false,"description":"<p>paginate results</p>","name":"page"},{"validator":"Must be String","required":false,"full_name":"per_page","expected_type":"string","allow_nil":false,"description":"<p>number of entries per request</p>","name":"per_page"}],"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}"],"apis":[{"api_url":"/api/smart_proxies","short_description":"List all smart_proxies.","http_method":"GET"}],"errors":[],"see":[],"name":"index","formats":null,"doc_url":"/apidoc/v2/smart_proxies/index"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["GET /api/smart_proxies/980190962-dhcp-proxy\n200\n{\n \"smart_proxy\": {\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"features\": [],\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"url\": \"https://somewhere.net:8443\",\n \"id\": 980190962,\n \"name\": \"DHCP Proxy\"\n }\n}"],"apis":[{"api_url":"/api/smart_proxies/:id","short_description":"Show a smart proxy.","http_method":"GET"}],"errors":[],"see":[],"name":"show","formats":null,"doc_url":"/apidoc/v2/smart_proxies/show"},{"full_description":"","params":[{"validator":"Must be a Hash","required":true,"full_name":"smart_proxy","params":[{"full_name":"smart_proxy[name]","required":true,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"name"},{"full_name":"smart_proxy[url]","required":true,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"url"}],"expected_type":"hash","allow_nil":false,"description":"","name":"smart_proxy"}],"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 \"created_at\": \"2012-12-18T15:24:52Z\",\n \"updated_at\": \"2012-12-18T15:24:52Z\",\n \"url\": \"http://server:8443\",\n \"id\": 980190963,\n \"name\": \"master02\"\n }\n}"],"apis":[{"api_url":"/api/smart_proxies","short_description":"Create a smart proxy.","http_method":"POST"}],"errors":[],"see":[],"name":"create","formats":null,"doc_url":"/apidoc/v2/smart_proxies/create"},{"full_description":"","params":[{"validator":"Must be String","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"},{"validator":"Must be a Hash","required":true,"full_name":"smart_proxy","params":[{"full_name":"smart_proxy[name]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"name"},{"full_name":"smart_proxy[url]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"url"}],"expected_type":"hash","allow_nil":false,"description":"","name":"smart_proxy"}],"examples":["PUT /api/smart_proxies/980190962-dhcp-proxy\n{\n \"smart_proxy\": {}\n}\n200\n{\n \"smart_proxy\": {\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"url\": \"https://somewhere.net:8443\",\n \"id\": 980190962,\n \"name\": \"DHCP Proxy\"\n }\n}"],"apis":[{"api_url":"/api/smart_proxies/:id","short_description":"Update a smart proxy.","http_method":"PUT"}],"errors":[],"see":[],"name":"update","formats":null,"doc_url":"/apidoc/v2/smart_proxies/update"},{"full_description":"","params":[{"validator":"Must be String","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["DELETE /api/smart_proxies/281110143-unused-proxy\n200\n{\n \"smart_proxy\": {\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"url\": \"http://else.where:4567\",\n \"id\": 281110143,\n \"name\": \"Unused Proxy\"\n }\n}"],"apis":[{"api_url":"/api/smart_proxies/:id","short_description":"Delete a smart_proxy.","http_method":"DELETE"}],"errors":[],"see":[],"name":"destroy","formats":null,"doc_url":"/apidoc/v2/smart_proxies/destroy"}],"short_description":null,"name":"Smart proxies","doc_url":"/apidoc/v2/smart_proxies","formats":null},"architectures":{"api_url":"/api","full_description":null,"version":"v2","methods":[{"full_description":"","params":[{"validator":"Must be String","required":false,"full_name":"search","expected_type":"string","allow_nil":false,"description":"<p>filter results</p>","name":"search"},{"validator":"Must be String","required":false,"full_name":"order","expected_type":"string","allow_nil":false,"description":"<p>sort results</p>","name":"order"},{"validator":"Must be String","required":false,"full_name":"page","expected_type":"string","allow_nil":false,"description":"<p>paginate results</p>","name":"page"},{"validator":"Must be String","required":false,"full_name":"per_page","expected_type":"string","allow_nil":false,"description":"<p>number of entries per request</p>","name":"per_page"}],"examples":["GET /api/architectures\n200\n[\n {\n \"architecture\": {\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"operatingsystem_ids\": [],\n \"id\": 381564594,\n \"name\": \"s390\"\n }\n },\n {\n \"architecture\": {\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"operatingsystem_ids\": [\n 442321401\n ],\n \"id\": 331892513,\n \"name\": \"sparc\"\n }\n },\n {\n \"architecture\": {\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"operatingsystem_ids\": [\n 331303656,\n 309172073,\n 1073012828\n ],\n \"id\": 501905019,\n \"name\": \"x86_64\"\n }\n }\n]"],"apis":[{"api_url":"/api/architectures","short_description":"List all architectures.","http_method":"GET"}],"errors":[],"see":[],"name":"index","formats":null,"doc_url":"/apidoc/v2/architectures/index"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["GET /api/architectures/x86_64\n200\n{\n \"architecture\": {\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"operatingsystem_ids\": [\n 309172073,\n 1073012828,\n 331303656\n ],\n \"id\": 501905019,\n \"name\": \"x86_64\"\n }\n}"],"apis":[{"api_url":"/api/architectures/:id","short_description":"Show an architecture.","http_method":"GET"}],"errors":[],"see":[],"name":"show","formats":null,"doc_url":"/apidoc/v2/architectures/show"},{"full_description":"","params":[{"validator":"Must be a Hash","required":true,"full_name":"architecture","params":[{"full_name":"architecture[name]","required":true,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"name"},{"full_name":"architecture[operatingsystem_ids]","required":false,"validator":"Must be Array","expected_type":"array","allow_nil":false,"description":"<p>Operatingsystem ID&#8217;s</p>","name":"operatingsystem_ids"}],"expected_type":"hash","allow_nil":false,"description":"","name":"architecture"}],"examples":["POST /api/architectures\n{\n \"architecture\": {\n \"name\": \"i386\"\n }\n}\n200\n{\n \"architecture\": {\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"operatingsystem_ids\": [],\n \"id\": 501905020,\n \"name\": \"i386\"\n }\n}"],"apis":[{"api_url":"/api/architectures","short_description":"Create an architecture.","http_method":"POST"}],"errors":[],"see":[],"name":"create","formats":null,"doc_url":"/apidoc/v2/architectures/create"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"},{"validator":"Must be a Hash","required":true,"full_name":"architecture","params":[{"full_name":"architecture[name]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"name"},{"full_name":"architecture[operatingsystem_ids]","required":false,"validator":"Must be Array","expected_type":"array","allow_nil":false,"description":"<p>Operatingsystem ID&#8217;s</p>","name":"operatingsystem_ids"}],"expected_type":"hash","allow_nil":false,"description":"","name":"architecture"}],"examples":["PUT /api/architectures/x86_64\n{\n \"architecture\": {}\n}\n200\n{\n \"architecture\": {\n \"id\": 501905019,\n \"name\": \"x86_64\"\n }\n}"],"apis":[{"api_url":"/api/architectures/:id","short_description":"Update an architecture.","http_method":"PUT"}],"errors":[],"see":[],"name":"update","formats":null,"doc_url":"/apidoc/v2/architectures/update"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["DELETE /api/architectures/s390\n200\n{\n \"architecture\": {\n \"id\": 381564594,\n \"name\": \"s390\"\n }\n}"],"apis":[{"api_url":"/api/architectures/:id","short_description":"Delete an architecture.","http_method":"DELETE"}],"errors":[],"see":[],"name":"destroy","formats":null,"doc_url":"/apidoc/v2/architectures/destroy"}],"short_description":null,"name":"Architectures","doc_url":"/apidoc/v2/architectures","formats":null},"common_parameters":{"api_url":"/api","full_description":null,"version":"v2","methods":[{"full_description":"","params":[{"validator":"Must be String","required":false,"full_name":"search","expected_type":"string","allow_nil":false,"description":"<p>filter results</p>","name":"search"},{"validator":"Must be String","required":false,"full_name":"order","expected_type":"string","allow_nil":false,"description":"<p>sort results</p>","name":"order"},{"validator":"Must be String","required":false,"full_name":"page","expected_type":"string","allow_nil":false,"description":"<p>paginate results</p>","name":"page"},{"validator":"Must be String","required":false,"full_name":"per_page","expected_type":"string","allow_nil":false,"description":"<p>number of entries per request</p>","name":"per_page"}],"examples":["GET /api/common_parameters\n200\n[\n {\n \"common_parameter\": {\n \"value\": \"myvalue\",\n \"id\": 636252244,\n \"name\": \"test\"\n }\n }\n]"],"apis":[{"api_url":"/api/common_parameters","short_description":"List all common parameters.","http_method":"GET"}],"errors":[],"see":[],"name":"index","formats":null,"doc_url":"/apidoc/v2/common_parameters/index"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["GET /api/common_parameters/636252244\n200\n{\n \"common_parameter\": {\n \"value\": \"myvalue\",\n \"id\": 636252244,\n \"name\": \"test\"\n }\n}"],"apis":[{"api_url":"/api/common_parameters/:id","short_description":"Show a common parameter.","http_method":"GET"}],"errors":[],"see":[],"name":"show","formats":null,"doc_url":"/apidoc/v2/common_parameters/show"},{"full_description":"","params":[{"validator":"Must be a Hash","required":true,"full_name":"common_parameter","params":[{"full_name":"common_parameter[name]","required":true,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"name"},{"full_name":"common_parameter[value]","required":true,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"value"}],"expected_type":"hash","allow_nil":false,"description":"","name":"common_parameter"}],"examples":["POST /api/common_parameters\n{\n \"common_parameter\": {\n \"value\": \"123\",\n \"name\": \"special_key\"\n }\n}\n200\n{\n \"common_parameter\": {\n \"value\": \"123\",\n \"id\": 767575239,\n \"name\": \"special_key\"\n }\n}"],"apis":[{"api_url":"/api/common_parameters","short_description":"Create a common_parameter","http_method":"POST"}],"errors":[],"see":[],"name":"create","formats":null,"doc_url":"/apidoc/v2/common_parameters/create"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"},{"validator":"Must be a Hash","required":true,"full_name":"common_parameter","params":[{"full_name":"common_parameter[name]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"name"},{"full_name":"common_parameter[value]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"value"}],"expected_type":"hash","allow_nil":false,"description":"","name":"common_parameter"}],"examples":["PUT /api/common_parameters/636252244\n{\n \"common_parameter\": {}\n}\n200\n{\n \"common_parameter\": {\n \"value\": \"myvalue\",\n \"id\": 636252244,\n \"name\": \"test\"\n }\n}"],"apis":[{"api_url":"/api/common_parameters/:id","short_description":"Update a common_parameter","http_method":"PUT"}],"errors":[],"see":[],"name":"update","formats":null,"doc_url":"/apidoc/v2/common_parameters/update"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["DELETE /api/common_parameters/636252244\n200\n{\n \"common_parameter\": {\n \"value\": \"myvalue\",\n \"id\": 636252244,\n \"name\": \"test\"\n }\n}"],"apis":[{"api_url":"/api/common_parameters/:id","short_description":"Delete a common_parameter","http_method":"DELETE"}],"errors":[],"see":[],"name":"destroy","formats":null,"doc_url":"/apidoc/v2/common_parameters/destroy"}],"short_description":null,"name":"Common parameters","doc_url":"/apidoc/v2/common_parameters","formats":null}},"copyright":"","info":"Another API description","name":"Foreman","doc_url":"/apidoc/v2"}}