foreman_api 0.0.8 → 0.0.9

Sign up to get free protection for your applications and to get access to all the features.
@@ -1 +1 @@
1
- {"docs":{"resources":{"roles":{"methods":[{"see_url":null,"examples":[],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"GET","short_description":"List all roles.","api_url":"/api/roles"}],"doc_url":"/apidoc/roles/index","params":[{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"page","name":"page","expected_type":"string","description":"<p>paginate results</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"per_page","name":"per_page","expected_type":"string","description":"<p>number of entries per request</p>\n"}],"name":"index"},{"see_url":null,"examples":["GET /api/roles/1\n200\n{\n \"role\": {\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 ],\n \"name\": \"Manager\",\n \"id\": 1,\n \"builtin\": 0\n }\n}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"GET","short_description":"Show an role.","api_url":"/api/roles/:id"}],"doc_url":"/apidoc/roles/show","params":[{"allow_nil":false,"required":true,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","full_name":"id","name":"id","expected_type":"string","description":""}],"name":"show"},{"see_url":null,"examples":["POST /api/roles\n{\n \"role\": {\n \"name\": \"staff\"\n }\n}\n200\n{\n \"role\": {\n \"permissions\": [],\n \"name\": \"staff\",\n \"id\": 15,\n \"builtin\": 0\n }\n}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"POST","short_description":"Create an role.","api_url":"/api/roles"}],"doc_url":"/apidoc/roles/create","params":[{"allow_nil":false,"required":true,"validator":"Must be a Hash","params":[{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"role[name]","name":"name","expected_type":"string","description":""}],"full_name":"role","name":"role","expected_type":"hash","description":""}],"name":"create"},{"see_url":null,"examples":["PUT /api/roles/1\n{\n \"role\": {}\n}\n200\n{\n \"role\": {\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 ],\n \"name\": \"Manager\",\n \"id\": 1,\n \"builtin\": 0\n }\n}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"PUT","short_description":"Update an role.","api_url":"/api/roles/:id"}],"doc_url":"/apidoc/roles/update","params":[{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"id","name":"id","expected_type":"string","description":""},{"allow_nil":false,"required":true,"validator":"Must be a Hash","params":[{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"role[name]","name":"name","expected_type":"string","description":""}],"full_name":"role","name":"role","expected_type":"hash","description":""}],"name":"update"},{"see_url":null,"examples":["DELETE /api/roles/1\n200\n{\n \"role\": {\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 ],\n \"name\": \"Manager\",\n \"id\": 1,\n \"builtin\": 0\n }\n}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"DELETE","short_description":"Delete an role.","api_url":"/api/roles/:id"}],"doc_url":"/apidoc/roles/destroy","params":[{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"id","name":"id","expected_type":"string","description":""}],"name":"destroy"}],"version":"1","full_description":"","formats":[],"short_description":"","doc_url":"/apidoc/roles","name":"Roles","api_url":"/api"},"puppetclasses":{"methods":[{"see_url":null,"examples":["GET /api/puppetclasses\n200\n{\n \"base\": [\n {\n \"puppetclass\": {\n \"lookup_keys\": [\n {\n \"id\": 298486374\n }\n ],\n \"name\": \"base\",\n \"id\": 980190962\n }\n }\n ],\n \"apache\": [\n {\n \"puppetclass\": {\n \"lookup_keys\": [],\n \"name\": \"apache\",\n \"id\": 298486374\n }\n }\n ]\n}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"GET","short_description":"List all puppetclasses.","api_url":"/api/puppetclasses"}],"doc_url":"/apidoc/puppetclasses/index","params":[{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"search","name":"search","expected_type":"string","description":"<p>filter results</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"order","name":"order","expected_type":"string","description":"<p>sort results</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"page","name":"page","expected_type":"string","description":"<p>paginate results</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"per_page","name":"per_page","expected_type":"string","description":"<p>number of entries per request</p>\n"}],"name":"index"},{"see_url":null,"examples":["GET /api/puppetclasses/base\n200\n{\n \"puppetclass\": {\n \"lookup_keys\": [\n {\n \"lookup_key\": {\n \"default_value\": \"443\",\n \"required\": false,\n \"is_param\": false,\n \"key\": \"ssl_port\",\n \"id\": 298486374,\n \"description\": null,\n \"override\": false\n }\n }\n ],\n \"name\": \"base\",\n \"id\": 980190962\n }\n}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"GET","short_description":"Show a puppetclass.","api_url":"/api/puppetclasses/:id"}],"doc_url":"/apidoc/puppetclasses/show","params":[{"allow_nil":false,"required":true,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","full_name":"id","name":"id","expected_type":"string","description":""}],"name":"show"},{"see_url":null,"examples":["POST /api/puppetclasses\n{\n \"puppetclass\": {\n \"name\": \"test_puppetclass\"\n }\n}\n201\n{\n \"puppetclass\": {\n \"lookup_keys\": [],\n \"name\": \"test_puppetclass\",\n \"id\": 980190963\n }\n}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"POST","short_description":"Create a puppetclass.","api_url":"/api/puppetclasses"}],"doc_url":"/apidoc/puppetclasses/create","params":[{"allow_nil":false,"required":true,"validator":"Must be a Hash","params":[{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"puppetclass[name]","name":"name","expected_type":"string","description":""}],"full_name":"puppetclass","name":"puppetclass","expected_type":"hash","description":""}],"name":"create"},{"see_url":null,"examples":["PUT /api/puppetclasses/base\n{\n \"puppetclass\": {}\n}\n200\n{\n \"puppetclass\": {\n \"lookup_keys\": [\n {\n \"id\": 298486374\n }\n ],\n \"name\": \"base\",\n \"id\": 980190962\n }\n}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"PUT","short_description":"Update a puppetclass.","api_url":"/api/puppetclasses/:id"}],"doc_url":"/apidoc/puppetclasses/update","params":[{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"id","name":"id","expected_type":"string","description":""},{"allow_nil":false,"required":true,"validator":"Must be a Hash","params":[{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"puppetclass[name]","name":"name","expected_type":"string","description":""}],"full_name":"puppetclass","name":"puppetclass","expected_type":"hash","description":""}],"name":"update"},{"see_url":null,"examples":["DELETE /api/puppetclasses/base\n200\n{\n \"puppetclass\": {\n \"lookup_keys\": [\n {\n \"id\": 298486374\n }\n ],\n \"name\": \"base\",\n \"id\": 980190962\n }\n}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"DELETE","short_description":"Delete a puppetclass.","api_url":"/api/puppetclasses/:id"}],"doc_url":"/apidoc/puppetclasses/destroy","params":[{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"id","name":"id","expected_type":"string","description":""}],"name":"destroy"}],"version":"1","full_description":"","formats":[],"short_description":"","doc_url":"/apidoc/puppetclasses","name":"Puppetclasses","api_url":"/api"},"environments":{"methods":[{"see_url":null,"examples":["GET /api/environments\n200\n[\n {\n \"environment\": {\n \"created_at\": \"2012-11-21T13:01:46Z\",\n \"name\": \"global_puppetmaster\",\n \"updated_at\": \"2012-11-21T13:01:46Z\",\n \"id\": 153855663\n }\n },\n {\n \"environment\": {\n \"created_at\": \"2012-11-21T13:01:46Z\",\n \"name\": \"production\",\n \"updated_at\": \"2012-11-21T13:01:46Z\",\n \"id\": 334344675\n }\n },\n {\n \"environment\": {\n \"created_at\": \"2012-11-21T13:01:46Z\",\n \"name\": \"testing\",\n \"updated_at\": \"2012-11-21T13:01:46Z\",\n \"id\": 687036937\n }\n }\n]"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"GET","short_description":"List all environments.","api_url":"/api/environments"}],"doc_url":"/apidoc/environments/index","params":[{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"search","name":"search","expected_type":"string","description":"<p>Filter results</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"order","name":"order","expected_type":"string","description":"<p>Sort results</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"page","name":"page","expected_type":"string","description":"<p>paginate results</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"per_page","name":"per_page","expected_type":"string","description":"<p>number of entries per request</p>\n"}],"name":"index"},{"see_url":null,"examples":["GET /api/environments/production\n200\n{\n \"environment\": {\n \"created_at\": \"2012-11-21T13:01:46Z\",\n \"name\": \"production\",\n \"updated_at\": \"2012-11-21T13:01:46Z\",\n \"id\": 334344675\n }\n}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"GET","short_description":"Show an environment.","api_url":"/api/environments/:id"}],"doc_url":"/apidoc/environments/show","params":[{"allow_nil":false,"required":true,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","full_name":"id","name":"id","expected_type":"string","description":""}],"name":"show"},{"see_url":null,"examples":["POST /api/environments\n{\n \"environment\": {\n \"name\": \"Development\"\n }\n}\n200\n{\n \"environment\": {\n \"created_at\": \"2012-11-21T13:01:50Z\",\n \"name\": \"Development\",\n \"updated_at\": \"2012-11-21T13:01:50Z\",\n \"id\": 687036938\n }\n}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"POST","short_description":"Create an environment.","api_url":"/api/environments"}],"doc_url":"/apidoc/environments/create","params":[{"allow_nil":false,"required":true,"validator":"Must be a Hash","params":[{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"environment[name]","name":"name","expected_type":"string","description":""}],"full_name":"environment","name":"environment","expected_type":"hash","description":""}],"name":"create"},{"see_url":null,"examples":["PUT /api/environments/production\n{\n \"environment\": {}\n}\n200\n{\n \"environment\": {\n \"name\": \"production\",\n \"id\": 334344675\n }\n}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"PUT","short_description":"Update an environment.","api_url":"/api/environments/:id"}],"doc_url":"/apidoc/environments/update","params":[{"allow_nil":false,"required":true,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","full_name":"id","name":"id","expected_type":"string","description":""},{"allow_nil":false,"required":true,"validator":"Must be a Hash","params":[{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"environment[name]","name":"name","expected_type":"string","description":""}],"full_name":"environment","name":"environment","expected_type":"hash","description":""}],"name":"update"},{"see_url":null,"examples":["DELETE /api/environments/testing\n200\n{\n \"environment\": {\n \"name\": \"testing\",\n \"id\": 687036937\n }\n}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"DELETE","short_description":"Delete an environment.","api_url":"/api/environments/:id"}],"doc_url":"/apidoc/environments/destroy","params":[{"allow_nil":false,"required":true,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","full_name":"id","name":"id","expected_type":"string","description":""}],"name":"destroy"}],"version":"1","full_description":"","formats":[],"short_description":"","doc_url":"/apidoc/environments","name":"Environments","api_url":"/api"},"operatingsystems":{"methods":[{"see_url":null,"examples":[],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"GET","short_description":"List all operating systems.","api_url":"/api/operatingsystems"}],"doc_url":"/apidoc/operatingsystems/index","params":[{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"search","name":"search","expected_type":"string","description":"<p>filter results</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"order","name":"order","expected_type":"string","description":"<p>for example, name ASC, or name DESC</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"page","name":"page","expected_type":"string","description":"<p>paginate results</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"per_page","name":"per_page","expected_type":"string","description":"<p>number of entries per request</p>\n"}],"name":"index"},{"see_url":null,"examples":["GET /api/operatingsystems/1073012828\n200\n{\n \"operatingsystem\": {\n \"family\": \"Redhat\",\n \"ptables\": [\n {\n \"ptable\": {\n \"name\": \"default\",\n \"id\": 980190962\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 \"\": [],\n \"release_name\": null,\n \"architectures\": [\n {\n \"architecture\": {\n \"name\": \"x86_64\",\n \"id\": 501905019\n }\n }\n ],\n \"name\": \"Redhat\",\n \"media\": [\n {\n \"medium\": {\n \"name\": \"CentOS 5.4\",\n \"id\": 980190962\n }\n }\n ],\n \"major\": \"6\",\n \"id\": 1073012828,\n \"minor\": \"1\"\n }\n}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"GET","short_description":"Show an OS.","api_url":"/api/operatingsystems/:id"}],"doc_url":"/apidoc/operatingsystems/show","params":[{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"id","name":"id","expected_type":"string","description":""}],"name":"show"},{"see_url":null,"examples":["POST /api/operatingsystems\n{\n \"operatingsystem\": {\n \"name\": \"awsome_os\",\n \"major\": \"1\",\n \"minor\": \"2\"\n }\n}\n200\n{\n \"operatingsystem\": {\n \"family\": null,\n \"\": [],\n \"release_name\": null,\n \"name\": \"awsome_os\",\n \"major\": \"1\",\n \"id\": 1073012829,\n \"minor\": \"2\"\n }\n}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"POST","short_description":"Create an OS.","api_url":"/api/operatingsystems"}],"doc_url":"/apidoc/operatingsystems/create","params":[{"allow_nil":false,"required":true,"validator":"Must be a Hash","params":[{"allow_nil":false,"required":true,"validator":"Must match regular expression /\\A(\\S+)\\Z/.","full_name":"operatingsystem[name]","name":"name","expected_type":"string","description":""},{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"operatingsystem[major]","name":"major","expected_type":"string","description":""},{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"operatingsystem[minor]","name":"minor","expected_type":"string","description":""},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"operatingsystem[family]","name":"family","expected_type":"string","description":""},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"operatingsystem[release_name]","name":"release_name","expected_type":"string","description":""}],"full_name":"operatingsystem","name":"operatingsystem","expected_type":"hash","description":""}],"name":"create"},{"see_url":null,"examples":["PUT /api/operatingsystems/1073012828\n{\n \"operatingsystem\": {\n \"name\": \"new_name\"\n }\n}\n200\n{\n \"operatingsystem\": {\n \"family\": \"Redhat\",\n \"ptables\": [\n {\n \"ptable\": {\n \"name\": \"default\",\n \"id\": 980190962\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 \"\": [],\n \"release_name\": null,\n \"architectures\": [\n {\n \"architecture\": {\n \"name\": \"x86_64\",\n \"id\": 501905019\n }\n }\n ],\n \"name\": \"new_name\",\n \"media\": [\n {\n \"medium\": {\n \"name\": \"CentOS 5.4\",\n \"id\": 980190962\n }\n }\n ],\n \"major\": \"6\",\n \"id\": 1073012828,\n \"minor\": \"1\"\n }\n}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"PUT","short_description":"Update an OS.","api_url":"/api/operatingsystems/:id"}],"doc_url":"/apidoc/operatingsystems/update","params":[{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"id","name":"id","expected_type":"string","description":""},{"allow_nil":false,"required":true,"validator":"Must be a Hash","params":[{"allow_nil":false,"required":false,"validator":"Must match regular expression /\\A(\\S+)\\Z/.","full_name":"operatingsystem[name]","name":"name","expected_type":"string","description":""},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"operatingsystem[major]","name":"major","expected_type":"string","description":""},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"operatingsystem[minor]","name":"minor","expected_type":"string","description":""},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"operatingsystem[family]","name":"family","expected_type":"string","description":""},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"operatingsystem[release_name]","name":"release_name","expected_type":"string","description":""}],"full_name":"operatingsystem","name":"operatingsystem","expected_type":"hash","description":""}],"name":"update"},{"see_url":null,"examples":["DELETE /api/operatingsystems/775246587\n200\n{\n \"operatingsystem\": {\n \"ptables\": [],\n \"config_templates\": [],\n \"architectures\": [],\n \"name\": \"NoHosts 1.1\",\n \"media\": [],\n \"id\": 775246587\n }\n}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"DELETE","short_description":"Delete an OS.","api_url":"/api/operatingsystems/:id"}],"doc_url":"/apidoc/operatingsystems/destroy","params":[{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"id","name":"id","expected_type":"string","description":""}],"name":"destroy"},{"see_url":null,"examples":[],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"GET","short_description":"List boot files an OS.","api_url":"/api/operatingsystems/:id/bootfiles"}],"doc_url":"/apidoc/operatingsystems/bootfiles","params":[{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"id","name":"id","expected_type":"string","description":""},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"medium","name":"medium","expected_type":"string","description":""},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"architecture","name":"architecture","expected_type":"string","description":""}],"name":"bootfiles"}],"version":"1","full_description":"","formats":[],"short_description":"","doc_url":"/apidoc/operatingsystems","name":"Operating systems","api_url":"/api"},"fact_values":{"methods":[{"see_url":null,"examples":["GET /api/fact_values\n200\n{\n \"my5name.mydomain.net\": {\n \"kernelversion\": \"2.6.9\",\n \"ipaddress\": \"10.0.19.33\"\n }\n}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"GET","short_description":"List all fact values.","api_url":"/api/fact_values"}],"doc_url":"/apidoc/fact_values/index","params":[{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"search","name":"search","expected_type":"string","description":"<p>filter results</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"order","name":"order","expected_type":"string","description":"<p>sort results</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"page","name":"page","expected_type":"string","description":"<p>paginate results</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"per_page","name":"per_page","expected_type":"string","description":"<p>number of entries per request</p>\n"}],"name":"index"}],"version":"1","full_description":"","formats":[],"short_description":"","doc_url":"/apidoc/fact_values","name":"Fact values","api_url":"/api"},"smart_proxies":{"methods":[{"see_url":null,"examples":["GET /api/smart_proxies\n200\n[\n {\n \"smart_proxy\": {\n \"created_at\": \"2012-11-21T13:01:46Z\",\n \"url\": \"https://somewhere.net:8443\",\n \"name\": \"DHCP Proxy\",\n \"updated_at\": \"2012-11-21T13:01:46Z\",\n \"id\": 980190962\n }\n },\n {\n \"smart_proxy\": {\n \"created_at\": \"2012-11-21T13:01:46Z\",\n \"url\": \"http://else.where:4567\",\n \"name\": \"DNS Proxy\",\n \"updated_at\": \"2012-11-21T13:01:46Z\",\n \"id\": 113629430\n }\n },\n {\n \"smart_proxy\": {\n \"created_at\": \"2012-11-21T13:01:46Z\",\n \"url\": \"http://else.where:4567\",\n \"name\": \"Puppetmaster Proxy\",\n \"updated_at\": \"2012-11-21T13:01:46Z\",\n \"id\": 182953976\n }\n },\n {\n \"smart_proxy\": {\n \"created_at\": \"2012-11-21T13:01:46Z\",\n \"url\": \"http://somewhere.else\",\n \"name\": \"TFTP Proxy\",\n \"updated_at\": \"2012-11-21T13:01:46Z\",\n \"id\": 298486374\n }\n },\n {\n \"smart_proxy\": {\n \"created_at\": \"2012-11-21T13:01:46Z\",\n \"url\": \"http://else.where:4567\",\n \"name\": \"Unused Proxy\",\n \"updated_at\": \"2012-11-21T13:01:46Z\",\n \"id\": 281110143\n }\n }\n]"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"GET","short_description":"List all smart_proxies.","api_url":"/api/smart_proxies"}],"doc_url":"/apidoc/smart_proxies/index","params":[{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"type","name":"type","expected_type":"string","description":"<p>filter by type</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"page","name":"page","expected_type":"string","description":"<p>paginate results</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"per_page","name":"per_page","expected_type":"string","description":"<p>number of entries per request</p>\n"}],"name":"index"},{"see_url":null,"examples":["GET /api/smart_proxies/980190962-dhcp-proxy\n200\n{\n \"smart_proxy\": {\n \"created_at\": \"2012-11-21T13:01:46Z\",\n \"\": [],\n \"url\": \"https://somewhere.net:8443\",\n \"name\": \"DHCP Proxy\",\n \"updated_at\": \"2012-11-21T13:01:46Z\",\n \"id\": 980190962\n }\n}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"GET","short_description":"Show a smart proxy.","api_url":"/api/smart_proxies/:id"}],"doc_url":"/apidoc/smart_proxies/show","params":[{"allow_nil":false,"required":true,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","full_name":"id","name":"id","expected_type":"string","description":""}],"name":"show"},{"see_url":null,"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-11-21T13:01:55Z\",\n \"url\": \"http://server:8443\",\n \"name\": \"master02\",\n \"updated_at\": \"2012-11-21T13:01:55Z\",\n \"id\": 980190963\n }\n}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"POST","short_description":"Create a smart proxy.","api_url":"/api/smart_proxies"}],"doc_url":"/apidoc/smart_proxies/create","params":[{"allow_nil":false,"required":true,"validator":"Must be a Hash","params":[{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"smart_proxy[name]","name":"name","expected_type":"string","description":""},{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"smart_proxy[url]","name":"url","expected_type":"string","description":""}],"full_name":"smart_proxy","name":"smart_proxy","expected_type":"hash","description":""}],"name":"create"},{"see_url":null,"examples":["PUT /api/smart_proxies/980190962-dhcp-proxy\n{\n \"smart_proxy\": {}\n}\n200\n{\n \"smart_proxy\": {\n \"created_at\": \"2012-11-21T13:01:46Z\",\n \"url\": \"https://somewhere.net:8443\",\n \"name\": \"DHCP Proxy\",\n \"updated_at\": \"2012-11-21T13:01:46Z\",\n \"id\": 980190962\n }\n}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"PUT","short_description":"Update a smart proxy.","api_url":"/api/smart_proxies/:id"}],"doc_url":"/apidoc/smart_proxies/update","params":[{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"id","name":"id","expected_type":"string","description":""},{"allow_nil":false,"required":true,"validator":"Must be a Hash","params":[{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"smart_proxy[name]","name":"name","expected_type":"string","description":""},{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"smart_proxy[url]","name":"url","expected_type":"string","description":""}],"full_name":"smart_proxy","name":"smart_proxy","expected_type":"hash","description":""}],"name":"update"},{"see_url":null,"examples":["DELETE /api/smart_proxies/281110143-unused-proxy\n200\n{\n \"smart_proxy\": {\n \"created_at\": \"2012-11-21T13:01:46Z\",\n \"url\": \"http://else.where:4567\",\n \"name\": \"Unused Proxy\",\n \"updated_at\": \"2012-11-21T13:01:46Z\",\n \"id\": 281110143\n }\n}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"DELETE","short_description":"Delete a smart_proxy.","api_url":"/api/smart_proxies/:id"}],"doc_url":"/apidoc/smart_proxies/destroy","params":[{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"id","name":"id","expected_type":"string","description":""}],"name":"destroy"}],"version":"1","full_description":"","formats":[],"short_description":"","doc_url":"/apidoc/smart_proxies","name":"Smart proxies","api_url":"/api"},"ptables":{"methods":[{"see_url":null,"examples":["GET /api/ptables\n200\n[\n {\n \"ptable\": {\n \"created_at\": \"2012-11-21T13:01:46Z\",\n \"name\": \"default\",\n \"updated_at\": \"2012-11-21T13:01:46Z\",\n \"id\": 980190962\n }\n },\n {\n \"ptable\": {\n \"created_at\": \"2012-11-21T13:01:46Z\",\n \"name\": \"four\",\n \"updated_at\": \"2012-11-21T13:01:46Z\",\n \"id\": 281110143\n }\n },\n {\n \"ptable\": {\n \"created_at\": \"2012-11-21T13:01:46Z\",\n \"name\": \"suse default\",\n \"updated_at\": \"2012-11-21T13:01:46Z\",\n \"id\": 859751735\n }\n },\n {\n \"ptable\": {\n \"created_at\": \"2012-11-21T13:01:46Z\",\n \"name\": \"ubuntu default\",\n \"updated_at\": \"2012-11-21T13:01:46Z\",\n \"id\": 1011586618\n }\n }\n]"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"GET","short_description":"List all ptables.","api_url":"/api/ptables"}],"doc_url":"/apidoc/ptables/index","params":[{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"search","name":"search","expected_type":"string","description":"<p>filter results</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"order","name":"order","expected_type":"string","description":"<p>sort results</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"page","name":"page","expected_type":"string","description":"<p>paginate results</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"per_page","name":"per_page","expected_type":"string","description":"<p>number of entries per request</p>\n"}],"name":"index"},{"see_url":null,"examples":["GET /api/ptables/980190962\n200\n{\n \"ptable\": {\n \"created_at\": \"2012-11-21T13:01:46Z\",\n \"name\": \"default\",\n \"updated_at\": \"2012-11-21T13:01:46Z\",\n \"id\": 980190962\n }\n}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"GET","short_description":"Show a ptable.","api_url":"/api/ptables/:id"}],"doc_url":"/apidoc/ptables/show","params":[{"allow_nil":false,"required":true,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","full_name":"id","name":"id","expected_type":"string","description":""}],"name":"show"},{"see_url":null,"examples":["POST /api/ptables\n{\n \"ptable\": {\n \"layout\": \"d-i partman-auto/disk\",\n \"name\": \"ptable_test\"\n }\n}\n201\n{\n \"ptable\": {\n \"name\": \"ptable_test\",\n \"id\": 1011586619\n }\n}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"POST","short_description":"Create a ptable.","api_url":"/api/ptables"}],"doc_url":"/apidoc/ptables/create","params":[{"allow_nil":false,"required":true,"validator":"Must be a Hash","params":[{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"ptable[name]","name":"name","expected_type":"string","description":""},{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"ptable[layout]","name":"layout","expected_type":"string","description":""},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"ptable[os_family]","name":"os_family","expected_type":"string","description":""}],"full_name":"ptable","name":"ptable","expected_type":"hash","description":""}],"name":"create"},{"see_url":null,"examples":["PUT /api/ptables/980190962\n{\n \"ptable\": {}\n}\n200\n{\n \"ptable\": {\n \"name\": \"default\",\n \"id\": 980190962\n }\n}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"PUT","short_description":"Update a ptable.","api_url":"/api/ptables/:id"}],"doc_url":"/apidoc/ptables/update","params":[{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"id","name":"id","expected_type":"string","description":""},{"allow_nil":false,"required":true,"validator":"Must be a Hash","params":[{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"ptable[name]","name":"name","expected_type":"string","description":""},{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"ptable[layout]","name":"layout","expected_type":"string","description":""},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"ptable[os_family]","name":"os_family","expected_type":"string","description":""}],"full_name":"ptable","name":"ptable","expected_type":"hash","description":""}],"name":"update"},{"see_url":null,"examples":["DELETE /api/ptables/980190962\n422\n{\n \"ptable\": {\n \"full_messages\": [\n \"default is used by dhcp.mydomain.net\",\n \"default is used by temp.yourdomain.net\",\n \"default is used by sdhcp.mydomain.net\",\n \"default is used by my5name.mydomain.net\",\n \"default is used by temp01.yourdomain.net\"\n ],\n \"errors\": {\n \"base\": [\n \"default is used by dhcp.mydomain.net\",\n \"default is used by temp.yourdomain.net\",\n \"default is used by sdhcp.mydomain.net\",\n \"default is used by my5name.mydomain.net\",\n \"default is used by temp01.yourdomain.net\"\n ]\n },\n \"id\": 980190962\n }\n}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"DELETE","short_description":"Delete a ptable.","api_url":"/api/ptables/:id"}],"doc_url":"/apidoc/ptables/destroy","params":[{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"id","name":"id","expected_type":"string","description":""}],"name":"destroy"}],"version":"1","full_description":"","formats":[],"short_description":"","doc_url":"/apidoc/ptables","name":"Ptables","api_url":"/api"},"domains":{"methods":[{"see_url":null,"examples":["GET /api/domains\n200\n[\n {\n \"domain\": {\n \"fullname\": null,\n \"created_at\": \"2012-11-21T13:01:46Z\",\n \"dns_id\": 113629430,\n \"name\": \"mydomain.net\",\n \"updated_at\": \"2012-11-21T13:01:46Z\",\n \"id\": 22495316\n }\n },\n {\n \"domain\": {\n \"fullname\": \"somewhare that is never used\",\n \"created_at\": \"2012-11-21T13:01:46Z\",\n \"dns_id\": 113629430,\n \"name\": \"unused.net\",\n \"updated_at\": \"2012-11-21T13:01:46Z\",\n \"id\": 759776763\n }\n },\n {\n \"domain\": {\n \"fullname\": null,\n \"created_at\": \"2012-11-21T13:01:46Z\",\n \"dns_id\": null,\n \"name\": \"useless.net\",\n \"updated_at\": \"2012-11-21T13:01:46Z\",\n \"id\": 229305443\n }\n },\n {\n \"domain\": {\n \"fullname\": \"somewhere in yourdomain\",\n \"created_at\": \"2012-11-21T13:01:46Z\",\n \"dns_id\": 113629430,\n \"name\": \"yourdomain.net\",\n \"updated_at\": \"2012-11-21T13:01:46Z\",\n \"id\": 589326610\n }\n }\n]"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"GET","short_description":"List of domains","api_url":"/api/domains"}],"doc_url":"/apidoc/domains/index","params":[{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"search","name":"search","expected_type":"string","description":"<p>Filter results</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"order","name":"order","expected_type":"string","description":"<p>Sort results</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"page","name":"page","expected_type":"string","description":"<p>paginate results</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"per_page","name":"per_page","expected_type":"string","description":"<p>number of entries per request</p>\n"}],"name":"index"},{"see_url":null,"examples":["GET /api/domains/mydomain.net\n200\n{\n \"domain\": {\n \"fullname\": null,\n \"created_at\": \"2012-11-21T13:01:46Z\",\n \"dns_id\": 113629430,\n \"name\": \"mydomain.net\",\n \"updated_at\": \"2012-11-21T13:01:46Z\",\n \"id\": 22495316\n }\n}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"GET","short_description":"Show a domain.","api_url":"/api/domains/:id"}],"doc_url":"/apidoc/domains/show","params":[{"allow_nil":false,"required":true,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","full_name":"id","name":"id","expected_type":"string","description":"<p>May be numerical id or domain name</p>\n"}],"name":"show"},{"see_url":null,"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}"],"full_description":"<p>The <b>fullname</b> field is used for human readability in reports\nand other pages that refer to domains, and also available as\nan external node parameter</p>\n","formats":[],"see":null,"errors":[],"apis":[{"http_method":"POST","short_description":"Create a domain.","api_url":"/api/domains"}],"doc_url":"/apidoc/domains/create","params":[{"allow_nil":false,"required":true,"validator":"Must be a Hash","params":[{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"domain[name]","name":"name","expected_type":"string","description":"<p>The full DNS Domain name</p>\n"},{"allow_nil":true,"required":false,"validator":"Must be String","full_name":"domain[fullname]","name":"fullname","expected_type":"string","description":"<p>Full name describing the domain</p>\n"},{"allow_nil":true,"required":false,"validator":"Must be a number.","full_name":"domain[dns_id]","name":"dns_id","expected_type":"string","description":"<p>DNS Proxy to use within this domain</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be Array","full_name":"domain[domain_parameters_attributes]","name":"domain_parameters_attributes","expected_type":"string","description":"<p>Array of parameters (name, value)</p>\n"}],"full_name":"domain","name":"domain","expected_type":"hash","description":""}],"name":"create"},{"see_url":null,"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}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"PUT","short_description":"Update a domain.","api_url":"/api/domains/:id"}],"doc_url":"/apidoc/domains/update","params":[{"allow_nil":false,"required":true,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","full_name":"id","name":"id","expected_type":"string","description":""},{"allow_nil":false,"required":true,"validator":"Must be a Hash","params":[{"allow_nil":true,"required":true,"validator":"Must be String","full_name":"domain[name]","name":"name","expected_type":"string","description":"<p>The full DNS Domain name</p>\n"},{"allow_nil":true,"required":false,"validator":"Must be String","full_name":"domain[fullname]","name":"fullname","expected_type":"string","description":"<p>Full name describing the domain</p>\n"},{"allow_nil":true,"required":false,"validator":"Must be a number.","full_name":"domain[dns_id]","name":"dns_id","expected_type":"string","description":"<p>DNS Proxy to use within this domain</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be Array","full_name":"domain[domain_parameters_attributes]","name":"domain_parameters_attributes","expected_type":"string","description":"<p>Array of parameters (name, value)</p>\n"}],"full_name":"domain","name":"domain","expected_type":"hash","description":""}],"name":"update"},{"see_url":null,"examples":["DELETE /api/domains/mydomain.net\n200\n{\n \"domain\": {\n \"name\": \"mydomain.net\",\n \"id\": 22495316\n }\n}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"DELETE","short_description":"Delete a domain.","api_url":"/api/domains/:id"}],"doc_url":"/apidoc/domains/destroy","params":[{"allow_nil":false,"required":true,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","full_name":"id","name":"id","expected_type":"string","description":""}],"name":"destroy"}],"version":"1","full_description":"<p>Foreman considers a domain and a DNS zone as the same thing. That is, if you\nare planning to manage a site where all the machines are or the form\n<i>hostname</i>.<b>somewhere.com</b> then the domain is <b>somewhere.com</b>.\nThis allows Foreman to associate a puppet variable with a domain/site\nand automatically append this variable to all external node requests made\nby machines at that site.</p>\n","formats":[],"short_description":"","doc_url":"/apidoc/domains","name":"Domains","api_url":"/api"},"hosts":{"methods":[{"see_url":null,"examples":["GET /api/hosts\n200\n[\n {\n \"host\": {\n \"operatingsystem_id\": 1073012828,\n \"name\": \"anotherfullhost\",\n \"hostgroup_id\": null,\n \"id\": 55602819\n }\n },\n {\n \"host\": {\n \"operatingsystem_id\": 1073012828,\n \"name\": \"dhcp.mydomain.net\",\n \"hostgroup_id\": null,\n \"id\": 219245707\n }\n },\n {\n \"host\": {\n \"operatingsystem_id\": 1073012828,\n \"name\": \"my5name.mydomain.net\",\n \"hostgroup_id\": null,\n \"id\": 980190962\n }\n },\n {\n \"host\": {\n \"operatingsystem_id\": 309172073,\n \"name\": \"myfullname.mydomain.net\",\n \"hostgroup_id\": null,\n \"id\": 1053842695\n }\n },\n {\n \"host\": {\n \"operatingsystem_id\": 1073012828,\n \"name\": \"otherfullhost\",\n \"hostgroup_id\": null,\n \"id\": 661942085\n }\n },\n {\n \"host\": {\n \"operatingsystem_id\": 1073012828,\n \"name\": \"sdhcp.mydomain.net\",\n \"hostgroup_id\": null,\n \"id\": 500757383\n }\n },\n {\n \"host\": {\n \"operatingsystem_id\": 442321401,\n \"name\": \"sol10host\",\n \"hostgroup_id\": null,\n \"id\": 715054938\n }\n },\n {\n \"host\": {\n \"operatingsystem_id\": 859751735,\n \"name\": \"suse01.yourdomain.net\",\n \"hostgroup_id\": null,\n \"id\": 859751735\n }\n },\n {\n \"host\": {\n \"operatingsystem_id\": 331303656,\n \"name\": \"temp-01.yourdomain.net\",\n \"hostgroup_id\": null,\n \"id\": 1011586618\n }\n },\n {\n \"host\": {\n \"operatingsystem_id\": 331303656,\n \"name\": \"temp-02.useless.net\",\n \"hostgroup_id\": null,\n \"id\": 3666571\n }\n },\n {\n \"host\": {\n \"operatingsystem_id\": 309172073,\n \"name\": \"temp.yourdomain.net\",\n \"hostgroup_id\": null,\n \"id\": 298486374\n }\n },\n {\n \"host\": {\n \"operatingsystem_id\": 1073012828,\n \"name\": \"temp01.yourdomain.net\",\n \"hostgroup_id\": null,\n \"id\": 1073012828\n }\n }\n]"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"GET","short_description":"List all hosts.","api_url":"/api/hosts"}],"doc_url":"/apidoc/hosts/index","params":[{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"search","name":"search","expected_type":"string","description":"<p>Filter results</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"order","name":"order","expected_type":"string","description":"<p>Sort results</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"page","name":"page","expected_type":"string","description":"<p>paginate results</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"per_page","name":"per_page","expected_type":"string","description":"<p>number of entries per request</p>\n"}],"name":"index"},{"see_url":null,"examples":["GET /api/hosts/my5name.mydomain.net\n200\n{\n \"host\": {\n \"use_image\": null,\n \"installed_at\": null,\n \"model_id\": null,\n \"sp_name\": \"\",\n \"sp_subnet_id\": null,\n \"created_at\": \"2012-11-21T13:01:46Z\",\n \"comment\": null,\n \"mac\": \"aabbCCddeeee\",\n \"sp_ip\": \"\",\n \"build\": false,\n \"uuid\": null,\n \"operatingsystem_id\": 1073012828,\n \"image_file\": \"\",\n \"puppet_proxy_id\": 182953976,\n \"medium_id\": null,\n \"owner_id\": null,\n \"compute_resource_id\": 980190962,\n \"enabled\": true,\n \"architecture_id\": 501905019,\n \"sp_mac\": \"\",\n \"environment\": {\n \"environment\": {\n \"name\": \"production\",\n \"id\": 334344675\n }\n },\n \"ptable_id\": 980190962,\n \"owner_type\": null,\n \"image_id\": null,\n \"domain_id\": 22495316,\n \"certname\": \"my5name.mydomain.net\",\n \"subnet_id\": 980190962,\n \"name\": \"my5name.mydomain.net\",\n \"updated_at\": \"2012-11-21T13:01:46Z\",\n \"host_parameters\": [\n {\n \"host_parameter\": {\n \"created_at\": \"2012-11-21T13:01:46Z\",\n \"priority\": 4,\n \"reference_id\": 980190962,\n \"name\": \"host1\",\n \"updated_at\": \"2012-11-21T13:01:46Z\",\n \"id\": 254219264,\n \"value\": \"host1\"\n }\n }\n ],\n \"managed\": true,\n \"hostgroup_id\": null,\n \"environment_id\": 334344675,\n \"puppet_ca_proxy_id\": null,\n \"last_report\": null,\n \"ip\": \"2.3.4.1\",\n \"id\": 980190962,\n \"disk\": null\n }\n}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"GET","short_description":"Show a host.","api_url":"/api/hosts/:id"}],"doc_url":"/apidoc/hosts/show","params":[{"allow_nil":false,"required":true,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","full_name":"id","name":"id","expected_type":"string","description":""}],"name":"show"},{"see_url":null,"examples":["POST /api/hosts\n{\n \"host\": {\n \"mac\": \"52:53:00:1e:85:93\",\n \"operatingsystem_id\": 1073012828,\n \"puppet_proxy_id\": 7,\n \"architecture_id\": 501905019,\n \"domain_id\": 22495316,\n \"name\": \"testhost11\",\n \"environment_id\": 334344675,\n \"ip\": \"10.0.0.20\"\n }\n}\n200\n{\n \"host\": {\n \"use_image\": null,\n \"installed_at\": null,\n \"model_id\": null,\n \"sp_name\": \"\",\n \"sp_subnet_id\": null,\n \"created_at\": \"2012-11-21T13:01:51Z\",\n \"comment\": null,\n \"mac\": \"52:53:00:1e:85:93\",\n \"sp_ip\": \"\",\n \"build\": false,\n \"uuid\": null,\n \"operatingsystem_id\": 1073012828,\n \"image_file\": \"\",\n \"puppet_proxy_id\": 7,\n \"medium_id\": null,\n \"owner_id\": 135138680,\n \"compute_resource_id\": null,\n \"enabled\": true,\n \"architecture_id\": 501905019,\n \"sp_mac\": \"\",\n \"ptable_id\": null,\n \"environment\": {\n \"environment\": {\n \"name\": \"production\",\n \"id\": 334344675\n }\n },\n \"owner_type\": \"User\",\n \"image_id\": null,\n \"domain_id\": 22495316,\n \"certname\": \"03d92d31-e8c8-4157-aacb-7073283f4b22\",\n \"subnet_id\": null,\n \"name\": \"testhost11.mydomain.net\",\n \"updated_at\": \"2012-11-21T13:01:51Z\",\n \"host_parameters\": [],\n \"managed\": true,\n \"hostgroup_id\": null,\n \"environment_id\": 334344675,\n \"puppet_ca_proxy_id\": null,\n \"last_report\": null,\n \"ip\": \"10.0.0.20\",\n \"id\": 1073012829,\n \"disk\": null\n }\n}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"POST","short_description":"Create a host.","api_url":"/api/hosts"}],"doc_url":"/apidoc/hosts/create","params":[{"allow_nil":false,"required":true,"validator":"Must be a Hash","params":[{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"host[name]","name":"name","expected_type":"string","description":""},{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"host[environment_id]","name":"environment_id","expected_type":"string","description":""},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"host[ip]","name":"ip","expected_type":"string","description":"<p>not required if using a subnet with dhcp proxy</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"host[mac]","name":"mac","expected_type":"string","description":"<p>not required if its a virtual machine</p>\n"},{"allow_nil":false,"required":true,"validator":"Must be a number.","full_name":"host[architecture_id]","name":"architecture_id","expected_type":"string","description":""},{"allow_nil":false,"required":true,"validator":"Must be a number.","full_name":"host[domain_id]","name":"domain_id","expected_type":"string","description":""},{"allow_nil":false,"required":true,"validator":"Must be a number.","full_name":"host[puppet_proxy_id]","name":"puppet_proxy_id","expected_type":"string","description":""},{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"host[operatingsystem_id]","name":"operatingsystem_id","expected_type":"string","description":""},{"allow_nil":false,"required":false,"validator":"Must be a number.","full_name":"host[medium_id]","name":"medium_id","expected_type":"string","description":""},{"allow_nil":false,"required":false,"validator":"Must be a number.","full_name":"host[ptable_id]","name":"ptable_id","expected_type":"string","description":""},{"allow_nil":false,"required":false,"validator":"Must be a number.","full_name":"host[subnet_id]","name":"subnet_id","expected_type":"string","description":""},{"allow_nil":false,"required":false,"validator":"Must be a number.","full_name":"host[sp_subnet_id]","name":"sp_subnet_id","expected_type":"string","description":""},{"allow_nil":false,"required":false,"validator":"Must be a number.","full_name":"host[model_id_id]","name":"model_id_id","expected_type":"string","description":""},{"allow_nil":false,"required":false,"validator":"Must be a number.","full_name":"host[hostgroup_id]","name":"hostgroup_id","expected_type":"string","description":""},{"allow_nil":false,"required":false,"validator":"Must be a number.","full_name":"host[owner_id]","name":"owner_id","expected_type":"string","description":""},{"allow_nil":false,"required":false,"validator":"Must be a number.","full_name":"host[puppet_ca_proxy_id]","name":"puppet_ca_proxy_id","expected_type":"string","description":""},{"allow_nil":false,"required":false,"validator":"Must be a number.","full_name":"host[image_id]","name":"image_id","expected_type":"string","description":""},{"allow_nil":false,"required":false,"validator":"Must be Array","full_name":"host[host_parameters_attributes]","name":"host_parameters_attributes","expected_type":"string","description":""}],"full_name":"host","name":"host","expected_type":"hash","description":""}],"name":"create"},{"see_url":null,"examples":["PUT /api/hosts/temp.yourdomain.net\n{\n \"host\": {}\n}\n200\n{\n \"host\": {\n \"use_image\": null,\n \"installed_at\": null,\n \"model_id\": null,\n \"sp_name\": \"\",\n \"sp_subnet_id\": null,\n \"comment\": null,\n \"created_at\": \"2012-11-21T13:01:46Z\",\n \"mac\": \"aa:bb:cc:dd:ee:ff\",\n \"last_freshcheck\": null,\n \"sp_ip\": \"\",\n \"root_pass\": \"xybxa6JUkz63w\",\n \"last_compile\": null,\n \"build\": false,\n \"uuid\": null,\n \"source_file_id\": null,\n \"operatingsystem_id\": 309172073,\n \"image_file\": \"\",\n \"puppet_proxy_id\": 182953976,\n \"medium_id\": 980190962,\n \"puppet_status\": 0,\n \"owner_id\": 135138680,\n \"compute_resource_id\": 980190962,\n \"enabled\": true,\n \"architecture_id\": 501905019,\n \"sp_mac\": \"\",\n \"environment\": {\n \"environment\": {\n \"name\": \"production\",\n \"id\": 334344675\n }\n },\n \"ptable_id\": 980190962,\n \"owner_type\": \"User\",\n \"serial\": null,\n \"image_id\": null,\n \"certname\": \"temp.yourdomain.net\",\n \"domain_id\": 589326610,\n \"subnet_id\": 980190962,\n \"name\": \"temp.yourdomain.net\",\n \"updated_at\": \"2012-11-21T13:01:51Z\",\n \"managed\": null,\n \"hostgroup_id\": null,\n \"environment_id\": 334344675,\n \"puppet_ca_proxy_id\": null,\n \"last_report\": null,\n \"id\": 298486374,\n \"ip\": \"2.3.4.5\",\n \"disk\": null\n }\n}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"PUT","short_description":"Update a host.","api_url":"/api/hosts/:id"}],"doc_url":"/apidoc/hosts/update","params":[{"allow_nil":false,"required":true,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","full_name":"id","name":"id","expected_type":"string","description":""},{"allow_nil":false,"required":true,"validator":"Must be a Hash","params":[{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"host[name]","name":"name","expected_type":"string","description":""},{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"host[environment_id]","name":"environment_id","expected_type":"string","description":""},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"host[ip]","name":"ip","expected_type":"string","description":"<p>not required if using a subnet with dhcp proxy</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"host[mac]","name":"mac","expected_type":"string","description":"<p>not required if its a virtual machine</p>\n"},{"allow_nil":false,"required":true,"validator":"Must be a number.","full_name":"host[architecture_id]","name":"architecture_id","expected_type":"string","description":""},{"allow_nil":false,"required":true,"validator":"Must be a number.","full_name":"host[domain_id]","name":"domain_id","expected_type":"string","description":""},{"allow_nil":false,"required":true,"validator":"Must be a number.","full_name":"host[puppet_proxy_id]","name":"puppet_proxy_id","expected_type":"string","description":""},{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"host[operatingsystem_id]","name":"operatingsystem_id","expected_type":"string","description":""},{"allow_nil":false,"required":false,"validator":"Must be a number.","full_name":"host[medium_id]","name":"medium_id","expected_type":"string","description":""},{"allow_nil":false,"required":false,"validator":"Must be a number.","full_name":"host[ptable_id]","name":"ptable_id","expected_type":"string","description":""},{"allow_nil":false,"required":false,"validator":"Must be a number.","full_name":"host[subnet_id]","name":"subnet_id","expected_type":"string","description":""},{"allow_nil":false,"required":false,"validator":"Must be a number.","full_name":"host[sp_subnet_id]","name":"sp_subnet_id","expected_type":"string","description":""},{"allow_nil":false,"required":false,"validator":"Must be a number.","full_name":"host[model_id_id]","name":"model_id_id","expected_type":"string","description":""},{"allow_nil":false,"required":false,"validator":"Must be a number.","full_name":"host[hostgroup_id]","name":"hostgroup_id","expected_type":"string","description":""},{"allow_nil":false,"required":false,"validator":"Must be a number.","full_name":"host[owner_id]","name":"owner_id","expected_type":"string","description":""},{"allow_nil":false,"required":false,"validator":"Must be a number.","full_name":"host[puppet_ca_proxy_id]","name":"puppet_ca_proxy_id","expected_type":"string","description":""},{"allow_nil":false,"required":false,"validator":"Must be a number.","full_name":"host[image_id]","name":"image_id","expected_type":"string","description":""},{"allow_nil":false,"required":false,"validator":"Must be Array","full_name":"host[host_parameters_attributes]","name":"host_parameters_attributes","expected_type":"string","description":""}],"full_name":"host","name":"host","expected_type":"hash","description":""}],"name":"update"},{"see_url":null,"examples":["DELETE /api/hosts/my5name.mydomain.net\n200\n{\n \"host\": {\n \"use_image\": null,\n \"installed_at\": null,\n \"model_id\": null,\n \"sp_name\": \"\",\n \"sp_subnet_id\": null,\n \"comment\": null,\n \"created_at\": \"2012-11-21T13:01:46Z\",\n \"mac\": \"aabbCCddeeee\",\n \"last_freshcheck\": null,\n \"sp_ip\": \"\",\n \"root_pass\": \"xybxa6JUkz63w\",\n \"last_compile\": null,\n \"build\": false,\n \"uuid\": null,\n \"source_file_id\": null,\n \"operatingsystem_id\": 1073012828,\n \"image_file\": \"\",\n \"puppet_proxy_id\": 182953976,\n \"medium_id\": null,\n \"puppet_status\": 0,\n \"owner_id\": null,\n \"compute_resource_id\": 980190962,\n \"enabled\": true,\n \"architecture_id\": 501905019,\n \"sp_mac\": \"\",\n \"environment\": {\n \"environment\": {\n \"name\": \"production\",\n \"id\": 334344675\n }\n },\n \"ptable_id\": 980190962,\n \"owner_type\": null,\n \"serial\": null,\n \"image_id\": null,\n \"certname\": \"my5name.mydomain.net\",\n \"domain_id\": 22495316,\n \"subnet_id\": 980190962,\n \"name\": \"my5name.mydomain.net\",\n \"updated_at\": \"2012-11-21T13:01:46Z\",\n \"managed\": true,\n \"hostgroup_id\": null,\n \"environment_id\": 334344675,\n \"puppet_ca_proxy_id\": null,\n \"last_report\": null,\n \"id\": 980190962,\n \"ip\": \"2.3.4.1\",\n \"disk\": null\n }\n}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"DELETE","short_description":"Delete an host.","api_url":"/api/hosts/:id"}],"doc_url":"/apidoc/hosts/destroy","params":[{"allow_nil":false,"required":true,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","full_name":"id","name":"id","expected_type":"string","description":""}],"name":"destroy"}],"version":"1","full_description":"","formats":[],"short_description":"","doc_url":"/apidoc/hosts","name":"Hosts","api_url":"/api"},"home":{"methods":[{"see_url":null,"examples":["GET /api\n200\n{\n \"links\": {\n \"List all roles\": \"/api/roles\",\n \"List all authsource ldaps\": \"/api/auth_source_ldaps\",\n \"List all images for compute resource\": \"/api/compute_resources/:compute_resource_id/images\",\n \"List all hostgroups\": \"/api/hostgroups\",\n \"List all compute resources\": \"/api/compute_resources\",\n \"List all operating systems\": \"/api/operatingsystems\",\n \"List of subnets\": \"/api/subnets\",\n \"List all fact values\": \"/api/fact_values\",\n \"List all puppetclasses\": \"/api/puppetclasses\",\n \"List all hosts\": \"/api/hosts\",\n \"List all audits\": \"/api/audits\",\n \"List all common parameters\": \"/api/common_parameters\",\n \"List all models\": \"/api/models\",\n \"List all bookmarks\": \"/api/bookmarks\",\n \"List all architectures\": \"/api/architectures\",\n \"List all ptables\": \"/api/ptables\",\n \"List all users\": \"/api/users\",\n \"List templates\": \"/api/config_templates\",\n \"List all media\": \"/api/media\",\n \"List of domains\": \"/api/domains\",\n \"Show status\": \"/api/status\",\n \"Get Dashboard results\": \"/api/dashboard\",\n \"Show available links\": \"/api\",\n \"List all reports\": \"/api/reports\",\n \"List all settings\": \"/api/settings\",\n \"List all smart_proxies\": \"/api/smart_proxies\",\n \"List all lookup_keys\": \"/api/lookup_keys\",\n \"List all usergroups\": \"/api/usergroups\",\n \"List all environments\": \"/api/environments\"\n }\n}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"GET","short_description":"Show available links.","api_url":"/api"}],"doc_url":"/apidoc/home/index","params":[],"name":"index"},{"see_url":null,"examples":[],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"GET","short_description":"Show status.","api_url":"/api/status"}],"doc_url":"/apidoc/home/status","params":[],"name":"status"}],"version":"1","full_description":"","formats":[],"short_description":"","doc_url":"/apidoc/home","name":"Home","api_url":"/api"},"reports":{"methods":[{"see_url":null,"examples":["GET /api/reports\n200\n[\n {\n \"report\": {\n \"\": [],\n \"summary\": \"Success\",\n \"status\": {\n \"restarted\": 0,\n \"failed_restarts\": 0,\n \"applied\": 0,\n \"pending\": 0,\n \"skipped\": 0,\n \"failed\": 0\n },\n \"metrics\": {\n \"events\": {\n \"total\": 0\n },\n \"time\": {\n \"config_retrieval\": 16.3637869358063,\n \"mailalias\": 0.000283,\n \"cron\": 0.000419,\n \"package\": 0.003989,\n \"exec\": 0.000299,\n \"filebucket\": 0.000171,\n \"schedule\": 0.00083,\n \"file\": 0.007025,\n \"service\": 0.149739\n },\n \"resources\": {\n \"total\": 33\n },\n \"changes\": {}\n },\n \"reported_at\": \"2012-11-14T13:01:46Z\",\n \"id\": 70219655\n }\n }\n]"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"GET","short_description":"List all reports.","api_url":"/api/reports"}],"doc_url":"/apidoc/reports/index","params":[{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"search","name":"search","expected_type":"string","description":"<p>filter results</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"order","name":"order","expected_type":"string","description":"<p>sort results</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"page","name":"page","expected_type":"string","description":"<p>paginate results</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"per_page","name":"per_page","expected_type":"string","description":"<p>number of entries per request</p>\n"}],"name":"index"},{"see_url":null,"examples":["GET /api/reports/70219655\n200\n{\n \"report\": {\n \"\": [],\n \"summary\": \"Success\",\n \"status\": {\n \"restarted\": 0,\n \"failed_restarts\": 0,\n \"applied\": 0,\n \"pending\": 0,\n \"skipped\": 0,\n \"failed\": 0\n },\n \"metrics\": {\n \"events\": {\n \"total\": 0\n },\n \"time\": {\n \"config_retrieval\": 16.3637869358063,\n \"mailalias\": 0.000283,\n \"cron\": 0.000419,\n \"package\": 0.003989,\n \"exec\": 0.000299,\n \"filebucket\": 0.000171,\n \"schedule\": 0.00083,\n \"file\": 0.007025,\n \"service\": 0.149739\n },\n \"resources\": {\n \"total\": 33\n },\n \"changes\": {}\n },\n \"reported_at\": \"2012-11-14T13:01:46Z\",\n \"id\": 70219655\n }\n}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"GET","short_description":"Show a report.","api_url":"/api/reports/:id"}],"doc_url":"/apidoc/reports/show","params":[{"allow_nil":false,"required":true,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","full_name":"id","name":"id","expected_type":"string","description":""}],"name":"show"},{"see_url":null,"examples":["DELETE /api/reports/70219655\n200\n{\n \"report\": {\n \"summary\": \"Success\",\n \"status\": {\n \"restarted\": 0,\n \"failed_restarts\": 0,\n \"applied\": 0,\n \"pending\": 0,\n \"skipped\": 0,\n \"failed\": 0\n },\n \"metrics\": {\n \"events\": {\n \"total\": 0\n },\n \"time\": {\n \"config_retrieval\": 16.3637869358063,\n \"mailalias\": 0.000283,\n \"cron\": 0.000419,\n \"package\": 0.003989,\n \"exec\": 0.000299,\n \"filebucket\": 0.000171,\n \"schedule\": 0.00083,\n \"file\": 0.007025,\n \"service\": 0.149739\n },\n \"resources\": {\n \"total\": 33\n },\n \"changes\": {}\n },\n \"host\": \"my5name.mydomain.net\",\n \"logs\": [],\n \"reported_at\": \"2012-11-14T13:01:46Z\",\n \"id\": 70219655\n }\n}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"DELETE","short_description":"Delete a report.","api_url":"/api/ptables/:id"}],"doc_url":"/apidoc/reports/destroy","params":[{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"id","name":"id","expected_type":"string","description":""}],"name":"destroy"}],"version":"1","full_description":"","formats":[],"short_description":"","doc_url":"/apidoc/reports","name":"Reports","api_url":"/api"},"config_templates":{"methods":[{"see_url":null,"examples":["GET /api/config_templates\n200\n[\n {\n \"config_template\": {\n \"template_kind\": {\n \"name\": \"finish\",\n \"id\": 550103832\n },\n \"snippet\": null,\n \"name\": \"MyFinish\",\n \"template\": \"MyFinish\",\n \"audit_comment\": null,\n \"id\": 104314179\n }\n },\n {\n \"config_template\": {\n \"template_kind\": {\n \"name\": \"script\",\n \"id\": 478250810\n },\n \"snippet\": null,\n \"name\": \"MyScript\",\n \"template\": \"MyText\",\n \"audit_comment\": null,\n \"id\": 981457253\n }\n },\n {\n \"config_template\": {\n \"template_kind\": {\n \"name\": \"gPXE\",\n \"id\": 158998239\n },\n \"snippet\": null,\n \"name\": \"MyString\",\n \"template\": \"MyText\",\n \"audit_comment\": null,\n \"id\": 943779058\n }\n },\n {\n \"config_template\": {\n \"template_kind\": {\n \"name\": \"provision\",\n \"id\": 983253650\n },\n \"snippet\": null,\n \"name\": \"MyString2\",\n \"template\": \"MyText\",\n \"audit_comment\": null,\n \"id\": 269958254\n }\n },\n {\n \"config_template\": {\n \"template_kind\": {\n \"name\": \"PXELinux\",\n \"id\": 452984334\n },\n \"snippet\": null,\n \"name\": \"PXE Default File\",\n \"template\": \"default linux~label linux~kernel <%= @kernel %>~append initrd=<%= @initrd %> ksdevice=bootif network kssendmac\",\n \"audit_comment\": null,\n \"id\": 352050261\n }\n },\n {\n \"config_template\": {\n \"\": null,\n \"snippet\": null,\n \"name\": \"PXE Default Menu\",\n \"template\": \"FOO\",\n \"audit_comment\": null,\n \"id\": 684651467\n }\n },\n {\n \"config_template\": {\n \"template_kind\": {\n \"name\": \"PXELinux\",\n \"id\": 452984334\n },\n \"snippet\": null,\n \"name\": \"centos5_3_pxelinux\",\n \"template\": \"default linux~label linux~kernel <%= @kernel %>~append initrd=<%= @initrd %> ks=<%= foreman_url(\\\"kickstart\\\")%> ksdevice=bootif network kssendmac\",\n \"audit_comment\": null,\n \"id\": 1007981701\n }\n }\n]"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"GET","short_description":"List templates","api_url":"/api/config_templates"}],"doc_url":"/apidoc/config_templates/index","params":[{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"search","name":"search","expected_type":"string","description":"<p>filter results</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"order","name":"order","expected_type":"string","description":"<p>sort results</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"page","name":"page","expected_type":"string","description":"<p>paginate results</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"per_page","name":"per_page","expected_type":"string","description":"<p>number of entries per request</p>\n"}],"name":"index"},{"see_url":null,"examples":["GET /api/config_templates/centos5_3_pxelinux\n200\n{\n \"config_template\": {\n \"template_kind\": {\n \"name\": \"PXELinux\",\n \"id\": 452984334\n },\n \"snippet\": null,\n \"name\": \"centos5_3_pxelinux\",\n \"template\": \"default linux~label linux~kernel <%= @kernel %>~append initrd=<%= @initrd %> ks=<%= foreman_url(\\\"kickstart\\\")%> ksdevice=bootif network kssendmac\",\n \"audit_comment\": null,\n \"id\": 1007981701\n }\n}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"GET","short_description":"Show template details","api_url":"/api/config_templates/:id"}],"doc_url":"/apidoc/config_templates/show","params":[{"allow_nil":false,"required":true,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","full_name":"id","name":"id","expected_type":"string","description":""}],"name":"show"},{"see_url":null,"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 \"\": null,\n \"snippet\": null,\n \"name\": \"RandomName\",\n \"template\": \"This is a test template\",\n \"audit_comment\": null,\n \"id\": 1007981702\n }\n}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"POST","short_description":"Create a template","api_url":"/api/config_templates"}],"doc_url":"/apidoc/config_templates/create","params":[{"allow_nil":false,"required":true,"validator":"Must be a Hash","params":[{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"config_template[name]","name":"name","expected_type":"string","description":"<p>template name</p>\n"},{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"config_template[template]","name":"template","expected_type":"string","description":""},{"allow_nil":true,"required":false,"validator":"Must be 'true' or 'false'","full_name":"config_template[snippet]","name":"snippet","expected_type":"string","description":""},{"allow_nil":true,"required":false,"validator":"Must be String","full_name":"config_template[audit_comment]","name":"audit_comment","expected_type":"string","description":""},{"allow_nil":true,"required":false,"validator":"Must be a number.","full_name":"config_template[template_kind_id]","name":"template_kind_id","expected_type":"string","description":"<p>not relevant for snippet</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be Array","full_name":"config_template[template_combinations_attributes]","name":"template_combinations_attributes","expected_type":"string","description":"<p>Array of template combinations (hostgroup<em>id, environment</em>id)</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be Array","full_name":"config_template[operatingsystem_ids]","name":"operatingsystem_ids","expected_type":"string","description":"<p>Array of operating systems ID to associate the template with</p>\n"}],"full_name":"config_template","name":"config_template","expected_type":"hash","description":""}],"name":"create"},{"see_url":null,"examples":["PUT /api/config_templates/centos5_3_pxelinux\n{\n \"config_template\": {\n \"template\": \"tmp\",\n \"audit_comment\": \"aha\"\n }\n}\n200\n{\n \"config_template\": {\n \"template_kind\": {\n \"name\": \"PXELinux\",\n \"id\": 452984334\n },\n \"snippet\": null,\n \"name\": \"centos5_3_pxelinux\",\n \"template\": \"tmp\",\n \"id\": 1007981701\n }\n}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"PUT","short_description":"Update a template","api_url":"/api/config_templates/:id"}],"doc_url":"/apidoc/config_templates/update","params":[{"allow_nil":false,"required":true,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","full_name":"id","name":"id","expected_type":"string","description":""},{"allow_nil":false,"required":true,"validator":"Must be a Hash","params":[{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"config_template[name]","name":"name","expected_type":"string","description":"<p>template name</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"config_template[template]","name":"template","expected_type":"string","description":""},{"allow_nil":false,"required":false,"validator":"Must be 'true' or 'false'","full_name":"config_template[snippet]","name":"snippet","expected_type":"string","description":""},{"allow_nil":true,"required":false,"validator":"Must be String","full_name":"config_template[audit_comment]","name":"audit_comment","expected_type":"string","description":""},{"allow_nil":false,"required":false,"validator":"Must be a number.","full_name":"config_template[template_kind_id]","name":"template_kind_id","expected_type":"string","description":"<p>not relevant for snippet</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be Array","full_name":"config_template[template_combinations_attributes]","name":"template_combinations_attributes","expected_type":"string","description":"<p>Array of template combinations (hostgroup<em>id, environment</em>id)</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be Array","full_name":"config_template[operatingsystem_ids]","name":"operatingsystem_ids","expected_type":"string","description":"<p>Array of operating systems ID to associate the template with</p>\n"}],"full_name":"config_template","name":"config_template","expected_type":"hash","description":""}],"name":"update"},{"see_url":null,"examples":[],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"GET","short_description":null,"api_url":"/api/config_templates/revision"}],"doc_url":"/apidoc/config_templates/revision","params":[{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"version","name":"version","expected_type":"string","description":"<p>template version</p>\n"}],"name":"revision"},{"see_url":null,"examples":["DELETE /api/config_templates/centos5_3_pxelinux\n200\n{\n \"config_template\": {\n \"template_kind\": {\n \"name\": \"PXELinux\",\n \"id\": 452984334\n },\n \"snippet\": null,\n \"name\": \"centos5_3_pxelinux\",\n \"template\": \"default linux~label linux~kernel <%= @kernel %>~append initrd=<%= @initrd %> ks=<%= foreman_url(\\\"kickstart\\\")%> ksdevice=bootif network kssendmac\",\n \"id\": 1007981701\n }\n}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"DELETE","short_description":"Delete a template","api_url":"/api/config_templates/:id"}],"doc_url":"/apidoc/config_templates/destroy","params":[{"allow_nil":false,"required":true,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","full_name":"id","name":"id","expected_type":"string","description":""}],"name":"destroy"},{"see_url":null,"examples":["GET /api/config_templates/build_pxe_default\n200\nPXE Default file has been deployed to all Smart Proxies"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"GET","short_description":"Change the default PXE menu on all configured TFTP servers","api_url":"/api/config_templates/build_pxe_default"}],"doc_url":"/apidoc/config_templates/build_pxe_default","params":[],"name":"build_pxe_default"}],"version":"1","full_description":"","formats":[],"short_description":"","doc_url":"/apidoc/config_templates","name":"Config templates","api_url":"/api"},"models":{"methods":[{"see_url":null,"examples":["GET /api/models\n200\n[\n {\n \"model\": {\n \"created_at\": \"2012-11-21T13:01:46Z\",\n \"vendor_class\": null,\n \"hardware_model\": null,\n \"name\": \"KVM\",\n \"updated_at\": \"2012-11-21T13:01:46Z\",\n \"info\": \"Virtual Machine\",\n \"id\": 980190962\n }\n },\n {\n \"model\": {\n \"created_at\": \"2012-11-21T13:01:46Z\",\n \"vendor_class\": \"Sun-Fire-V210\",\n \"hardware_model\": \"SUN4U\",\n \"name\": \"SUN V210\",\n \"updated_at\": \"2012-11-21T13:01:46Z\",\n \"info\": null,\n \"id\": 139037058\n }\n }\n]"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"GET","short_description":"List all models.","api_url":"/api/models"}],"doc_url":"/apidoc/models/index","params":[{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"search","name":"search","expected_type":"string","description":"<p>filter results</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"order","name":"order","expected_type":"string","description":"<p>sort results</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"page","name":"page","expected_type":"string","description":"<p>paginate results</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"per_page","name":"per_page","expected_type":"string","description":"<p>number of entries per request</p>\n"}],"name":"index"},{"see_url":null,"examples":["GET /api/models/980190962\n200\n{\n \"model\": {\n \"created_at\": \"2012-11-21T13:01:46Z\",\n \"vendor_class\": null,\n \"hardware_model\": null,\n \"name\": \"KVM\",\n \"updated_at\": \"2012-11-21T13:01:46Z\",\n \"info\": \"Virtual Machine\",\n \"id\": 980190962\n }\n}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"GET","short_description":"Show a model.","api_url":"/api/models/:id"}],"doc_url":"/apidoc/models/show","params":[{"allow_nil":false,"required":true,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","full_name":"id","name":"id","expected_type":"string","description":""}],"name":"show"},{"see_url":null,"examples":["POST /api/models\n{\n \"model\": {\n \"name\": \"new model\"\n }\n}\n201\n{\n \"model\": {\n \"created_at\": \"2012-11-21T13:01:53Z\",\n \"vendor_class\": null,\n \"hardware_model\": null,\n \"name\": \"new model\",\n \"updated_at\": \"2012-11-21T13:01:53Z\",\n \"info\": null,\n \"id\": 980190963\n }\n}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"POST","short_description":"Create a model.","api_url":"/api/models"}],"doc_url":"/apidoc/models/create","params":[{"allow_nil":false,"required":true,"validator":"Must be a Hash","params":[{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"model[name]","name":"name","expected_type":"string","description":""},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"model[info]","name":"info","expected_type":"string","description":""},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"model[vendor_class]","name":"vendor_class","expected_type":"string","description":""},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"model[hardware_model]","name":"hardware_model","expected_type":"string","description":""}],"full_name":"model","name":"model","expected_type":"hash","description":""}],"name":"create"},{"see_url":null,"examples":["PUT /api/models/980190962\n{\n \"name\": \"KVM\"\n}\n200\n{\n \"model\": {\n \"created_at\": \"2012-11-21T13:01:46Z\",\n \"vendor_class\": null,\n \"hardware_model\": null,\n \"name\": \"KVM\",\n \"updated_at\": \"2012-11-21T13:01:46Z\",\n \"info\": \"Virtual Machine\",\n \"id\": 980190962\n }\n}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"PUT","short_description":"Update a model.","api_url":"/api/models/:id"}],"doc_url":"/apidoc/models/update","params":[{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"id","name":"id","expected_type":"string","description":""},{"allow_nil":false,"required":true,"validator":"Must be a Hash","params":[{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"model[name]","name":"name","expected_type":"string","description":""},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"model[info]","name":"info","expected_type":"string","description":""},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"model[vendor_class]","name":"vendor_class","expected_type":"string","description":""},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"model[hardware_model]","name":"hardware_model","expected_type":"string","description":""}],"full_name":"model","name":"model","expected_type":"hash","description":""}],"name":"update"},{"see_url":null,"examples":["DELETE /api/models/980190962\n200\n{\n \"model\": {\n \"created_at\": \"2012-11-21T13:01:46Z\",\n \"vendor_class\": null,\n \"hardware_model\": null,\n \"name\": \"KVM\",\n \"updated_at\": \"2012-11-21T13:01:46Z\",\n \"info\": \"Virtual Machine\",\n \"id\": 980190962\n }\n}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"DELETE","short_description":"Delete a model.","api_url":"/api/models/:id"}],"doc_url":"/apidoc/models/destroy","params":[{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"id","name":"id","expected_type":"string","description":""}],"name":"destroy"}],"version":"1","full_description":"","formats":[],"short_description":"","doc_url":"/apidoc/models","name":"Models","api_url":"/api"},"users":{"methods":[{"see_url":null,"examples":["GET /api/users\n200\n[\n {\n \"user\": {\n \"mail\": \"admin@someware.com\",\n \"created_at\": \"2012-11-21T13:01:46Z\",\n \"auth_source_id\": 980190962,\n \"filter_on_owner\": null,\n \"hostgroups_andor\": \"or\",\n \"compute_resources_andor\": \"or\",\n \"facts_andor\": \"or\",\n \"admin\": true,\n \"lastname\": \"User\",\n \"last_login_on\": \"2009-10-12T21:50:04Z\",\n \"login\": \"admin\",\n \"role_id\": null,\n \"updated_at\": \"2012-11-21T13:01:46Z\",\n \"domains_andor\": \"or\",\n \"id\": 135138680,\n \"firstname\": \"Admin\"\n }\n },\n {\n \"user\": {\n \"mail\": \"testuser@someware.com\",\n \"created_at\": \"2012-11-21T13:01:46Z\",\n \"auth_source_id\": 200482051,\n \"filter_on_owner\": null,\n \"hostgroups_andor\": \"or\",\n \"compute_resources_andor\": \"or\",\n \"facts_andor\": \"or\",\n \"admin\": false,\n \"lastname\": \"User\",\n \"last_login_on\": \"2009-10-12T21:50:04Z\",\n \"login\": \"test\",\n \"role_id\": null,\n \"updated_at\": \"2012-11-21T13:01:46Z\",\n \"domains_andor\": \"or\",\n \"id\": 200482051,\n \"firstname\": \"test\"\n }\n },\n {\n \"user\": {\n \"mail\": \"usertwo@someware.com\",\n \"created_at\": \"2012-11-21T13:01:46Z\",\n \"auth_source_id\": 980190962,\n \"filter_on_owner\": null,\n \"hostgroups_andor\": \"or\",\n \"compute_resources_andor\": \"or\",\n \"facts_andor\": \"or\",\n \"admin\": false,\n \"lastname\": \"User\",\n \"last_login_on\": \"2009-10-12T21:50:04Z\",\n \"login\": \"two\",\n \"role_id\": null,\n \"updated_at\": \"2012-11-21T13:01:46Z\",\n \"domains_andor\": \"or\",\n \"id\": 298486374,\n \"firstname\": \"Two\"\n }\n },\n {\n \"user\": {\n \"mail\": \"userone@someware.com\",\n \"created_at\": \"2012-11-21T13:01:46Z\",\n \"auth_source_id\": 980190962,\n \"filter_on_owner\": null,\n \"hostgroups_andor\": \"or\",\n \"compute_resources_andor\": \"or\",\n \"facts_andor\": \"or\",\n \"admin\": false,\n \"lastname\": \"User\",\n \"last_login_on\": \"2009-10-12T21:50:04Z\",\n \"login\": \"one\",\n \"role_id\": null,\n \"updated_at\": \"2012-11-21T13:01:46Z\",\n \"domains_andor\": \"or\",\n \"id\": 980190962,\n \"firstname\": \"One\"\n }\n }\n]"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"GET","short_description":"List all users.","api_url":"/api/users"}],"doc_url":"/apidoc/users/index","params":[{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"search","name":"search","expected_type":"string","description":"<p>filter results</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"order","name":"order","expected_type":"string","description":"<p>sort results</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"page","name":"page","expected_type":"string","description":"<p>paginate results</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"per_page","name":"per_page","expected_type":"string","description":"<p>number of entries per request</p>\n"}],"name":"index"},{"see_url":null,"examples":["GET /api/users/980190962-one\n200\n{\n \"user\": {\n \"mail\": \"userone@someware.com\",\n \"created_at\": \"2012-11-21T13:01:46Z\",\n \"auth_source_id\": 980190962,\n \"filter_on_owner\": null,\n \"hostgroups_andor\": \"or\",\n \"\": [],\n \"compute_resources_andor\": \"or\",\n \"facts_andor\": \"or\",\n \"admin\": false,\n \"lastname\": \"User\",\n \"auth_source_ldap\": {\n \"created_at\": \"2012-11-21T13:01:46Z\",\n \"attr_lastname\": \"sn\",\n \"attr_login\": \"uid\",\n \"attr_mail\": \"mail\",\n \"type\": \"AuthSourceLdap\",\n \"tls\": true,\n \"host\": \"ldap\",\n \"account\": null,\n \"onthefly_register\": true,\n \"name\": \"ldap\",\n \"updated_at\": \"2012-11-21T13:01:46Z\",\n \"attr_firstname\": \"givenName\",\n \"base_dn\": \"dn=x,dn=y\",\n \"id\": 980190962,\n \"port\": 123\n },\n \"last_login_on\": \"2009-10-12T21:50:04Z\",\n \"login\": \"one\",\n \"role_id\": null,\n \"updated_at\": \"2012-11-21T13:01:46Z\",\n \"domains_andor\": \"or\",\n \"id\": 980190962,\n \"firstname\": \"One\"\n }\n}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"GET","short_description":"Show an user.","api_url":"/api/users/:id"}],"doc_url":"/apidoc/users/show","params":[{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"id","name":"id","expected_type":"string","description":""}],"name":"show"},{"see_url":null,"examples":[],"full_description":"<p>Adds role &#39;Anonymous&#39; to the user by default</p>\n","formats":[],"see":null,"errors":[],"apis":[{"http_method":"POST","short_description":"Create an user.","api_url":"/api/users"}],"doc_url":"/apidoc/users/create","params":[{"allow_nil":false,"required":true,"validator":"Must be a Hash","params":[{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"user[login]","name":"login","expected_type":"string","description":""},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"user[firstname]","name":"firstname","expected_type":"string","description":""},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"user[lastname]","name":"lastname","expected_type":"string","description":""},{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"user[mail]","name":"mail","expected_type":"string","description":""},{"allow_nil":false,"required":false,"validator":"Must be 'true' or 'false'","full_name":"user[admin]","name":"admin","expected_type":"string","description":"<p>Is an admin account?</p>\n"},{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"user[password]","name":"password","expected_type":"string","description":""},{"allow_nil":false,"required":true,"validator":"Must be Integer","full_name":"user[auth_source_id]","name":"auth_source_id","expected_type":"numeric","description":""}],"full_name":"user","name":"user","expected_type":"hash","description":""}],"name":"create"},{"see_url":null,"examples":["PUT /api/users/980190963\n{\n \"user\": {\n \"login\": \"johnsmith\",\n \"password\": \"dummy\",\n \"password_confirmation\": \"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}"],"full_description":"<p>Adds role &#39;Anonymous&#39; to the user if it is not already present.\nOnly admin can set admin account.</p>\n","formats":[],"see":null,"errors":[],"apis":[{"http_method":"PUT","short_description":"Update an user.","api_url":"/api/users/:id"}],"doc_url":"/apidoc/users/update","params":[{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"id","name":"id","expected_type":"string","description":""},{"allow_nil":false,"required":true,"validator":"Must be a Hash","params":[{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"user[login]","name":"login","expected_type":"string","description":""},{"allow_nil":true,"required":false,"validator":"Must be String","full_name":"user[firstname]","name":"firstname","expected_type":"string","description":""},{"allow_nil":true,"required":false,"validator":"Must be String","full_name":"user[lastname]","name":"lastname","expected_type":"string","description":""},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"user[mail]","name":"mail","expected_type":"string","description":""},{"allow_nil":false,"required":false,"validator":"Must be 'true' or 'false'","full_name":"user[admin]","name":"admin","expected_type":"string","description":"<p>Is an admin account?</p>\n"},{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"user[password]","name":"password","expected_type":"string","description":""}],"full_name":"user","name":"user","expected_type":"hash","description":""}],"name":"update"},{"see_url":null,"examples":["DELETE /api/users/980190962\n200\n{\n \"user\": {\n \"mail\": \"userone@someware.com\",\n \"created_at\": \"2012-11-21T13:01:46Z\",\n \"auth_source_id\": 980190962,\n \"password_hash\": null,\n \"filter_on_owner\": null,\n \"hostgroups_andor\": \"or\",\n \"compute_resources_andor\": \"or\",\n \"facts_andor\": \"or\",\n \"admin\": false,\n \"lastname\": \"User\",\n \"last_login_on\": \"2009-10-12T21:50:04Z\",\n \"login\": \"one\",\n \"role_id\": null,\n \"updated_at\": \"2012-11-21T13:01:46Z\",\n \"password_salt\": null,\n \"domains_andor\": \"or\",\n \"id\": 980190962,\n \"firstname\": \"One\"\n }\n}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"DELETE","short_description":"Delete an user.","api_url":"/api/users/:id"}],"doc_url":"/apidoc/users/destroy","params":[{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"id","name":"id","expected_type":"string","description":""}],"name":"destroy"}],"version":"1","full_description":"","formats":[],"short_description":"","doc_url":"/apidoc/users","name":"Users","api_url":"/api"},"hostgroups":{"methods":[{"see_url":null,"examples":["GET /api/hostgroups\n200\n[\n {\n \"hostgroup\": {\n \"puppetclass_ids\": [],\n \"ancestry\": null,\n \"operatingsystem_id\": 309172073,\n \"parameters\": {},\n \"domain_id\": null,\n \"subnet_id\": null,\n \"name\": \"db\",\n \"environment_id\": 334344675,\n \"id\": 603241515,\n \"label\": \"db\"\n }\n },\n {\n \"hostgroup\": {\n \"puppetclass_ids\": [\n 980190962\n ],\n \"ancestry\": null,\n \"operatingsystem_id\": 309172073,\n \"parameters\": {\n \"group1\": \"group1\"\n },\n \"domain_id\": 22495316,\n \"subnet_id\": null,\n \"name\": \"Common\",\n \"environment_id\": 334344675,\n \"id\": 636252244,\n \"label\": \"Common\"\n }\n },\n {\n \"hostgroup\": {\n \"puppetclass_ids\": [],\n \"ancestry\": null,\n \"operatingsystem_id\": null,\n \"parameters\": {},\n \"domain_id\": null,\n \"subnet_id\": null,\n \"name\": \"Unusual\",\n \"environment_id\": null,\n \"id\": 866317115,\n \"label\": \"Unusual\"\n }\n }\n]"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"GET","short_description":"List all hostgroups.","api_url":"/api/hostgroups"}],"doc_url":"/apidoc/hostgroups/index","params":[{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"search","name":"search","expected_type":"string","description":"<p>filter results</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"order","name":"order","expected_type":"string","description":"<p>sort results</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"page","name":"page","expected_type":"string","description":"<p>paginate results</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"per_page","name":"per_page","expected_type":"string","description":"<p>number of entries per request</p>\n"}],"name":"index"},{"see_url":null,"examples":["GET /api/hostgroups/636252244-common\n200\n{\n \"hostgroup\": {\n \"puppetclass_ids\": [\n 980190962\n ],\n \"ancestry\": null,\n \"operatingsystem_id\": 309172073,\n \"parameters\": {\n \"group1\": \"group1\"\n },\n \"domain_id\": 22495316,\n \"subnet_id\": null,\n \"name\": \"Common\",\n \"environment_id\": 334344675,\n \"id\": 636252244,\n \"label\": \"Common\"\n }\n}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"GET","short_description":"Show a hostgroup.","api_url":"/api/hostgroups/:id"}],"doc_url":"/apidoc/hostgroups/show","params":[{"allow_nil":false,"required":true,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","full_name":"id","name":"id","expected_type":"string","description":""}],"name":"show"},{"see_url":null,"examples":["POST /api/hostgroups\n{\n \"hostgroup\": {\n \"name\": \"TestHostgroup\"\n }\n}\n200\n{\n \"hostgroup\": {\n \"puppetclass_ids\": [],\n \"ancestry\": null,\n \"operatingsystem_id\": null,\n \"parameters\": {},\n \"domain_id\": null,\n \"subnet_id\": null,\n \"name\": \"TestHostgroup\",\n \"environment_id\": null,\n \"id\": 866317116,\n \"label\": \"TestHostgroup\"\n }\n}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"POST","short_description":"Create an hostgroup.","api_url":"/api/hostgroups"}],"doc_url":"/apidoc/hostgroups/create","params":[{"allow_nil":false,"required":true,"validator":"Must be a Hash","params":[{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"hostgroup[name]","name":"name","expected_type":"string","description":""},{"allow_nil":false,"required":false,"validator":"Must be a number.","full_name":"hostgroup[environment_id]","name":"environment_id","expected_type":"string","description":""},{"allow_nil":false,"required":false,"validator":"Must be a number.","full_name":"hostgroup[operatingsystem_id]","name":"operatingsystem_id","expected_type":"string","description":""},{"allow_nil":false,"required":false,"validator":"Must be a number.","full_name":"hostgroup[architecture_id]","name":"architecture_id","expected_type":"string","description":""},{"allow_nil":false,"required":false,"validator":"Must be a number.","full_name":"hostgroup[medium_id]","name":"medium_id","expected_type":"string","description":""},{"allow_nil":false,"required":false,"validator":"Must be a number.","full_name":"hostgroup[ptable_id]","name":"ptable_id","expected_type":"string","description":""},{"allow_nil":false,"required":false,"validator":"Must be a number.","full_name":"hostgroup[puppet_ca_proxy_id]","name":"puppet_ca_proxy_id","expected_type":"string","description":""},{"allow_nil":false,"required":false,"validator":"Must be a number.","full_name":"hostgroup[subnet_id]","name":"subnet_id","expected_type":"string","description":""},{"allow_nil":false,"required":false,"validator":"Must be a number.","full_name":"hostgroup[domain_id]","name":"domain_id","expected_type":"string","description":""},{"allow_nil":false,"required":false,"validator":"Must be a number.","full_name":"hostgroup[puppet_proxy_id]","name":"puppet_proxy_id","expected_type":"string","description":""}],"full_name":"hostgroup","name":"hostgroup","expected_type":"hash","description":""}],"name":"create"},{"see_url":null,"examples":["PUT /api/hostgroups/636252244-common\n{\n \"hostgroup\": {}\n}\n200\n{\n \"hostgroup\": {\n \"puppetclass_ids\": [\n 980190962\n ],\n \"ancestry\": null,\n \"operatingsystem_id\": 309172073,\n \"parameters\": {\n \"group1\": \"group1\"\n },\n \"domain_id\": 22495316,\n \"subnet_id\": null,\n \"name\": \"Common\",\n \"environment_id\": 334344675,\n \"id\": 636252244,\n \"label\": \"Common\"\n }\n}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"PUT","short_description":"Update an hostgroup.","api_url":"/api/hostgroups/:id"}],"doc_url":"/apidoc/hostgroups/update","params":[{"allow_nil":false,"required":true,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","full_name":"id","name":"id","expected_type":"string","description":""},{"allow_nil":false,"required":true,"validator":"Must be a Hash","params":[{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"hostgroup[name]","name":"name","expected_type":"string","description":""},{"allow_nil":false,"required":false,"validator":"Must be a number.","full_name":"hostgroup[environment_id]","name":"environment_id","expected_type":"string","description":""},{"allow_nil":false,"required":false,"validator":"Must be a number.","full_name":"hostgroup[operatingsystem_id]","name":"operatingsystem_id","expected_type":"string","description":""},{"allow_nil":false,"required":false,"validator":"Must be a number.","full_name":"hostgroup[architecture_id]","name":"architecture_id","expected_type":"string","description":""},{"allow_nil":false,"required":false,"validator":"Must be a number.","full_name":"hostgroup[medium_id]","name":"medium_id","expected_type":"string","description":""},{"allow_nil":false,"required":false,"validator":"Must be a number.","full_name":"hostgroup[ptable_id]","name":"ptable_id","expected_type":"string","description":""},{"allow_nil":false,"required":false,"validator":"Must be a number.","full_name":"hostgroup[puppet_ca_proxy_id]","name":"puppet_ca_proxy_id","expected_type":"string","description":""},{"allow_nil":false,"required":false,"validator":"Must be a number.","full_name":"hostgroup[subnet_id]","name":"subnet_id","expected_type":"string","description":""},{"allow_nil":false,"required":false,"validator":"Must be a number.","full_name":"hostgroup[domain_id]","name":"domain_id","expected_type":"string","description":""},{"allow_nil":false,"required":false,"validator":"Must be a number.","full_name":"hostgroup[puppet_proxy_id]","name":"puppet_proxy_id","expected_type":"string","description":""}],"full_name":"hostgroup","name":"hostgroup","expected_type":"hash","description":""}],"name":"update"},{"see_url":null,"examples":["DELETE /api/hostgroups/636252244-common\n200\n{\n \"hostgroup\": {\n \"puppetclass_ids\": [],\n \"ancestry\": null,\n \"operatingsystem_id\": 309172073,\n \"parameters\": {},\n \"domain_id\": 22495316,\n \"subnet_id\": null,\n \"name\": \"Common\",\n \"environment_id\": 334344675,\n \"id\": 636252244,\n \"label\": \"Common\"\n }\n}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"DELETE","short_description":"Delete an hostgroup.","api_url":"/api/hostgroups/:id"}],"doc_url":"/apidoc/hostgroups/destroy","params":[{"allow_nil":false,"required":true,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","full_name":"id","name":"id","expected_type":"string","description":""}],"name":"destroy"}],"version":"1","full_description":"","formats":[],"short_description":"","doc_url":"/apidoc/hostgroups","name":"Hostgroups","api_url":"/api"},"audits":{"methods":[{"see_url":null,"examples":["GET /api/audits\n200\n[\n {\n \"audit\": {\n \"user_type\": null,\n \"action\": \"update\",\n \"created_at\": \"2009-12-14T08:01:17Z\",\n \"auditable_name\": null,\n \"comment\": null,\n \"auditable_type\": \"Host\",\n \"associated_type\": \"Host\",\n \"user_id\": null,\n \"associated_id\": 272,\n \"audited_changes\": {\n \"architecture_id\": [\n 10463,\n 10466\n ]\n },\n \"remote_address\": null,\n \"version\": 1,\n \"associated_name\": null,\n \"id\": 1,\n \"auditable_id\": 0\n }\n }\n]"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"GET","short_description":"List all audits.","api_url":"/api/audits"}],"doc_url":"/apidoc/audits/index","params":[{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"search","name":"search","expected_type":"string","description":"<p>filter results</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"order","name":"order","expected_type":"string","description":"<p>sort results</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"page","name":"page","expected_type":"string","description":"<p>paginate results</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"per_page","name":"per_page","expected_type":"string","description":"<p>number of entries per request</p>\n"}],"name":"index"},{"see_url":null,"examples":["GET /api/audits/1\n200\n{\n \"audit\": {\n \"user_type\": null,\n \"action\": \"update\",\n \"created_at\": \"2009-12-14T08:01:17Z\",\n \"auditable_name\": null,\n \"comment\": null,\n \"auditable_type\": \"Host\",\n \"associated_type\": \"Host\",\n \"user_id\": null,\n \"associated_id\": 272,\n \"audited_changes\": {\n \"architecture_id\": [\n 10463,\n 10466\n ]\n },\n \"remote_address\": null,\n \"version\": 1,\n \"associated_name\": null,\n \"id\": 1,\n \"auditable_id\": 0\n }\n}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"GET","short_description":"Show an audit","api_url":"/api/audits/:id"}],"doc_url":"/apidoc/audits/show","params":[{"allow_nil":false,"required":true,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","full_name":"id","name":"id","expected_type":"string","description":""}],"name":"show"}],"version":"1","full_description":"","formats":[],"short_description":"","doc_url":"/apidoc/audits","name":"Audits","api_url":"/api"},"auth_source_ldaps":{"methods":[{"see_url":null,"examples":["GET /api/auth_source_ldaps\n200\n[\n {\n \"auth_source_ldap\": {\n \"created_at\": \"2012-11-21T13:01:46Z\",\n \"attr_lastname\": \"sn\",\n \"attr_login\": \"uid\",\n \"attr_mail\": \"mail\",\n \"type\": \"AuthSourceLdap\",\n \"tls\": true,\n \"host\": \"ldap\",\n \"account\": null,\n \"onthefly_register\": true,\n \"name\": \"ldap\",\n \"updated_at\": \"2012-11-21T13:01:46Z\",\n \"attr_firstname\": \"givenName\",\n \"base_dn\": \"dn=x,dn=y\",\n \"id\": 980190962,\n \"port\": 123\n }\n }\n]"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"GET","short_description":"List all authsource ldaps","api_url":"/api/auth_source_ldaps"}],"doc_url":"/apidoc/auth_source_ldaps/index","params":[{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"page","name":"page","expected_type":"string","description":"<p>paginate results</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"per_page","name":"per_page","expected_type":"string","description":"<p>number of entries per request</p>\n"}],"name":"index"},{"see_url":null,"examples":["GET /api/auth_source_ldaps/980190962\n200\n{\n \"auth_source_ldap\": {\n \"created_at\": \"2012-11-21T13:01:46Z\",\n \"attr_lastname\": \"sn\",\n \"attr_login\": \"uid\",\n \"attr_mail\": \"mail\",\n \"type\": \"AuthSourceLdap\",\n \"tls\": true,\n \"host\": \"ldap\",\n \"account\": null,\n \"onthefly_register\": true,\n \"name\": \"ldap\",\n \"updated_at\": \"2012-11-21T13:01:46Z\",\n \"attr_firstname\": \"givenName\",\n \"base_dn\": \"dn=x,dn=y\",\n \"id\": 980190962,\n \"port\": 123\n }\n}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"GET","short_description":"Show an authsource ldap.","api_url":"/api/auth_source_ldaps/:id"}],"doc_url":"/apidoc/auth_source_ldaps/show","params":[{"allow_nil":false,"required":true,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","full_name":"id","name":"id","expected_type":"string","description":""}],"name":"show"},{"see_url":null,"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 \"created_at\": \"2012-11-21T13:01:47Z\",\n \"attr_lastname\": null,\n \"attr_login\": null,\n \"attr_mail\": null,\n \"tls\": false,\n \"host\": \"ldap2\",\n \"account\": null,\n \"onthefly_register\": false,\n \"name\": \"ldap2\",\n \"updated_at\": \"2012-11-21T13:01:47Z\",\n \"attr_firstname\": null,\n \"account_password\": null,\n \"base_dn\": null,\n \"id\": 980190963,\n \"port\": 389\n }\n}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"POST","short_description":"Create an auth_source_ldap.","api_url":"/api/auth_source_ldaps"}],"doc_url":"/apidoc/auth_source_ldaps/create","params":[{"allow_nil":false,"required":true,"validator":"Must be a Hash","params":[{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"auth_source_ldap[name]","name":"name","expected_type":"string","description":""},{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"auth_source_ldap[host]","name":"host","expected_type":"string","description":""},{"allow_nil":false,"required":false,"validator":"Must be a number.","full_name":"auth_source_ldap[port]","name":"port","expected_type":"string","description":"<p>defaults to 389</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"auth_source_ldap[account]","name":"account","expected_type":"string","description":""},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"auth_source_ldap[base_dn]","name":"base_dn","expected_type":"string","description":""},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"auth_source_ldap[account_password]","name":"account_password","expected_type":"string","description":"<p>required if onthefly_register is true</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"auth_source_ldap[attr_login]","name":"attr_login","expected_type":"string","description":"<p>required if onthefly_register is true</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"auth_source_ldap[attr_firstname]","name":"attr_firstname","expected_type":"string","description":"<p>required if onthefly_register is true</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"auth_source_ldap[attr_lastname]","name":"attr_lastname","expected_type":"string","description":"<p>required if onthefly_register is true</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"auth_source_ldap[attr_mail]","name":"attr_mail","expected_type":"string","description":"<p>required if onthefly_register is true</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be 'true' or 'false'","full_name":"auth_source_ldap[onthefly_register]","name":"onthefly_register","expected_type":"string","description":""},{"allow_nil":false,"required":false,"validator":"Must be 'true' or 'false'","full_name":"auth_source_ldap[tls]","name":"tls","expected_type":"string","description":""}],"full_name":"auth_source_ldap","name":"auth_source_ldap","expected_type":"hash","description":""}],"name":"create"},{"see_url":null,"examples":["PUT /api/auth_source_ldaps/980190962\n{\n \"auth_source_ldap\": {}\n}\n200\n{\n \"auth_source_ldap\": {\n \"created_at\": \"2012-11-21T13:01:46Z\",\n \"attr_lastname\": \"sn\",\n \"attr_login\": \"uid\",\n \"attr_mail\": \"mail\",\n \"tls\": true,\n \"host\": \"ldap\",\n \"account\": null,\n \"onthefly_register\": true,\n \"name\": \"ldap\",\n \"updated_at\": \"2012-11-21T13:01:46Z\",\n \"attr_firstname\": \"givenName\",\n \"account_password\": null,\n \"base_dn\": \"dn=x,dn=y\",\n \"id\": 980190962,\n \"port\": 123\n }\n}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"PUT","short_description":"Update an auth_source_ldap.","api_url":"/api/auth_source_ldaps/:id"}],"doc_url":"/apidoc/auth_source_ldaps/update","params":[{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"id","name":"id","expected_type":"string","description":""},{"allow_nil":false,"required":true,"validator":"Must be a Hash","params":[{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"auth_source_ldap[name]","name":"name","expected_type":"string","description":""},{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"auth_source_ldap[host]","name":"host","expected_type":"string","description":""},{"allow_nil":false,"required":false,"validator":"Must be a number.","full_name":"auth_source_ldap[port]","name":"port","expected_type":"string","description":"<p>defaults to 389</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"auth_source_ldap[account]","name":"account","expected_type":"string","description":""},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"auth_source_ldap[base_dn]","name":"base_dn","expected_type":"string","description":""},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"auth_source_ldap[account_password]","name":"account_password","expected_type":"string","description":"<p>required if onthefly_register is true</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"auth_source_ldap[attr_login]","name":"attr_login","expected_type":"string","description":"<p>required if onthefly_register is true</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"auth_source_ldap[attr_firstname]","name":"attr_firstname","expected_type":"string","description":"<p>required if onthefly_register is true</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"auth_source_ldap[attr_lastname]","name":"attr_lastname","expected_type":"string","description":"<p>required if onthefly_register is true</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"auth_source_ldap[attr_mail]","name":"attr_mail","expected_type":"string","description":"<p>required if onthefly_register is true</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be 'true' or 'false'","full_name":"auth_source_ldap[onthefly_register]","name":"onthefly_register","expected_type":"string","description":""},{"allow_nil":false,"required":false,"validator":"Must be 'true' or 'false'","full_name":"auth_source_ldap[tls]","name":"tls","expected_type":"string","description":""}],"full_name":"auth_source_ldap","name":"auth_source_ldap","expected_type":"hash","description":""}],"name":"update"},{"see_url":null,"examples":["DELETE /api/auth_source_ldaps/980190962\n200\n{\n \"auth_source_ldap\": {\n \"created_at\": \"2012-11-21T13:01:46Z\",\n \"attr_lastname\": \"sn\",\n \"attr_login\": \"uid\",\n \"attr_mail\": \"mail\",\n \"tls\": true,\n \"host\": \"ldap\",\n \"account\": null,\n \"onthefly_register\": true,\n \"name\": \"ldap\",\n \"updated_at\": \"2012-11-21T13:01:46Z\",\n \"attr_firstname\": \"givenName\",\n \"account_password\": null,\n \"base_dn\": \"dn=x,dn=y\",\n \"id\": 980190962,\n \"port\": 123\n }\n}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"DELETE","short_description":"Delete an auth_source_ldap.","api_url":"/api/auth_source_ldaps/:id"}],"doc_url":"/apidoc/auth_source_ldaps/destroy","params":[{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"id","name":"id","expected_type":"string","description":""}],"name":"destroy"}],"version":"1","full_description":"","formats":[],"short_description":"","doc_url":"/apidoc/auth_source_ldaps","name":"Auth source ldaps","api_url":"/api"},"images":{"methods":[{"see_url":null,"examples":["GET /api/compute_resources/980190962/images\n200\n[\n {\n \"image\": {\n \"created_at\": \"2012-11-21T13:01:46Z\",\n \"uuid\": \"MyString2\",\n \"operatingsystem_id\": 309172073,\n \"compute_resource_id\": 980190962,\n \"architecture_id\": 501905019,\n \"name\": \"centos-2\",\n \"updated_at\": \"2012-11-21T13:01:46Z\",\n \"username\": \"MyString\",\n \"id\": 298486374\n }\n },\n {\n \"image\": {\n \"created_at\": \"2012-11-21T13:01:46Z\",\n \"uuid\": \"string-of-uuid\",\n \"operatingsystem_id\": 309172073,\n \"compute_resource_id\": 980190962,\n \"architecture_id\": 501905019,\n \"name\": \"centos-1\",\n \"updated_at\": \"2012-11-21T13:01:46Z\",\n \"username\": \"root\",\n \"id\": 980190962\n }\n }\n]"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"GET","short_description":"List all images for compute resource","api_url":"/api/compute_resources/:compute_resource_id/images"}],"doc_url":"/apidoc/images/index","params":[{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"search","name":"search","expected_type":"string","description":"<p>filter results</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"order","name":"order","expected_type":"string","description":"<p>sort results</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"page","name":"page","expected_type":"string","description":"<p>paginate results</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"per_page","name":"per_page","expected_type":"string","description":"<p>number of entries per request</p>\n"},{"allow_nil":false,"required":true,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","full_name":"compute_resource_id","name":"compute_resource_id","expected_type":"string","description":""}],"name":"index"},{"see_url":null,"examples":["GET /api/compute_resources/980190962/images/980190962\n200\n{\n \"image\": {\n \"created_at\": \"2012-11-21T13:01:46Z\",\n \"uuid\": \"string-of-uuid\",\n \"operatingsystem_id\": 309172073,\n \"compute_resource_id\": 980190962,\n \"architecture_id\": 501905019,\n \"name\": \"centos-1\",\n \"updated_at\": \"2012-11-21T13:01:46Z\",\n \"username\": \"root\",\n \"id\": 980190962\n }\n}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"GET","short_description":"Show an image","api_url":"/api/compute_resources/:compute_resource_id/images/:id"}],"doc_url":"/apidoc/images/show","params":[{"allow_nil":false,"required":true,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","full_name":"id","name":"id","expected_type":"string","description":""},{"allow_nil":false,"required":true,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","full_name":"compute_resource_id","name":"compute_resource_id","expected_type":"string","description":""}],"name":"show"},{"see_url":null,"examples":["POST /api/compute_resources/980190962/images\n{\n \"image\": {\n \"uuid\": \"abcdef\",\n \"operatingsystem_id\": 309172073,\n \"compute_resource_id\": 367690737,\n \"architecture_id\": 331892513,\n \"name\": \"TestImage\",\n \"username\": \"ec2-user\"\n }\n}\n201\n{\n \"compute_resource\": {\n \"created_at\": \"2012-11-21T13:01:46Z\",\n \"uuid\": \"MyString\",\n \"url\": \"qemu://stam/system\",\n \"name\": \"MyString\",\n \"updated_at\": \"2012-11-21T13:01:46Z\",\n \"user\": \"MyString\",\n \"id\": 980190962,\n \"description\": \"MyString\",\n \"attrs\": null\n }\n}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"POST","short_description":"Create a image","api_url":"/api/compute_resources/:compute_resource_id/images"}],"doc_url":"/apidoc/images/create","params":[{"allow_nil":false,"required":true,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","full_name":"compute_resource_id","name":"compute_resource_id","expected_type":"string","description":""},{"allow_nil":false,"required":true,"validator":"Must be a Hash","params":[{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"image[name]","name":"name","expected_type":"string","description":""},{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"image[username]","name":"username","expected_type":"string","description":""},{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"image[uuid]","name":"uuid","expected_type":"string","description":""},{"allow_nil":false,"required":true,"validator":"Must be a number.","full_name":"image[compute_resource_id]","name":"compute_resource_id","expected_type":"string","description":""},{"allow_nil":false,"required":true,"validator":"Must be a number.","full_name":"image[architecture_id]","name":"architecture_id","expected_type":"string","description":""},{"allow_nil":false,"required":true,"validator":"Must be a number.","full_name":"image[operatingsystem_id]","name":"operatingsystem_id","expected_type":"string","description":""}],"full_name":"image","name":"image","expected_type":"hash","description":""}],"name":"create"},{"see_url":null,"examples":["PUT /api/compute_resources/980190962/images/980190962\n{\n \"image\": {}\n}\n200\n{\n \"image\": {\n \"created_at\": \"2012-11-21T13:01:46Z\",\n \"uuid\": \"string-of-uuid\",\n \"operatingsystem_id\": 309172073,\n \"compute_resource_id\": 980190962,\n \"architecture_id\": 501905019,\n \"name\": \"centos-1\",\n \"updated_at\": \"2012-11-21T13:01:46Z\",\n \"username\": \"root\",\n \"id\": 980190962\n }\n}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"PUT","short_description":"Update a image.","api_url":"/api/compute_resources/:compute_resource_id/images/:id"}],"doc_url":"/apidoc/images/update","params":[{"allow_nil":false,"required":true,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","full_name":"compute_resource_id","name":"compute_resource_id","expected_type":"string","description":""},{"allow_nil":false,"required":true,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","full_name":"id","name":"id","expected_type":"string","description":""},{"allow_nil":false,"required":true,"validator":"Must be a Hash","params":[{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"image[name]","name":"name","expected_type":"string","description":""},{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"image[username]","name":"username","expected_type":"string","description":""},{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"image[uuid]","name":"uuid","expected_type":"string","description":""},{"allow_nil":false,"required":true,"validator":"Must be a number.","full_name":"image[compute_resource_id]","name":"compute_resource_id","expected_type":"string","description":""},{"allow_nil":false,"required":true,"validator":"Must be a number.","full_name":"image[architecture_id]","name":"architecture_id","expected_type":"string","description":""},{"allow_nil":false,"required":true,"validator":"Must be a number.","full_name":"image[operatingsystem_id]","name":"operatingsystem_id","expected_type":"string","description":""}],"full_name":"image","name":"image","expected_type":"hash","description":""}],"name":"update"},{"see_url":null,"examples":["DELETE /api/compute_resources/980190962/images/980190962\n200\n{\n \"image\": {\n \"created_at\": \"2012-11-21T13:01:46Z\",\n \"uuid\": \"string-of-uuid\",\n \"operatingsystem_id\": 309172073,\n \"compute_resource_id\": 980190962,\n \"architecture_id\": 501905019,\n \"name\": \"centos-1\",\n \"updated_at\": \"2012-11-21T13:01:46Z\",\n \"username\": \"root\",\n \"id\": 980190962\n }\n}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"DELETE","short_description":"Delete an image.","api_url":"/api/compute_resources/:compute_resource_id/images/:id"}],"doc_url":"/apidoc/images/destroy","params":[{"allow_nil":false,"required":true,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","full_name":"compute_resource_id","name":"compute_resource_id","expected_type":"string","description":""},{"allow_nil":false,"required":true,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","full_name":"id","name":"id","expected_type":"string","description":""}],"name":"destroy"}],"version":"1","full_description":"","formats":[],"short_description":"","doc_url":"/apidoc/images","name":"Images","api_url":"/api"},"architectures":{"methods":[{"see_url":null,"examples":["GET /api/architectures\n200\n[\n {\n \"architecture\": {\n \"created_at\": \"2012-11-21T13:01:46Z\",\n \"operatingsystem_ids\": [\n 442321401\n ],\n \"name\": \"sparc\",\n \"updated_at\": \"2012-11-21T13:01:46Z\",\n \"id\": 331892513\n }\n },\n {\n \"architecture\": {\n \"created_at\": \"2012-11-21T13:01:46Z\",\n \"operatingsystem_ids\": [],\n \"name\": \"s390\",\n \"updated_at\": \"2012-11-21T13:01:46Z\",\n \"id\": 381564594\n }\n },\n {\n \"architecture\": {\n \"created_at\": \"2012-11-21T13:01:46Z\",\n \"operatingsystem_ids\": [\n 309172073,\n 331303656,\n 1073012828\n ],\n \"name\": \"x86_64\",\n \"updated_at\": \"2012-11-21T13:01:46Z\",\n \"id\": 501905019\n }\n }\n]"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"GET","short_description":"List all architectures.","api_url":"/api/architectures"}],"doc_url":"/apidoc/architectures/index","params":[{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"search","name":"search","expected_type":"string","description":"<p>filter results</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"order","name":"order","expected_type":"string","description":"<p>sort results</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"page","name":"page","expected_type":"string","description":"<p>paginate results</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"per_page","name":"per_page","expected_type":"string","description":"<p>number of entries per request</p>\n"}],"name":"index"},{"see_url":null,"examples":["GET /api/architectures/x86_64\n200\n{\n \"architecture\": {\n \"created_at\": \"2012-11-21T13:01:46Z\",\n \"operatingsystem_ids\": [\n 309172073,\n 1073012828,\n 331303656\n ],\n \"name\": \"x86_64\",\n \"updated_at\": \"2012-11-21T13:01:46Z\",\n \"id\": 501905019\n }\n}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"GET","short_description":"Show an architecture.","api_url":"/api/architectures/:id"}],"doc_url":"/apidoc/architectures/show","params":[{"allow_nil":false,"required":true,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","full_name":"id","name":"id","expected_type":"string","description":""}],"name":"show"},{"see_url":null,"examples":["POST /api/architectures\n{\n \"architecture\": {\n \"name\": \"i386\"\n }\n}\n200\n{\n \"architecture\": {\n \"created_at\": \"2012-11-21T13:01:46Z\",\n \"operatingsystem_ids\": [],\n \"name\": \"i386\",\n \"updated_at\": \"2012-11-21T13:01:46Z\",\n \"id\": 501905020\n }\n}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"POST","short_description":"Create an architecture.","api_url":"/api/architectures"}],"doc_url":"/apidoc/architectures/create","params":[{"allow_nil":false,"required":true,"validator":"Must be a Hash","params":[{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"architecture[name]","name":"name","expected_type":"string","description":""},{"allow_nil":false,"required":false,"validator":"Must be Array","full_name":"architecture[operatingsystem_ids]","name":"operatingsystem_ids","expected_type":"string","description":"<p>Operatingsystem ID&#39;s</p>\n"}],"full_name":"architecture","name":"architecture","expected_type":"hash","description":""}],"name":"create"},{"see_url":null,"examples":["PUT /api/architectures/x86_64\n{\n \"architecture\": {}\n}\n200\n{\n \"architecture\": {\n \"name\": \"x86_64\",\n \"id\": 501905019\n }\n}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"PUT","short_description":"Update an architecture.","api_url":"/api/architectures/:id"}],"doc_url":"/apidoc/architectures/update","params":[{"allow_nil":false,"required":true,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","full_name":"id","name":"id","expected_type":"string","description":""},{"allow_nil":false,"required":true,"validator":"Must be a Hash","params":[{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"architecture[name]","name":"name","expected_type":"string","description":""},{"allow_nil":false,"required":false,"validator":"Must be Array","full_name":"architecture[operatingsystem_ids]","name":"operatingsystem_ids","expected_type":"string","description":"<p>Operatingsystem ID&#39;s</p>\n"}],"full_name":"architecture","name":"architecture","expected_type":"hash","description":""}],"name":"update"},{"see_url":null,"examples":["DELETE /api/architectures/s390\n200\n{\n \"architecture\": {\n \"name\": \"s390\",\n \"id\": 381564594\n }\n}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"DELETE","short_description":"Delete an architecture.","api_url":"/api/architectures/:id"}],"doc_url":"/apidoc/architectures/destroy","params":[{"allow_nil":false,"required":true,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","full_name":"id","name":"id","expected_type":"string","description":""}],"name":"destroy"}],"version":"1","full_description":"","formats":[],"short_description":"","doc_url":"/apidoc/architectures","name":"Architectures","api_url":"/api"},"usergroups":{"methods":[{"see_url":null,"examples":["GET /api/usergroups\n200\n[\n {\n \"usergroup\": {\n \"created_at\": \"2012-11-21T13:01:46Z\",\n \"name\": \"MyString\",\n \"updated_at\": \"2012-11-21T13:01:46Z\",\n \"id\": 980190962\n }\n },\n {\n \"usergroup\": {\n \"created_at\": \"2012-11-21T13:01:46Z\",\n \"name\": \"MyString2\",\n \"updated_at\": \"2012-11-21T13:01:46Z\",\n \"id\": 298486374\n }\n }\n]"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"GET","short_description":"List all usergroups.","api_url":"/api/usergroups"}],"doc_url":"/apidoc/usergroups/index","params":[{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"page","name":"page","expected_type":"string","description":"<p>paginate results</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"per_page","name":"per_page","expected_type":"string","description":"<p>number of entries per request</p>\n"}],"name":"index"},{"see_url":null,"examples":["GET /api/usergroups/980190962\n200\n{\n \"usergroup\": {\n \"created_at\": \"2012-11-21T13:01:46Z\",\n \"name\": \"MyString\",\n \"updated_at\": \"2012-11-21T13:01:46Z\",\n \"id\": 980190962\n }\n}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"GET","short_description":"Show a usergroup.","api_url":"/api/usergroups/:id"}],"doc_url":"/apidoc/usergroups/show","params":[{"allow_nil":false,"required":true,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","full_name":"id","name":"id","expected_type":"string","description":""}],"name":"show"},{"see_url":null,"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}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"POST","short_description":"Create a usergroup.","api_url":"/api/usergroups"}],"doc_url":"/apidoc/usergroups/create","params":[{"allow_nil":false,"required":true,"validator":"Must be a Hash","params":[{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"usergroup[name]","name":"name","expected_type":"string","description":""}],"full_name":"usergroup","name":"usergroup","expected_type":"hash","description":""}],"name":"create"},{"see_url":null,"examples":["PUT /api/usergroups/980190962\n{\n \"usergroup\": {}\n}\n200\n{\n \"usergroup\": {\n \"name\": \"MyString\",\n \"id\": 980190962\n }\n}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"PUT","short_description":"Update a usergroup.","api_url":"/api/usergroups/:id"}],"doc_url":"/apidoc/usergroups/update","params":[{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"id","name":"id","expected_type":"string","description":""},{"allow_nil":false,"required":true,"validator":"Must be a Hash","params":[{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"usergroup[name]","name":"name","expected_type":"string","description":""}],"full_name":"usergroup","name":"usergroup","expected_type":"hash","description":""}],"name":"update"},{"see_url":null,"examples":["DELETE /api/usergroups/980190962\n200\n{\n \"usergroup\": {\n \"name\": \"MyString\",\n \"id\": 980190962\n }\n}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"DELETE","short_description":"Delete a usergroup.","api_url":"/api/usergroups/:id"}],"doc_url":"/apidoc/usergroups/destroy","params":[{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"id","name":"id","expected_type":"string","description":""}],"name":"destroy"}],"version":"1","full_description":"","formats":[],"short_description":"","doc_url":"/apidoc/usergroups","name":"Usergroups","api_url":"/api"},"common_parameters":{"methods":[{"see_url":null,"examples":["GET /api/common_parameters\n200\n[\n {\n \"common_parameter\": {\n \"name\": \"test\",\n \"id\": 636252244,\n \"value\": \"myvalue\"\n }\n }\n]"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"GET","short_description":"List all common parameters.","api_url":"/api/common_parameters"}],"doc_url":"/apidoc/common_parameters/index","params":[{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"search","name":"search","expected_type":"string","description":"<p>filter results</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"order","name":"order","expected_type":"string","description":"<p>sort results</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"page","name":"page","expected_type":"string","description":"<p>paginate results</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"per_page","name":"per_page","expected_type":"string","description":"<p>number of entries per request</p>\n"}],"name":"index"},{"see_url":null,"examples":["GET /api/common_parameters/636252244\n200\n{\n \"common_parameter\": {\n \"name\": \"test\",\n \"id\": 636252244,\n \"value\": \"myvalue\"\n }\n}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"GET","short_description":"Show a common parameter.","api_url":"/api/common_parameters/:id"}],"doc_url":"/apidoc/common_parameters/show","params":[{"allow_nil":false,"required":true,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","full_name":"id","name":"id","expected_type":"string","description":""}],"name":"show"},{"see_url":null,"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 \"id\": 767575239,\n \"value\": \"123\"\n }\n}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"POST","short_description":"Create a common_parameter","api_url":"/api/common_parameters"}],"doc_url":"/apidoc/common_parameters/create","params":[{"allow_nil":false,"required":true,"validator":"Must be a Hash","params":[{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"common_parameter[name]","name":"name","expected_type":"string","description":""},{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"common_parameter[value]","name":"value","expected_type":"string","description":""}],"full_name":"common_parameter","name":"common_parameter","expected_type":"hash","description":""}],"name":"create"},{"see_url":null,"examples":["PUT /api/common_parameters/636252244\n{\n \"common_parameter\": {}\n}\n200\n{\n \"common_parameter\": {\n \"name\": \"test\",\n \"id\": 636252244,\n \"value\": \"myvalue\"\n }\n}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"PUT","short_description":"Update a common_parameter","api_url":"/api/common_parameters/:id"}],"doc_url":"/apidoc/common_parameters/update","params":[{"allow_nil":false,"required":true,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","full_name":"id","name":"id","expected_type":"string","description":""},{"allow_nil":false,"required":true,"validator":"Must be a Hash","params":[{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"common_parameter[name]","name":"name","expected_type":"string","description":""},{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"common_parameter[value]","name":"value","expected_type":"string","description":""}],"full_name":"common_parameter","name":"common_parameter","expected_type":"hash","description":""}],"name":"update"},{"see_url":null,"examples":["DELETE /api/common_parameters/636252244\n200\n{\n \"common_parameter\": {\n \"name\": \"test\",\n \"id\": 636252244,\n \"value\": \"myvalue\"\n }\n}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"DELETE","short_description":"Delete a common_parameter","api_url":"/api/common_parameters/:id"}],"doc_url":"/apidoc/common_parameters/destroy","params":[{"allow_nil":false,"required":true,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","full_name":"id","name":"id","expected_type":"string","description":""}],"name":"destroy"}],"version":"1","full_description":"","formats":[],"short_description":"","doc_url":"/apidoc/common_parameters","name":"Common parameters","api_url":"/api"},"subnets":{"methods":[{"see_url":null,"examples":["GET /api/subnets\n200\n[\n {\n \"subnet\": {\n \"from\": null,\n \"domain_ids\": [],\n \"vlanid\": null,\n \"priority\": null,\n \"mask\": \"255.255.255.0\",\n \"dns_id\": null,\n \"to\": null,\n \"network\": \"3.3.4.3\",\n \"gateway\": null,\n \"tftp_id\": 298486374,\n \"dhcp_id\": 980190962,\n \"dns_primary\": null,\n \"name\": \"three\",\n \"id\": 113629430,\n \"dns_secondary\": null\n }\n },\n {\n \"subnet\": {\n \"from\": null,\n \"domain_ids\": [\n 534821992\n ],\n \"vlanid\": null,\n \"priority\": null,\n \"mask\": \"255.255.255.0\",\n \"dns_id\": null,\n \"to\": null,\n \"network\": \"3.3.4.0\",\n \"gateway\": null,\n \"tftp_id\": 298486374,\n \"dhcp_id\": 980190962,\n \"dns_primary\": null,\n \"name\": \"two\",\n \"id\": 298486374,\n \"dns_secondary\": null\n }\n },\n {\n \"subnet\": {\n \"from\": null,\n \"domain_ids\": [\n 822172901\n ],\n \"vlanid\": null,\n \"priority\": null,\n \"mask\": \"255.255.255.0\",\n \"dns_id\": 113629430,\n \"to\": null,\n \"network\": \"2.3.4.0\",\n \"gateway\": null,\n \"tftp_id\": 298486374,\n \"dhcp_id\": 980190962,\n \"dns_primary\": null,\n \"name\": \"one\",\n \"id\": 980190962,\n \"dns_secondary\": null\n }\n }\n]"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"GET","short_description":"List of subnets","api_url":"/api/subnets"}],"doc_url":"/apidoc/subnets/index","params":[{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"search","name":"search","expected_type":"string","description":"<p>Filter results</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"order","name":"order","expected_type":"string","description":"<p>Sort results</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"page","name":"page","expected_type":"string","description":"<p>paginate results</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"per_page","name":"per_page","expected_type":"string","description":"<p>number of entries per request</p>\n"}],"name":"index"},{"see_url":null,"examples":["GET /api/subnets/980190962\n200\n{\n \"subnet\": {\n \"from\": null,\n \"domain_ids\": [\n 822172901\n ],\n \"vlanid\": null,\n \"priority\": null,\n \"mask\": \"255.255.255.0\",\n \"dns_id\": 113629430,\n \"to\": null,\n \"dhcp\": {\n \"url\": \"https://somewhere.net:8443\",\n \"name\": \"DHCP Proxy\",\n \"id\": 980190962\n },\n \"dns\": {\n \"url\": \"http://else.where:4567\",\n \"name\": \"DNS Proxy\",\n \"id\": 113629430\n },\n \"network\": \"2.3.4.0\",\n \"gateway\": null,\n \"tftp\": {\n \"url\": \"http://somewhere.else\",\n \"name\": \"TFTP Proxy\",\n \"id\": 298486374\n },\n \"tftp_id\": 298486374,\n \"dhcp_id\": 980190962,\n \"dns_primary\": null,\n \"name\": \"one\",\n \"id\": 980190962,\n \"dns_secondary\": null\n }\n}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"GET","short_description":"Show a subnet.","api_url":"/api/subnets/:id"}],"doc_url":"/apidoc/subnets/show","params":[{"allow_nil":false,"required":true,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","full_name":"id","name":"id","expected_type":"string","description":""}],"name":"show"},{"see_url":null,"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 \"from\": null,\n \"domain_ids\": [],\n \"vlanid\": null,\n \"priority\": null,\n \"mask\": \"255.255.255.0\",\n \"dns_id\": null,\n \"to\": null,\n \"dhcp\": null,\n \"dns\": null,\n \"network\": \"10.35.2.27\",\n \"gateway\": null,\n \"tftp\": null,\n \"tftp_id\": null,\n \"dhcp_id\": null,\n \"dns_primary\": null,\n \"name\": \"QA2\",\n \"id\": 980190963,\n \"dns_secondary\": null\n }\n}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"POST","short_description":"Create a subnet","api_url":"/api/subnets"}],"doc_url":"/apidoc/subnets/create","params":[{"allow_nil":false,"required":true,"validator":"Must be a Hash","params":[{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"subnet[name]","name":"name","expected_type":"string","description":"<p>Subnet name</p>\n"},{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"subnet[network]","name":"network","expected_type":"string","description":"<p>Subnet network</p>\n"},{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"subnet[mask]","name":"mask","expected_type":"string","description":"<p>Netmask for this subnet</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"subnet[gateway]","name":"gateway","expected_type":"string","description":"<p>Primary DNS for this subnet</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"subnet[dns_primary]","name":"dns_primary","expected_type":"string","description":"<p>Primary DNS for this subnet</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"subnet[dns_secondary]","name":"dns_secondary","expected_type":"string","description":"<p>Secondary DNS for this subnet</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"subnet[from]","name":"from","expected_type":"string","description":"<p>Starting IP Address for IP auto suggestion</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"subnet[to]","name":"to","expected_type":"string","description":"<p>Ending IP Address for IP auto suggestion</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"subnet[vlanid]","name":"vlanid","expected_type":"string","description":"<p>VLAN ID for this subnet</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be Array","full_name":"subnet[domain_ids]","name":"domain_ids","expected_type":"string","description":"<p>Domains in which this subnet is part</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be a number.","full_name":"subnet[dhcp_id]","name":"dhcp_id","expected_type":"string","description":"<p>DHCP Proxy to use within this subnet</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be a number.","full_name":"subnet[tftp_id]","name":"tftp_id","expected_type":"string","description":"<p>TFTP Proxy to use within this subnet</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be a number.","full_name":"subnet[dns_id]","name":"dns_id","expected_type":"string","description":"<p>DNS Proxy to use within this subnet</p>\n"}],"full_name":"subnet","name":"subnet","expected_type":"hash","description":""}],"name":"create"},{"see_url":null,"examples":["PUT /api/subnets/980190962\n{\n \"subnet\": {}\n}\n200\n{\n \"subnet\": {\n \"from\": null,\n \"domain_ids\": [\n 822172901\n ],\n \"vlanid\": null,\n \"priority\": null,\n \"mask\": \"255.255.255.0\",\n \"dns_id\": 113629430,\n \"to\": null,\n \"dhcp\": {\n \"url\": \"https://somewhere.net:8443\",\n \"name\": \"DHCP Proxy\",\n \"id\": 980190962\n },\n \"dns\": {\n \"url\": \"http://else.where:4567\",\n \"name\": \"DNS Proxy\",\n \"id\": 113629430\n },\n \"network\": \"2.3.4.0\",\n \"gateway\": null,\n \"tftp\": {\n \"url\": \"http://somewhere.else\",\n \"name\": \"TFTP Proxy\",\n \"id\": 298486374\n },\n \"tftp_id\": 298486374,\n \"dhcp_id\": 980190962,\n \"dns_primary\": null,\n \"name\": \"one\",\n \"id\": 980190962,\n \"dns_secondary\": null\n }\n}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"PUT","short_description":"Update a subnet","api_url":"/api/subnets/:id"}],"doc_url":"/apidoc/subnets/update","params":[{"allow_nil":false,"required":true,"validator":"Must be a number.","full_name":"id","name":"id","expected_type":"string","description":"<p>Subnet numeric identifier</p>\n"},{"allow_nil":false,"required":true,"validator":"Must be a Hash","params":[{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"subnet[name]","name":"name","expected_type":"string","description":"<p>Subnet name</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"subnet[network]","name":"network","expected_type":"string","description":"<p>Subnet network</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"subnet[mask]","name":"mask","expected_type":"string","description":"<p>Netmask for this subnet</p>\n"},{"allow_nil":true,"required":false,"validator":"Must be String","full_name":"subnet[gateway]","name":"gateway","expected_type":"string","description":"<p>Primary DNS for this subnet</p>\n"},{"allow_nil":true,"required":false,"validator":"Must be String","full_name":"subnet[dns_primary]","name":"dns_primary","expected_type":"string","description":"<p>Primary DNS for this subnet</p>\n"},{"allow_nil":true,"required":false,"validator":"Must be String","full_name":"subnet[dns_secondary]","name":"dns_secondary","expected_type":"string","description":"<p>Secondary DNS for this subnet</p>\n"},{"allow_nil":true,"required":false,"validator":"Must be String","full_name":"subnet[from]","name":"from","expected_type":"string","description":"<p>Starting IP Address for IP auto suggestion</p>\n"},{"allow_nil":true,"required":false,"validator":"Must be String","full_name":"subnet[to]","name":"to","expected_type":"string","description":"<p>Ending IP Address for IP auto suggestion</p>\n"},{"allow_nil":true,"required":false,"validator":"Must be String","full_name":"subnet[vlanid]","name":"vlanid","expected_type":"string","description":"<p>VLAN ID for this subnet</p>\n"},{"allow_nil":true,"required":false,"validator":"Must be Array","full_name":"subnet[domain_ids]","name":"domain_ids","expected_type":"string","description":"<p>Domains in which this subnet is part</p>\n"},{"allow_nil":true,"required":false,"validator":"Must be a number.","full_name":"subnet[dhcp_id]","name":"dhcp_id","expected_type":"string","description":"<p>DHCP Proxy to use within this subnet</p>\n"},{"allow_nil":true,"required":false,"validator":"Must be a number.","full_name":"subnet[tftp_id]","name":"tftp_id","expected_type":"string","description":"<p>TFTP Proxy to use within this subnet</p>\n"},{"allow_nil":true,"required":false,"validator":"Must be a number.","full_name":"subnet[dns_id]","name":"dns_id","expected_type":"string","description":"<p>DNS Proxy to use within this subnet</p>\n"}],"full_name":"subnet","name":"subnet","expected_type":"hash","description":""}],"name":"update"},{"see_url":null,"examples":["DELETE /api/subnets/980190962\n422\n{\n \"subnet\": {\n \"full_messages\": [\n \"2.3.4.0/24 is used by anotherfullhost\",\n \"2.3.4.0/24 is used by dhcp.mydomain.net\",\n \"2.3.4.0/24 is used by temp.yourdomain.net\",\n \"2.3.4.0/24 is used by sdhcp.mydomain.net\",\n \"2.3.4.0/24 is used by otherfullhost\",\n \"2.3.4.0/24 is used by sol10host\",\n \"2.3.4.0/24 is used by suse01.yourdomain.net\",\n \"2.3.4.0/24 is used by my5name.mydomain.net\",\n \"2.3.4.0/24 is used by temp-01.yourdomain.net\",\n \"2.3.4.0/24 is used by temp01.yourdomain.net\",\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 anotherfullhost\",\n \"2.3.4.0/24 is used by dhcp.mydomain.net\",\n \"2.3.4.0/24 is used by temp.yourdomain.net\",\n \"2.3.4.0/24 is used by sdhcp.mydomain.net\",\n \"2.3.4.0/24 is used by otherfullhost\",\n \"2.3.4.0/24 is used by sol10host\",\n \"2.3.4.0/24 is used by suse01.yourdomain.net\",\n \"2.3.4.0/24 is used by my5name.mydomain.net\",\n \"2.3.4.0/24 is used by temp-01.yourdomain.net\",\n \"2.3.4.0/24 is used by temp01.yourdomain.net\",\n \"2.3.4.0/24 is used by sdhcp.mydomain.net\"\n ]\n },\n \"id\": 980190962\n }\n}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"DELETE","short_description":"Delete a subnet","api_url":"/api/subnets/:id"}],"doc_url":"/apidoc/subnets/destroy","params":[{"allow_nil":false,"required":true,"validator":"Must be a number.","full_name":"id","name":"id","expected_type":"string","description":"<p>Subnet numeric identifier</p>\n"}],"name":"destroy"}],"version":"1","full_description":"","formats":[],"short_description":"","doc_url":"/apidoc/subnets","name":"Subnets","api_url":"/api"},"dashboard":{"methods":[{"see_url":null,"examples":["GET /api/dashboard\n200\n{\n \"good_hosts\": 0,\n \"percentage\": 0,\n \"ok_hosts_enabled\": 0,\n \"bad_hosts\": 0,\n \"good_hosts_enabled\": 0,\n \"reports_missing\": 12,\n \"out_of_sync_hosts\": 0,\n \"pending_hosts\": 0,\n \"active_hosts\": 0,\n \"disabled_hosts\": 0,\n \"active_hosts_ok\": 0,\n \"out_of_sync_hosts_enabled\": 0,\n \"ok_hosts\": 0,\n \"pending_hosts_enabled\": 0,\n \"total_hosts\": 12,\n \"active_hosts_ok_enabled\": 0,\n \"bad_hosts_enabled\": 0\n}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"GET","short_description":"Get Dashboard results","api_url":"/api/dashboard"}],"doc_url":"/apidoc/dashboard/index","params":[{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"search","name":"search","expected_type":"string","description":"<p>filter results</p>\n"}],"name":"index"}],"version":"1","full_description":"","formats":[],"short_description":"","doc_url":"/apidoc/dashboard","name":"Dashboard","api_url":"/api"},"lookup_keys":{"methods":[{"see_url":null,"examples":["GET /api/lookup_keys\n200\n[\n {\n \"lookup_key\": {\n \"default_value\": \"80\",\n \"required\": false,\n \"is_param\": true,\n \"key\": \"port\",\n \"id\": 980190962,\n \"description\": null,\n \"override\": false\n }\n },\n {\n \"lookup_key\": {\n \"default_value\": \"t\",\n \"required\": false,\n \"is_param\": true,\n \"key\": \"ssl\",\n \"id\": 113629430,\n \"description\": null,\n \"override\": true\n }\n },\n {\n \"lookup_key\": {\n \"default_value\": \"443\",\n \"required\": false,\n \"is_param\": false,\n \"key\": \"ssl_port\",\n \"id\": 298486374,\n \"description\": null,\n \"override\": false\n }\n }\n]"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"GET","short_description":"List all lookup_keys.","api_url":"/api/lookup_keys"}],"doc_url":"/apidoc/lookup_keys/index","params":[{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"search","name":"search","expected_type":"string","description":"<p>filter results</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"order","name":"order","expected_type":"string","description":"<p>sort results</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"page","name":"page","expected_type":"string","description":"<p>paginate results</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"per_page","name":"per_page","expected_type":"string","description":"<p>number of entries per request</p>\n"}],"name":"index"},{"see_url":null,"examples":["GET /api/lookup_keys/980190962-port\n200\n{\n \"lookup_key\": {\n \"default_value\": \"80\",\n \"required\": false,\n \"is_param\": true,\n \"key\": \"port\",\n \"id\": 980190962,\n \"description\": null,\n \"override\": false\n }\n}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"GET","short_description":"Show a lookup key.","api_url":"/api/lookup_keys/:id"}],"doc_url":"/apidoc/lookup_keys/show","params":[{"allow_nil":false,"required":true,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","full_name":"id","name":"id","expected_type":"string","description":""}],"name":"show"},{"see_url":null,"examples":["POST /api/lookup_keys\n{\n \"lookup_key\": {\n \"is_param\": true,\n \"key\": \"testkey\"\n }\n}\n201\n{\n \"lookup_key\": {\n \"default_value\": null,\n \"required\": false,\n \"is_param\": true,\n \"key\": \"testkey\",\n \"id\": 980190963,\n \"description\": null,\n \"override\": false\n }\n}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"POST","short_description":"Create a lookup key.","api_url":"/api/lookup_keys"}],"doc_url":"/apidoc/lookup_keys/create","params":[{"allow_nil":false,"required":true,"validator":"Must be a Hash","params":[{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"lookup_key[key]","name":"key","expected_type":"string","description":""},{"allow_nil":false,"required":false,"validator":"Must be a number.","full_name":"lookup_key[puppetclass_id]","name":"puppetclass_id","expected_type":"string","description":""},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"lookup_key[default_value]","name":"default_value","expected_type":"string","description":""},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"lookup_key[path]","name":"path","expected_type":"string","description":""},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"lookup_key[description]","name":"description","expected_type":"string","description":""},{"allow_nil":false,"required":false,"validator":"Must be a number.","full_name":"lookup_key[lookup_values_count]","name":"lookup_values_count","expected_type":"string","description":""}],"full_name":"lookup_key","name":"lookup_key","expected_type":"hash","description":""}],"name":"create"},{"see_url":null,"examples":["PUT /api/lookup_keys/980190962-port\n{\n \"lookup_key\": {\n \"default_value\": 8080\n }\n}\n200\n{\n \"lookup_key\": {\n \"default_value\": 8080,\n \"required\": false,\n \"is_param\": true,\n \"key\": \"port\",\n \"id\": 980190962,\n \"description\": null,\n \"override\": false\n }\n}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"PUT","short_description":"Update a lookup key.","api_url":"/api/lookup_keys/:id"}],"doc_url":"/apidoc/lookup_keys/update","params":[{"allow_nil":false,"required":true,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","full_name":"id","name":"id","expected_type":"string","description":""},{"allow_nil":false,"required":true,"validator":"Must be a Hash","params":[{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"lookup_key[key]","name":"key","expected_type":"string","description":""},{"allow_nil":false,"required":false,"validator":"Must be a number.","full_name":"lookup_key[puppetclass_id]","name":"puppetclass_id","expected_type":"string","description":""},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"lookup_key[default_value]","name":"default_value","expected_type":"string","description":""},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"lookup_key[path]","name":"path","expected_type":"string","description":""},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"lookup_key[description]","name":"description","expected_type":"string","description":""},{"allow_nil":false,"required":false,"validator":"Must be a number.","full_name":"lookup_key[lookup_values_count]","name":"lookup_values_count","expected_type":"string","description":""}],"full_name":"lookup_key","name":"lookup_key","expected_type":"hash","description":""}],"name":"update"},{"see_url":null,"examples":["DELETE /api/lookup_keys/980190962-port\n200\n{\n \"lookup_key\": {\n \"default_value\": \"80\",\n \"required\": false,\n \"is_param\": true,\n \"key\": \"port\",\n \"id\": 980190962,\n \"description\": null,\n \"override\": false\n }\n}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"DELETE","short_description":"Delete a lookup key.","api_url":"/api/lookup_keys/:id"}],"doc_url":"/apidoc/lookup_keys/destroy","params":[{"allow_nil":false,"required":true,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","full_name":"id","name":"id","expected_type":"string","description":""}],"name":"destroy"}],"version":"1","full_description":"","formats":[],"short_description":"","doc_url":"/apidoc/lookup_keys","name":"Lookup keys","api_url":"/api"},"media":{"methods":[{"see_url":null,"examples":["GET /api/media\n200\n[\n {\n \"medium\": {\n \"name\": \"CentOS 5.4\",\n \"path\": \"http://mirror.averse.net/centos/6.0/os/$arch\",\n \"id\": 980190962\n }\n },\n {\n \"medium\": {\n \"name\": \"OpenSuse Mirror\",\n \"path\": \"http://mirror.isoc.org.il/pub/opensuse/distribution/$major.$minor/repo/oss\",\n \"id\": 859751735\n }\n },\n {\n \"medium\": {\n \"name\": \"Solaris 10\",\n \"path\": \"http://brsla01/vol/solgi_5.10/sol$minor_$release_$arch\",\n \"id\": 442321401\n }\n },\n {\n \"medium\": {\n \"name\": \"Ubuntu Mirror\",\n \"path\": \"http://sg.archive.ubuntu.com\",\n \"id\": 1011586618\n }\n },\n {\n \"medium\": {\n \"name\": \"unused\",\n \"path\": \"http://nothing.intersting.com\",\n \"id\": 338446587\n }\n }\n]"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"GET","short_description":"List all media.","api_url":"/api/media"}],"doc_url":"/apidoc/media/index","params":[{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"search","name":"search","expected_type":"string","description":"<p>filter results</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"order","name":"order","expected_type":"string","description":"<p>for example, name ASC, or name DESC</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"page","name":"page","expected_type":"string","description":"<p>paginate results</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"per_page","name":"per_page","expected_type":"string","description":"<p>number of entries per request</p>\n"}],"name":"index"},{"see_url":null,"examples":["GET /api/media/980190962\n200\n{\n \"medium\": {\n \"name\": \"CentOS 5.4\",\n \"path\": \"http://mirror.averse.net/centos/6.0/os/$arch\",\n \"id\": 980190962\n }\n}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"GET","short_description":"Show a medium.","api_url":"/api/media/:id"}],"doc_url":"/apidoc/media/show","params":[{"allow_nil":false,"required":true,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","full_name":"id","name":"id","expected_type":"string","description":""}],"name":"show"},{"see_url":null,"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}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"POST","short_description":"Create a medium.","api_url":"/api/medium"}],"doc_url":"/apidoc/media/create","params":[{"allow_nil":false,"required":true,"validator":"Must be a Hash","params":[{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"medium[name]","name":"name","expected_type":"string","description":"<p>Name of media</p>\n"},{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"medium[path]","name":"path","expected_type":"string","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\nwhere $arch will be substituted for the host&#39;s actual OS architecture and $version, $major and $minor\nwill be substituted for the version of the operating system.</p>\n\n<p>Solaris and Debian media may also use $release.</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"medium[os_family]","name":"os_family","expected_type":"string","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<li>Debian</li>\n<li>Redhat</li>\n<li>Solaris</li>\n<li>Suse</li>\n<li>Windows</li>\n</ul>\n"}],"full_name":"medium","name":"medium","expected_type":"hash","description":""}],"name":"create"},{"see_url":null,"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}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"PUT","short_description":"Update a medium.","api_url":"/api/media/:id"}],"doc_url":"/apidoc/media/update","params":[{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"id","name":"id","expected_type":"string","description":""},{"allow_nil":false,"required":true,"validator":"Must be a Hash","params":[{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"medium[name]","name":"name","expected_type":"string","description":"<p>Name of media</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"medium[path]","name":"path","expected_type":"string","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\nwhere $arch will be substituted for the host&#39;s actual OS architecture and $version, $major and $minor\nwill be substituted for the version of the operating system.</p>\n\n<p>Solaris and Debian media may also use $release.</p>\n"},{"allow_nil":true,"required":false,"validator":"Must be String","full_name":"medium[os_family]","name":"os_family","expected_type":"string","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<li>Debian</li>\n<li>Redhat</li>\n<li>Solaris</li>\n<li>Suse</li>\n<li>Windows</li>\n</ul>\n"}],"full_name":"medium","name":"medium","expected_type":"hash","description":""}],"name":"update"},{"see_url":null,"examples":["DELETE /api/media/338446587\n200\n{\n \"medium\": {\n \"name\": \"unused\",\n \"id\": 338446587\n }\n}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"DELETE","short_description":"Delete a medium.","api_url":"/api/media/:id"}],"doc_url":"/apidoc/media/destroy","params":[{"allow_nil":false,"required":true,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","full_name":"id","name":"id","expected_type":"string","description":""}],"name":"destroy"}],"version":"1","full_description":"","formats":[],"short_description":"","doc_url":"/apidoc/media","name":"Media","api_url":"/api"},"compute_resources":{"methods":[{"see_url":null,"examples":["GET /api/compute_resources\n200\n[\n {\n \"compute_resource\": {\n \"created_at\": \"2012-11-21T13:01:46Z\",\n \"url\": \"qemu://stam/system\",\n \"name\": \"MyString\",\n \"updated_at\": \"2012-11-21T13:01:46Z\",\n \"user\": \"MyString\",\n \"id\": 980190962,\n \"description\": \"MyString\",\n \"provider\": \"Libvirt\"\n }\n },\n {\n \"compute_resource\": {\n \"created_at\": \"2012-11-21T13:01:46Z\",\n \"url\": \"test:///default\",\n \"name\": \"mycompute\",\n \"updated_at\": \"2012-11-21T13:01:46Z\",\n \"user\": \"MyString\",\n \"id\": 367690737,\n \"description\": \"mycompute\",\n \"provider\": \"Libvirt\"\n }\n },\n {\n \"compute_resource\": {\n \"created_at\": \"2012-11-21T13:01:46Z\",\n \"url\": \"test:///default\",\n \"name\": \"yourcompute\",\n \"updated_at\": \"2012-11-21T13:01:46Z\",\n \"user\": \"MyString\",\n \"id\": 932571420,\n \"description\": \"yourcompute\",\n \"provider\": \"Libvirt\"\n }\n }\n]"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"GET","short_description":"List all compute resources.","api_url":"/api/compute_resources"}],"doc_url":"/apidoc/compute_resources/index","params":[{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"search","name":"search","expected_type":"string","description":"<p>filter results</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"order","name":"order","expected_type":"string","description":"<p>sort results</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"page","name":"page","expected_type":"string","description":"<p>paginate results</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"per_page","name":"per_page","expected_type":"string","description":"<p>number of entries per request</p>\n"}],"name":"index"},{"see_url":null,"examples":["GET /api/compute_resources/980190962-mystring\n200\n{\n \"compute_resource\": {\n \"created_at\": \"2012-11-21T13:01:46Z\",\n \"url\": \"qemu://stam/system\",\n \"name\": \"MyString\",\n \"updated_at\": \"2012-11-21T13:01:46Z\",\n \"user\": \"MyString\",\n \"id\": 980190962,\n \"description\": \"MyString\",\n \"provider\": \"Libvirt\"\n }\n}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"GET","short_description":"Show an compute resource.","api_url":"/api/compute_resources/:id"}],"doc_url":"/apidoc/compute_resources/show","params":[{"allow_nil":false,"required":true,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","full_name":"id","name":"id","expected_type":"string","description":""}],"name":"show"},{"see_url":null,"examples":[],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"PUT","short_description":"Update a compute resource.","api_url":"/api/compute_resources/:id"}],"doc_url":"/apidoc/compute_resources/update","params":[{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"id","name":"id","expected_type":"string","description":""},{"allow_nil":false,"required":true,"validator":"Must be a Hash","params":[{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"compute_resource[name]","name":"name","expected_type":"string","description":""},{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"compute_resource[provider]","name":"provider","expected_type":"string","description":"<p>Providers include Libvirt, Ovirt, EC2, Vmware, Openstack</p>\n"},{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"compute_resource[url]","name":"url","expected_type":"string","description":"<p>URL for Libvirt, Ovirt, and Openstack</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"compute_resource[description]","name":"description","expected_type":"string","description":""},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"compute_resource[user]","name":"user","expected_type":"string","description":"<p>Username for Ovirt, EC2, Vmware, Openstack. Access Key for EC2.</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"compute_resource[password]","name":"password","expected_type":"string","description":"<p>Password for Ovirt, EC2, Vmware, Openstack. Secret key for EC2</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"compute_resource[uuid]","name":"uuid","expected_type":"string","description":"<p>for Ovirt, Vmware Datacenter</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"compute_resource[region]","name":"region","expected_type":"string","description":"<p>for EC2 only</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"compute_resource[tenant]","name":"tenant","expected_type":"string","description":"<p>for Openstack only</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"compute_resource[server]","name":"server","expected_type":"string","description":"<p>for Vmware</p>\n"}],"full_name":"compute_resource","name":"compute_resource","expected_type":"hash","description":""}],"name":"update"}],"version":"1","full_description":"","formats":[],"short_description":"","doc_url":"/apidoc/compute_resources","name":"Compute resources","api_url":"/api"},"settings":{"methods":[{"see_url":null,"examples":[],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"GET","short_description":"List all settings.","api_url":"/api/settings"}],"doc_url":"/apidoc/settings/index","params":[{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"search","name":"search","expected_type":"string","description":"<p>Filter results</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"order","name":"order","expected_type":"string","description":"<p>Sort results</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"page","name":"page","expected_type":"string","description":"<p>paginate results</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"per_page","name":"per_page","expected_type":"string","description":"<p>number of entries per request</p>\n"}],"name":"index"},{"see_url":null,"examples":["GET /api/settings/333972760\n200\n{\n \"setting\": {\n \"created_at\": \"2012-11-21T13:01:46Z\",\n \"category\": \"General\",\n \"settings_type\": null,\n \"default\": \"root@some.host.fqdn\",\n \"name\": \"administrator\",\n \"updated_at\": \"2012-11-21T13:01:46Z\",\n \"id\": 333972760,\n \"description\": \"The Default administrator email address\",\n \"value\": \"root@some.host.fqdn\"\n }\n}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"GET","short_description":"Show an setting.","api_url":"/api/settings/:id"}],"doc_url":"/apidoc/settings/show","params":[{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"id","name":"id","expected_type":"string","description":""}],"name":"show"},{"see_url":null,"examples":["PUT /api/settings/333972760\n{\n \"setting\": {}\n}\n200\n{\n \"setting\": {\n \"created_at\": \"2012-11-21T13:01:46Z\",\n \"category\": \"General\",\n \"settings_type\": null,\n \"default\": \"root@some.host.fqdn\",\n \"name\": \"administrator\",\n \"updated_at\": \"2012-11-21T13:01:46Z\",\n \"id\": 333972760,\n \"description\": \"The Default administrator email address\",\n \"value\": \"root@some.host.fqdn\"\n }\n}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"PUT","short_description":"Update a setting.","api_url":"/api/settings/:id"}],"doc_url":"/apidoc/settings/update","params":[{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"id","name":"id","expected_type":"string","description":""},{"allow_nil":false,"required":true,"validator":"Must be a Hash","params":[{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"setting[value]","name":"value","expected_type":"string","description":""}],"full_name":"setting","name":"setting","expected_type":"hash","description":""}],"name":"update"}],"version":"1","full_description":"","formats":[],"short_description":"","doc_url":"/apidoc/settings","name":"Settings","api_url":"/api"},"bookmarks":{"methods":[{"see_url":null,"examples":["GET /api/bookmarks\n200\n[\n {\n \"bookmark\": {\n \"controller\": \"hosts\",\n \"owner_id\": null,\n \"owner_type\": null,\n \"name\": \"bar\",\n \"public\": false,\n \"query\": \"bar=car\",\n \"id\": 298486374\n }\n },\n {\n \"bookmark\": {\n \"controller\": \"hosts\",\n \"owner_id\": null,\n \"owner_type\": null,\n \"name\": \"foo\",\n \"public\": true,\n \"query\": \"foo=boo\",\n \"id\": 980190962\n }\n }\n]"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"GET","short_description":"List all bookmarks.","api_url":"/api/bookmarks"}],"doc_url":"/apidoc/bookmarks/index","params":[{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"page","name":"page","expected_type":"string","description":"<p>paginate results</p>\n"},{"allow_nil":false,"required":false,"validator":"Must be String","full_name":"per_page","name":"per_page","expected_type":"string","description":"<p>number of entries per request</p>\n"}],"name":"index"},{"see_url":null,"examples":["GET /api/bookmarks/foo\n200\n{\n \"bookmark\": {\n \"controller\": \"hosts\",\n \"owner_id\": null,\n \"owner_type\": null,\n \"name\": \"foo\",\n \"public\": true,\n \"query\": \"foo=boo\",\n \"id\": 980190962\n }\n}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"GET","short_description":"Show a bookmark.","api_url":"/api/bookmarks/:id"}],"doc_url":"/apidoc/bookmarks/show","params":[{"allow_nil":false,"required":true,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","full_name":"id","name":"id","expected_type":"string","description":""}],"name":"show"},{"see_url":null,"examples":["POST /api/bookmarks\n{\n \"bookmark\": {\n \"controller\": \"hosts\",\n \"name\": \"foo-bar\",\n \"public\": false,\n \"query\": \"bar\"\n }\n}\n200\n{\n \"bookmark\": {\n \"controller\": \"hosts\",\n \"owner_id\": 135138680,\n \"owner_type\": \"User\",\n \"name\": \"foo-bar\",\n \"public\": false,\n \"query\": \"bar\",\n \"id\": 980190963\n }\n}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"POST","short_description":"Create a bookmark.","api_url":"/api/bookmarks"}],"doc_url":"/apidoc/bookmarks/create","params":[{"allow_nil":false,"required":true,"validator":"Must be a Hash","params":[{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"bookmark[name]","name":"name","expected_type":"string","description":""},{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"bookmark[controller]","name":"controller","expected_type":"string","description":""},{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"bookmark[query]","name":"query","expected_type":"string","description":""},{"allow_nil":false,"required":false,"validator":"Must be 'true' or 'false'","full_name":"bookmark[public]","name":"public","expected_type":"string","description":""}],"full_name":"bookmark","name":"bookmark","expected_type":"hash","description":""}],"name":"create"},{"see_url":null,"examples":["PUT /api/bookmarks/foo\n{\n \"bookmark\": {}\n}\n200\n{\n \"bookmark\": {\n \"controller\": \"hosts\",\n \"name\": \"foo\",\n \"public\": true,\n \"query\": \"foo=boo\",\n \"user\": {\n \"login\": \"admin\",\n \"email\": \"admin@someware.com\",\n \"name\": \"Admin User\"\n },\n \"id\": 980190962\n }\n}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"PUT","short_description":"Update a bookmark.","api_url":"/api/bookmarks/:id"}],"doc_url":"/apidoc/bookmarks/update","params":[{"allow_nil":false,"required":true,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","full_name":"id","name":"id","expected_type":"string","description":""},{"allow_nil":false,"required":true,"validator":"Must be a Hash","params":[{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"bookmark[name]","name":"name","expected_type":"string","description":""},{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"bookmark[controller]","name":"controller","expected_type":"string","description":""},{"allow_nil":false,"required":true,"validator":"Must be String","full_name":"bookmark[query]","name":"query","expected_type":"string","description":""},{"allow_nil":false,"required":false,"validator":"Must be 'true' or 'false'","full_name":"bookmark[public]","name":"public","expected_type":"string","description":""}],"full_name":"bookmark","name":"bookmark","expected_type":"hash","description":""}],"name":"update"},{"see_url":null,"examples":["DELETE /api/bookmarks/foo\n200\n{\n \"bookmark\": {\n \"controller\": \"hosts\",\n \"owner_id\": null,\n \"owner_type\": null,\n \"name\": \"foo\",\n \"public\": true,\n \"query\": \"foo=boo\",\n \"id\": 980190962\n }\n}"],"full_description":"","formats":[],"see":null,"errors":[],"apis":[{"http_method":"DELETE","short_description":"Delete a bookmark.","api_url":"/api/bookmarks/:id"}],"doc_url":"/apidoc/bookmarks/destroy","params":[{"allow_nil":false,"required":true,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","full_name":"id","name":"id","expected_type":"string","description":""}],"name":"destroy"}],"version":"1","full_description":"","formats":[],"short_description":"","doc_url":"/apidoc/bookmarks","name":"Bookmarks","api_url":"/api"}},"info":"<p>The Foreman is aimed to be a single address for all machines life cycle management.</p>\n","doc_url":"/apidoc","copyright":"","api_url":"/api","name":"Foreman"}}
1
+ {"docs":{"doc_url":"/apidoc","copyright":"","api_url":"/api","resources":{"template_kinds":{"version":"1","doc_url":"/apidoc/template_kinds","methods":[{"see":null,"apis":[{"api_url":"/api/template_kinds","http_method":"GET","short_description":"List all template kinds."}],"doc_url":"/apidoc/template_kinds/index","params":[{"allow_nil":false,"full_name":"page","expected_type":"string","description":"<p>paginate results</p>\n","required":false,"name":"page","validator":"Must be String"},{"allow_nil":false,"full_name":"per_page","expected_type":"string","description":"<p>number of entries per request</p>\n","required":false,"name":"per_page","validator":"Must be String"}],"formats":[],"see_url":null,"errors":[],"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]"],"name":"index","full_description":""}],"api_url":"/api","formats":[],"name":"Template kinds","full_description":"","short_description":""},"hosts":{"version":"1","doc_url":"/apidoc/hosts","methods":[{"see":null,"apis":[{"api_url":"/api/hosts","http_method":"GET","short_description":"List all hosts."}],"doc_url":"/apidoc/hosts/index","params":[{"allow_nil":false,"full_name":"search","expected_type":"string","description":"<p>Filter results</p>\n","required":false,"name":"search","validator":"Must be String"},{"allow_nil":false,"full_name":"order","expected_type":"string","description":"<p>Sort results</p>\n","required":false,"name":"order","validator":"Must be String"},{"allow_nil":false,"full_name":"page","expected_type":"string","description":"<p>paginate results</p>\n","required":false,"name":"page","validator":"Must be String"},{"allow_nil":false,"full_name":"per_page","expected_type":"string","description":"<p>number of entries per request</p>\n","required":false,"name":"per_page","validator":"Must be String"}],"formats":[],"see_url":null,"errors":[],"examples":["GET /api/hosts\n200\n[\n {\n \"host\": {\n \"hostgroup_id\": null,\n \"operatingsystem_id\": 1073012828,\n \"id\": 55602819,\n \"name\": \"anotherfullhost\"\n }\n },\n {\n \"host\": {\n \"hostgroup_id\": null,\n \"operatingsystem_id\": 1073012828,\n \"id\": 219245707,\n \"name\": \"dhcp.mydomain.net\"\n }\n },\n {\n \"host\": {\n \"hostgroup_id\": null,\n \"operatingsystem_id\": 1073012828,\n \"id\": 980190962,\n \"name\": \"my5name.mydomain.net\"\n }\n },\n {\n \"host\": {\n \"hostgroup_id\": null,\n \"operatingsystem_id\": 309172073,\n \"id\": 1053842695,\n \"name\": \"myfullname.mydomain.net\"\n }\n },\n {\n \"host\": {\n \"hostgroup_id\": null,\n \"operatingsystem_id\": 1073012828,\n \"id\": 661942085,\n \"name\": \"otherfullhost\"\n }\n },\n {\n \"host\": {\n \"hostgroup_id\": null,\n \"operatingsystem_id\": 1073012828,\n \"id\": 500757383,\n \"name\": \"sdhcp.mydomain.net\"\n }\n },\n {\n \"host\": {\n \"hostgroup_id\": null,\n \"operatingsystem_id\": 442321401,\n \"id\": 715054938,\n \"name\": \"sol10host\"\n }\n },\n {\n \"host\": {\n \"hostgroup_id\": null,\n \"operatingsystem_id\": 859751735,\n \"id\": 859751735,\n \"name\": \"suse01.yourdomain.net\"\n }\n },\n {\n \"host\": {\n \"hostgroup_id\": null,\n \"operatingsystem_id\": 331303656,\n \"id\": 1011586618,\n \"name\": \"temp-01.yourdomain.net\"\n }\n },\n {\n \"host\": {\n \"hostgroup_id\": null,\n \"operatingsystem_id\": 1073012828,\n \"id\": 1073012828,\n \"name\": \"temp01.yourdomain.net\"\n }\n },\n {\n \"host\": {\n \"hostgroup_id\": null,\n \"operatingsystem_id\": 331303656,\n \"id\": 3666571,\n \"name\": \"temp-02.useless.net\"\n }\n },\n {\n \"host\": {\n \"hostgroup_id\": null,\n \"operatingsystem_id\": 309172073,\n \"id\": 298486374,\n \"name\": \"temp.yourdomain.net\"\n }\n }\n]"],"name":"index","full_description":""},{"see":null,"apis":[{"api_url":"/api/hosts/:id","http_method":"GET","short_description":"Show a host."}],"doc_url":"/apidoc/hosts/show","params":[{"allow_nil":false,"full_name":"id","expected_type":"string","description":"","required":true,"name":"id","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."}],"formats":[],"see_url":null,"errors":[],"examples":["GET /api/hosts/my5name.mydomain.net\n200\n{\n \"host\": {\n \"sp_subnet_id\": null,\n \"sp_name\": \"\",\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"puppet_proxy_id\": 182953976,\n \"environment_id\": 334344675,\n \"medium_id\": null,\n \"compute_resource_id\": 980190962,\n \"hostgroup_id\": null,\n \"domain_id\": 22495316,\n \"operatingsystem_id\": 1073012828,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"mac\": \"aabbCCddeeee\",\n \"managed\": true,\n \"owner_type\": null,\n \"owner_id\": null,\n \"sp_ip\": \"\",\n \"image_id\": null,\n \"model_id\": null,\n \"subnet_id\": 980190962,\n \"build\": false,\n \"sp_mac\": \"\",\n \"image_file\": \"\",\n \"use_image\": null,\n \"certname\": \"my5name.mydomain.net\",\n \"id\": 980190962,\n \"ip\": \"2.3.4.1\",\n \"disk\": null,\n \"puppet_ca_proxy_id\": null,\n \"uuid\": null,\n \"enabled\": true,\n \"name\": \"my5name.mydomain.net\",\n \"architecture_id\": 501905019,\n \"ptable_id\": 980190962,\n \"environment\": {\n \"environment\": {\n \"id\": 334344675,\n \"name\": \"production\"\n }\n },\n \"comment\": null,\n \"last_report\": null,\n \"installed_at\": null,\n \"host_parameters\": [\n {\n \"host_parameter\": {\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"priority\": 4,\n \"id\": 254219264,\n \"value\": \"host1\",\n \"name\": \"host1\",\n \"reference_id\": 980190962\n }\n }\n ]\n }\n}"],"name":"show","full_description":""},{"see":null,"apis":[{"api_url":"/api/hosts","http_method":"POST","short_description":"Create a host."}],"doc_url":"/apidoc/hosts/create","params":[{"allow_nil":false,"full_name":"host","params":[{"allow_nil":false,"full_name":"host[name]","expected_type":"string","description":"","required":true,"name":"name","validator":"Must be String"},{"allow_nil":false,"full_name":"host[environment_id]","expected_type":"string","description":"","required":true,"name":"environment_id","validator":"Must be String"},{"allow_nil":false,"full_name":"host[ip]","expected_type":"string","description":"<p>not required if using a subnet with dhcp proxy</p>\n","required":false,"name":"ip","validator":"Must be String"},{"allow_nil":false,"full_name":"host[mac]","expected_type":"string","description":"<p>not required if its a virtual machine</p>\n","required":false,"name":"mac","validator":"Must be String"},{"allow_nil":false,"full_name":"host[architecture_id]","expected_type":"string","description":"","required":true,"name":"architecture_id","validator":"Must be a number."},{"allow_nil":false,"full_name":"host[domain_id]","expected_type":"string","description":"","required":true,"name":"domain_id","validator":"Must be a number."},{"allow_nil":false,"full_name":"host[puppet_proxy_id]","expected_type":"string","description":"","required":true,"name":"puppet_proxy_id","validator":"Must be a number."},{"allow_nil":false,"full_name":"host[operatingsystem_id]","expected_type":"string","description":"","required":true,"name":"operatingsystem_id","validator":"Must be String"},{"allow_nil":false,"full_name":"host[medium_id]","expected_type":"string","description":"","required":false,"name":"medium_id","validator":"Must be a number."},{"allow_nil":false,"full_name":"host[ptable_id]","expected_type":"string","description":"","required":false,"name":"ptable_id","validator":"Must be a number."},{"allow_nil":false,"full_name":"host[subnet_id]","expected_type":"string","description":"","required":false,"name":"subnet_id","validator":"Must be a number."},{"allow_nil":false,"full_name":"host[sp_subnet_id]","expected_type":"string","description":"","required":false,"name":"sp_subnet_id","validator":"Must be a number."},{"allow_nil":false,"full_name":"host[model_id_id]","expected_type":"string","description":"","required":false,"name":"model_id_id","validator":"Must be a number."},{"allow_nil":false,"full_name":"host[hostgroup_id]","expected_type":"string","description":"","required":false,"name":"hostgroup_id","validator":"Must be a number."},{"allow_nil":false,"full_name":"host[owner_id]","expected_type":"string","description":"","required":false,"name":"owner_id","validator":"Must be a number."},{"allow_nil":false,"full_name":"host[puppet_ca_proxy_id]","expected_type":"string","description":"","required":false,"name":"puppet_ca_proxy_id","validator":"Must be a number."},{"allow_nil":false,"full_name":"host[image_id]","expected_type":"string","description":"","required":false,"name":"image_id","validator":"Must be a number."},{"allow_nil":false,"full_name":"host[host_parameters_attributes]","expected_type":"string","description":"","required":false,"name":"host_parameters_attributes","validator":"Must be Array"}],"expected_type":"hash","description":"","required":true,"name":"host","validator":"Must be a Hash"}],"formats":[],"see_url":null,"errors":[],"examples":["POST /api/hosts\n{\n \"host\": {\n \"puppet_proxy_id\": 7,\n \"environment_id\": 334344675,\n \"domain_id\": 22495316,\n \"operatingsystem_id\": 1073012828,\n \"mac\": \"52:53:00:1e:85:93\",\n \"ip\": \"10.0.0.20\",\n \"name\": \"testhost11\",\n \"architecture_id\": 501905019\n }\n}\n200\n{\n \"host\": {\n \"sp_subnet_id\": null,\n \"sp_name\": \"\",\n \"created_at\": \"2012-12-18T15:24:48Z\",\n \"puppet_proxy_id\": 7,\n \"environment_id\": 334344675,\n \"medium_id\": null,\n \"compute_resource_id\": null,\n \"hostgroup_id\": null,\n \"domain_id\": 22495316,\n \"operatingsystem_id\": 1073012828,\n \"updated_at\": \"2012-12-18T15:24:48Z\",\n \"mac\": \"52:53:00:1e:85:93\",\n \"managed\": true,\n \"owner_type\": \"User\",\n \"owner_id\": 886836129,\n \"sp_ip\": \"\",\n \"image_id\": null,\n \"model_id\": null,\n \"subnet_id\": null,\n \"build\": false,\n \"sp_mac\": \"\",\n \"image_file\": \"\",\n \"use_image\": null,\n \"certname\": \"fcfce82c-33d1-4565-843a-4f58ff8e371a\",\n \"ip\": \"10.0.0.20\",\n \"id\": 1073012829,\n \"disk\": null,\n \"puppet_ca_proxy_id\": null,\n \"uuid\": null,\n \"enabled\": true,\n \"name\": \"testhost11.mydomain.net\",\n \"architecture_id\": 501905019,\n \"ptable_id\": null,\n \"environment\": {\n \"environment\": {\n \"id\": 334344675,\n \"name\": \"production\"\n }\n },\n \"comment\": null,\n \"last_report\": null,\n \"installed_at\": null,\n \"host_parameters\": []\n }\n}"],"name":"create","full_description":""},{"see":null,"apis":[{"api_url":"/api/hosts/:id","http_method":"PUT","short_description":"Update a host."}],"doc_url":"/apidoc/hosts/update","params":[{"allow_nil":false,"full_name":"id","expected_type":"string","description":"","required":true,"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."},{"allow_nil":false,"full_name":"host","params":[{"allow_nil":false,"full_name":"host[name]","expected_type":"string","description":"","required":false,"name":"name","validator":"Must be String"},{"allow_nil":false,"full_name":"host[environment_id]","expected_type":"string","description":"","required":false,"name":"environment_id","validator":"Must be String"},{"allow_nil":false,"full_name":"host[ip]","expected_type":"string","description":"<p>not required if using a subnet with dhcp proxy</p>\n","required":false,"name":"ip","validator":"Must be String"},{"allow_nil":false,"full_name":"host[mac]","expected_type":"string","description":"<p>not required if its a virtual machine</p>\n","required":false,"name":"mac","validator":"Must be String"},{"allow_nil":false,"full_name":"host[architecture_id]","expected_type":"string","description":"","required":false,"name":"architecture_id","validator":"Must be a number."},{"allow_nil":false,"full_name":"host[domain_id]","expected_type":"string","description":"","required":false,"name":"domain_id","validator":"Must be a number."},{"allow_nil":false,"full_name":"host[puppet_proxy_id]","expected_type":"string","description":"","required":false,"name":"puppet_proxy_id","validator":"Must be a number."},{"allow_nil":false,"full_name":"host[operatingsystem_id]","expected_type":"string","description":"","required":false,"name":"operatingsystem_id","validator":"Must be String"},{"allow_nil":false,"full_name":"host[medium_id]","expected_type":"string","description":"","required":false,"name":"medium_id","validator":"Must be a number."},{"allow_nil":false,"full_name":"host[ptable_id]","expected_type":"string","description":"","required":false,"name":"ptable_id","validator":"Must be a number."},{"allow_nil":false,"full_name":"host[subnet_id]","expected_type":"string","description":"","required":false,"name":"subnet_id","validator":"Must be a number."},{"allow_nil":false,"full_name":"host[sp_subnet_id]","expected_type":"string","description":"","required":false,"name":"sp_subnet_id","validator":"Must be a number."},{"allow_nil":false,"full_name":"host[model_id_id]","expected_type":"string","description":"","required":false,"name":"model_id_id","validator":"Must be a number."},{"allow_nil":false,"full_name":"host[hostgroup_id]","expected_type":"string","description":"","required":false,"name":"hostgroup_id","validator":"Must be a number."},{"allow_nil":false,"full_name":"host[owner_id]","expected_type":"string","description":"","required":false,"name":"owner_id","validator":"Must be a number."},{"allow_nil":false,"full_name":"host[puppet_ca_proxy_id]","expected_type":"string","description":"","required":false,"name":"puppet_ca_proxy_id","validator":"Must be a number."},{"allow_nil":false,"full_name":"host[image_id]","expected_type":"string","description":"","required":false,"name":"image_id","validator":"Must be a number."},{"allow_nil":false,"full_name":"host[host_parameters_attributes]","expected_type":"string","description":"","required":false,"name":"host_parameters_attributes","validator":"Must be Array"}],"expected_type":"hash","description":"","required":true,"name":"host","validator":"Must be a Hash"}],"formats":[],"see_url":null,"errors":[],"examples":["PUT /api/hosts/temp.yourdomain.net\n{\n \"host\": {}\n}\n200\n{\n \"host\": {\n \"sp_subnet_id\": null,\n \"sp_name\": \"\",\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"puppet_proxy_id\": 182953976,\n \"environment_id\": 334344675,\n \"medium_id\": 980190962,\n \"compute_resource_id\": 980190962,\n \"domain_id\": 589326610,\n \"hostgroup_id\": null,\n \"operatingsystem_id\": 309172073,\n \"mac\": \"aa:bb:cc:dd:ee:ff\",\n \"updated_at\": \"2012-12-18T15:24:48Z\",\n \"managed\": null,\n \"owner_type\": \"User\",\n \"owner_id\": 886836129,\n \"last_compile\": null,\n \"root_pass\": \"xybxa6JUkz63w\",\n \"sp_ip\": \"\",\n \"image_id\": null,\n \"model_id\": null,\n \"serial\": null,\n \"subnet_id\": 980190962,\n \"build\": false,\n \"location_id\": null,\n \"sp_mac\": \"\",\n \"image_file\": \"\",\n \"last_freshcheck\": null,\n \"use_image\": null,\n \"certname\": \"temp.yourdomain.net\",\n \"id\": 298486374,\n \"ip\": \"2.3.4.5\",\n \"disk\": null,\n \"puppet_status\": 0,\n \"organization_id\": null,\n \"puppet_ca_proxy_id\": null,\n \"source_file_id\": null,\n \"uuid\": null,\n \"enabled\": true,\n \"name\": \"temp.yourdomain.net\",\n \"architecture_id\": 501905019,\n \"ptable_id\": 980190962,\n \"environment\": {\n \"environment\": {\n \"id\": 334344675,\n \"name\": \"production\"\n }\n },\n \"comment\": null,\n \"last_report\": null,\n \"installed_at\": null\n }\n}"],"name":"update","full_description":""},{"see":null,"apis":[{"api_url":"/api/hosts/:id","http_method":"DELETE","short_description":"Delete an host."}],"doc_url":"/apidoc/hosts/destroy","params":[{"allow_nil":false,"full_name":"id","expected_type":"string","description":"","required":true,"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."}],"formats":[],"see_url":null,"errors":[],"examples":["DELETE /api/hosts/my5name.mydomain.net\n200\n{\n \"host\": {\n \"sp_subnet_id\": null,\n \"sp_name\": \"\",\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"puppet_proxy_id\": 182953976,\n \"environment_id\": 334344675,\n \"medium_id\": null,\n \"compute_resource_id\": 980190962,\n \"domain_id\": 22495316,\n \"hostgroup_id\": null,\n \"operatingsystem_id\": 1073012828,\n \"mac\": \"aabbCCddeeee\",\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"managed\": true,\n \"owner_type\": null,\n \"owner_id\": null,\n \"last_compile\": null,\n \"root_pass\": \"xybxa6JUkz63w\",\n \"sp_ip\": \"\",\n \"image_id\": null,\n \"model_id\": null,\n \"serial\": null,\n \"subnet_id\": 980190962,\n \"build\": false,\n \"location_id\": null,\n \"sp_mac\": \"\",\n \"image_file\": \"\",\n \"last_freshcheck\": null,\n \"use_image\": null,\n \"certname\": \"my5name.mydomain.net\",\n \"id\": 980190962,\n \"ip\": \"2.3.4.1\",\n \"disk\": null,\n \"puppet_status\": 0,\n \"organization_id\": null,\n \"puppet_ca_proxy_id\": null,\n \"source_file_id\": null,\n \"uuid\": null,\n \"enabled\": true,\n \"name\": \"my5name.mydomain.net\",\n \"architecture_id\": 501905019,\n \"ptable_id\": 980190962,\n \"environment\": {\n \"environment\": {\n \"id\": 334344675,\n \"name\": \"production\"\n }\n },\n \"comment\": null,\n \"last_report\": null,\n \"installed_at\": null\n }\n}"],"name":"destroy","full_description":""},{"see":null,"apis":[{"api_url":"/api/hosts/:id/status","http_method":"GET","short_description":"Get status of host"}],"doc_url":"/apidoc/hosts/status","params":[{"allow_nil":false,"full_name":"id","expected_type":"string","description":"","required":true,"name":"id","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."}],"formats":[],"see_url":null,"errors":[],"examples":["GET /api/hosts/my5name.mydomain.net/status\n200\n{\n \"status\": \"missing\"\n}"],"name":"status","full_description":"<p>Return value may either be one of the following:</p>\n\n<ul>\n<li>missing</li>\n<li>failed</li>\n<li>pending</li>\n<li>changed</li>\n<li>unchanged</li>\n<li>unreported</li>\n</ul>\n"}],"api_url":"/api","formats":[],"name":"Hosts","full_description":"","short_description":""},"audits":{"version":"1","doc_url":"/apidoc/audits","methods":[{"see":null,"apis":[{"api_url":"/api/audits","http_method":"GET","short_description":"List all audits."}],"doc_url":"/apidoc/audits/index","params":[{"allow_nil":false,"full_name":"search","expected_type":"string","description":"<p>filter results</p>\n","required":false,"name":"search","validator":"Must be String"},{"allow_nil":false,"full_name":"order","expected_type":"string","description":"<p>sort results</p>\n","required":false,"name":"order","validator":"Must be String"},{"allow_nil":false,"full_name":"page","expected_type":"string","description":"<p>paginate results</p>\n","required":false,"name":"page","validator":"Must be String"},{"allow_nil":false,"full_name":"per_page","expected_type":"string","description":"<p>number of entries per request</p>\n","required":false,"name":"per_page","validator":"Must be String"}],"formats":[],"see_url":null,"errors":[],"examples":["GET /api/audits\n200\n[\n {\n \"audit\": {\n \"created_at\": \"2009-12-14T08:01:17Z\",\n \"associated_type\": \"Host\",\n \"associated_id\": 272,\n \"auditable_type\": \"Host\",\n \"action\": \"update\",\n \"version\": 1,\n \"audited_changes\": {\n \"architecture_id\": [\n 10463,\n 10466\n ]\n },\n \"user_type\": null,\n \"associated_name\": null,\n \"user_id\": null,\n \"auditable_name\": null,\n \"id\": 1,\n \"auditable_id\": 0,\n \"remote_address\": null,\n \"comment\": null\n }\n }\n]"],"name":"index","full_description":""},{"see":null,"apis":[{"api_url":"/api/audits/:id","http_method":"GET","short_description":"Show an audit"}],"doc_url":"/apidoc/audits/show","params":[{"allow_nil":false,"full_name":"id","expected_type":"string","description":"","required":true,"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."}],"formats":[],"see_url":null,"errors":[],"examples":["GET /api/audits/1\n200\n{\n \"audit\": {\n \"created_at\": \"2009-12-14T08:01:17Z\",\n \"associated_type\": \"Host\",\n \"associated_id\": 272,\n \"auditable_type\": \"Host\",\n \"action\": \"update\",\n \"version\": 1,\n \"audited_changes\": {\n \"architecture_id\": [\n 10463,\n 10466\n ]\n },\n \"user_type\": null,\n \"associated_name\": null,\n \"user_id\": null,\n \"auditable_name\": null,\n \"id\": 1,\n \"auditable_id\": 0,\n \"remote_address\": null,\n \"comment\": null\n }\n}"],"name":"show","full_description":""}],"api_url":"/api","formats":[],"name":"Audits","full_description":"","short_description":""},"bookmarks":{"version":"1","doc_url":"/apidoc/bookmarks","methods":[{"see":null,"apis":[{"api_url":"/api/bookmarks","http_method":"GET","short_description":"List all bookmarks."}],"doc_url":"/apidoc/bookmarks/index","params":[{"allow_nil":false,"full_name":"page","expected_type":"string","description":"<p>paginate results</p>\n","required":false,"name":"page","validator":"Must be String"},{"allow_nil":false,"full_name":"per_page","expected_type":"string","description":"<p>number of entries per request</p>\n","required":false,"name":"per_page","validator":"Must be String"}],"formats":[],"see_url":null,"errors":[],"examples":["GET /api/bookmarks\n200\n[\n {\n \"bookmark\": {\n \"owner_type\": null,\n \"owner_id\": null,\n \"public\": false,\n \"id\": 298486374,\n \"query\": \"bar=car\",\n \"name\": \"bar\",\n \"controller\": \"hosts\"\n }\n },\n {\n \"bookmark\": {\n \"owner_type\": null,\n \"owner_id\": null,\n \"public\": true,\n \"id\": 980190962,\n \"query\": \"foo=boo\",\n \"name\": \"foo\",\n \"controller\": \"hosts\"\n }\n }\n]"],"name":"index","full_description":""},{"see":null,"apis":[{"api_url":"/api/bookmarks/:id","http_method":"GET","short_description":"Show a bookmark."}],"doc_url":"/apidoc/bookmarks/show","params":[{"allow_nil":false,"full_name":"id","expected_type":"string","description":"","required":true,"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."}],"formats":[],"see_url":null,"errors":[],"examples":["GET /api/bookmarks/foo\n200\n{\n \"bookmark\": {\n \"owner_type\": null,\n \"owner_id\": null,\n \"public\": true,\n \"id\": 980190962,\n \"query\": \"foo=boo\",\n \"name\": \"foo\",\n \"controller\": \"hosts\"\n }\n}"],"name":"show","full_description":""},{"see":null,"apis":[{"api_url":"/api/bookmarks","http_method":"POST","short_description":"Create a bookmark."}],"doc_url":"/apidoc/bookmarks/create","params":[{"allow_nil":false,"full_name":"bookmark","params":[{"allow_nil":false,"full_name":"bookmark[name]","expected_type":"string","description":"","required":true,"name":"name","validator":"Must be String"},{"allow_nil":false,"full_name":"bookmark[controller]","expected_type":"string","description":"","required":true,"name":"controller","validator":"Must be String"},{"allow_nil":false,"full_name":"bookmark[query]","expected_type":"string","description":"","required":true,"name":"query","validator":"Must be String"},{"allow_nil":false,"full_name":"bookmark[public]","expected_type":"string","description":"","required":false,"name":"public","validator":"Must be 'true' or 'false'"}],"expected_type":"hash","description":"","required":true,"name":"bookmark","validator":"Must be a Hash"}],"formats":[],"see_url":null,"errors":[],"examples":["POST /api/bookmarks\n{\n \"bookmark\": {\n \"public\": false,\n \"query\": \"bar\",\n \"name\": \"foo-bar\",\n \"controller\": \"hosts\"\n }\n}\n200\n{\n \"bookmark\": {\n \"owner_type\": \"User\",\n \"owner_id\": 886836129,\n \"public\": false,\n \"id\": 980190963,\n \"query\": \"bar\",\n \"name\": \"foo-bar\",\n \"controller\": \"hosts\"\n }\n}"],"name":"create","full_description":""},{"see":null,"apis":[{"api_url":"/api/bookmarks/:id","http_method":"PUT","short_description":"Update a bookmark."}],"doc_url":"/apidoc/bookmarks/update","params":[{"allow_nil":false,"full_name":"id","expected_type":"string","description":"","required":true,"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."},{"allow_nil":false,"full_name":"bookmark","params":[{"allow_nil":false,"full_name":"bookmark[name]","expected_type":"string","description":"","required":false,"name":"name","validator":"Must be String"},{"allow_nil":false,"full_name":"bookmark[controller]","expected_type":"string","description":"","required":false,"name":"controller","validator":"Must be String"},{"allow_nil":false,"full_name":"bookmark[query]","expected_type":"string","description":"","required":false,"name":"query","validator":"Must be String"},{"allow_nil":false,"full_name":"bookmark[public]","expected_type":"string","description":"","required":false,"name":"public","validator":"Must be 'true' or 'false'"}],"expected_type":"hash","description":"","required":true,"name":"bookmark","validator":"Must be a Hash"}],"formats":[],"see_url":null,"errors":[],"examples":["PUT /api/bookmarks/foo\n{\n \"bookmark\": {}\n}\n200\n{\n \"bookmark\": {\n \"user\": {\n \"name\": \"apiadmin User\",\n \"email\": \"apiadmin@someware.com\",\n \"login\": \"apiadmin\"\n },\n \"public\": true,\n \"id\": 980190962,\n \"query\": \"foo=boo\",\n \"name\": \"foo\",\n \"controller\": \"hosts\"\n }\n}"],"name":"update","full_description":""},{"see":null,"apis":[{"api_url":"/api/bookmarks/:id","http_method":"DELETE","short_description":"Delete a bookmark."}],"doc_url":"/apidoc/bookmarks/destroy","params":[{"allow_nil":false,"full_name":"id","expected_type":"string","description":"","required":true,"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."}],"formats":[],"see_url":null,"errors":[],"examples":["DELETE /api/bookmarks/foo\n200\n{\n \"bookmark\": {\n \"owner_type\": null,\n \"owner_id\": null,\n \"public\": true,\n \"id\": 980190962,\n \"query\": \"foo=boo\",\n \"name\": \"foo\",\n \"controller\": \"hosts\"\n }\n}"],"name":"destroy","full_description":""}],"api_url":"/api","formats":[],"name":"Bookmarks","full_description":"","short_description":""},"config_templates":{"version":"1","doc_url":"/apidoc/config_templates","methods":[{"see":null,"apis":[{"api_url":"/api/config_templates","http_method":"GET","short_description":"List templates"}],"doc_url":"/apidoc/config_templates/index","params":[{"allow_nil":false,"full_name":"search","expected_type":"string","description":"<p>filter results</p>\n","required":false,"name":"search","validator":"Must be String"},{"allow_nil":false,"full_name":"order","expected_type":"string","description":"<p>sort results</p>\n","required":false,"name":"order","validator":"Must be String"},{"allow_nil":false,"full_name":"page","expected_type":"string","description":"<p>paginate results</p>\n","required":false,"name":"page","validator":"Must be String"},{"allow_nil":false,"full_name":"per_page","expected_type":"string","description":"<p>number of entries per request</p>\n","required":false,"name":"per_page","validator":"Must be String"}],"formats":[],"see_url":null,"errors":[],"examples":["GET /api/config_templates\n200\n[\n {\n \"config_template\": {\n \"template_kind\": {\n \"id\": 452984334,\n \"name\": \"PXELinux\"\n },\n \"audit_comment\": null,\n \"id\": 1007981701,\n \"template\": \"default linux~label linux~kernel <%= @kernel %>~append initrd=<%= @initrd %> ks=<%= foreman_url(\\\"kickstart\\\")%> ksdevice=bootif network kssendmac\",\n \"name\": \"centos5_3_pxelinux\",\n \"snippet\": null\n }\n },\n {\n \"config_template\": {\n \"template_kind\": {\n \"id\": 550103832,\n \"name\": \"finish\"\n },\n \"audit_comment\": null,\n \"id\": 104314179,\n \"template\": \"MyFinish\",\n \"name\": \"MyFinish\",\n \"snippet\": null\n }\n },\n {\n \"config_template\": {\n \"template_kind\": {\n \"id\": 478250810,\n \"name\": \"script\"\n },\n \"audit_comment\": null,\n \"id\": 981457253,\n \"template\": \"MyText\",\n \"name\": \"MyScript\",\n \"snippet\": null\n }\n },\n {\n \"config_template\": {\n \"template_kind\": {\n \"id\": 158998239,\n \"name\": \"gPXE\"\n },\n \"audit_comment\": null,\n \"id\": 943779058,\n \"template\": \"MyText\",\n \"name\": \"MyString\",\n \"snippet\": null\n }\n },\n {\n \"config_template\": {\n \"template_kind\": {\n \"id\": 983253650,\n \"name\": \"provision\"\n },\n \"audit_comment\": null,\n \"id\": 269958254,\n \"template\": \"MyText\",\n \"name\": \"MyString2\",\n \"snippet\": null\n }\n },\n {\n \"config_template\": {\n \"template_kind\": {\n \"id\": 452984334,\n \"name\": \"PXELinux\"\n },\n \"audit_comment\": null,\n \"id\": 352050261,\n \"template\": \"default linux~label linux~kernel <%= @kernel %>~append initrd=<%= @initrd %> ksdevice=bootif network kssendmac\",\n \"name\": \"PXE Default File\",\n \"snippet\": null\n }\n },\n {\n \"config_template\": {\n \"\": null,\n \"audit_comment\": null,\n \"id\": 684651467,\n \"template\": \"FOO\",\n \"name\": \"PXE Default Menu\",\n \"snippet\": null\n }\n },\n {\n \"config_template\": {\n \"template_kind\": {\n \"id\": 452984334,\n \"name\": \"PXELinux\"\n },\n \"audit_comment\": null,\n \"id\": 821548108,\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 \"name\": \"PXE Localboot Default\",\n \"snippet\": null\n }\n }\n]"],"name":"index","full_description":""},{"see":null,"apis":[{"api_url":"/api/config_templates/:id","http_method":"GET","short_description":"Show template details"}],"doc_url":"/apidoc/config_templates/show","params":[{"allow_nil":false,"full_name":"id","expected_type":"string","description":"","required":true,"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."}],"formats":[],"see_url":null,"errors":[],"examples":["GET /api/config_templates/centos5_3_pxelinux\n200\n{\n \"config_template\": {\n \"template_kind\": {\n \"id\": 452984334,\n \"name\": \"PXELinux\"\n },\n \"audit_comment\": null,\n \"id\": 1007981701,\n \"template\": \"default linux~label linux~kernel <%= @kernel %>~append initrd=<%= @initrd %> ks=<%= foreman_url(\\\"kickstart\\\")%> ksdevice=bootif network kssendmac\",\n \"name\": \"centos5_3_pxelinux\",\n \"snippet\": null\n }\n}"],"name":"show","full_description":""},{"see":null,"apis":[{"api_url":"/api/config_templates","http_method":"POST","short_description":"Create a template"}],"doc_url":"/apidoc/config_templates/create","params":[{"allow_nil":false,"full_name":"config_template","params":[{"allow_nil":false,"full_name":"config_template[name]","expected_type":"string","description":"<p>template name</p>\n","required":true,"name":"name","validator":"Must be String"},{"allow_nil":false,"full_name":"config_template[template]","expected_type":"string","description":"","required":true,"name":"template","validator":"Must be String"},{"allow_nil":true,"full_name":"config_template[snippet]","expected_type":"string","description":"","required":false,"name":"snippet","validator":"Must be 'true' or 'false'"},{"allow_nil":true,"full_name":"config_template[audit_comment]","expected_type":"string","description":"","required":false,"name":"audit_comment","validator":"Must be String"},{"allow_nil":true,"full_name":"config_template[template_kind_id]","expected_type":"string","description":"<p>not relevant for snippet</p>\n","required":false,"name":"template_kind_id","validator":"Must be a number."},{"allow_nil":false,"full_name":"config_template[template_combinations_attributes]","expected_type":"string","description":"<p>Array of template combinations (hostgroup<em>id, environment</em>id)</p>\n","required":false,"name":"template_combinations_attributes","validator":"Must be Array"},{"allow_nil":false,"full_name":"config_template[operatingsystem_ids]","expected_type":"string","description":"<p>Array of operating systems ID to associate the template with</p>\n","required":false,"name":"operatingsystem_ids","validator":"Must be Array"}],"expected_type":"hash","description":"","required":true,"name":"config_template","validator":"Must be a Hash"}],"formats":[],"see_url":null,"errors":[],"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 \"id\": 1007981702,\n \"template\": \"This is a test template\",\n \"name\": \"RandomName\",\n \"snippet\": null\n }\n}"],"name":"create","full_description":""},{"see":null,"apis":[{"api_url":"/api/config_templates/:id","http_method":"PUT","short_description":"Update a template"}],"doc_url":"/apidoc/config_templates/update","params":[{"allow_nil":false,"full_name":"id","expected_type":"string","description":"","required":true,"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."},{"allow_nil":false,"full_name":"config_template","params":[{"allow_nil":false,"full_name":"config_template[name]","expected_type":"string","description":"<p>template name</p>\n","required":false,"name":"name","validator":"Must be String"},{"allow_nil":false,"full_name":"config_template[template]","expected_type":"string","description":"","required":false,"name":"template","validator":"Must be String"},{"allow_nil":false,"full_name":"config_template[snippet]","expected_type":"string","description":"","required":false,"name":"snippet","validator":"Must be 'true' or 'false'"},{"allow_nil":true,"full_name":"config_template[audit_comment]","expected_type":"string","description":"","required":false,"name":"audit_comment","validator":"Must be String"},{"allow_nil":true,"full_name":"config_template[template_kind_id]","expected_type":"string","description":"<p>not relevant for snippet</p>\n","required":false,"name":"template_kind_id","validator":"Must be a number."},{"allow_nil":false,"full_name":"config_template[template_combinations_attributes]","expected_type":"string","description":"<p>Array of template combinations (hostgroup<em>id, environment</em>id)</p>\n","required":false,"name":"template_combinations_attributes","validator":"Must be Array"},{"allow_nil":false,"full_name":"config_template[operatingsystem_ids]","expected_type":"string","description":"<p>Array of operating systems ID to associate the template with</p>\n","required":false,"name":"operatingsystem_ids","validator":"Must be Array"}],"expected_type":"hash","description":"","required":true,"name":"config_template","validator":"Must be a Hash"}],"formats":[],"see_url":null,"errors":[],"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 \"template_kind\": {\n \"id\": 452984334,\n \"name\": \"PXELinux\"\n },\n \"id\": 1007981701,\n \"template\": \"tmp\",\n \"name\": \"centos5_3_pxelinux\",\n \"snippet\": null\n }\n}"],"name":"update","full_description":""},{"see":null,"apis":[{"api_url":"/api/config_templates/revision","http_method":"GET","short_description":null}],"doc_url":"/apidoc/config_templates/revision","params":[{"allow_nil":false,"full_name":"version","expected_type":"string","description":"<p>template version</p>\n","required":false,"name":"version","validator":"Must be String"}],"formats":[],"see_url":null,"errors":[],"examples":[],"name":"revision","full_description":""},{"see":null,"apis":[{"api_url":"/api/config_templates/:id","http_method":"DELETE","short_description":"Delete a template"}],"doc_url":"/apidoc/config_templates/destroy","params":[{"allow_nil":false,"full_name":"id","expected_type":"string","description":"","required":true,"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."}],"formats":[],"see_url":null,"errors":[],"examples":["DELETE /api/config_templates/centos5_3_pxelinux\n200\n{\n \"config_template\": {\n \"template_kind\": {\n \"id\": 452984334,\n \"name\": \"PXELinux\"\n },\n \"id\": 1007981701,\n \"template\": \"default linux~label linux~kernel <%= @kernel %>~append initrd=<%= @initrd %> ks=<%= foreman_url(\\\"kickstart\\\")%> ksdevice=bootif network kssendmac\",\n \"name\": \"centos5_3_pxelinux\",\n \"snippet\": null\n }\n}"],"name":"destroy","full_description":""},{"see":null,"apis":[{"api_url":"/api/config_templates/build_pxe_default","http_method":"GET","short_description":"Change the default PXE menu on all configured TFTP servers"}],"doc_url":"/apidoc/config_templates/build_pxe_default","params":[],"formats":[],"see_url":null,"errors":[],"examples":["GET /api/config_templates/build_pxe_default\n200\nPXE Default file has been deployed to all Smart Proxies"],"name":"build_pxe_default","full_description":""}],"api_url":"/api","formats":[],"name":"Config templates","full_description":"","short_description":""},"domains":{"version":"1","doc_url":"/apidoc/domains","methods":[{"see":null,"apis":[{"api_url":"/api/domains","http_method":"GET","short_description":"List of domains"}],"doc_url":"/apidoc/domains/index","params":[{"allow_nil":false,"full_name":"search","expected_type":"string","description":"<p>Filter results</p>\n","required":false,"name":"search","validator":"Must be String"},{"allow_nil":false,"full_name":"order","expected_type":"string","description":"<p>Sort results</p>\n","required":false,"name":"order","validator":"Must be String"},{"allow_nil":false,"full_name":"page","expected_type":"string","description":"<p>paginate results</p>\n","required":false,"name":"page","validator":"Must be String"},{"allow_nil":false,"full_name":"per_page","expected_type":"string","description":"<p>number of entries per request</p>\n","required":false,"name":"per_page","validator":"Must be String"}],"formats":[],"see_url":null,"errors":[],"examples":["GET /api/domains\n200\n[\n {\n \"domain\": {\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"dns_id\": 113629430,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"fullname\": null,\n \"id\": 22495316,\n \"name\": \"mydomain.net\"\n }\n },\n {\n \"domain\": {\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"dns_id\": 113629430,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"fullname\": \"somewhare that is never used\",\n \"id\": 759776763,\n \"name\": \"unused.net\"\n }\n },\n {\n \"domain\": {\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"dns_id\": null,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"fullname\": null,\n \"id\": 229305443,\n \"name\": \"useless.net\"\n }\n },\n {\n \"domain\": {\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"dns_id\": 113629430,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"fullname\": \"somewhere in yourdomain\",\n \"id\": 589326610,\n \"name\": \"yourdomain.net\"\n }\n }\n]"],"name":"index","full_description":""},{"see":null,"apis":[{"api_url":"/api/domains/:id","http_method":"GET","short_description":"Show a domain."}],"doc_url":"/apidoc/domains/show","params":[{"allow_nil":false,"full_name":"id","expected_type":"string","description":"<p>May be numerical id or domain name</p>\n","required":true,"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."}],"formats":[],"see_url":null,"errors":[],"examples":["GET /api/domains/mydomain.net\n200\n{\n \"domain\": {\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"dns_id\": 113629430,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"fullname\": null,\n \"id\": 22495316,\n \"name\": \"mydomain.net\"\n }\n}"],"name":"show","full_description":""},{"see":null,"apis":[{"api_url":"/api/domains","http_method":"POST","short_description":"Create a domain."}],"doc_url":"/apidoc/domains/create","params":[{"allow_nil":false,"full_name":"domain","params":[{"allow_nil":false,"full_name":"domain[name]","expected_type":"string","description":"<p>The full DNS Domain name</p>\n","required":true,"name":"name","validator":"Must be String"},{"allow_nil":true,"full_name":"domain[fullname]","expected_type":"string","description":"<p>Full name describing the domain</p>\n","required":false,"name":"fullname","validator":"Must be String"},{"allow_nil":true,"full_name":"domain[dns_id]","expected_type":"string","description":"<p>DNS Proxy to use within this domain</p>\n","required":false,"name":"dns_id","validator":"Must be a number."},{"allow_nil":false,"full_name":"domain[domain_parameters_attributes]","expected_type":"string","description":"<p>Array of parameters (name, value)</p>\n","required":false,"name":"domain_parameters_attributes","validator":"Must be Array"}],"expected_type":"hash","description":"","required":true,"name":"domain","validator":"Must be a Hash"}],"formats":[],"see_url":null,"errors":[],"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}"],"name":"create","full_description":"<p>The <b>fullname</b> field is used for human readability in reports\nand other pages that refer to domains, and also available as\nan external node parameter</p>\n"},{"see":null,"apis":[{"api_url":"/api/domains/:id","http_method":"PUT","short_description":"Update a domain."}],"doc_url":"/apidoc/domains/update","params":[{"allow_nil":false,"full_name":"id","expected_type":"string","description":"","required":true,"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."},{"allow_nil":false,"full_name":"domain","params":[{"allow_nil":true,"full_name":"domain[name]","expected_type":"string","description":"<p>The full DNS Domain name</p>\n","required":false,"name":"name","validator":"Must be String"},{"allow_nil":true,"full_name":"domain[fullname]","expected_type":"string","description":"<p>Full name describing the domain</p>\n","required":false,"name":"fullname","validator":"Must be String"},{"allow_nil":true,"full_name":"domain[dns_id]","expected_type":"string","description":"<p>DNS Proxy to use within this domain</p>\n","required":false,"name":"dns_id","validator":"Must be a number."},{"allow_nil":false,"full_name":"domain[domain_parameters_attributes]","expected_type":"string","description":"<p>Array of parameters (name, value)</p>\n","required":false,"name":"domain_parameters_attributes","validator":"Must be Array"}],"expected_type":"hash","description":"","required":true,"name":"domain","validator":"Must be a Hash"}],"formats":[],"see_url":null,"errors":[],"examples":["PUT /api/domains/mydomain.net\n{\n \"domain\": {\n \"name\": \"\"\n }\n}\n422\n{\n \"domain\": {\n \"errors\": {\n \"name\": [\n \"can't be blank\"\n ]\n },\n \"full_messages\": [\n \"Name can't be blank\"\n ],\n \"id\": 22495316\n }\n}"],"name":"update","full_description":""},{"see":null,"apis":[{"api_url":"/api/domains/:id","http_method":"DELETE","short_description":"Delete a domain."}],"doc_url":"/apidoc/domains/destroy","params":[{"allow_nil":false,"full_name":"id","expected_type":"string","description":"","required":true,"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."}],"formats":[],"see_url":null,"errors":[],"examples":["DELETE /api/domains/mydomain.net\n200\n{\n \"domain\": {\n \"id\": 22495316,\n \"name\": \"mydomain.net\"\n }\n}"],"name":"destroy","full_description":""}],"api_url":"/api","formats":[],"name":"Domains","full_description":"<p>Foreman considers a domain and a DNS zone as the same thing. That is, if you\nare planning to manage a site where all the machines are or the form\n<i>hostname</i>.<b>somewhere.com</b> then the domain is <b>somewhere.com</b>.\nThis allows Foreman to associate a puppet variable with a domain/site\nand automatically append this variable to all external node requests made\nby machines at that site.</p>\n","short_description":""},"roles":{"version":"1","doc_url":"/apidoc/roles","methods":[{"see":null,"apis":[{"api_url":"/api/roles","http_method":"GET","short_description":"List all roles."}],"doc_url":"/apidoc/roles/index","params":[{"allow_nil":false,"full_name":"page","expected_type":"string","description":"<p>paginate results</p>\n","required":false,"name":"page","validator":"Must be String"},{"allow_nil":false,"full_name":"per_page","expected_type":"string","description":"<p>number of entries per request</p>\n","required":false,"name":"per_page","validator":"Must be String"}],"formats":[],"see_url":null,"errors":[],"examples":[],"name":"index","full_description":""},{"see":null,"apis":[{"api_url":"/api/roles/:id","http_method":"GET","short_description":"Show an role."}],"doc_url":"/apidoc/roles/show","params":[{"allow_nil":false,"full_name":"id","expected_type":"string","description":"","required":true,"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."}],"formats":[],"see_url":null,"errors":[],"examples":["GET /api/roles/1\n200\n{\n \"role\": {\n \"builtin\": 0,\n \"id\": 1,\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 \"name\": \"Manager\"\n }\n}"],"name":"show","full_description":""},{"see":null,"apis":[{"api_url":"/api/roles","http_method":"POST","short_description":"Create an role."}],"doc_url":"/apidoc/roles/create","params":[{"allow_nil":false,"full_name":"role","params":[{"allow_nil":false,"full_name":"role[name]","expected_type":"string","description":"","required":true,"name":"name","validator":"Must be String"}],"expected_type":"hash","description":"","required":true,"name":"role","validator":"Must be a Hash"}],"formats":[],"see_url":null,"errors":[],"examples":["POST /api/roles\n{\n \"role\": {\n \"name\": \"staff\"\n }\n}\n200\n{\n \"role\": {\n \"builtin\": 0,\n \"id\": 11,\n \"permissions\": [],\n \"name\": \"staff\"\n }\n}"],"name":"create","full_description":""},{"see":null,"apis":[{"api_url":"/api/roles/:id","http_method":"PUT","short_description":"Update an role."}],"doc_url":"/apidoc/roles/update","params":[{"allow_nil":false,"full_name":"id","expected_type":"string","description":"","required":true,"name":"id","validator":"Must be String"},{"allow_nil":false,"full_name":"role","params":[{"allow_nil":false,"full_name":"role[name]","expected_type":"string","description":"","required":false,"name":"name","validator":"Must be String"}],"expected_type":"hash","description":"","required":true,"name":"role","validator":"Must be a Hash"}],"formats":[],"see_url":null,"errors":[],"examples":["PUT /api/roles/1\n{\n \"role\": {}\n}\n200\n{\n \"role\": {\n \"builtin\": 0,\n \"id\": 1,\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 \"name\": \"Manager\"\n }\n}"],"name":"update","full_description":""},{"see":null,"apis":[{"api_url":"/api/roles/:id","http_method":"DELETE","short_description":"Delete an role."}],"doc_url":"/apidoc/roles/destroy","params":[{"allow_nil":false,"full_name":"id","expected_type":"string","description":"","required":true,"name":"id","validator":"Must be String"}],"formats":[],"see_url":null,"errors":[],"examples":["DELETE /api/roles/1\n200\n{\n \"role\": {\n \"builtin\": 0,\n \"id\": 1,\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 \"name\": \"Manager\"\n }\n}"],"name":"destroy","full_description":""}],"api_url":"/api","formats":[],"name":"Roles","full_description":"","short_description":""},"fact_values":{"version":"1","doc_url":"/apidoc/fact_values","methods":[{"see":null,"apis":[{"api_url":"/api/fact_values","http_method":"GET","short_description":"List all fact values."}],"doc_url":"/apidoc/fact_values/index","params":[{"allow_nil":false,"full_name":"search","expected_type":"string","description":"<p>filter results</p>\n","required":false,"name":"search","validator":"Must be String"},{"allow_nil":false,"full_name":"order","expected_type":"string","description":"<p>sort results</p>\n","required":false,"name":"order","validator":"Must be String"},{"allow_nil":false,"full_name":"page","expected_type":"string","description":"<p>paginate results</p>\n","required":false,"name":"page","validator":"Must be String"},{"allow_nil":false,"full_name":"per_page","expected_type":"string","description":"<p>number of entries per request</p>\n","required":false,"name":"per_page","validator":"Must be String"}],"formats":[],"see_url":null,"errors":[],"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}"],"name":"index","full_description":""}],"api_url":"/api","formats":[],"name":"Fact values","full_description":"","short_description":""},"home":{"version":"1","doc_url":"/apidoc/home","methods":[{"see":null,"apis":[{"api_url":"/api","http_method":"GET","short_description":"Show available links."}],"doc_url":"/apidoc/home/index","params":[],"formats":[],"see_url":null,"errors":[],"examples":["GET /api\n200\n{\n \"links\": {\n \"List all settings\": \"/api/settings\",\n \"List all bookmarks\": \"/api/bookmarks\",\n \"List all authsource ldaps\": \"/api/auth_source_ldaps\",\n \"List all usergroups\": \"/api/usergroups\",\n \"List all environments\": \"/api/environments\",\n \"List all smart_proxies\": \"/api/smart_proxies\",\n \"List all roles\": \"/api/roles\",\n \"List all puppetclasses\": \"/api/puppetclasses\",\n \"List all ptables\": \"/api/ptables\",\n \"List all models\": \"/api/models\",\n \"List all images for compute resource\": \"/api/compute_resources/:compute_resource_id/images\",\n \"List all fact values\": \"/api/fact_values\",\n \"List all architectures\": \"/api/architectures\",\n \"List all operating systems\": \"/api/operatingsystems\",\n \"List of domains\": \"/api/domains\",\n \"List all compute resources\": \"/api/compute_resources\",\n \"List all hosts\": \"/api/hosts\",\n \"List all media\": \"/api/media\",\n \"Show status\": \"/api/status\",\n \"List all common parameters\": \"/api/common_parameters\",\n \"List all template kinds\": \"/api/template_kinds\",\n \"List all users\": \"/api/users\",\n \"List templates\": \"/api/config_templates\",\n \"List of subnets\": \"/api/subnets\",\n \"List all audits\": \"/api/audits\",\n \"List all lookup_keys\": \"/api/lookup_keys\",\n \"List all reports\": \"/api/reports\",\n \"Get Dashboard results\": \"/api/dashboard\",\n \"List all hostgroups\": \"/api/hostgroups\",\n \"Show available links\": \"/api\"\n }\n}"],"name":"index","full_description":""},{"see":null,"apis":[{"api_url":"/api/status","http_method":"GET","short_description":"Show status."}],"doc_url":"/apidoc/home/status","params":[],"formats":[],"see_url":null,"errors":[],"examples":[],"name":"status","full_description":""}],"api_url":"/api","formats":[],"name":"Home","full_description":"","short_description":""},"compute_resources":{"version":"1","doc_url":"/apidoc/compute_resources","methods":[{"see":null,"apis":[{"api_url":"/api/compute_resources","http_method":"GET","short_description":"List all compute resources."}],"doc_url":"/apidoc/compute_resources/index","params":[{"allow_nil":false,"full_name":"search","expected_type":"string","description":"<p>filter results</p>\n","required":false,"name":"search","validator":"Must be String"},{"allow_nil":false,"full_name":"order","expected_type":"string","description":"<p>sort results</p>\n","required":false,"name":"order","validator":"Must be String"},{"allow_nil":false,"full_name":"page","expected_type":"string","description":"<p>paginate results</p>\n","required":false,"name":"page","validator":"Must be String"},{"allow_nil":false,"full_name":"per_page","expected_type":"string","description":"<p>number of entries per request</p>\n","required":false,"name":"per_page","validator":"Must be String"}],"formats":[],"see_url":null,"errors":[],"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 \"user\": \"MyString\",\n \"url\": \"test:///default\",\n \"id\": 367690737,\n \"description\": \"mycompute\",\n \"provider\": \"Libvirt\",\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 \"user\": \"MyString\",\n \"url\": \"qemu://stam/system\",\n \"id\": 980190962,\n \"description\": \"MyString\",\n \"provider\": \"Libvirt\",\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 \"user\": \"MyString\",\n \"url\": \"test:///default\",\n \"id\": 932571420,\n \"description\": \"yourcompute\",\n \"provider\": \"Libvirt\",\n \"name\": \"yourcompute\"\n }\n }\n]"],"name":"index","full_description":""},{"see":null,"apis":[{"api_url":"/api/compute_resources/:id","http_method":"GET","short_description":"Show an compute resource."}],"doc_url":"/apidoc/compute_resources/show","params":[{"allow_nil":false,"full_name":"id","expected_type":"string","description":"","required":true,"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."}],"formats":[],"see_url":null,"errors":[],"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 \"user\": \"MyString\",\n \"url\": \"qemu://stam/system\",\n \"id\": 980190962,\n \"description\": \"MyString\",\n \"provider\": \"Libvirt\",\n \"name\": \"MyString\"\n }\n}"],"name":"show","full_description":""},{"see":null,"apis":[{"api_url":"/api/compute_resources/:id","http_method":"PUT","short_description":"Update a compute resource."},{"api_url":"/api/compute_resources","http_method":"POST","short_description":"Create a compute resource."}],"doc_url":"/apidoc/compute_resources/create","params":[{"allow_nil":false,"full_name":"id","expected_type":"string","description":"","required":true,"name":"id","validator":"Must be String"},{"allow_nil":false,"full_name":"compute_resource","params":[{"allow_nil":false,"full_name":"compute_resource[name]","expected_type":"string","description":"","required":false,"name":"name","validator":"Must be String"},{"allow_nil":false,"full_name":"compute_resource[provider]","expected_type":"string","description":"<p>Providers include Libvirt, Ovirt, EC2, Vmware, Openstack, Rackspace</p>\n","required":false,"name":"provider","validator":"Must be String"},{"allow_nil":false,"full_name":"compute_resource[url]","expected_type":"string","description":"<p>URL for Libvirt, Ovirt, and Openstack</p>\n","required":false,"name":"url","validator":"Must be String"},{"allow_nil":false,"full_name":"compute_resource[description]","expected_type":"string","description":"","required":false,"name":"description","validator":"Must be String"},{"allow_nil":false,"full_name":"compute_resource[user]","expected_type":"string","description":"<p>Username for Ovirt, EC2, Vmware, Openstack. Access Key for EC2.</p>\n","required":false,"name":"user","validator":"Must be String"},{"allow_nil":false,"full_name":"compute_resource[password]","expected_type":"string","description":"<p>Password for Ovirt, EC2, Vmware, Openstack. Secret key for EC2</p>\n","required":false,"name":"password","validator":"Must be String"},{"allow_nil":false,"full_name":"compute_resource[uuid]","expected_type":"string","description":"<p>for Ovirt, Vmware Datacenter</p>\n","required":false,"name":"uuid","validator":"Must be String"},{"allow_nil":false,"full_name":"compute_resource[region]","expected_type":"string","description":"<p>for EC2 only</p>\n","required":false,"name":"region","validator":"Must be String"},{"allow_nil":false,"full_name":"compute_resource[tenant]","expected_type":"string","description":"<p>for Openstack only</p>\n","required":false,"name":"tenant","validator":"Must be String"},{"allow_nil":false,"full_name":"compute_resource[server]","expected_type":"string","description":"<p>for Vmware</p>\n","required":false,"name":"server","validator":"Must be String"}],"expected_type":"hash","description":"","required":true,"name":"compute_resource","validator":"Must be a Hash"},{"allow_nil":false,"full_name":"compute_resource","params":[{"allow_nil":false,"full_name":"compute_resource[name]","expected_type":"string","description":"","required":false,"name":"name","validator":"Must be String"},{"allow_nil":false,"full_name":"compute_resource[provider]","expected_type":"string","description":"<p>Providers include Libvirt, Ovirt, EC2, Vmware, Openstack, Rackspace</p>\n","required":false,"name":"provider","validator":"Must be String"},{"allow_nil":false,"full_name":"compute_resource[url]","expected_type":"string","description":"<p>URL for Libvirt, Ovirt, and Openstack</p>\n","required":true,"name":"url","validator":"Must be String"},{"allow_nil":false,"full_name":"compute_resource[description]","expected_type":"string","description":"","required":false,"name":"description","validator":"Must be String"},{"allow_nil":false,"full_name":"compute_resource[user]","expected_type":"string","description":"<p>Username for Ovirt, EC2, Vmware, Openstack. Access Key for EC2.</p>\n","required":false,"name":"user","validator":"Must be String"},{"allow_nil":false,"full_name":"compute_resource[password]","expected_type":"string","description":"<p>Password for Ovirt, EC2, Vmware, Openstack. Secret key for EC2</p>\n","required":false,"name":"password","validator":"Must be String"},{"allow_nil":false,"full_name":"compute_resource[uuid]","expected_type":"string","description":"<p>for Ovirt, Vmware Datacenter</p>\n","required":false,"name":"uuid","validator":"Must be String"},{"allow_nil":false,"full_name":"compute_resource[region]","expected_type":"string","description":"<p>for EC2 only</p>\n","required":false,"name":"region","validator":"Must be String"},{"allow_nil":false,"full_name":"compute_resource[tenant]","expected_type":"string","description":"<p>for Openstack only</p>\n","required":false,"name":"tenant","validator":"Must be String"},{"allow_nil":false,"full_name":"compute_resource[server]","expected_type":"string","description":"<p>for Vmware</p>\n","required":false,"name":"server","validator":"Must be String"}],"expected_type":"hash","description":"","required":true,"name":"compute_resource","validator":"Must be a Hash"}],"formats":[],"see_url":null,"errors":[],"examples":["POST /api/compute_resources\n{\n \"compute_resource\": {\n \"user\": \"user@example.com\",\n \"region\": \"eu-west-1\",\n \"password\": \"secret\",\n \"provider\": \"EC2\",\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 \"user\": \"user@example.com\",\n \"url\": \"eu-west-1\",\n \"id\": 980190963,\n \"description\": null,\n \"provider\": \"EC2\",\n \"name\": \"special_compute\"\n }\n}"],"name":"create","full_description":""},{"see":null,"apis":[{"api_url":"/api/compute_resources/:id","http_method":"PUT","short_description":"Update a compute resource."}],"doc_url":"/apidoc/compute_resources/update","params":[{"allow_nil":false,"full_name":"id","expected_type":"string","description":"","required":true,"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."}],"formats":[],"see_url":null,"errors":[],"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 \"updated_at\": \"2012-12-18T15:24:45Z\",\n \"user\": \"MyString\",\n \"url\": \"test:///default\",\n \"attrs\": {},\n \"id\": 367690737,\n \"description\": \"new_description\",\n \"uuid\": \"mycompute\",\n \"name\": \"mycompute\"\n }\n}"],"name":"update","full_description":""},{"see":null,"apis":[{"api_url":"/api/compute_resources/:id","http_method":"DELETE","short_description":"Delete a compute resource."}],"doc_url":"/apidoc/compute_resources/destroy","params":[{"allow_nil":false,"full_name":"id","expected_type":"string","description":"","required":true,"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."}],"formats":[],"see_url":null,"errors":[],"examples":["DELETE /api/compute_resources/932571420\n200\n{\n \"compute_resource\": {\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"user\": \"MyString\",\n \"url\": \"test:///default\",\n \"attrs\": null,\n \"id\": 932571420,\n \"description\": \"yourcompute\",\n \"uuid\": \"yourcompute\",\n \"name\": \"yourcompute\"\n }\n}"],"name":"destroy","full_description":""}],"api_url":"/api","formats":[],"name":"Compute resources","full_description":"","short_description":""},"smart_proxies":{"version":"1","doc_url":"/apidoc/smart_proxies","methods":[{"see":null,"apis":[{"api_url":"/api/smart_proxies","http_method":"GET","short_description":"List all smart_proxies."}],"doc_url":"/apidoc/smart_proxies/index","params":[{"allow_nil":false,"full_name":"type","expected_type":"string","description":"<p>filter by type</p>\n","required":false,"name":"type","validator":"Must be String"},{"allow_nil":false,"full_name":"page","expected_type":"string","description":"<p>paginate results</p>\n","required":false,"name":"page","validator":"Must be String"},{"allow_nil":false,"full_name":"per_page","expected_type":"string","description":"<p>number of entries per request</p>\n","required":false,"name":"per_page","validator":"Must be String"}],"formats":[],"see_url":null,"errors":[],"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}"],"name":"index","full_description":""},{"see":null,"apis":[{"api_url":"/api/smart_proxies/:id","http_method":"GET","short_description":"Show a smart proxy."}],"doc_url":"/apidoc/smart_proxies/show","params":[{"allow_nil":false,"full_name":"id","expected_type":"string","description":"","required":true,"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."}],"formats":[],"see_url":null,"errors":[],"examples":["GET /api/smart_proxies/980190962-dhcp-proxy\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 \"features\": [],\n \"name\": \"DHCP Proxy\"\n }\n}"],"name":"show","full_description":""},{"see":null,"apis":[{"api_url":"/api/smart_proxies","http_method":"POST","short_description":"Create a smart proxy."}],"doc_url":"/apidoc/smart_proxies/create","params":[{"allow_nil":false,"full_name":"smart_proxy","params":[{"allow_nil":false,"full_name":"smart_proxy[name]","expected_type":"string","description":"","required":true,"name":"name","validator":"Must be String"},{"allow_nil":false,"full_name":"smart_proxy[url]","expected_type":"string","description":"","required":true,"name":"url","validator":"Must be String"}],"expected_type":"hash","description":"","required":true,"name":"smart_proxy","validator":"Must be a Hash"}],"formats":[],"see_url":null,"errors":[],"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}"],"name":"create","full_description":""},{"see":null,"apis":[{"api_url":"/api/smart_proxies/:id","http_method":"PUT","short_description":"Update a smart proxy."}],"doc_url":"/apidoc/smart_proxies/update","params":[{"allow_nil":false,"full_name":"id","expected_type":"string","description":"","required":true,"name":"id","validator":"Must be String"},{"allow_nil":false,"full_name":"smart_proxy","params":[{"allow_nil":false,"full_name":"smart_proxy[name]","expected_type":"string","description":"","required":false,"name":"name","validator":"Must be String"},{"allow_nil":false,"full_name":"smart_proxy[url]","expected_type":"string","description":"","required":false,"name":"url","validator":"Must be String"}],"expected_type":"hash","description":"","required":true,"name":"smart_proxy","validator":"Must be a Hash"}],"formats":[],"see_url":null,"errors":[],"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}"],"name":"update","full_description":""},{"see":null,"apis":[{"api_url":"/api/smart_proxies/:id","http_method":"DELETE","short_description":"Delete a smart_proxy."}],"doc_url":"/apidoc/smart_proxies/destroy","params":[{"allow_nil":false,"full_name":"id","expected_type":"string","description":"","required":true,"name":"id","validator":"Must be String"}],"formats":[],"see_url":null,"errors":[],"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}"],"name":"destroy","full_description":""}],"api_url":"/api","formats":[],"name":"Smart proxies","full_description":"","short_description":""},"users":{"version":"1","doc_url":"/apidoc/users","methods":[{"see":null,"apis":[{"api_url":"/api/users","http_method":"GET","short_description":"List all users."}],"doc_url":"/apidoc/users/index","params":[{"allow_nil":false,"full_name":"search","expected_type":"string","description":"<p>filter results</p>\n","required":false,"name":"search","validator":"Must be String"},{"allow_nil":false,"full_name":"order","expected_type":"string","description":"<p>sort results</p>\n","required":false,"name":"order","validator":"Must be String"},{"allow_nil":false,"full_name":"page","expected_type":"string","description":"<p>paginate results</p>\n","required":false,"name":"page","validator":"Must be String"},{"allow_nil":false,"full_name":"per_page","expected_type":"string","description":"<p>number of entries per request</p>\n","required":false,"name":"per_page","validator":"Must be String"}],"formats":[],"see_url":null,"errors":[],"examples":["GET /api/users\n200\n[\n {\n \"user\": {\n \"auth_source_id\": 980190962,\n \"firstname\": \"Admin\",\n \"facts_andor\": \"or\",\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"compute_resources_andor\": \"or\",\n \"domains_andor\": \"or\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"hostgroups_andor\": \"or\",\n \"last_login_on\": \"2009-10-12T21:50:04Z\",\n \"lastname\": \"User\",\n \"mail\": \"admin@someware.com\",\n \"admin\": true,\n \"id\": 135138680,\n \"filter_on_owner\": null,\n \"role_id\": null,\n \"login\": \"admin\"\n }\n },\n {\n \"user\": {\n \"auth_source_id\": 200482051,\n \"firstname\": \"apiadmin\",\n \"facts_andor\": \"or\",\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"compute_resources_andor\": \"or\",\n \"domains_andor\": \"or\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"hostgroups_andor\": \"or\",\n \"last_login_on\": \"2009-10-12T21:50:04Z\",\n \"lastname\": \"User\",\n \"mail\": \"apiadmin@someware.com\",\n \"admin\": true,\n \"id\": 886836129,\n \"filter_on_owner\": null,\n \"role_id\": null,\n \"login\": \"apiadmin\"\n }\n },\n {\n \"user\": {\n \"auth_source_id\": 980190962,\n \"firstname\": \"One\",\n \"facts_andor\": \"or\",\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"compute_resources_andor\": \"or\",\n \"domains_andor\": \"or\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"hostgroups_andor\": \"or\",\n \"last_login_on\": \"2009-10-12T21:50:04Z\",\n \"lastname\": \"User\",\n \"mail\": \"userone@someware.com\",\n \"admin\": false,\n \"id\": 980190962,\n \"filter_on_owner\": null,\n \"role_id\": null,\n \"login\": \"one\"\n }\n },\n {\n \"user\": {\n \"auth_source_id\": 200482051,\n \"firstname\": \"test\",\n \"facts_andor\": \"or\",\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"compute_resources_andor\": \"or\",\n \"domains_andor\": \"or\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"hostgroups_andor\": \"or\",\n \"last_login_on\": \"2009-10-12T21:50:04Z\",\n \"lastname\": \"User\",\n \"mail\": \"testuser@someware.com\",\n \"admin\": false,\n \"id\": 200482051,\n \"filter_on_owner\": null,\n \"role_id\": null,\n \"login\": \"test\"\n }\n },\n {\n \"user\": {\n \"auth_source_id\": 980190962,\n \"firstname\": \"Two\",\n \"facts_andor\": \"or\",\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"compute_resources_andor\": \"or\",\n \"domains_andor\": \"or\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"hostgroups_andor\": \"or\",\n \"last_login_on\": \"2009-10-12T21:50:04Z\",\n \"lastname\": \"User\",\n \"mail\": \"usertwo@someware.com\",\n \"admin\": false,\n \"id\": 298486374,\n \"filter_on_owner\": null,\n \"role_id\": null,\n \"login\": \"two\"\n }\n }\n]"],"name":"index","full_description":""},{"see":null,"apis":[{"api_url":"/api/users/:id","http_method":"GET","short_description":"Show an user."}],"doc_url":"/apidoc/users/show","params":[{"allow_nil":false,"full_name":"id","expected_type":"string","description":"","required":true,"name":"id","validator":"Must be String"}],"formats":[],"see_url":null,"errors":[],"examples":["GET /api/users/980190962-one\n200\n{\n \"user\": {\n \"auth_source_id\": 980190962,\n \"firstname\": \"One\",\n \"facts_andor\": \"or\",\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"compute_resources_andor\": \"or\",\n \"roles\": [\n {\n \"role\": {\n \"builtin\": 0,\n \"id\": 5,\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 \"name\": \"Viewer\"\n }\n },\n {\n \"role\": {\n \"builtin\": 2,\n \"id\": 7,\n \"permissions\": [\n \"view_hosts\"\n ],\n \"name\": \"Anonymous\"\n }\n }\n ],\n \"domains_andor\": \"or\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"hostgroups_andor\": \"or\",\n \"last_login_on\": \"2009-10-12T21:50:04Z\",\n \"auth_source_ldap\": {\n \"host\": \"ldap\",\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"type\": \"AuthSourceLdap\",\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"attr_login\": \"uid\",\n \"tls\": true,\n \"onthefly_register\": true,\n \"account\": null,\n \"attr_firstname\": \"givenName\",\n \"base_dn\": \"dn=x,dn=y\",\n \"attr_mail\": \"mail\",\n \"id\": 980190962,\n \"attr_lastname\": \"sn\",\n \"name\": \"ldap\",\n \"port\": 123\n },\n \"lastname\": \"User\",\n \"mail\": \"userone@someware.com\",\n \"admin\": false,\n \"id\": 980190962,\n \"filter_on_owner\": null,\n \"role_id\": null,\n \"login\": \"one\"\n }\n}"],"name":"show","full_description":""},{"see":null,"apis":[{"api_url":"/api/users","http_method":"POST","short_description":"Create an user."}],"doc_url":"/apidoc/users/create","params":[{"allow_nil":false,"full_name":"user","params":[{"allow_nil":false,"full_name":"user[login]","expected_type":"string","description":"","required":true,"name":"login","validator":"Must be String"},{"allow_nil":false,"full_name":"user[firstname]","expected_type":"string","description":"","required":false,"name":"firstname","validator":"Must be String"},{"allow_nil":false,"full_name":"user[lastname]","expected_type":"string","description":"","required":false,"name":"lastname","validator":"Must be String"},{"allow_nil":false,"full_name":"user[mail]","expected_type":"string","description":"","required":true,"name":"mail","validator":"Must be String"},{"allow_nil":false,"full_name":"user[admin]","expected_type":"string","description":"<p>Is an admin account?</p>\n","required":false,"name":"admin","validator":"Must be 'true' or 'false'"},{"allow_nil":false,"full_name":"user[password]","expected_type":"string","description":"","required":true,"name":"password","validator":"Must be String"},{"allow_nil":false,"full_name":"user[auth_source_id]","expected_type":"numeric","description":"","required":true,"name":"auth_source_id","validator":"Must be Integer"}],"expected_type":"hash","description":"","required":true,"name":"user","validator":"Must be a Hash"}],"formats":[],"see_url":null,"errors":[],"examples":[],"name":"create","full_description":"<p>Adds role &#39;Anonymous&#39; to the user by default</p>\n"},{"see":null,"apis":[{"api_url":"/api/users/:id","http_method":"PUT","short_description":"Update an user."}],"doc_url":"/apidoc/users/update","params":[{"allow_nil":false,"full_name":"id","expected_type":"string","description":"","required":true,"name":"id","validator":"Must be String"},{"allow_nil":false,"full_name":"user","params":[{"allow_nil":false,"full_name":"user[login]","expected_type":"string","description":"","required":false,"name":"login","validator":"Must be String"},{"allow_nil":true,"full_name":"user[firstname]","expected_type":"string","description":"","required":false,"name":"firstname","validator":"Must be String"},{"allow_nil":true,"full_name":"user[lastname]","expected_type":"string","description":"","required":false,"name":"lastname","validator":"Must be String"},{"allow_nil":false,"full_name":"user[mail]","expected_type":"string","description":"","required":false,"name":"mail","validator":"Must be String"},{"allow_nil":false,"full_name":"user[admin]","expected_type":"string","description":"<p>Is an admin account?</p>\n","required":false,"name":"admin","validator":"Must be 'true' or 'false'"},{"allow_nil":false,"full_name":"user[password]","expected_type":"string","description":"","required":false,"name":"password","validator":"Must be String"}],"expected_type":"hash","description":"","required":true,"name":"user","validator":"Must be a Hash"}],"formats":[],"see_url":null,"errors":[],"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 \"errors\": {\n \"password\": [\n \"doesn't match confirmation\"\n ]\n },\n \"full_messages\": [\n \"Password doesn't match confirmation\"\n ],\n \"id\": 980190963\n }\n}"],"name":"update","full_description":"<p>Adds role &#39;Anonymous&#39; to the user if it is not already present.\nOnly admin can set admin account.</p>\n"},{"see":null,"apis":[{"api_url":"/api/users/:id","http_method":"DELETE","short_description":"Delete an user."}],"doc_url":"/apidoc/users/destroy","params":[{"allow_nil":false,"full_name":"id","expected_type":"string","description":"","required":true,"name":"id","validator":"Must be String"}],"formats":[],"see_url":null,"errors":[],"examples":["DELETE /api/users/980190962\n200\n{\n \"user\": {\n \"auth_source_id\": 980190962,\n \"firstname\": \"One\",\n \"facts_andor\": \"or\",\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"compute_resources_andor\": \"or\",\n \"domains_andor\": \"or\",\n \"password_hash\": null,\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"password_salt\": null,\n \"hostgroups_andor\": \"or\",\n \"last_login_on\": \"2009-10-12T21:50:04Z\",\n \"organizations_andor\": \"or\",\n \"lastname\": \"User\",\n \"mail\": \"userone@someware.com\",\n \"locations_andor\": \"or\",\n \"admin\": false,\n \"id\": 980190962,\n \"filter_on_owner\": null,\n \"role_id\": null,\n \"login\": \"one\"\n }\n}"],"name":"destroy","full_description":""}],"api_url":"/api","formats":[],"name":"Users","full_description":"","short_description":""},"operatingsystems":{"version":"1","doc_url":"/apidoc/operatingsystems","methods":[{"see":null,"apis":[{"api_url":"/api/operatingsystems","http_method":"GET","short_description":"List all operating systems."}],"doc_url":"/apidoc/operatingsystems/index","params":[{"allow_nil":false,"full_name":"search","expected_type":"string","description":"<p>filter results</p>\n","required":false,"name":"search","validator":"Must be String"},{"allow_nil":false,"full_name":"order","expected_type":"string","description":"<p>for example, name ASC, or name DESC</p>\n","required":false,"name":"order","validator":"Must be String"},{"allow_nil":false,"full_name":"page","expected_type":"string","description":"<p>paginate results</p>\n","required":false,"name":"page","validator":"Must be String"},{"allow_nil":false,"full_name":"per_page","expected_type":"string","description":"<p>number of entries per request</p>\n","required":false,"name":"per_page","validator":"Must be String"}],"formats":[],"see_url":null,"errors":[],"examples":[],"name":"index","full_description":""},{"see":null,"apis":[{"api_url":"/api/operatingsystems/:id","http_method":"GET","short_description":"Show an OS."}],"doc_url":"/apidoc/operatingsystems/show","params":[{"allow_nil":false,"full_name":"id","expected_type":"string","description":"","required":true,"name":"id","validator":"Must be String"}],"formats":[],"see_url":null,"errors":[],"examples":["GET /api/operatingsystems/1073012828\n200\n{\n \"operatingsystem\": {\n \"major\": \"6\",\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 \"minor\": \"1\",\n \"family\": \"Redhat\",\n \"release_name\": null,\n \"os_default_templates\": [],\n \"architectures\": [\n {\n \"architecture\": {\n \"id\": 501905019,\n \"name\": \"x86_64\"\n }\n }\n ],\n \"id\": 1073012828,\n \"name\": \"Redhat\",\n \"media\": [\n {\n \"medium\": {\n \"id\": 980190962,\n \"name\": \"CentOS 5.4\"\n }\n }\n ],\n \"ptables\": [\n {\n \"ptable\": {\n \"id\": 980190962,\n \"name\": \"default\"\n }\n }\n ]\n }\n}"],"name":"show","full_description":""},{"see":null,"apis":[{"api_url":"/api/operatingsystems","http_method":"POST","short_description":"Create an OS."}],"doc_url":"/apidoc/operatingsystems/create","params":[{"allow_nil":false,"full_name":"operatingsystem","params":[{"allow_nil":false,"full_name":"operatingsystem[name]","expected_type":"string","description":"","required":true,"name":"name","validator":"Must match regular expression /\\A(\\S+)\\Z/."},{"allow_nil":false,"full_name":"operatingsystem[major]","expected_type":"string","description":"","required":true,"name":"major","validator":"Must be String"},{"allow_nil":false,"full_name":"operatingsystem[minor]","expected_type":"string","description":"","required":true,"name":"minor","validator":"Must be String"},{"allow_nil":false,"full_name":"operatingsystem[family]","expected_type":"string","description":"","required":false,"name":"family","validator":"Must be String"},{"allow_nil":false,"full_name":"operatingsystem[release_name]","expected_type":"string","description":"","required":false,"name":"release_name","validator":"Must be String"}],"expected_type":"hash","description":"","required":true,"name":"operatingsystem","validator":"Must be a Hash"}],"formats":[],"see_url":null,"errors":[],"examples":["POST /api/operatingsystems\n{\n \"operatingsystem\": {\n \"major\": \"1\",\n \"minor\": \"2\",\n \"name\": \"awsome_os\"\n }\n}\n200\n{\n \"operatingsystem\": {\n \"major\": \"1\",\n \"config_templates\": [],\n \"minor\": \"2\",\n \"family\": null,\n \"release_name\": null,\n \"os_default_templates\": [],\n \"architectures\": [],\n \"id\": 1073012829,\n \"name\": \"awsome_os\",\n \"media\": [],\n \"ptables\": []\n }\n}"],"name":"create","full_description":""},{"see":null,"apis":[{"api_url":"/api/operatingsystems/:id","http_method":"PUT","short_description":"Update an OS."}],"doc_url":"/apidoc/operatingsystems/update","params":[{"allow_nil":false,"full_name":"id","expected_type":"string","description":"","required":true,"name":"id","validator":"Must be String"},{"allow_nil":false,"full_name":"operatingsystem","params":[{"allow_nil":false,"full_name":"operatingsystem[name]","expected_type":"string","description":"","required":false,"name":"name","validator":"Must match regular expression /\\A(\\S+)\\Z/."},{"allow_nil":false,"full_name":"operatingsystem[major]","expected_type":"string","description":"","required":false,"name":"major","validator":"Must be String"},{"allow_nil":false,"full_name":"operatingsystem[minor]","expected_type":"string","description":"","required":false,"name":"minor","validator":"Must be String"},{"allow_nil":false,"full_name":"operatingsystem[family]","expected_type":"string","description":"","required":false,"name":"family","validator":"Must be String"},{"allow_nil":false,"full_name":"operatingsystem[release_name]","expected_type":"string","description":"","required":false,"name":"release_name","validator":"Must be String"}],"expected_type":"hash","description":"","required":true,"name":"operatingsystem","validator":"Must be a Hash"}],"formats":[],"see_url":null,"errors":[],"examples":["PUT /api/operatingsystems/1073012828\n{\n \"operatingsystem\": {\n \"name\": \"new_name\"\n }\n}\n200\n{\n \"operatingsystem\": {\n \"major\": \"6\",\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 \"minor\": \"1\",\n \"family\": \"Redhat\",\n \"release_name\": null,\n \"os_default_templates\": [],\n \"architectures\": [\n {\n \"architecture\": {\n \"id\": 501905019,\n \"name\": \"x86_64\"\n }\n }\n ],\n \"id\": 1073012828,\n \"name\": \"new_name\",\n \"media\": [\n {\n \"medium\": {\n \"id\": 980190962,\n \"name\": \"CentOS 5.4\"\n }\n }\n ],\n \"ptables\": [\n {\n \"ptable\": {\n \"id\": 980190962,\n \"name\": \"default\"\n }\n }\n ]\n }\n}"],"name":"update","full_description":""},{"see":null,"apis":[{"api_url":"/api/operatingsystems/:id","http_method":"DELETE","short_description":"Delete an OS."}],"doc_url":"/apidoc/operatingsystems/destroy","params":[{"allow_nil":false,"full_name":"id","expected_type":"string","description":"","required":true,"name":"id","validator":"Must be String"}],"formats":[],"see_url":null,"errors":[],"examples":["DELETE /api/operatingsystems/775246587\n200\n{\n \"operatingsystem\": {\n \"config_templates\": [],\n \"architectures\": [],\n \"id\": 775246587,\n \"name\": \"NoHosts 1.1\",\n \"media\": [],\n \"ptables\": []\n }\n}"],"name":"destroy","full_description":""},{"see":null,"apis":[{"api_url":"/api/operatingsystems/:id/bootfiles","http_method":"GET","short_description":"List boot files an OS."}],"doc_url":"/apidoc/operatingsystems/bootfiles","params":[{"allow_nil":false,"full_name":"id","expected_type":"string","description":"","required":true,"name":"id","validator":"Must be String"},{"allow_nil":false,"full_name":"medium","expected_type":"string","description":"","required":false,"name":"medium","validator":"Must be String"},{"allow_nil":false,"full_name":"architecture","expected_type":"string","description":"","required":false,"name":"architecture","validator":"Must be String"}],"formats":[],"see_url":null,"errors":[],"examples":[],"name":"bootfiles","full_description":""}],"api_url":"/api","formats":[],"name":"Operating systems","full_description":"","short_description":""},"settings":{"version":"1","doc_url":"/apidoc/settings","methods":[{"see":null,"apis":[{"api_url":"/api/settings","http_method":"GET","short_description":"List all settings."}],"doc_url":"/apidoc/settings/index","params":[{"allow_nil":false,"full_name":"search","expected_type":"string","description":"<p>Filter results</p>\n","required":false,"name":"search","validator":"Must be String"},{"allow_nil":false,"full_name":"order","expected_type":"string","description":"<p>Sort results</p>\n","required":false,"name":"order","validator":"Must be String"},{"allow_nil":false,"full_name":"page","expected_type":"string","description":"<p>paginate results</p>\n","required":false,"name":"page","validator":"Must be String"},{"allow_nil":false,"full_name":"per_page","expected_type":"string","description":"<p>number of entries per request</p>\n","required":false,"name":"per_page","validator":"Must be String"}],"formats":[],"see_url":null,"errors":[],"examples":[],"name":"index","full_description":""},{"see":null,"apis":[{"api_url":"/api/settings/:id","http_method":"GET","short_description":"Show an setting."}],"doc_url":"/apidoc/settings/show","params":[{"allow_nil":false,"full_name":"id","expected_type":"string","description":"","required":true,"name":"id","validator":"Must be String"}],"formats":[],"see_url":null,"errors":[],"examples":["GET /api/settings/333972760\n200\n{\n \"setting\": {\n \"default\": \"root@some.host.fqdn\",\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"id\": 333972760,\n \"settings_type\": null,\n \"description\": \"The Default administrator email address\",\n \"value\": \"root@some.host.fqdn\",\n \"category\": \"General\",\n \"name\": \"administrator\"\n }\n}"],"name":"show","full_description":""},{"see":null,"apis":[{"api_url":"/api/settings/:id","http_method":"PUT","short_description":"Update a setting."}],"doc_url":"/apidoc/settings/update","params":[{"allow_nil":false,"full_name":"id","expected_type":"string","description":"","required":true,"name":"id","validator":"Must be String"},{"allow_nil":false,"full_name":"setting","params":[{"allow_nil":false,"full_name":"setting[value]","expected_type":"string","description":"","required":false,"name":"value","validator":"Must be String"}],"expected_type":"hash","description":"","required":true,"name":"setting","validator":"Must be a Hash"}],"formats":[],"see_url":null,"errors":[],"examples":["PUT /api/settings/333972760\n{\n \"setting\": {}\n}\n200\n{\n \"setting\": {\n \"default\": \"root@some.host.fqdn\",\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"id\": 333972760,\n \"settings_type\": null,\n \"description\": \"The Default administrator email address\",\n \"value\": \"root@some.host.fqdn\",\n \"category\": \"General\",\n \"name\": \"administrator\"\n }\n}"],"name":"update","full_description":""}],"api_url":"/api","formats":[],"name":"Settings","full_description":"","short_description":""},"lookup_keys":{"version":"1","doc_url":"/apidoc/lookup_keys","methods":[{"see":null,"apis":[{"api_url":"/api/lookup_keys","http_method":"GET","short_description":"List all lookup_keys."}],"doc_url":"/apidoc/lookup_keys/index","params":[{"allow_nil":false,"full_name":"search","expected_type":"string","description":"<p>filter results</p>\n","required":false,"name":"search","validator":"Must be String"},{"allow_nil":false,"full_name":"order","expected_type":"string","description":"<p>sort results</p>\n","required":false,"name":"order","validator":"Must be String"},{"allow_nil":false,"full_name":"page","expected_type":"string","description":"<p>paginate results</p>\n","required":false,"name":"page","validator":"Must be String"},{"allow_nil":false,"full_name":"per_page","expected_type":"string","description":"<p>number of entries per request</p>\n","required":false,"name":"per_page","validator":"Must be String"}],"formats":[],"see_url":null,"errors":[],"examples":["GET /api/lookup_keys\n200\n[\n {\n \"lookup_key\": {\n \"default_value\": \"80\",\n \"override\": false,\n \"required\": false,\n \"is_param\": true,\n \"id\": 980190962,\n \"key\": \"port\",\n \"description\": null\n }\n },\n {\n \"lookup_key\": {\n \"default_value\": \"t\",\n \"override\": true,\n \"required\": false,\n \"is_param\": true,\n \"id\": 113629430,\n \"key\": \"ssl\",\n \"description\": null\n }\n },\n {\n \"lookup_key\": {\n \"default_value\": \"443\",\n \"override\": false,\n \"required\": false,\n \"is_param\": false,\n \"id\": 298486374,\n \"key\": \"ssl_port\",\n \"description\": null\n }\n }\n]"],"name":"index","full_description":""},{"see":null,"apis":[{"api_url":"/api/lookup_keys/:id","http_method":"GET","short_description":"Show a lookup key."}],"doc_url":"/apidoc/lookup_keys/show","params":[{"allow_nil":false,"full_name":"id","expected_type":"string","description":"","required":true,"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."}],"formats":[],"see_url":null,"errors":[],"examples":["GET /api/lookup_keys/980190962-port\n200\n{\n \"lookup_key\": {\n \"default_value\": \"80\",\n \"override\": false,\n \"required\": false,\n \"is_param\": true,\n \"id\": 980190962,\n \"key\": \"port\",\n \"description\": null\n }\n}"],"name":"show","full_description":""},{"see":null,"apis":[{"api_url":"/api/lookup_keys","http_method":"POST","short_description":"Create a lookup key."}],"doc_url":"/apidoc/lookup_keys/create","params":[{"allow_nil":false,"full_name":"lookup_key","params":[{"allow_nil":false,"full_name":"lookup_key[key]","expected_type":"string","description":"","required":true,"name":"key","validator":"Must be String"},{"allow_nil":false,"full_name":"lookup_key[puppetclass_id]","expected_type":"string","description":"","required":false,"name":"puppetclass_id","validator":"Must be a number."},{"allow_nil":false,"full_name":"lookup_key[default_value]","expected_type":"string","description":"","required":false,"name":"default_value","validator":"Must be String"},{"allow_nil":false,"full_name":"lookup_key[path]","expected_type":"string","description":"","required":false,"name":"path","validator":"Must be String"},{"allow_nil":false,"full_name":"lookup_key[description]","expected_type":"string","description":"","required":false,"name":"description","validator":"Must be String"},{"allow_nil":false,"full_name":"lookup_key[lookup_values_count]","expected_type":"string","description":"","required":false,"name":"lookup_values_count","validator":"Must be a number."}],"expected_type":"hash","description":"","required":true,"name":"lookup_key","validator":"Must be a Hash"}],"formats":[],"see_url":null,"errors":[],"examples":["POST /api/lookup_keys\n{\n \"lookup_key\": {\n \"is_param\": true,\n \"key\": \"testkey\"\n }\n}\n201\n{\n \"lookup_key\": {\n \"default_value\": null,\n \"override\": false,\n \"required\": false,\n \"is_param\": true,\n \"id\": 980190963,\n \"key\": \"testkey\",\n \"description\": null\n }\n}"],"name":"create","full_description":""},{"see":null,"apis":[{"api_url":"/api/lookup_keys/:id","http_method":"PUT","short_description":"Update a lookup key."}],"doc_url":"/apidoc/lookup_keys/update","params":[{"allow_nil":false,"full_name":"id","expected_type":"string","description":"","required":true,"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."},{"allow_nil":false,"full_name":"lookup_key","params":[{"allow_nil":false,"full_name":"lookup_key[key]","expected_type":"string","description":"","required":false,"name":"key","validator":"Must be String"},{"allow_nil":false,"full_name":"lookup_key[puppetclass_id]","expected_type":"string","description":"","required":false,"name":"puppetclass_id","validator":"Must be a number."},{"allow_nil":false,"full_name":"lookup_key[default_value]","expected_type":"string","description":"","required":false,"name":"default_value","validator":"Must be String"},{"allow_nil":false,"full_name":"lookup_key[path]","expected_type":"string","description":"","required":false,"name":"path","validator":"Must be String"},{"allow_nil":false,"full_name":"lookup_key[description]","expected_type":"string","description":"","required":false,"name":"description","validator":"Must be String"},{"allow_nil":false,"full_name":"lookup_key[lookup_values_count]","expected_type":"string","description":"","required":false,"name":"lookup_values_count","validator":"Must be a number."}],"expected_type":"hash","description":"","required":true,"name":"lookup_key","validator":"Must be a Hash"}],"formats":[],"see_url":null,"errors":[],"examples":["PUT /api/lookup_keys/980190962-port\n{\n \"lookup_key\": {\n \"default_value\": 8080\n }\n}\n200\n{\n \"lookup_key\": {\n \"default_value\": 8080,\n \"override\": false,\n \"required\": false,\n \"is_param\": true,\n \"id\": 980190962,\n \"key\": \"port\",\n \"description\": null\n }\n}"],"name":"update","full_description":""},{"see":null,"apis":[{"api_url":"/api/lookup_keys/:id","http_method":"DELETE","short_description":"Delete a lookup key."}],"doc_url":"/apidoc/lookup_keys/destroy","params":[{"allow_nil":false,"full_name":"id","expected_type":"string","description":"","required":true,"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."}],"formats":[],"see_url":null,"errors":[],"examples":["DELETE /api/lookup_keys/980190962-port\n200\n{\n \"lookup_key\": {\n \"default_value\": \"80\",\n \"override\": false,\n \"required\": false,\n \"is_param\": true,\n \"id\": 980190962,\n \"key\": \"port\",\n \"description\": null\n }\n}"],"name":"destroy","full_description":""}],"api_url":"/api","formats":[],"name":"Lookup keys","full_description":"","short_description":""},"images":{"version":"1","doc_url":"/apidoc/images","methods":[{"see":null,"apis":[{"api_url":"/api/compute_resources/:compute_resource_id/images","http_method":"GET","short_description":"List all images for compute resource"}],"doc_url":"/apidoc/images/index","params":[{"allow_nil":false,"full_name":"search","expected_type":"string","description":"<p>filter results</p>\n","required":false,"name":"search","validator":"Must be String"},{"allow_nil":false,"full_name":"order","expected_type":"string","description":"<p>sort results</p>\n","required":false,"name":"order","validator":"Must be String"},{"allow_nil":false,"full_name":"page","expected_type":"string","description":"<p>paginate results</p>\n","required":false,"name":"page","validator":"Must be String"},{"allow_nil":false,"full_name":"per_page","expected_type":"string","description":"<p>number of entries per request</p>\n","required":false,"name":"per_page","validator":"Must be String"},{"allow_nil":false,"full_name":"compute_resource_id","expected_type":"string","description":"","required":true,"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."}],"formats":[],"see_url":null,"errors":[],"examples":["GET /api/compute_resources/980190962/images\n200\n[\n {\n \"image\": {\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"username\": \"MyString\",\n \"compute_resource_id\": 980190962,\n \"operatingsystem_id\": 309172073,\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"id\": 298486374,\n \"uuid\": \"MyString2\",\n \"name\": \"centos-2\",\n \"architecture_id\": 501905019\n }\n },\n {\n \"image\": {\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"username\": \"root\",\n \"compute_resource_id\": 980190962,\n \"operatingsystem_id\": 309172073,\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"id\": 980190962,\n \"uuid\": \"string-of-uuid\",\n \"name\": \"centos-1\",\n \"architecture_id\": 501905019\n }\n }\n]"],"name":"index","full_description":""},{"see":null,"apis":[{"api_url":"/api/compute_resources/:compute_resource_id/images/:id","http_method":"GET","short_description":"Show an image"}],"doc_url":"/apidoc/images/show","params":[{"allow_nil":false,"full_name":"id","expected_type":"string","description":"","required":true,"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."},{"allow_nil":false,"full_name":"compute_resource_id","expected_type":"string","description":"","required":true,"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."}],"formats":[],"see_url":null,"errors":[],"examples":["GET /api/compute_resources/980190962/images/980190962\n200\n{\n \"image\": {\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"username\": \"root\",\n \"compute_resource_id\": 980190962,\n \"operatingsystem_id\": 309172073,\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"id\": 980190962,\n \"uuid\": \"string-of-uuid\",\n \"name\": \"centos-1\",\n \"architecture_id\": 501905019\n }\n}"],"name":"show","full_description":""},{"see":null,"apis":[{"api_url":"/api/compute_resources/:compute_resource_id/images","http_method":"POST","short_description":"Create a image"}],"doc_url":"/apidoc/images/create","params":[{"allow_nil":false,"full_name":"compute_resource_id","expected_type":"string","description":"","required":true,"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."},{"allow_nil":false,"full_name":"image","params":[{"allow_nil":false,"full_name":"image[name]","expected_type":"string","description":"","required":true,"name":"name","validator":"Must be String"},{"allow_nil":false,"full_name":"image[username]","expected_type":"string","description":"","required":true,"name":"username","validator":"Must be String"},{"allow_nil":false,"full_name":"image[uuid]","expected_type":"string","description":"","required":true,"name":"uuid","validator":"Must be String"},{"allow_nil":false,"full_name":"image[compute_resource_id]","expected_type":"string","description":"","required":true,"name":"compute_resource_id","validator":"Must be a number."},{"allow_nil":false,"full_name":"image[architecture_id]","expected_type":"string","description":"","required":true,"name":"architecture_id","validator":"Must be a number."},{"allow_nil":false,"full_name":"image[operatingsystem_id]","expected_type":"string","description":"","required":true,"name":"operatingsystem_id","validator":"Must be a number."}],"expected_type":"hash","description":"","required":true,"name":"image","validator":"Must be a Hash"}],"formats":[],"see_url":null,"errors":[],"examples":["POST /api/compute_resources/980190962/images\n{\n \"image\": {\n \"username\": \"ec2-user\",\n \"compute_resource_id\": 367690737,\n \"operatingsystem_id\": 309172073,\n \"uuid\": \"abcdef\",\n \"name\": \"TestImage\",\n \"architecture_id\": 381564594\n }\n}\n201\n{\n \"compute_resource\": {\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"user\": \"MyString\",\n \"url\": \"qemu://stam/system\",\n \"attrs\": null,\n \"id\": 980190962,\n \"description\": \"MyString\",\n \"uuid\": \"MyString\",\n \"name\": \"MyString\"\n }\n}"],"name":"create","full_description":""},{"see":null,"apis":[{"api_url":"/api/compute_resources/:compute_resource_id/images/:id","http_method":"PUT","short_description":"Update a image."}],"doc_url":"/apidoc/images/update","params":[{"allow_nil":false,"full_name":"compute_resource_id","expected_type":"string","description":"","required":true,"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."},{"allow_nil":false,"full_name":"id","expected_type":"string","description":"","required":true,"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."},{"allow_nil":false,"full_name":"image","params":[{"allow_nil":false,"full_name":"image[name]","expected_type":"string","description":"","required":false,"name":"name","validator":"Must be String"},{"allow_nil":false,"full_name":"image[username]","expected_type":"string","description":"","required":false,"name":"username","validator":"Must be String"},{"allow_nil":false,"full_name":"image[uuid]","expected_type":"string","description":"","required":false,"name":"uuid","validator":"Must be String"},{"allow_nil":false,"full_name":"image[compute_resource_id]","expected_type":"string","description":"","required":false,"name":"compute_resource_id","validator":"Must be a number."},{"allow_nil":false,"full_name":"image[architecture_id]","expected_type":"string","description":"","required":false,"name":"architecture_id","validator":"Must be a number."},{"allow_nil":false,"full_name":"image[operatingsystem_id]","expected_type":"string","description":"","required":false,"name":"operatingsystem_id","validator":"Must be a number."}],"expected_type":"hash","description":"","required":true,"name":"image","validator":"Must be a Hash"}],"formats":[],"see_url":null,"errors":[],"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 \"compute_resource_id\": 980190962,\n \"operatingsystem_id\": 309172073,\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"id\": 980190962,\n \"uuid\": \"string-of-uuid\",\n \"name\": \"centos-1\",\n \"architecture_id\": 501905019\n }\n}"],"name":"update","full_description":""},{"see":null,"apis":[{"api_url":"/api/compute_resources/:compute_resource_id/images/:id","http_method":"DELETE","short_description":"Delete an image."}],"doc_url":"/apidoc/images/destroy","params":[{"allow_nil":false,"full_name":"compute_resource_id","expected_type":"string","description":"","required":true,"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."},{"allow_nil":false,"full_name":"id","expected_type":"string","description":"","required":true,"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."}],"formats":[],"see_url":null,"errors":[],"examples":["DELETE /api/compute_resources/980190962/images/980190962\n200\n{\n \"image\": {\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"username\": \"root\",\n \"compute_resource_id\": 980190962,\n \"operatingsystem_id\": 309172073,\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"id\": 980190962,\n \"uuid\": \"string-of-uuid\",\n \"name\": \"centos-1\",\n \"architecture_id\": 501905019\n }\n}"],"name":"destroy","full_description":""}],"api_url":"/api","formats":[],"name":"Images","full_description":"","short_description":""},"architectures":{"version":"1","doc_url":"/apidoc/architectures","methods":[{"see":null,"apis":[{"api_url":"/api/architectures","http_method":"GET","short_description":"List all architectures."}],"doc_url":"/apidoc/architectures/index","params":[{"allow_nil":false,"full_name":"search","expected_type":"string","description":"<p>filter results</p>\n","required":false,"name":"search","validator":"Must be String"},{"allow_nil":false,"full_name":"order","expected_type":"string","description":"<p>sort results</p>\n","required":false,"name":"order","validator":"Must be String"},{"allow_nil":false,"full_name":"page","expected_type":"string","description":"<p>paginate results</p>\n","required":false,"name":"page","validator":"Must be String"},{"allow_nil":false,"full_name":"per_page","expected_type":"string","description":"<p>number of entries per request</p>\n","required":false,"name":"per_page","validator":"Must be String"}],"formats":[],"see_url":null,"errors":[],"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 \"id\": 381564594,\n \"name\": \"s390\",\n \"operatingsystem_ids\": []\n }\n },\n {\n \"architecture\": {\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"id\": 331892513,\n \"name\": \"sparc\",\n \"operatingsystem_ids\": [\n 442321401\n ]\n }\n },\n {\n \"architecture\": {\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"id\": 501905019,\n \"name\": \"x86_64\",\n \"operatingsystem_ids\": [\n 331303656,\n 309172073,\n 1073012828\n ]\n }\n }\n]"],"name":"index","full_description":""},{"see":null,"apis":[{"api_url":"/api/architectures/:id","http_method":"GET","short_description":"Show an architecture."}],"doc_url":"/apidoc/architectures/show","params":[{"allow_nil":false,"full_name":"id","expected_type":"string","description":"","required":true,"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."}],"formats":[],"see_url":null,"errors":[],"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 \"id\": 501905019,\n \"name\": \"x86_64\",\n \"operatingsystem_ids\": [\n 309172073,\n 1073012828,\n 331303656\n ]\n }\n}"],"name":"show","full_description":""},{"see":null,"apis":[{"api_url":"/api/architectures","http_method":"POST","short_description":"Create an architecture."}],"doc_url":"/apidoc/architectures/create","params":[{"allow_nil":false,"full_name":"architecture","params":[{"allow_nil":false,"full_name":"architecture[name]","expected_type":"string","description":"","required":true,"name":"name","validator":"Must be String"},{"allow_nil":false,"full_name":"architecture[operatingsystem_ids]","expected_type":"string","description":"<p>Operatingsystem ID&#39;s</p>\n","required":false,"name":"operatingsystem_ids","validator":"Must be Array"}],"expected_type":"hash","description":"","required":true,"name":"architecture","validator":"Must be a Hash"}],"formats":[],"see_url":null,"errors":[],"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 \"id\": 501905020,\n \"name\": \"i386\",\n \"operatingsystem_ids\": []\n }\n}"],"name":"create","full_description":""},{"see":null,"apis":[{"api_url":"/api/architectures/:id","http_method":"PUT","short_description":"Update an architecture."}],"doc_url":"/apidoc/architectures/update","params":[{"allow_nil":false,"full_name":"id","expected_type":"string","description":"","required":true,"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."},{"allow_nil":false,"full_name":"architecture","params":[{"allow_nil":false,"full_name":"architecture[name]","expected_type":"string","description":"","required":false,"name":"name","validator":"Must be String"},{"allow_nil":false,"full_name":"architecture[operatingsystem_ids]","expected_type":"string","description":"<p>Operatingsystem ID&#39;s</p>\n","required":false,"name":"operatingsystem_ids","validator":"Must be Array"}],"expected_type":"hash","description":"","required":true,"name":"architecture","validator":"Must be a Hash"}],"formats":[],"see_url":null,"errors":[],"examples":["PUT /api/architectures/x86_64\n{\n \"architecture\": {}\n}\n200\n{\n \"architecture\": {\n \"id\": 501905019,\n \"name\": \"x86_64\"\n }\n}"],"name":"update","full_description":""},{"see":null,"apis":[{"api_url":"/api/architectures/:id","http_method":"DELETE","short_description":"Delete an architecture."}],"doc_url":"/apidoc/architectures/destroy","params":[{"allow_nil":false,"full_name":"id","expected_type":"string","description":"","required":true,"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."}],"formats":[],"see_url":null,"errors":[],"examples":["DELETE /api/architectures/s390\n200\n{\n \"architecture\": {\n \"id\": 381564594,\n \"name\": \"s390\"\n }\n}"],"name":"destroy","full_description":""}],"api_url":"/api","formats":[],"name":"Architectures","full_description":"","short_description":""},"subnets":{"version":"1","doc_url":"/apidoc/subnets","methods":[{"see":null,"apis":[{"api_url":"/api/subnets","http_method":"GET","short_description":"List of subnets"}],"doc_url":"/apidoc/subnets/index","params":[{"allow_nil":false,"full_name":"search","expected_type":"string","description":"<p>Filter results</p>\n","required":false,"name":"search","validator":"Must be String"},{"allow_nil":false,"full_name":"order","expected_type":"string","description":"<p>Sort results</p>\n","required":false,"name":"order","validator":"Must be String"},{"allow_nil":false,"full_name":"page","expected_type":"string","description":"<p>paginate results</p>\n","required":false,"name":"page","validator":"Must be String"},{"allow_nil":false,"full_name":"per_page","expected_type":"string","description":"<p>number of entries per request</p>\n","required":false,"name":"per_page","validator":"Must be String"}],"formats":[],"see_url":null,"errors":[],"examples":["GET /api/subnets\n200\n[\n {\n \"subnet\": {\n \"dns_secondary\": null,\n \"dns_id\": 113629430,\n \"domain_ids\": [\n 822172901\n ],\n \"priority\": null,\n \"gateway\": null,\n \"mask\": \"255.255.255.0\",\n \"dhcp_id\": 980190962,\n \"network\": \"2.3.4.0\",\n \"to\": null,\n \"id\": 980190962,\n \"tftp_id\": 298486374,\n \"from\": null,\n \"dns_primary\": null,\n \"name\": \"one\",\n \"vlanid\": \"41\"\n }\n },\n {\n \"subnet\": {\n \"dns_secondary\": null,\n \"dns_id\": null,\n \"domain_ids\": [\n 534821992\n ],\n \"priority\": null,\n \"gateway\": null,\n \"mask\": \"255.255.255.0\",\n \"dhcp_id\": 980190962,\n \"network\": \"3.3.4.0\",\n \"to\": null,\n \"id\": 298486374,\n \"tftp_id\": 298486374,\n \"from\": null,\n \"dns_primary\": null,\n \"name\": \"two\",\n \"vlanid\": \"42\"\n }\n },\n {\n \"subnet\": {\n \"dns_secondary\": null,\n \"dns_id\": null,\n \"domain_ids\": [],\n \"priority\": null,\n \"gateway\": null,\n \"mask\": \"255.255.255.0\",\n \"dhcp_id\": 980190962,\n \"network\": \"3.3.4.3\",\n \"to\": null,\n \"id\": 113629430,\n \"tftp_id\": 298486374,\n \"from\": null,\n \"dns_primary\": null,\n \"name\": \"three\",\n \"vlanid\": \"43\"\n }\n }\n]"],"name":"index","full_description":""},{"see":null,"apis":[{"api_url":"/api/subnets/:id","http_method":"GET","short_description":"Show a subnet."}],"doc_url":"/apidoc/subnets/show","params":[{"allow_nil":false,"full_name":"id","expected_type":"string","description":"","required":true,"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."}],"formats":[],"see_url":null,"errors":[],"examples":["GET /api/subnets/980190962\n200\n{\n \"subnet\": {\n \"dns_secondary\": null,\n \"dns_id\": 113629430,\n \"tftp\": {\n \"url\": \"http://somewhere.else\",\n \"id\": 298486374,\n \"name\": \"TFTP Proxy\"\n },\n \"dns\": {\n \"url\": \"http://else.where:4567\",\n \"id\": 113629430,\n \"name\": \"DNS Proxy\"\n },\n \"domain_ids\": [\n 822172901\n ],\n \"priority\": null,\n \"gateway\": null,\n \"mask\": \"255.255.255.0\",\n \"dhcp_id\": 980190962,\n \"network\": \"2.3.4.0\",\n \"to\": null,\n \"id\": 980190962,\n \"tftp_id\": 298486374,\n \"from\": null,\n \"dns_primary\": null,\n \"name\": \"one\",\n \"vlanid\": \"41\",\n \"dhcp\": {\n \"url\": \"https://somewhere.net:8443\",\n \"id\": 980190962,\n \"name\": \"DHCP Proxy\"\n }\n }\n}"],"name":"show","full_description":""},{"see":null,"apis":[{"api_url":"/api/subnets","http_method":"POST","short_description":"Create a subnet"}],"doc_url":"/apidoc/subnets/create","params":[{"allow_nil":false,"full_name":"subnet","params":[{"allow_nil":false,"full_name":"subnet[name]","expected_type":"string","description":"<p>Subnet name</p>\n","required":true,"name":"name","validator":"Must be String"},{"allow_nil":false,"full_name":"subnet[network]","expected_type":"string","description":"<p>Subnet network</p>\n","required":true,"name":"network","validator":"Must be String"},{"allow_nil":false,"full_name":"subnet[mask]","expected_type":"string","description":"<p>Netmask for this subnet</p>\n","required":true,"name":"mask","validator":"Must be String"},{"allow_nil":false,"full_name":"subnet[gateway]","expected_type":"string","description":"<p>Primary DNS for this subnet</p>\n","required":false,"name":"gateway","validator":"Must be String"},{"allow_nil":false,"full_name":"subnet[dns_primary]","expected_type":"string","description":"<p>Primary DNS for this subnet</p>\n","required":false,"name":"dns_primary","validator":"Must be String"},{"allow_nil":false,"full_name":"subnet[dns_secondary]","expected_type":"string","description":"<p>Secondary DNS for this subnet</p>\n","required":false,"name":"dns_secondary","validator":"Must be String"},{"allow_nil":false,"full_name":"subnet[from]","expected_type":"string","description":"<p>Starting IP Address for IP auto suggestion</p>\n","required":false,"name":"from","validator":"Must be String"},{"allow_nil":false,"full_name":"subnet[to]","expected_type":"string","description":"<p>Ending IP Address for IP auto suggestion</p>\n","required":false,"name":"to","validator":"Must be String"},{"allow_nil":false,"full_name":"subnet[vlanid]","expected_type":"string","description":"<p>VLAN ID for this subnet</p>\n","required":false,"name":"vlanid","validator":"Must be String"},{"allow_nil":false,"full_name":"subnet[domain_ids]","expected_type":"string","description":"<p>Domains in which this subnet is part</p>\n","required":false,"name":"domain_ids","validator":"Must be Array"},{"allow_nil":false,"full_name":"subnet[dhcp_id]","expected_type":"string","description":"<p>DHCP Proxy to use within this subnet</p>\n","required":false,"name":"dhcp_id","validator":"Must be a number."},{"allow_nil":false,"full_name":"subnet[tftp_id]","expected_type":"string","description":"<p>TFTP Proxy to use within this subnet</p>\n","required":false,"name":"tftp_id","validator":"Must be a number."},{"allow_nil":false,"full_name":"subnet[dns_id]","expected_type":"string","description":"<p>DNS Proxy to use within this subnet</p>\n","required":false,"name":"dns_id","validator":"Must be a number."}],"expected_type":"hash","description":"","required":true,"name":"subnet","validator":"Must be a Hash"}],"formats":[],"see_url":null,"errors":[],"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_secondary\": null,\n \"dns_id\": null,\n \"tftp\": null,\n \"dns\": null,\n \"domain_ids\": [],\n \"priority\": null,\n \"gateway\": null,\n \"mask\": \"255.255.255.0\",\n \"dhcp_id\": null,\n \"network\": \"10.35.2.27\",\n \"to\": null,\n \"id\": 980190963,\n \"tftp_id\": null,\n \"from\": null,\n \"dns_primary\": null,\n \"name\": \"QA2\",\n \"vlanid\": null,\n \"dhcp\": null\n }\n}"],"name":"create","full_description":""},{"see":null,"apis":[{"api_url":"/api/subnets/:id","http_method":"PUT","short_description":"Update a subnet"}],"doc_url":"/apidoc/subnets/update","params":[{"allow_nil":false,"full_name":"id","expected_type":"string","description":"<p>Subnet numeric identifier</p>\n","required":true,"name":"id","validator":"Must be a number."},{"allow_nil":false,"full_name":"subnet","params":[{"allow_nil":false,"full_name":"subnet[name]","expected_type":"string","description":"<p>Subnet name</p>\n","required":false,"name":"name","validator":"Must be String"},{"allow_nil":false,"full_name":"subnet[network]","expected_type":"string","description":"<p>Subnet network</p>\n","required":false,"name":"network","validator":"Must be String"},{"allow_nil":false,"full_name":"subnet[mask]","expected_type":"string","description":"<p>Netmask for this subnet</p>\n","required":false,"name":"mask","validator":"Must be String"},{"allow_nil":true,"full_name":"subnet[gateway]","expected_type":"string","description":"<p>Primary DNS for this subnet</p>\n","required":false,"name":"gateway","validator":"Must be String"},{"allow_nil":true,"full_name":"subnet[dns_primary]","expected_type":"string","description":"<p>Primary DNS for this subnet</p>\n","required":false,"name":"dns_primary","validator":"Must be String"},{"allow_nil":true,"full_name":"subnet[dns_secondary]","expected_type":"string","description":"<p>Secondary DNS for this subnet</p>\n","required":false,"name":"dns_secondary","validator":"Must be String"},{"allow_nil":true,"full_name":"subnet[from]","expected_type":"string","description":"<p>Starting IP Address for IP auto suggestion</p>\n","required":false,"name":"from","validator":"Must be String"},{"allow_nil":true,"full_name":"subnet[to]","expected_type":"string","description":"<p>Ending IP Address for IP auto suggestion</p>\n","required":false,"name":"to","validator":"Must be String"},{"allow_nil":true,"full_name":"subnet[vlanid]","expected_type":"string","description":"<p>VLAN ID for this subnet</p>\n","required":false,"name":"vlanid","validator":"Must be String"},{"allow_nil":true,"full_name":"subnet[domain_ids]","expected_type":"string","description":"<p>Domains in which this subnet is part</p>\n","required":false,"name":"domain_ids","validator":"Must be Array"},{"allow_nil":true,"full_name":"subnet[dhcp_id]","expected_type":"string","description":"<p>DHCP Proxy to use within this subnet</p>\n","required":false,"name":"dhcp_id","validator":"Must be a number."},{"allow_nil":true,"full_name":"subnet[tftp_id]","expected_type":"string","description":"<p>TFTP Proxy to use within this subnet</p>\n","required":false,"name":"tftp_id","validator":"Must be a number."},{"allow_nil":true,"full_name":"subnet[dns_id]","expected_type":"string","description":"<p>DNS Proxy to use within this subnet</p>\n","required":false,"name":"dns_id","validator":"Must be a number."}],"expected_type":"hash","description":"","required":true,"name":"subnet","validator":"Must be a Hash"}],"formats":[],"see_url":null,"errors":[],"examples":["PUT /api/subnets/980190962\n{\n \"subnet\": {}\n}\n200\n{\n \"subnet\": {\n \"dns_secondary\": null,\n \"dns_id\": 113629430,\n \"tftp\": {\n \"url\": \"http://somewhere.else\",\n \"id\": 298486374,\n \"name\": \"TFTP Proxy\"\n },\n \"dns\": {\n \"url\": \"http://else.where:4567\",\n \"id\": 113629430,\n \"name\": \"DNS Proxy\"\n },\n \"domain_ids\": [\n 822172901\n ],\n \"priority\": null,\n \"gateway\": null,\n \"mask\": \"255.255.255.0\",\n \"dhcp_id\": 980190962,\n \"network\": \"2.3.4.0\",\n \"to\": null,\n \"id\": 980190962,\n \"tftp_id\": 298486374,\n \"from\": null,\n \"dns_primary\": null,\n \"name\": \"one\",\n \"vlanid\": \"41\",\n \"dhcp\": {\n \"url\": \"https://somewhere.net:8443\",\n \"id\": 980190962,\n \"name\": \"DHCP Proxy\"\n }\n }\n}"],"name":"update","full_description":""},{"see":null,"apis":[{"api_url":"/api/subnets/:id","http_method":"DELETE","short_description":"Delete a subnet"}],"doc_url":"/apidoc/subnets/destroy","params":[{"allow_nil":false,"full_name":"id","expected_type":"string","description":"<p>Subnet numeric identifier</p>\n","required":true,"name":"id","validator":"Must be a number."}],"formats":[],"see_url":null,"errors":[],"examples":["DELETE /api/subnets/980190962\n422\n{\n \"subnet\": {\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 \"id\": 980190962\n }\n}"],"name":"destroy","full_description":""}],"api_url":"/api","formats":[],"name":"Subnets","full_description":"","short_description":""},"models":{"version":"1","doc_url":"/apidoc/models","methods":[{"see":null,"apis":[{"api_url":"/api/models","http_method":"GET","short_description":"List all models."}],"doc_url":"/apidoc/models/index","params":[{"allow_nil":false,"full_name":"search","expected_type":"string","description":"<p>filter results</p>\n","required":false,"name":"search","validator":"Must be String"},{"allow_nil":false,"full_name":"order","expected_type":"string","description":"<p>sort results</p>\n","required":false,"name":"order","validator":"Must be String"},{"allow_nil":false,"full_name":"page","expected_type":"string","description":"<p>paginate results</p>\n","required":false,"name":"page","validator":"Must be String"},{"allow_nil":false,"full_name":"per_page","expected_type":"string","description":"<p>number of entries per request</p>\n","required":false,"name":"per_page","validator":"Must be String"}],"formats":[],"see_url":null,"errors":[],"examples":["GET /api/models\n200\n[\n {\n \"model\": {\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"vendor_class\": null,\n \"hardware_model\": null,\n \"id\": 980190962,\n \"info\": \"Virtual Machine\",\n \"name\": \"KVM\"\n }\n },\n {\n \"model\": {\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"vendor_class\": \"Sun-Fire-V210\",\n \"hardware_model\": \"SUN4U\",\n \"id\": 139037058,\n \"info\": null,\n \"name\": \"SUN V210\"\n }\n }\n]"],"name":"index","full_description":""},{"see":null,"apis":[{"api_url":"/api/models/:id","http_method":"GET","short_description":"Show a model."}],"doc_url":"/apidoc/models/show","params":[{"allow_nil":false,"full_name":"id","expected_type":"string","description":"","required":true,"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."}],"formats":[],"see_url":null,"errors":[],"examples":["GET /api/models/980190962\n200\n{\n \"model\": {\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"vendor_class\": null,\n \"hardware_model\": null,\n \"id\": 980190962,\n \"info\": \"Virtual Machine\",\n \"name\": \"KVM\"\n }\n}"],"name":"show","full_description":""},{"see":null,"apis":[{"api_url":"/api/models","http_method":"POST","short_description":"Create a model."}],"doc_url":"/apidoc/models/create","params":[{"allow_nil":false,"full_name":"model","params":[{"allow_nil":false,"full_name":"model[name]","expected_type":"string","description":"","required":true,"name":"name","validator":"Must be String"},{"allow_nil":false,"full_name":"model[info]","expected_type":"string","description":"","required":false,"name":"info","validator":"Must be String"},{"allow_nil":false,"full_name":"model[vendor_class]","expected_type":"string","description":"","required":false,"name":"vendor_class","validator":"Must be String"},{"allow_nil":false,"full_name":"model[hardware_model]","expected_type":"string","description":"","required":false,"name":"hardware_model","validator":"Must be String"}],"expected_type":"hash","description":"","required":true,"name":"model","validator":"Must be a Hash"}],"formats":[],"see_url":null,"errors":[],"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 \"updated_at\": \"2012-12-18T15:24:49Z\",\n \"vendor_class\": null,\n \"hardware_model\": null,\n \"id\": 980190963,\n \"info\": null,\n \"name\": \"new model\"\n }\n}"],"name":"create","full_description":""},{"see":null,"apis":[{"api_url":"/api/models/:id","http_method":"PUT","short_description":"Update a model."}],"doc_url":"/apidoc/models/update","params":[{"allow_nil":false,"full_name":"id","expected_type":"string","description":"","required":true,"name":"id","validator":"Must be String"},{"allow_nil":false,"full_name":"model","params":[{"allow_nil":false,"full_name":"model[name]","expected_type":"string","description":"","required":false,"name":"name","validator":"Must be String"},{"allow_nil":false,"full_name":"model[info]","expected_type":"string","description":"","required":false,"name":"info","validator":"Must be String"},{"allow_nil":false,"full_name":"model[vendor_class]","expected_type":"string","description":"","required":false,"name":"vendor_class","validator":"Must be String"},{"allow_nil":false,"full_name":"model[hardware_model]","expected_type":"string","description":"","required":false,"name":"hardware_model","validator":"Must be String"}],"expected_type":"hash","description":"","required":true,"name":"model","validator":"Must be a Hash"}],"formats":[],"see_url":null,"errors":[],"examples":["PUT /api/models/980190962\n{\n \"name\": \"KVM\"\n}\n200\n{\n \"model\": {\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"vendor_class\": null,\n \"hardware_model\": null,\n \"id\": 980190962,\n \"info\": \"Virtual Machine\",\n \"name\": \"KVM\"\n }\n}"],"name":"update","full_description":""},{"see":null,"apis":[{"api_url":"/api/models/:id","http_method":"DELETE","short_description":"Delete a model."}],"doc_url":"/apidoc/models/destroy","params":[{"allow_nil":false,"full_name":"id","expected_type":"string","description":"","required":true,"name":"id","validator":"Must be String"}],"formats":[],"see_url":null,"errors":[],"examples":["DELETE /api/models/980190962\n200\n{\n \"model\": {\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"vendor_class\": null,\n \"hardware_model\": null,\n \"id\": 980190962,\n \"info\": \"Virtual Machine\",\n \"name\": \"KVM\"\n }\n}"],"name":"destroy","full_description":""}],"api_url":"/api","formats":[],"name":"Models","full_description":"","short_description":""},"common_parameters":{"version":"1","doc_url":"/apidoc/common_parameters","methods":[{"see":null,"apis":[{"api_url":"/api/common_parameters","http_method":"GET","short_description":"List all common parameters."}],"doc_url":"/apidoc/common_parameters/index","params":[{"allow_nil":false,"full_name":"search","expected_type":"string","description":"<p>filter results</p>\n","required":false,"name":"search","validator":"Must be String"},{"allow_nil":false,"full_name":"order","expected_type":"string","description":"<p>sort results</p>\n","required":false,"name":"order","validator":"Must be String"},{"allow_nil":false,"full_name":"page","expected_type":"string","description":"<p>paginate results</p>\n","required":false,"name":"page","validator":"Must be String"},{"allow_nil":false,"full_name":"per_page","expected_type":"string","description":"<p>number of entries per request</p>\n","required":false,"name":"per_page","validator":"Must be String"}],"formats":[],"see_url":null,"errors":[],"examples":["GET /api/common_parameters\n200\n[\n {\n \"common_parameter\": {\n \"id\": 636252244,\n \"value\": \"myvalue\",\n \"name\": \"test\"\n }\n }\n]"],"name":"index","full_description":""},{"see":null,"apis":[{"api_url":"/api/common_parameters/:id","http_method":"GET","short_description":"Show a common parameter."}],"doc_url":"/apidoc/common_parameters/show","params":[{"allow_nil":false,"full_name":"id","expected_type":"string","description":"","required":true,"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."}],"formats":[],"see_url":null,"errors":[],"examples":["GET /api/common_parameters/636252244\n200\n{\n \"common_parameter\": {\n \"id\": 636252244,\n \"value\": \"myvalue\",\n \"name\": \"test\"\n }\n}"],"name":"show","full_description":""},{"see":null,"apis":[{"api_url":"/api/common_parameters","http_method":"POST","short_description":"Create a common_parameter"}],"doc_url":"/apidoc/common_parameters/create","params":[{"allow_nil":false,"full_name":"common_parameter","params":[{"allow_nil":false,"full_name":"common_parameter[name]","expected_type":"string","description":"","required":true,"name":"name","validator":"Must be String"},{"allow_nil":false,"full_name":"common_parameter[value]","expected_type":"string","description":"","required":true,"name":"value","validator":"Must be String"}],"expected_type":"hash","description":"","required":true,"name":"common_parameter","validator":"Must be a Hash"}],"formats":[],"see_url":null,"errors":[],"examples":["POST /api/common_parameters\n{\n \"common_parameter\": {\n \"value\": \"123\",\n \"name\": \"special_key\"\n }\n}\n200\n{\n \"common_parameter\": {\n \"id\": 767575239,\n \"value\": \"123\",\n \"name\": \"special_key\"\n }\n}"],"name":"create","full_description":""},{"see":null,"apis":[{"api_url":"/api/common_parameters/:id","http_method":"PUT","short_description":"Update a common_parameter"}],"doc_url":"/apidoc/common_parameters/update","params":[{"allow_nil":false,"full_name":"id","expected_type":"string","description":"","required":true,"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."},{"allow_nil":false,"full_name":"common_parameter","params":[{"allow_nil":false,"full_name":"common_parameter[name]","expected_type":"string","description":"","required":false,"name":"name","validator":"Must be String"},{"allow_nil":false,"full_name":"common_parameter[value]","expected_type":"string","description":"","required":false,"name":"value","validator":"Must be String"}],"expected_type":"hash","description":"","required":true,"name":"common_parameter","validator":"Must be a Hash"}],"formats":[],"see_url":null,"errors":[],"examples":["PUT /api/common_parameters/636252244\n{\n \"common_parameter\": {}\n}\n200\n{\n \"common_parameter\": {\n \"id\": 636252244,\n \"value\": \"myvalue\",\n \"name\": \"test\"\n }\n}"],"name":"update","full_description":""},{"see":null,"apis":[{"api_url":"/api/common_parameters/:id","http_method":"DELETE","short_description":"Delete a common_parameter"}],"doc_url":"/apidoc/common_parameters/destroy","params":[{"allow_nil":false,"full_name":"id","expected_type":"string","description":"","required":true,"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."}],"formats":[],"see_url":null,"errors":[],"examples":["DELETE /api/common_parameters/636252244\n200\n{\n \"common_parameter\": {\n \"id\": 636252244,\n \"value\": \"myvalue\",\n \"name\": \"test\"\n }\n}"],"name":"destroy","full_description":""}],"api_url":"/api","formats":[],"name":"Common parameters","full_description":"","short_description":""},"dashboard":{"version":"1","doc_url":"/apidoc/dashboard","methods":[{"see":null,"apis":[{"api_url":"/api/dashboard","http_method":"GET","short_description":"Get Dashboard results"}],"doc_url":"/apidoc/dashboard/index","params":[{"allow_nil":false,"full_name":"search","expected_type":"string","description":"<p>filter results</p>\n","required":false,"name":"search","validator":"Must be String"}],"formats":[],"see_url":null,"errors":[],"examples":["GET /api/dashboard\n200\n{\n \"pending_hosts_enabled\": 0,\n \"good_hosts_enabled\": 0,\n \"out_of_sync_hosts\": 0,\n \"good_hosts\": 0,\n \"total_hosts\": 12,\n \"out_of_sync_hosts_enabled\": 0,\n \"bad_hosts\": 0,\n \"percentage\": 0,\n \"active_hosts\": 0,\n \"active_hosts_ok_enabled\": 0,\n \"bad_hosts_enabled\": 0,\n \"active_hosts_ok\": 0,\n \"ok_hosts_enabled\": 0,\n \"pending_hosts\": 0,\n \"reports_missing\": 12,\n \"ok_hosts\": 0,\n \"disabled_hosts\": 0\n}"],"name":"index","full_description":""}],"api_url":"/api","formats":[],"name":"Dashboard","full_description":"","short_description":""},"puppetclasses":{"version":"1","doc_url":"/apidoc/puppetclasses","methods":[{"see":null,"apis":[{"api_url":"/api/puppetclasses","http_method":"GET","short_description":"List all puppetclasses."}],"doc_url":"/apidoc/puppetclasses/index","params":[{"allow_nil":false,"full_name":"search","expected_type":"string","description":"<p>filter results</p>\n","required":false,"name":"search","validator":"Must be String"},{"allow_nil":false,"full_name":"order","expected_type":"string","description":"<p>sort results</p>\n","required":false,"name":"order","validator":"Must be String"},{"allow_nil":false,"full_name":"page","expected_type":"string","description":"<p>paginate results</p>\n","required":false,"name":"page","validator":"Must be String"},{"allow_nil":false,"full_name":"per_page","expected_type":"string","description":"<p>number of entries per request</p>\n","required":false,"name":"per_page","validator":"Must be String"}],"formats":[],"see_url":null,"errors":[],"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}"],"name":"index","full_description":""},{"see":null,"apis":[{"api_url":"/api/puppetclasses/:id","http_method":"GET","short_description":"Show a puppetclass."}],"doc_url":"/apidoc/puppetclasses/show","params":[{"allow_nil":false,"full_name":"id","expected_type":"string","description":"","required":true,"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."}],"formats":[],"see_url":null,"errors":[],"examples":["GET /api/puppetclasses/base\n200\n{\n \"puppetclass\": {\n \"lookup_keys\": [\n {\n \"lookup_key\": {\n \"default_value\": \"443\",\n \"override\": false,\n \"required\": false,\n \"is_param\": false,\n \"id\": 298486374,\n \"key\": \"ssl_port\",\n \"description\": null\n }\n }\n ],\n \"id\": 980190962,\n \"name\": \"base\"\n }\n}"],"name":"show","full_description":""},{"see":null,"apis":[{"api_url":"/api/puppetclasses","http_method":"POST","short_description":"Create a puppetclass."}],"doc_url":"/apidoc/puppetclasses/create","params":[{"allow_nil":false,"full_name":"puppetclass","params":[{"allow_nil":false,"full_name":"puppetclass[name]","expected_type":"string","description":"","required":true,"name":"name","validator":"Must be String"}],"expected_type":"hash","description":"","required":true,"name":"puppetclass","validator":"Must be a Hash"}],"formats":[],"see_url":null,"errors":[],"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}"],"name":"create","full_description":""},{"see":null,"apis":[{"api_url":"/api/puppetclasses/:id","http_method":"PUT","short_description":"Update a puppetclass."}],"doc_url":"/apidoc/puppetclasses/update","params":[{"allow_nil":false,"full_name":"id","expected_type":"string","description":"","required":true,"name":"id","validator":"Must be String"},{"allow_nil":false,"full_name":"puppetclass","params":[{"allow_nil":false,"full_name":"puppetclass[name]","expected_type":"string","description":"","required":false,"name":"name","validator":"Must be String"}],"expected_type":"hash","description":"","required":true,"name":"puppetclass","validator":"Must be a Hash"}],"formats":[],"see_url":null,"errors":[],"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}"],"name":"update","full_description":""},{"see":null,"apis":[{"api_url":"/api/puppetclasses/:id","http_method":"DELETE","short_description":"Delete a puppetclass."}],"doc_url":"/apidoc/puppetclasses/destroy","params":[{"allow_nil":false,"full_name":"id","expected_type":"string","description":"","required":true,"name":"id","validator":"Must be String"}],"formats":[],"see_url":null,"errors":[],"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}"],"name":"destroy","full_description":""}],"api_url":"/api","formats":[],"name":"Puppetclasses","full_description":"","short_description":""},"usergroups":{"version":"1","doc_url":"/apidoc/usergroups","methods":[{"see":null,"apis":[{"api_url":"/api/usergroups","http_method":"GET","short_description":"List all usergroups."}],"doc_url":"/apidoc/usergroups/index","params":[{"allow_nil":false,"full_name":"page","expected_type":"string","description":"<p>paginate results</p>\n","required":false,"name":"page","validator":"Must be String"},{"allow_nil":false,"full_name":"per_page","expected_type":"string","description":"<p>number of entries per request</p>\n","required":false,"name":"per_page","validator":"Must be String"}],"formats":[],"see_url":null,"errors":[],"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]"],"name":"index","full_description":""},{"see":null,"apis":[{"api_url":"/api/usergroups/:id","http_method":"GET","short_description":"Show a usergroup."}],"doc_url":"/apidoc/usergroups/show","params":[{"allow_nil":false,"full_name":"id","expected_type":"string","description":"","required":true,"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."}],"formats":[],"see_url":null,"errors":[],"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}"],"name":"show","full_description":""},{"see":null,"apis":[{"api_url":"/api/usergroups","http_method":"POST","short_description":"Create a usergroup."}],"doc_url":"/apidoc/usergroups/create","params":[{"allow_nil":false,"full_name":"usergroup","params":[{"allow_nil":false,"full_name":"usergroup[name]","expected_type":"string","description":"","required":true,"name":"name","validator":"Must be String"}],"expected_type":"hash","description":"","required":true,"name":"usergroup","validator":"Must be a Hash"}],"formats":[],"see_url":null,"errors":[],"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}"],"name":"create","full_description":""},{"see":null,"apis":[{"api_url":"/api/usergroups/:id","http_method":"PUT","short_description":"Update a usergroup."}],"doc_url":"/apidoc/usergroups/update","params":[{"allow_nil":false,"full_name":"id","expected_type":"string","description":"","required":true,"name":"id","validator":"Must be String"},{"allow_nil":false,"full_name":"usergroup","params":[{"allow_nil":false,"full_name":"usergroup[name]","expected_type":"string","description":"","required":false,"name":"name","validator":"Must be String"}],"expected_type":"hash","description":"","required":true,"name":"usergroup","validator":"Must be a Hash"}],"formats":[],"see_url":null,"errors":[],"examples":["PUT /api/usergroups/980190962\n{\n \"usergroup\": {}\n}\n200\n{\n \"usergroup\": {\n \"id\": 980190962,\n \"name\": \"MyString\"\n }\n}"],"name":"update","full_description":""},{"see":null,"apis":[{"api_url":"/api/usergroups/:id","http_method":"DELETE","short_description":"Delete a usergroup."}],"doc_url":"/apidoc/usergroups/destroy","params":[{"allow_nil":false,"full_name":"id","expected_type":"string","description":"","required":true,"name":"id","validator":"Must be String"}],"formats":[],"see_url":null,"errors":[],"examples":["DELETE /api/usergroups/980190962\n200\n{\n \"usergroup\": {\n \"id\": 980190962,\n \"name\": \"MyString\"\n }\n}"],"name":"destroy","full_description":""}],"api_url":"/api","formats":[],"name":"Usergroups","full_description":"","short_description":""},"environments":{"version":"1","doc_url":"/apidoc/environments","methods":[{"see":null,"apis":[{"api_url":"/api/environments","http_method":"GET","short_description":"List all environments."}],"doc_url":"/apidoc/environments/index","params":[{"allow_nil":false,"full_name":"search","expected_type":"string","description":"<p>Filter results</p>\n","required":false,"name":"search","validator":"Must be String"},{"allow_nil":false,"full_name":"order","expected_type":"string","description":"<p>Sort results</p>\n","required":false,"name":"order","validator":"Must be String"},{"allow_nil":false,"full_name":"page","expected_type":"string","description":"<p>paginate results</p>\n","required":false,"name":"page","validator":"Must be String"},{"allow_nil":false,"full_name":"per_page","expected_type":"string","description":"<p>number of entries per request</p>\n","required":false,"name":"per_page","validator":"Must be String"}],"formats":[],"see_url":null,"errors":[],"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]"],"name":"index","full_description":""},{"see":null,"apis":[{"api_url":"/api/environments/:id","http_method":"GET","short_description":"Show an environment."}],"doc_url":"/apidoc/environments/show","params":[{"allow_nil":false,"full_name":"id","expected_type":"string","description":"","required":true,"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."}],"formats":[],"see_url":null,"errors":[],"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}"],"name":"show","full_description":""},{"see":null,"apis":[{"api_url":"/api/environments","http_method":"POST","short_description":"Create an environment."}],"doc_url":"/apidoc/environments/create","params":[{"allow_nil":false,"full_name":"environment","params":[{"allow_nil":false,"full_name":"environment[name]","expected_type":"string","description":"","required":true,"name":"name","validator":"Must be String"}],"expected_type":"hash","description":"","required":true,"name":"environment","validator":"Must be a Hash"}],"formats":[],"see_url":null,"errors":[],"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}"],"name":"create","full_description":""},{"see":null,"apis":[{"api_url":"/api/environments/:id","http_method":"PUT","short_description":"Update an environment."}],"doc_url":"/apidoc/environments/update","params":[{"allow_nil":false,"full_name":"id","expected_type":"string","description":"","required":true,"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."},{"allow_nil":false,"full_name":"environment","params":[{"allow_nil":false,"full_name":"environment[name]","expected_type":"string","description":"","required":false,"name":"name","validator":"Must be String"}],"expected_type":"hash","description":"","required":true,"name":"environment","validator":"Must be a Hash"}],"formats":[],"see_url":null,"errors":[],"examples":["PUT /api/environments/production\n{\n \"environment\": {}\n}\n200\n{\n \"environment\": {\n \"id\": 334344675,\n \"name\": \"production\"\n }\n}"],"name":"update","full_description":""},{"see":null,"apis":[{"api_url":"/api/environments/:id","http_method":"DELETE","short_description":"Delete an environment."}],"doc_url":"/apidoc/environments/destroy","params":[{"allow_nil":false,"full_name":"id","expected_type":"string","description":"","required":true,"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."}],"formats":[],"see_url":null,"errors":[],"examples":["DELETE /api/environments/testing\n200\n{\n \"environment\": {\n \"id\": 687036937,\n \"name\": \"testing\"\n }\n}"],"name":"destroy","full_description":""}],"api_url":"/api","formats":[],"name":"Environments","full_description":"","short_description":""},"reports":{"version":"1","doc_url":"/apidoc/reports","methods":[{"see":null,"apis":[{"api_url":"/api/reports","http_method":"GET","short_description":"List all reports."}],"doc_url":"/apidoc/reports/index","params":[{"allow_nil":false,"full_name":"search","expected_type":"string","description":"<p>filter results</p>\n","required":false,"name":"search","validator":"Must be String"},{"allow_nil":false,"full_name":"order","expected_type":"string","description":"<p>sort results</p>\n","required":false,"name":"order","validator":"Must be String"},{"allow_nil":false,"full_name":"page","expected_type":"string","description":"<p>paginate results</p>\n","required":false,"name":"page","validator":"Must be String"},{"allow_nil":false,"full_name":"per_page","expected_type":"string","description":"<p>number of entries per request</p>\n","required":false,"name":"per_page","validator":"Must be String"}],"formats":[],"see_url":null,"errors":[],"examples":["GET /api/reports\n200\n[\n {\n \"report\": {\n \"summary\": \"Success\",\n \"reported_at\": \"2012-12-11T15:24:42Z\",\n \"logs\": [],\n \"metrics\": {\n \"events\": {\n \"total\": 0\n },\n \"resources\": {\n \"total\": 33\n },\n \"changes\": {},\n \"time\": {\n \"schedule\": 0.00083,\n \"filebucket\": 0.000171,\n \"config_retrieval\": 16.3637869358063,\n \"cron\": 0.000419,\n \"service\": 0.149739,\n \"package\": 0.003989,\n \"exec\": 0.000299,\n \"file\": 0.007025,\n \"mailalias\": 0.000283\n }\n },\n \"id\": 70219655,\n \"status\": {\n \"failed_restarts\": 0,\n \"applied\": 0,\n \"restarted\": 0,\n \"skipped\": 0,\n \"failed\": 0,\n \"pending\": 0\n }\n }\n }\n]"],"name":"index","full_description":""},{"see":null,"apis":[{"api_url":"/api/reports/:id","http_method":"GET","short_description":"Show a report."}],"doc_url":"/apidoc/reports/show","params":[{"allow_nil":false,"full_name":"id","expected_type":"string","description":"","required":true,"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."}],"formats":[],"see_url":null,"errors":[],"examples":["GET /api/reports/70219655\n200\n{\n \"report\": {\n \"summary\": \"Success\",\n \"reported_at\": \"2012-12-11T15:24:42Z\",\n \"logs\": [],\n \"metrics\": {\n \"events\": {\n \"total\": 0\n },\n \"resources\": {\n \"total\": 33\n },\n \"changes\": {},\n \"time\": {\n \"schedule\": 0.00083,\n \"filebucket\": 0.000171,\n \"config_retrieval\": 16.3637869358063,\n \"cron\": 0.000419,\n \"service\": 0.149739,\n \"package\": 0.003989,\n \"exec\": 0.000299,\n \"file\": 0.007025,\n \"mailalias\": 0.000283\n }\n },\n \"id\": 70219655,\n \"status\": {\n \"failed_restarts\": 0,\n \"applied\": 0,\n \"restarted\": 0,\n \"skipped\": 0,\n \"failed\": 0,\n \"pending\": 0\n }\n }\n}"],"name":"show","full_description":""},{"see":null,"apis":[{"api_url":"/api/ptables/:id","http_method":"DELETE","short_description":"Delete a report."}],"doc_url":"/apidoc/reports/destroy","params":[{"allow_nil":false,"full_name":"id","expected_type":"string","description":"","required":true,"name":"id","validator":"Must be String"}],"formats":[],"see_url":null,"errors":[],"examples":["DELETE /api/reports/70219655\n200\n{\n \"report\": {\n \"host\": \"my5name.mydomain.net\",\n \"summary\": \"Success\",\n \"reported_at\": \"2012-12-11T15:24:42Z\",\n \"metrics\": {\n \"events\": {\n \"total\": 0\n },\n \"resources\": {\n \"total\": 33\n },\n \"changes\": {},\n \"time\": {\n \"schedule\": 0.00083,\n \"filebucket\": 0.000171,\n \"config_retrieval\": 16.3637869358063,\n \"cron\": 0.000419,\n \"service\": 0.149739,\n \"package\": 0.003989,\n \"exec\": 0.000299,\n \"file\": 0.007025,\n \"mailalias\": 0.000283\n }\n },\n \"logs\": [],\n \"id\": 70219655,\n \"status\": {\n \"failed_restarts\": 0,\n \"applied\": 0,\n \"restarted\": 0,\n \"skipped\": 0,\n \"failed\": 0,\n \"pending\": 0\n }\n }\n}"],"name":"destroy","full_description":""}],"api_url":"/api","formats":[],"name":"Reports","full_description":"","short_description":""},"hostgroups":{"version":"1","doc_url":"/apidoc/hostgroups","methods":[{"see":null,"apis":[{"api_url":"/api/hostgroups","http_method":"GET","short_description":"List all hostgroups."}],"doc_url":"/apidoc/hostgroups/index","params":[{"allow_nil":false,"full_name":"search","expected_type":"string","description":"<p>filter results</p>\n","required":false,"name":"search","validator":"Must be String"},{"allow_nil":false,"full_name":"order","expected_type":"string","description":"<p>sort results</p>\n","required":false,"name":"order","validator":"Must be String"},{"allow_nil":false,"full_name":"page","expected_type":"string","description":"<p>paginate results</p>\n","required":false,"name":"page","validator":"Must be String"},{"allow_nil":false,"full_name":"per_page","expected_type":"string","description":"<p>number of entries per request</p>\n","required":false,"name":"per_page","validator":"Must be String"}],"formats":[],"see_url":null,"errors":[],"examples":["GET /api/hostgroups\n200\n[\n {\n \"hostgroup\": {\n \"environment_id\": 334344675,\n \"label\": \"db\",\n \"domain_id\": null,\n \"operatingsystem_id\": 309172073,\n \"ancestry\": null,\n \"subnet_id\": null,\n \"parameters\": {},\n \"puppetclass_ids\": [],\n \"id\": 603241515,\n \"name\": \"db\"\n }\n },\n {\n \"hostgroup\": {\n \"environment_id\": 334344675,\n \"label\": \"Common\",\n \"domain_id\": 22495316,\n \"operatingsystem_id\": 309172073,\n \"ancestry\": null,\n \"subnet_id\": null,\n \"parameters\": {\n \"group1\": \"group1\"\n },\n \"puppetclass_ids\": [\n 980190962\n ],\n \"id\": 636252244,\n \"name\": \"Common\"\n }\n },\n {\n \"hostgroup\": {\n \"environment_id\": null,\n \"label\": \"Unusual\",\n \"domain_id\": null,\n \"operatingsystem_id\": null,\n \"ancestry\": null,\n \"subnet_id\": null,\n \"parameters\": {},\n \"puppetclass_ids\": [],\n \"id\": 866317115,\n \"name\": \"Unusual\"\n }\n }\n]"],"name":"index","full_description":""},{"see":null,"apis":[{"api_url":"/api/hostgroups/:id","http_method":"GET","short_description":"Show a hostgroup."}],"doc_url":"/apidoc/hostgroups/show","params":[{"allow_nil":false,"full_name":"id","expected_type":"string","description":"","required":true,"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."}],"formats":[],"see_url":null,"errors":[],"examples":["GET /api/hostgroups/636252244-common\n200\n{\n \"hostgroup\": {\n \"environment_id\": 334344675,\n \"label\": \"Common\",\n \"domain_id\": 22495316,\n \"operatingsystem_id\": 309172073,\n \"ancestry\": null,\n \"subnet_id\": null,\n \"parameters\": {\n \"group1\": \"group1\"\n },\n \"puppetclass_ids\": [\n 980190962\n ],\n \"id\": 636252244,\n \"name\": \"Common\"\n }\n}"],"name":"show","full_description":""},{"see":null,"apis":[{"api_url":"/api/hostgroups","http_method":"POST","short_description":"Create an hostgroup."}],"doc_url":"/apidoc/hostgroups/create","params":[{"allow_nil":false,"full_name":"hostgroup","params":[{"allow_nil":false,"full_name":"hostgroup[name]","expected_type":"string","description":"","required":true,"name":"name","validator":"Must be String"},{"allow_nil":false,"full_name":"hostgroup[environment_id]","expected_type":"string","description":"","required":false,"name":"environment_id","validator":"Must be a number."},{"allow_nil":false,"full_name":"hostgroup[operatingsystem_id]","expected_type":"string","description":"","required":false,"name":"operatingsystem_id","validator":"Must be a number."},{"allow_nil":false,"full_name":"hostgroup[architecture_id]","expected_type":"string","description":"","required":false,"name":"architecture_id","validator":"Must be a number."},{"allow_nil":false,"full_name":"hostgroup[medium_id]","expected_type":"string","description":"","required":false,"name":"medium_id","validator":"Must be a number."},{"allow_nil":false,"full_name":"hostgroup[ptable_id]","expected_type":"string","description":"","required":false,"name":"ptable_id","validator":"Must be a number."},{"allow_nil":false,"full_name":"hostgroup[puppet_ca_proxy_id]","expected_type":"string","description":"","required":false,"name":"puppet_ca_proxy_id","validator":"Must be a number."},{"allow_nil":false,"full_name":"hostgroup[subnet_id]","expected_type":"string","description":"","required":false,"name":"subnet_id","validator":"Must be a number."},{"allow_nil":false,"full_name":"hostgroup[domain_id]","expected_type":"string","description":"","required":false,"name":"domain_id","validator":"Must be a number."},{"allow_nil":false,"full_name":"hostgroup[puppet_proxy_id]","expected_type":"string","description":"","required":false,"name":"puppet_proxy_id","validator":"Must be a number."}],"expected_type":"hash","description":"","required":true,"name":"hostgroup","validator":"Must be a Hash"}],"formats":[],"see_url":null,"errors":[],"examples":["POST /api/hostgroups\n{\n \"hostgroup\": {\n \"name\": \"TestHostgroup\"\n }\n}\n200\n{\n \"hostgroup\": {\n \"environment_id\": null,\n \"label\": \"TestHostgroup\",\n \"domain_id\": null,\n \"operatingsystem_id\": null,\n \"ancestry\": null,\n \"subnet_id\": null,\n \"parameters\": {},\n \"puppetclass_ids\": [],\n \"id\": 866317116,\n \"name\": \"TestHostgroup\"\n }\n}"],"name":"create","full_description":""},{"see":null,"apis":[{"api_url":"/api/hostgroups/:id","http_method":"PUT","short_description":"Update an hostgroup."}],"doc_url":"/apidoc/hostgroups/update","params":[{"allow_nil":false,"full_name":"id","expected_type":"string","description":"","required":true,"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."},{"allow_nil":false,"full_name":"hostgroup","params":[{"allow_nil":false,"full_name":"hostgroup[name]","expected_type":"string","description":"","required":false,"name":"name","validator":"Must be String"},{"allow_nil":false,"full_name":"hostgroup[environment_id]","expected_type":"string","description":"","required":false,"name":"environment_id","validator":"Must be a number."},{"allow_nil":false,"full_name":"hostgroup[operatingsystem_id]","expected_type":"string","description":"","required":false,"name":"operatingsystem_id","validator":"Must be a number."},{"allow_nil":false,"full_name":"hostgroup[architecture_id]","expected_type":"string","description":"","required":false,"name":"architecture_id","validator":"Must be a number."},{"allow_nil":false,"full_name":"hostgroup[medium_id]","expected_type":"string","description":"","required":false,"name":"medium_id","validator":"Must be a number."},{"allow_nil":false,"full_name":"hostgroup[ptable_id]","expected_type":"string","description":"","required":false,"name":"ptable_id","validator":"Must be a number."},{"allow_nil":false,"full_name":"hostgroup[puppet_ca_proxy_id]","expected_type":"string","description":"","required":false,"name":"puppet_ca_proxy_id","validator":"Must be a number."},{"allow_nil":false,"full_name":"hostgroup[subnet_id]","expected_type":"string","description":"","required":false,"name":"subnet_id","validator":"Must be a number."},{"allow_nil":false,"full_name":"hostgroup[domain_id]","expected_type":"string","description":"","required":false,"name":"domain_id","validator":"Must be a number."},{"allow_nil":false,"full_name":"hostgroup[puppet_proxy_id]","expected_type":"string","description":"","required":false,"name":"puppet_proxy_id","validator":"Must be a number."}],"expected_type":"hash","description":"","required":true,"name":"hostgroup","validator":"Must be a Hash"}],"formats":[],"see_url":null,"errors":[],"examples":["PUT /api/hostgroups/636252244-common\n{\n \"hostgroup\": {}\n}\n200\n{\n \"hostgroup\": {\n \"environment_id\": 334344675,\n \"label\": \"Common\",\n \"domain_id\": 22495316,\n \"operatingsystem_id\": 309172073,\n \"ancestry\": null,\n \"subnet_id\": null,\n \"parameters\": {\n \"group1\": \"group1\"\n },\n \"puppetclass_ids\": [\n 980190962\n ],\n \"id\": 636252244,\n \"name\": \"Common\"\n }\n}"],"name":"update","full_description":""},{"see":null,"apis":[{"api_url":"/api/hostgroups/:id","http_method":"DELETE","short_description":"Delete an hostgroup."}],"doc_url":"/apidoc/hostgroups/destroy","params":[{"allow_nil":false,"full_name":"id","expected_type":"string","description":"","required":true,"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."}],"formats":[],"see_url":null,"errors":[],"examples":["DELETE /api/hostgroups/636252244-common\n200\n{\n \"hostgroup\": {\n \"environment_id\": 334344675,\n \"label\": \"Common\",\n \"domain_id\": 22495316,\n \"operatingsystem_id\": 309172073,\n \"ancestry\": null,\n \"subnet_id\": null,\n \"parameters\": {},\n \"puppetclass_ids\": [],\n \"id\": 636252244,\n \"name\": \"Common\"\n }\n}"],"name":"destroy","full_description":""}],"api_url":"/api","formats":[],"name":"Hostgroups","full_description":"","short_description":""},"media":{"version":"1","doc_url":"/apidoc/media","methods":[{"see":null,"apis":[{"api_url":"/api/media","http_method":"GET","short_description":"List all media."}],"doc_url":"/apidoc/media/index","params":[{"allow_nil":false,"full_name":"search","expected_type":"string","description":"<p>filter results</p>\n","required":false,"name":"search","validator":"Must be String"},{"allow_nil":false,"full_name":"order","expected_type":"string","description":"<p>for example, name ASC, or name DESC</p>\n","required":false,"name":"order","validator":"Must be String"},{"allow_nil":false,"full_name":"page","expected_type":"string","description":"<p>paginate results</p>\n","required":false,"name":"page","validator":"Must be String"},{"allow_nil":false,"full_name":"per_page","expected_type":"string","description":"<p>number of entries per request</p>\n","required":false,"name":"per_page","validator":"Must be String"}],"formats":[],"see_url":null,"errors":[],"examples":["GET /api/media\n200\n[\n {\n \"medium\": {\n \"id\": 980190962,\n \"name\": \"CentOS 5.4\",\n \"path\": \"http://mirror.averse.net/centos/6.0/os/$arch\"\n }\n },\n {\n \"medium\": {\n \"id\": 859751735,\n \"name\": \"OpenSuse Mirror\",\n \"path\": \"http://mirror.isoc.org.il/pub/opensuse/distribution/$major.$minor/repo/oss\"\n }\n },\n {\n \"medium\": {\n \"id\": 442321401,\n \"name\": \"Solaris 10\",\n \"path\": \"http://brsla01/vol/solgi_5.10/sol$minor_$release_$arch\"\n }\n },\n {\n \"medium\": {\n \"id\": 1011586618,\n \"name\": \"Ubuntu Mirror\",\n \"path\": \"http://sg.archive.ubuntu.com\"\n }\n },\n {\n \"medium\": {\n \"id\": 338446587,\n \"name\": \"unused\",\n \"path\": \"http://nothing.intersting.com\"\n }\n }\n]"],"name":"index","full_description":""},{"see":null,"apis":[{"api_url":"/api/media/:id","http_method":"GET","short_description":"Show a medium."}],"doc_url":"/apidoc/media/show","params":[{"allow_nil":false,"full_name":"id","expected_type":"string","description":"","required":true,"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."}],"formats":[],"see_url":null,"errors":[],"examples":["GET /api/media/980190962\n200\n{\n \"medium\": {\n \"id\": 980190962,\n \"name\": \"CentOS 5.4\",\n \"path\": \"http://mirror.averse.net/centos/6.0/os/$arch\"\n }\n}"],"name":"show","full_description":""},{"see":null,"apis":[{"api_url":"/api/media","http_method":"POST","short_description":"Create a medium."}],"doc_url":"/apidoc/media/create","params":[{"allow_nil":false,"full_name":"medium","params":[{"allow_nil":false,"full_name":"medium[name]","expected_type":"string","description":"<p>Name of media</p>\n","required":true,"name":"name","validator":"Must be String"},{"allow_nil":false,"full_name":"medium[path]","expected_type":"string","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\nwhere $arch will be substituted for the host&#39;s actual OS architecture and $version, $major and $minor\nwill be substituted for the version of the operating system.</p>\n\n<p>Solaris and Debian media may also use $release.</p>\n","required":true,"name":"path","validator":"Must be String"},{"allow_nil":false,"full_name":"medium[os_family]","expected_type":"string","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<li>Debian</li>\n<li>Redhat</li>\n<li>Solaris</li>\n<li>Suse</li>\n<li>Windows</li>\n</ul>\n","required":false,"name":"os_family","validator":"Must be String"}],"expected_type":"hash","description":"","required":true,"name":"medium","validator":"Must be a Hash"}],"formats":[],"see_url":null,"errors":[],"examples":["POST /api/media\n{\n \"medium\": {\n \"name\": \"new medium\",\n \"path\": \"http://www.newmedium.com/\"\n }\n}\n201\n{\n \"medium\": {\n \"id\": 1011586619,\n \"name\": \"new medium\"\n }\n}"],"name":"create","full_description":""},{"see":null,"apis":[{"api_url":"/api/media/:id","http_method":"PUT","short_description":"Update a medium."}],"doc_url":"/apidoc/media/update","params":[{"allow_nil":false,"full_name":"id","expected_type":"string","description":"","required":true,"name":"id","validator":"Must be String"},{"allow_nil":false,"full_name":"medium","params":[{"allow_nil":false,"full_name":"medium[name]","expected_type":"string","description":"<p>Name of media</p>\n","required":false,"name":"name","validator":"Must be String"},{"allow_nil":false,"full_name":"medium[path]","expected_type":"string","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\nwhere $arch will be substituted for the host&#39;s actual OS architecture and $version, $major and $minor\nwill be substituted for the version of the operating system.</p>\n\n<p>Solaris and Debian media may also use $release.</p>\n","required":false,"name":"path","validator":"Must be String"},{"allow_nil":true,"full_name":"medium[os_family]","expected_type":"string","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<li>Debian</li>\n<li>Redhat</li>\n<li>Solaris</li>\n<li>Suse</li>\n<li>Windows</li>\n</ul>\n","required":false,"name":"os_family","validator":"Must be String"}],"expected_type":"hash","description":"","required":true,"name":"medium","validator":"Must be a Hash"}],"formats":[],"see_url":null,"errors":[],"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}"],"name":"update","full_description":""},{"see":null,"apis":[{"api_url":"/api/media/:id","http_method":"DELETE","short_description":"Delete a medium."}],"doc_url":"/apidoc/media/destroy","params":[{"allow_nil":false,"full_name":"id","expected_type":"string","description":"","required":true,"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."}],"formats":[],"see_url":null,"errors":[],"examples":["DELETE /api/media/338446587\n200\n{\n \"medium\": {\n \"id\": 338446587,\n \"name\": \"unused\"\n }\n}"],"name":"destroy","full_description":""}],"api_url":"/api","formats":[],"name":"Media","full_description":"","short_description":""},"auth_source_ldaps":{"version":"1","doc_url":"/apidoc/auth_source_ldaps","methods":[{"see":null,"apis":[{"api_url":"/api/auth_source_ldaps","http_method":"GET","short_description":"List all authsource ldaps"}],"doc_url":"/apidoc/auth_source_ldaps/index","params":[{"allow_nil":false,"full_name":"page","expected_type":"string","description":"<p>paginate results</p>\n","required":false,"name":"page","validator":"Must be String"},{"allow_nil":false,"full_name":"per_page","expected_type":"string","description":"<p>number of entries per request</p>\n","required":false,"name":"per_page","validator":"Must be String"}],"formats":[],"see_url":null,"errors":[],"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 \"type\": \"AuthSourceLdap\",\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"tls\": true,\n \"attr_login\": \"uid\",\n \"onthefly_register\": true,\n \"account\": null,\n \"attr_firstname\": \"givenName\",\n \"attr_mail\": \"mail\",\n \"base_dn\": \"dn=x,dn=y\",\n \"id\": 980190962,\n \"attr_lastname\": \"sn\",\n \"name\": \"ldap\",\n \"port\": 123\n }\n }\n]"],"name":"index","full_description":""},{"see":null,"apis":[{"api_url":"/api/auth_source_ldaps/:id","http_method":"GET","short_description":"Show an authsource ldap."}],"doc_url":"/apidoc/auth_source_ldaps/show","params":[{"allow_nil":false,"full_name":"id","expected_type":"string","description":"","required":true,"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."}],"formats":[],"see_url":null,"errors":[],"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 \"type\": \"AuthSourceLdap\",\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"tls\": true,\n \"attr_login\": \"uid\",\n \"onthefly_register\": true,\n \"account\": null,\n \"attr_firstname\": \"givenName\",\n \"attr_mail\": \"mail\",\n \"base_dn\": \"dn=x,dn=y\",\n \"id\": 980190962,\n \"attr_lastname\": \"sn\",\n \"name\": \"ldap\",\n \"port\": 123\n }\n}"],"name":"show","full_description":""},{"see":null,"apis":[{"api_url":"/api/auth_source_ldaps","http_method":"POST","short_description":"Create an auth_source_ldap."}],"doc_url":"/apidoc/auth_source_ldaps/create","params":[{"allow_nil":false,"full_name":"auth_source_ldap","params":[{"allow_nil":false,"full_name":"auth_source_ldap[name]","expected_type":"string","description":"","required":true,"name":"name","validator":"Must be String"},{"allow_nil":false,"full_name":"auth_source_ldap[host]","expected_type":"string","description":"","required":true,"name":"host","validator":"Must be String"},{"allow_nil":false,"full_name":"auth_source_ldap[port]","expected_type":"string","description":"<p>defaults to 389</p>\n","required":false,"name":"port","validator":"Must be a number."},{"allow_nil":false,"full_name":"auth_source_ldap[account]","expected_type":"string","description":"","required":false,"name":"account","validator":"Must be String"},{"allow_nil":false,"full_name":"auth_source_ldap[base_dn]","expected_type":"string","description":"","required":false,"name":"base_dn","validator":"Must be String"},{"allow_nil":false,"full_name":"auth_source_ldap[account_password]","expected_type":"string","description":"<p>required if onthefly_register is true</p>\n","required":false,"name":"account_password","validator":"Must be String"},{"allow_nil":false,"full_name":"auth_source_ldap[attr_login]","expected_type":"string","description":"<p>required if onthefly_register is true</p>\n","required":false,"name":"attr_login","validator":"Must be String"},{"allow_nil":false,"full_name":"auth_source_ldap[attr_firstname]","expected_type":"string","description":"<p>required if onthefly_register is true</p>\n","required":false,"name":"attr_firstname","validator":"Must be String"},{"allow_nil":false,"full_name":"auth_source_ldap[attr_lastname]","expected_type":"string","description":"<p>required if onthefly_register is true</p>\n","required":false,"name":"attr_lastname","validator":"Must be String"},{"allow_nil":false,"full_name":"auth_source_ldap[attr_mail]","expected_type":"string","description":"<p>required if onthefly_register is true</p>\n","required":false,"name":"attr_mail","validator":"Must be String"},{"allow_nil":false,"full_name":"auth_source_ldap[onthefly_register]","expected_type":"string","description":"","required":false,"name":"onthefly_register","validator":"Must be 'true' or 'false'"},{"allow_nil":false,"full_name":"auth_source_ldap[tls]","expected_type":"string","description":"","required":false,"name":"tls","validator":"Must be 'true' or 'false'"}],"expected_type":"hash","description":"","required":true,"name":"auth_source_ldap","validator":"Must be a Hash"}],"formats":[],"see_url":null,"errors":[],"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 \"updated_at\": \"2012-12-18T15:24:44Z\",\n \"attr_login\": null,\n \"tls\": false,\n \"onthefly_register\": false,\n \"account\": null,\n \"attr_firstname\": null,\n \"attr_mail\": null,\n \"base_dn\": null,\n \"id\": 980190963,\n \"attr_lastname\": null,\n \"name\": \"ldap2\",\n \"account_password\": null,\n \"port\": 389\n }\n}"],"name":"create","full_description":""},{"see":null,"apis":[{"api_url":"/api/auth_source_ldaps/:id","http_method":"PUT","short_description":"Update an auth_source_ldap."}],"doc_url":"/apidoc/auth_source_ldaps/update","params":[{"allow_nil":false,"full_name":"id","expected_type":"string","description":"","required":true,"name":"id","validator":"Must be String"},{"allow_nil":false,"full_name":"auth_source_ldap","params":[{"allow_nil":false,"full_name":"auth_source_ldap[name]","expected_type":"string","description":"","required":false,"name":"name","validator":"Must be String"},{"allow_nil":false,"full_name":"auth_source_ldap[host]","expected_type":"string","description":"","required":false,"name":"host","validator":"Must be String"},{"allow_nil":false,"full_name":"auth_source_ldap[port]","expected_type":"string","description":"<p>defaults to 389</p>\n","required":false,"name":"port","validator":"Must be a number."},{"allow_nil":false,"full_name":"auth_source_ldap[account]","expected_type":"string","description":"","required":false,"name":"account","validator":"Must be String"},{"allow_nil":false,"full_name":"auth_source_ldap[base_dn]","expected_type":"string","description":"","required":false,"name":"base_dn","validator":"Must be String"},{"allow_nil":false,"full_name":"auth_source_ldap[account_password]","expected_type":"string","description":"<p>required if onthefly_register is true</p>\n","required":false,"name":"account_password","validator":"Must be String"},{"allow_nil":false,"full_name":"auth_source_ldap[attr_login]","expected_type":"string","description":"<p>required if onthefly_register is true</p>\n","required":false,"name":"attr_login","validator":"Must be String"},{"allow_nil":false,"full_name":"auth_source_ldap[attr_firstname]","expected_type":"string","description":"<p>required if onthefly_register is true</p>\n","required":false,"name":"attr_firstname","validator":"Must be String"},{"allow_nil":false,"full_name":"auth_source_ldap[attr_lastname]","expected_type":"string","description":"<p>required if onthefly_register is true</p>\n","required":false,"name":"attr_lastname","validator":"Must be String"},{"allow_nil":false,"full_name":"auth_source_ldap[attr_mail]","expected_type":"string","description":"<p>required if onthefly_register is true</p>\n","required":false,"name":"attr_mail","validator":"Must be String"},{"allow_nil":false,"full_name":"auth_source_ldap[onthefly_register]","expected_type":"string","description":"","required":false,"name":"onthefly_register","validator":"Must be 'true' or 'false'"},{"allow_nil":false,"full_name":"auth_source_ldap[tls]","expected_type":"string","description":"","required":false,"name":"tls","validator":"Must be 'true' or 'false'"}],"expected_type":"hash","description":"","required":true,"name":"auth_source_ldap","validator":"Must be a Hash"}],"formats":[],"see_url":null,"errors":[],"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 \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"attr_login\": \"uid\",\n \"tls\": true,\n \"onthefly_register\": true,\n \"account\": null,\n \"attr_firstname\": \"givenName\",\n \"attr_mail\": \"mail\",\n \"base_dn\": \"dn=x,dn=y\",\n \"id\": 980190962,\n \"attr_lastname\": \"sn\",\n \"name\": \"ldap\",\n \"account_password\": null,\n \"port\": 123\n }\n}"],"name":"update","full_description":""},{"see":null,"apis":[{"api_url":"/api/auth_source_ldaps/:id","http_method":"DELETE","short_description":"Delete an auth_source_ldap."}],"doc_url":"/apidoc/auth_source_ldaps/destroy","params":[{"allow_nil":false,"full_name":"id","expected_type":"string","description":"","required":true,"name":"id","validator":"Must be String"}],"formats":[],"see_url":null,"errors":[],"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 \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"attr_login\": \"uid\",\n \"tls\": true,\n \"onthefly_register\": true,\n \"account\": null,\n \"attr_firstname\": \"givenName\",\n \"attr_mail\": \"mail\",\n \"base_dn\": \"dn=x,dn=y\",\n \"id\": 980190962,\n \"attr_lastname\": \"sn\",\n \"name\": \"ldap\",\n \"account_password\": null,\n \"port\": 123\n }\n}"],"name":"destroy","full_description":""}],"api_url":"/api","formats":[],"name":"Auth source ldaps","full_description":"","short_description":""},"ptables":{"version":"1","doc_url":"/apidoc/ptables","methods":[{"see":null,"apis":[{"api_url":"/api/ptables","http_method":"GET","short_description":"List all ptables."}],"doc_url":"/apidoc/ptables/index","params":[{"allow_nil":false,"full_name":"search","expected_type":"string","description":"<p>filter results</p>\n","required":false,"name":"search","validator":"Must be String"},{"allow_nil":false,"full_name":"order","expected_type":"string","description":"<p>sort results</p>\n","required":false,"name":"order","validator":"Must be String"},{"allow_nil":false,"full_name":"page","expected_type":"string","description":"<p>paginate results</p>\n","required":false,"name":"page","validator":"Must be String"},{"allow_nil":false,"full_name":"per_page","expected_type":"string","description":"<p>number of entries per request</p>\n","required":false,"name":"per_page","validator":"Must be String"}],"formats":[],"see_url":null,"errors":[],"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]"],"name":"index","full_description":""},{"see":null,"apis":[{"api_url":"/api/ptables/:id","http_method":"GET","short_description":"Show a ptable."}],"doc_url":"/apidoc/ptables/show","params":[{"allow_nil":false,"full_name":"id","expected_type":"string","description":"","required":true,"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."}],"formats":[],"see_url":null,"errors":[],"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}"],"name":"show","full_description":""},{"see":null,"apis":[{"api_url":"/api/ptables","http_method":"POST","short_description":"Create a ptable."}],"doc_url":"/apidoc/ptables/create","params":[{"allow_nil":false,"full_name":"ptable","params":[{"allow_nil":false,"full_name":"ptable[name]","expected_type":"string","description":"","required":true,"name":"name","validator":"Must be String"},{"allow_nil":false,"full_name":"ptable[layout]","expected_type":"string","description":"","required":true,"name":"layout","validator":"Must be String"},{"allow_nil":false,"full_name":"ptable[os_family]","expected_type":"string","description":"","required":false,"name":"os_family","validator":"Must be String"}],"expected_type":"hash","description":"","required":true,"name":"ptable","validator":"Must be a Hash"}],"formats":[],"see_url":null,"errors":[],"examples":["POST /api/ptables\n{\n \"ptable\": {\n \"layout\": \"d-i partman-auto/disk\",\n \"name\": \"ptable_test\"\n }\n}\n201\n{\n \"ptable\": {\n \"id\": 1011586619,\n \"name\": \"ptable_test\"\n }\n}"],"name":"create","full_description":""},{"see":null,"apis":[{"api_url":"/api/ptables/:id","http_method":"PUT","short_description":"Update a ptable."}],"doc_url":"/apidoc/ptables/update","params":[{"allow_nil":false,"full_name":"id","expected_type":"string","description":"","required":true,"name":"id","validator":"Must be String"},{"allow_nil":false,"full_name":"ptable","params":[{"allow_nil":false,"full_name":"ptable[name]","expected_type":"string","description":"","required":false,"name":"name","validator":"Must be String"},{"allow_nil":false,"full_name":"ptable[layout]","expected_type":"string","description":"","required":false,"name":"layout","validator":"Must be String"},{"allow_nil":false,"full_name":"ptable[os_family]","expected_type":"string","description":"","required":false,"name":"os_family","validator":"Must be String"}],"expected_type":"hash","description":"","required":true,"name":"ptable","validator":"Must be a Hash"}],"formats":[],"see_url":null,"errors":[],"examples":["PUT /api/ptables/980190962\n{\n \"ptable\": {}\n}\n200\n{\n \"ptable\": {\n \"id\": 980190962,\n \"name\": \"default\"\n }\n}"],"name":"update","full_description":""},{"see":null,"apis":[{"api_url":"/api/ptables/:id","http_method":"DELETE","short_description":"Delete a ptable."}],"doc_url":"/apidoc/ptables/destroy","params":[{"allow_nil":false,"full_name":"id","expected_type":"string","description":"","required":true,"name":"id","validator":"Must be String"}],"formats":[],"see_url":null,"errors":[],"examples":["DELETE /api/ptables/980190962\n422\n{\n \"ptable\": {\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 \"id\": 980190962\n }\n}"],"name":"destroy","full_description":""}],"api_url":"/api","formats":[],"name":"Ptables","full_description":"","short_description":""}},"info":"<p>The Foreman is aimed to be a single address for all machines life cycle management.</p>\n","name":"Foreman"}}