filter results
","name":"search"},{"validator":"Must be String","required":false,"full_name":"order","expected_type":"string","allow_nil":false,"description":"sort results
","name":"order"},{"validator":"Must be String","required":false,"full_name":"page","expected_type":"string","allow_nil":false,"description":"paginate results
","name":"page"},{"validator":"Must be String","required":false,"full_name":"per_page","expected_type":"string","allow_nil":false,"description":"number of entries per request
","name":"per_page"}],"examples":["GET /api/hosts/my5name.mydomain.net/facts\n200\n{\n \"my5name.mydomain.net\": {\n \"ipaddress\": \"10.0.19.33\",\n \"kernelversion\": \"2.6.9\"\n }\n}"],"apis":[{"api_url":"/api/fact_values","short_description":"List all fact values.","http_method":"GET"},{"api_url":"/api/hosts/:host_id/facts","short_description":"List all fact values of a given host.","http_method":"GET"}],"errors":[],"see":[],"name":"index","formats":null,"doc_url":"/apidoc/v2/fact_values/index"}],"short_description":null,"name":"Fact values","doc_url":"/apidoc/v2/fact_values","formats":null},"template_kinds":{"api_url":"/api","full_description":null,"version":"v2","methods":[{"full_description":"","params":[{"validator":"Must be String","required":false,"full_name":"page","expected_type":"string","allow_nil":false,"description":"paginate results
","name":"page"},{"validator":"Must be String","required":false,"full_name":"per_page","expected_type":"string","allow_nil":false,"description":"number of entries per request
","name":"per_page"}],"examples":["GET /api/template_kinds\n200\n[\n {\n \"template_kind\": {\n \"id\": 452984334,\n \"name\": \"PXELinux\"\n }\n },\n {\n \"template_kind\": {\n \"id\": 478250810,\n \"name\": \"script\"\n }\n },\n {\n \"template_kind\": {\n \"id\": 158998239,\n \"name\": \"gPXE\"\n }\n },\n {\n \"template_kind\": {\n \"id\": 550103832,\n \"name\": \"finish\"\n }\n },\n {\n \"template_kind\": {\n \"id\": 983253650,\n \"name\": \"provision\"\n }\n }\n]"],"apis":[{"api_url":"/api/template_kinds","short_description":"List all template kinds.","http_method":"GET"}],"errors":[],"see":[],"name":"index","formats":null,"doc_url":"/apidoc/v2/template_kinds/index"}],"short_description":null,"name":"Template kinds","doc_url":"/apidoc/v2/template_kinds","formats":null},"home":{"api_url":"/api","full_description":null,"version":"v2","methods":[{"full_description":"","params":[],"examples":["GET /api\n200\n{\n \"links\": {\n \"List of domains\": \"/api/domains\",\n \"List all audits\": \"/api/audits\",\n \"List all puppetclasses\": \"/api/puppetclasses\",\n \"List all fact values\": \"/api/fact_values\",\n \"List all hosts\": \"/api/hosts\",\n \"List all roles\": \"/api/roles\",\n \"List all architectures\": \"/api/architectures\",\n \"List all settings\": \"/api/settings\",\n \"List all lookup_keys\": \"/api/lookup_keys\",\n \"Show available links\": \"/api\",\n \"List all bookmarks\": \"/api/bookmarks\",\n \"List all usergroups\": \"/api/usergroups\",\n \"List all reports\": \"/api/reports\",\n \"List all users\": \"/api/users\",\n \"List all smart_proxies\": \"/api/smart_proxies\",\n \"List all operating systems\": \"/api/operatingsystems\",\n \"List all authsource ldaps\": \"/api/auth_source_ldaps\",\n \"Get Dashboard results\": \"/api/dashboard\",\n \"List all media\": \"/api/media\",\n \"List all ptables\": \"/api/ptables\",\n \"List all hostgroups\": \"/api/hostgroups\",\n \"List of subnets\": \"/api/subnets\",\n \"List all compute resources\": \"/api/compute_resources\",\n \"Show status\": \"/api/status\",\n \"List templates\": \"/api/config_templates\",\n \"List all models\": \"/api/models\",\n \"List all environments\": \"/api/environments\",\n \"List all template kinds\": \"/api/template_kinds\",\n \"List all common parameters\": \"/api/common_parameters\",\n \"List all images for compute resource\": \"/api/compute_resources/:compute_resource_id/images\"\n }\n}"],"apis":[{"api_url":"/api","short_description":"Show available links.","http_method":"GET"}],"errors":[],"see":[],"name":"index","formats":null,"doc_url":"/apidoc/v2/home/index"},{"full_description":"","params":[],"examples":[],"apis":[{"api_url":"/api/status","short_description":"Show status.","http_method":"GET"}],"errors":[],"see":[],"name":"status","formats":null,"doc_url":"/apidoc/v2/home/status"}],"short_description":null,"name":"Home","doc_url":"/apidoc/v2/home","formats":null},"locations":{"api_url":"/api","full_description":null,"version":"v2","methods":[{"full_description":"","params":[{"validator":"Must be String","required":false,"full_name":"search","expected_type":"string","allow_nil":false,"description":"filter results
","name":"search"},{"validator":"Must be String","required":false,"full_name":"order","expected_type":"string","allow_nil":false,"description":"sort results
","name":"order"},{"validator":"Must be String","required":false,"full_name":"page","expected_type":"string","allow_nil":false,"description":"paginate results
","name":"page"},{"validator":"Must be String","required":false,"full_name":"per_page","expected_type":"string","allow_nil":false,"description":"number of entries per request
","name":"per_page"}],"examples":[],"apis":[{"api_url":"/api/location_id","short_description":"List all location_id","http_method":"GET"}],"errors":[],"see":[],"name":"index","formats":null,"doc_url":"/apidoc/v2/locations/index"},{"full_description":"","params":[],"examples":[],"apis":[{"api_url":"/api/location_id/:id","short_description":"Show a location","http_method":"GET"}],"errors":[],"see":[],"name":"show","formats":null,"doc_url":"/apidoc/v2/locations/show"},{"full_description":"","params":[{"validator":"Must be a Hash","required":true,"full_name":"location","params":[{"full_name":"location[name]","required":true,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"name"}],"expected_type":"hash","allow_nil":false,"description":"","name":"location"}],"examples":[],"apis":[{"api_url":"/api/location_id","short_description":"Create a location","http_method":"POST"}],"errors":[],"see":[],"name":"create","formats":null,"doc_url":"/apidoc/v2/locations/create"},{"full_description":"","params":[{"validator":"Must be a Hash","required":true,"full_name":"location","params":[{"full_name":"location[name]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"name"}],"expected_type":"hash","allow_nil":false,"description":"","name":"location"}],"examples":[],"apis":[{"api_url":"/api/location_id/:id","short_description":"Update a location","http_method":"PUT"}],"errors":[],"see":[],"name":"update","formats":null,"doc_url":"/apidoc/v2/locations/update"},{"full_description":"","params":[],"examples":[],"apis":[{"api_url":"/api/location_id/:id","short_description":"Delete a location","http_method":"DELETE"}],"errors":[],"see":[],"name":"destroy","formats":null,"doc_url":"/apidoc/v2/locations/destroy"}],"short_description":null,"name":"Locations","doc_url":"/apidoc/v2/locations","formats":null},"reports":{"api_url":"/api","full_description":null,"version":"v2","methods":[{"full_description":"","params":[{"validator":"Must be String","required":false,"full_name":"search","expected_type":"string","allow_nil":false,"description":"filter results
","name":"search"},{"validator":"Must be String","required":false,"full_name":"order","expected_type":"string","allow_nil":false,"description":"sort results
","name":"order"},{"validator":"Must be String","required":false,"full_name":"page","expected_type":"string","allow_nil":false,"description":"paginate results
","name":"page"},{"validator":"Must be String","required":false,"full_name":"per_page","expected_type":"string","allow_nil":false,"description":"number of entries per request
","name":"per_page"}],"examples":["GET /api/reports\n200\n[\n {\n \"report\": {\n \"logs\": [],\n \"reported_at\": \"2012-12-11T15:24:42Z\",\n \"summary\": \"Success\",\n \"status\": {\n \"restarted\": 0,\n \"applied\": 0,\n \"failed_restarts\": 0,\n \"pending\": 0,\n \"skipped\": 0,\n \"failed\": 0\n },\n \"metrics\": {\n \"changes\": {},\n \"resources\": {\n \"total\": 33\n },\n \"time\": {\n \"cron\": 0.000419,\n \"config_retrieval\": 16.3637869358063,\n \"service\": 0.149739,\n \"exec\": 0.000299,\n \"schedule\": 0.00083,\n \"package\": 0.003989,\n \"filebucket\": 0.000171,\n \"file\": 0.007025,\n \"mailalias\": 0.000283\n },\n \"events\": {\n \"total\": 0\n }\n },\n \"id\": 70219655\n }\n }\n]"],"apis":[{"api_url":"/api/reports","short_description":"List all reports.","http_method":"GET"}],"errors":[],"see":[],"name":"index","formats":null,"doc_url":"/apidoc/v2/reports/index"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["GET /api/reports/70219655\n200\n{\n \"report\": {\n \"logs\": [],\n \"reported_at\": \"2012-12-11T15:24:42Z\",\n \"summary\": \"Success\",\n \"status\": {\n \"restarted\": 0,\n \"applied\": 0,\n \"failed_restarts\": 0,\n \"pending\": 0,\n \"skipped\": 0,\n \"failed\": 0\n },\n \"metrics\": {\n \"changes\": {},\n \"resources\": {\n \"total\": 33\n },\n \"time\": {\n \"cron\": 0.000419,\n \"config_retrieval\": 16.3637869358063,\n \"service\": 0.149739,\n \"exec\": 0.000299,\n \"schedule\": 0.00083,\n \"package\": 0.003989,\n \"filebucket\": 0.000171,\n \"file\": 0.007025,\n \"mailalias\": 0.000283\n },\n \"events\": {\n \"total\": 0\n }\n },\n \"id\": 70219655\n }\n}"],"apis":[{"api_url":"/api/reports/:id","short_description":"Show a report.","http_method":"GET"}],"errors":[],"see":[],"name":"show","formats":null,"doc_url":"/apidoc/v2/reports/show"},{"full_description":"","params":[{"validator":"Must be String","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["DELETE /api/reports/70219655\n200\n{\n \"report\": {\n \"host\": \"my5name.mydomain.net\",\n \"logs\": [],\n \"reported_at\": \"2012-12-11T15:24:42Z\",\n \"summary\": \"Success\",\n \"status\": {\n \"restarted\": 0,\n \"applied\": 0,\n \"failed_restarts\": 0,\n \"pending\": 0,\n \"skipped\": 0,\n \"failed\": 0\n },\n \"metrics\": {\n \"resources\": {\n \"total\": 33\n },\n \"changes\": {},\n \"time\": {\n \"cron\": 0.000419,\n \"config_retrieval\": 16.3637869358063,\n \"service\": 0.149739,\n \"exec\": 0.000299,\n \"schedule\": 0.00083,\n \"package\": 0.003989,\n \"filebucket\": 0.000171,\n \"file\": 0.007025,\n \"mailalias\": 0.000283\n },\n \"events\": {\n \"total\": 0\n }\n },\n \"id\": 70219655\n }\n}"],"apis":[{"api_url":"/api/ptables/:id","short_description":"Delete a report.","http_method":"DELETE"}],"errors":[],"see":[],"name":"destroy","formats":null,"doc_url":"/apidoc/v2/reports/destroy"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["GET /api/reports/last\n200\n{\n \"report\": {\n \"logs\": [],\n \"reported_at\": \"2012-12-11T15:24:42Z\",\n \"summary\": \"Success\",\n \"status\": {\n \"restarted\": 0,\n \"applied\": 0,\n \"failed_restarts\": 0,\n \"pending\": 0,\n \"skipped\": 0,\n \"failed\": 0\n },\n \"metrics\": {\n \"changes\": {},\n \"resources\": {\n \"total\": 33\n },\n \"time\": {\n \"cron\": 0.000419,\n \"config_retrieval\": 16.3637869358063,\n \"service\": 0.149739,\n \"exec\": 0.000299,\n \"schedule\": 0.00083,\n \"package\": 0.003989,\n \"filebucket\": 0.000171,\n \"file\": 0.007025,\n \"mailalias\": 0.000283\n },\n \"events\": {\n \"total\": 0\n }\n },\n \"id\": 70219655\n }\n}"],"apis":[{"api_url":"/api/hosts/:host_id/reports/last","short_description":"Show the last report for a given host.","http_method":"GET"}],"errors":[],"see":[],"name":"last","formats":null,"doc_url":"/apidoc/v2/reports/last"}],"short_description":null,"name":"Reports","doc_url":"/apidoc/v2/reports","formats":null},"operatingsystems":{"api_url":"/api","full_description":"","version":"v2","methods":[{"full_description":"","params":[{"validator":"Must be String","required":false,"full_name":"search","expected_type":"string","allow_nil":false,"description":"filter results
","name":"search"},{"validator":"Must be String","required":false,"full_name":"order","expected_type":"string","allow_nil":false,"description":"for example, name ASC, or name DESC
","name":"order"},{"validator":"Must be String","required":false,"full_name":"page","expected_type":"string","allow_nil":false,"description":"paginate results
","name":"page"},{"validator":"Must be String","required":false,"full_name":"per_page","expected_type":"string","allow_nil":false,"description":"number of entries per request
","name":"per_page"}],"examples":[],"apis":[{"api_url":"/api/operatingsystems","short_description":"List all operating systems.","http_method":"GET"}],"errors":[],"see":[],"name":"index","formats":null,"doc_url":"/apidoc/v2/operatingsystems/index"},{"full_description":"","params":[{"validator":"Must be String","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["GET /api/operatingsystems/1073012828\n200\n{\n \"operatingsystem\": {\n \"ptables\": [\n {\n \"ptable\": {\n \"id\": 980190962,\n \"name\": \"default\"\n }\n }\n ],\n \"media\": [\n {\n \"medium\": {\n \"id\": 980190962,\n \"name\": \"CentOS 5.4\"\n }\n }\n ],\n \"release_name\": null,\n \"minor\": \"1\",\n \"os_default_templates\": [],\n \"config_templates\": [\n {\n \"config_template\": {\n \"id\": 1007981701,\n \"name\": \"centos5_3_pxelinux\"\n }\n },\n {\n \"config_template\": {\n \"id\": 104314179,\n \"name\": \"MyFinish\"\n }\n },\n {\n \"config_template\": {\n \"id\": 981457253,\n \"name\": \"MyScript\"\n }\n },\n {\n \"config_template\": {\n \"id\": 943779058,\n \"name\": \"MyString\"\n }\n },\n {\n \"config_template\": {\n \"id\": 269958254,\n \"name\": \"MyString2\"\n }\n },\n {\n \"config_template\": {\n \"id\": 352050261,\n \"name\": \"PXE Default File\"\n }\n },\n {\n \"config_template\": {\n \"id\": 821548108,\n \"name\": \"PXE Localboot Default\"\n }\n }\n ],\n \"major\": \"6\",\n \"family\": \"Redhat\",\n \"id\": 1073012828,\n \"name\": \"Redhat\",\n \"architectures\": [\n {\n \"architecture\": {\n \"id\": 501905019,\n \"name\": \"x86_64\"\n }\n }\n ]\n }\n}"],"apis":[{"api_url":"/api/operatingsystems/:id","short_description":"Show an OS.","http_method":"GET"}],"errors":[],"see":[],"name":"show","formats":null,"doc_url":"/apidoc/v2/operatingsystems/show"},{"full_description":"","params":[{"validator":"Must be a Hash","required":true,"full_name":"operatingsystem","params":[{"full_name":"operatingsystem[name]","required":true,"validator":"Must match regular expression /\\A(\\S+)\\Z/.","expected_type":"string","allow_nil":false,"description":"","name":"name"},{"full_name":"operatingsystem[major]","required":true,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"major"},{"full_name":"operatingsystem[minor]","required":true,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"minor"},{"full_name":"operatingsystem[family]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"family"},{"full_name":"operatingsystem[release_name]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"release_name"}],"expected_type":"hash","allow_nil":false,"description":"","name":"operatingsystem"}],"examples":["POST /api/operatingsystems\n{\n \"operatingsystem\": {\n \"minor\": \"2\",\n \"major\": \"1\",\n \"name\": \"awsome_os\"\n }\n}\n200\n{\n \"operatingsystem\": {\n \"ptables\": [],\n \"media\": [],\n \"release_name\": null,\n \"minor\": \"2\",\n \"os_default_templates\": [],\n \"config_templates\": [],\n \"major\": \"1\",\n \"family\": null,\n \"id\": 1073012829,\n \"name\": \"awsome_os\",\n \"architectures\": []\n }\n}"],"apis":[{"api_url":"/api/operatingsystems","short_description":"Create an OS.","http_method":"POST"}],"errors":[],"see":[],"name":"create","formats":null,"doc_url":"/apidoc/v2/operatingsystems/create"},{"full_description":"","params":[{"validator":"Must be String","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"},{"validator":"Must be a Hash","required":true,"full_name":"operatingsystem","params":[{"full_name":"operatingsystem[name]","required":false,"validator":"Must match regular expression /\\A(\\S+)\\Z/.","expected_type":"string","allow_nil":false,"description":"","name":"name"},{"full_name":"operatingsystem[major]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"major"},{"full_name":"operatingsystem[minor]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"minor"},{"full_name":"operatingsystem[family]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"family"},{"full_name":"operatingsystem[release_name]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"release_name"}],"expected_type":"hash","allow_nil":false,"description":"","name":"operatingsystem"}],"examples":["PUT /api/operatingsystems/1073012828\n{\n \"operatingsystem\": {\n \"name\": \"new_name\"\n }\n}\n200\n{\n \"operatingsystem\": {\n \"ptables\": [\n {\n \"ptable\": {\n \"id\": 980190962,\n \"name\": \"default\"\n }\n }\n ],\n \"media\": [\n {\n \"medium\": {\n \"id\": 980190962,\n \"name\": \"CentOS 5.4\"\n }\n }\n ],\n \"release_name\": null,\n \"minor\": \"1\",\n \"os_default_templates\": [],\n \"config_templates\": [\n {\n \"config_template\": {\n \"id\": 1007981701,\n \"name\": \"centos5_3_pxelinux\"\n }\n },\n {\n \"config_template\": {\n \"id\": 104314179,\n \"name\": \"MyFinish\"\n }\n },\n {\n \"config_template\": {\n \"id\": 981457253,\n \"name\": \"MyScript\"\n }\n },\n {\n \"config_template\": {\n \"id\": 943779058,\n \"name\": \"MyString\"\n }\n },\n {\n \"config_template\": {\n \"id\": 269958254,\n \"name\": \"MyString2\"\n }\n },\n {\n \"config_template\": {\n \"id\": 352050261,\n \"name\": \"PXE Default File\"\n }\n },\n {\n \"config_template\": {\n \"id\": 821548108,\n \"name\": \"PXE Localboot Default\"\n }\n }\n ],\n \"major\": \"6\",\n \"family\": \"Redhat\",\n \"id\": 1073012828,\n \"name\": \"new_name\",\n \"architectures\": [\n {\n \"architecture\": {\n \"id\": 501905019,\n \"name\": \"x86_64\"\n }\n }\n ]\n }\n}"],"apis":[{"api_url":"/api/operatingsystems/:id","short_description":"Update an OS.","http_method":"PUT"}],"errors":[],"see":[],"name":"update","formats":null,"doc_url":"/apidoc/v2/operatingsystems/update"},{"full_description":"","params":[{"validator":"Must be String","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["DELETE /api/operatingsystems/775246587\n200\n{\n \"operatingsystem\": {\n \"ptables\": [],\n \"media\": [],\n \"config_templates\": [],\n \"id\": 775246587,\n \"name\": \"NoHosts 1.1\",\n \"architectures\": []\n }\n}"],"apis":[{"api_url":"/api/operatingsystems/:id","short_description":"Delete an OS.","http_method":"DELETE"}],"errors":[],"see":[],"name":"destroy","formats":null,"doc_url":"/apidoc/v2/operatingsystems/destroy"},{"full_description":"","params":[{"validator":"Must be String","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"},{"validator":"Must be String","required":false,"full_name":"medium","expected_type":"string","allow_nil":false,"description":"","name":"medium"},{"validator":"Must be String","required":false,"full_name":"architecture","expected_type":"string","allow_nil":false,"description":"","name":"architecture"}],"examples":[],"apis":[{"api_url":"/api/operatingsystems/:id/bootfiles","short_description":"List boot files an OS.","http_method":"GET"}],"errors":[],"see":[],"name":"bootfiles","formats":null,"doc_url":"/apidoc/v2/operatingsystems/bootfiles"}],"short_description":null,"name":"Operating systems","doc_url":"/apidoc/v2/operatingsystems","formats":null},"dashboard":{"api_url":"/api","full_description":null,"version":"v2","methods":[{"full_description":"","params":[{"validator":"Must be String","required":false,"full_name":"search","expected_type":"string","allow_nil":false,"description":"filter results
","name":"search"}],"examples":["GET /api/dashboard\n200\n{\n \"ok_hosts\": 0,\n \"reports_missing\": 12,\n \"out_of_sync_hosts\": 0,\n \"percentage\": 0,\n \"bad_hosts\": 0,\n \"pending_hosts\": 0,\n \"pending_hosts_enabled\": 0,\n \"good_hosts\": 0,\n \"total_hosts\": 12,\n \"active_hosts\": 0,\n \"ok_hosts_enabled\": 0,\n \"disabled_hosts\": 0,\n \"out_of_sync_hosts_enabled\": 0,\n \"good_hosts_enabled\": 0,\n \"bad_hosts_enabled\": 0,\n \"active_hosts_ok_enabled\": 0,\n \"active_hosts_ok\": 0\n}"],"apis":[{"api_url":"/api/dashboard","short_description":"Get Dashboard results","http_method":"GET"}],"errors":[],"see":[],"name":"index","formats":null,"doc_url":"/apidoc/v2/dashboard/index"}],"short_description":null,"name":"Dashboard","doc_url":"/apidoc/v2/dashboard","formats":null},"hostgroups":{"api_url":"/api","full_description":null,"version":"v2","methods":[{"full_description":"","params":[{"validator":"Must be String","required":false,"full_name":"search","expected_type":"string","allow_nil":false,"description":"filter results
","name":"search"},{"validator":"Must be String","required":false,"full_name":"order","expected_type":"string","allow_nil":false,"description":"sort results
","name":"order"},{"validator":"Must be String","required":false,"full_name":"page","expected_type":"string","allow_nil":false,"description":"paginate results
","name":"page"},{"validator":"Must be String","required":false,"full_name":"per_page","expected_type":"string","allow_nil":false,"description":"number of entries per request
","name":"per_page"}],"examples":["GET /api/hostgroups\n200\n[\n {\n \"hostgroup\": {\n \"domain_id\": null,\n \"subnet_id\": null,\n \"environment_id\": 334344675,\n \"puppetclass_ids\": [],\n \"label\": \"db\",\n \"parameters\": {},\n \"ancestry\": null,\n \"id\": 603241515,\n \"name\": \"db\",\n \"operatingsystem_id\": 309172073\n }\n },\n {\n \"hostgroup\": {\n \"domain_id\": 22495316,\n \"subnet_id\": null,\n \"environment_id\": 334344675,\n \"puppetclass_ids\": [\n 980190962\n ],\n \"label\": \"Common\",\n \"parameters\": {\n \"group1\": \"group1\"\n },\n \"ancestry\": null,\n \"id\": 636252244,\n \"name\": \"Common\",\n \"operatingsystem_id\": 309172073\n }\n },\n {\n \"hostgroup\": {\n \"domain_id\": null,\n \"subnet_id\": null,\n \"environment_id\": null,\n \"puppetclass_ids\": [],\n \"label\": \"Unusual\",\n \"parameters\": {},\n \"ancestry\": null,\n \"id\": 866317115,\n \"name\": \"Unusual\",\n \"operatingsystem_id\": null\n }\n }\n]"],"apis":[{"api_url":"/api/hostgroups","short_description":"List all hostgroups.","http_method":"GET"}],"errors":[],"see":[],"name":"index","formats":null,"doc_url":"/apidoc/v2/hostgroups/index"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["GET /api/hostgroups/636252244-common\n200\n{\n \"hostgroup\": {\n \"domain_id\": 22495316,\n \"subnet_id\": null,\n \"environment_id\": 334344675,\n \"puppetclass_ids\": [\n 980190962\n ],\n \"label\": \"Common\",\n \"parameters\": {\n \"group1\": \"group1\"\n },\n \"ancestry\": null,\n \"id\": 636252244,\n \"name\": \"Common\",\n \"operatingsystem_id\": 309172073\n }\n}"],"apis":[{"api_url":"/api/hostgroups/:id","short_description":"Show a hostgroup.","http_method":"GET"}],"errors":[],"see":[],"name":"show","formats":null,"doc_url":"/apidoc/v2/hostgroups/show"},{"full_description":"","params":[{"validator":"Must be a Hash","required":true,"full_name":"hostgroup","params":[{"full_name":"hostgroup[name]","required":true,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"name"},{"full_name":"hostgroup[parent_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"parent_id"},{"full_name":"hostgroup[environment_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"environment_id"},{"full_name":"hostgroup[operatingsystem_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"operatingsystem_id"},{"full_name":"hostgroup[architecture_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"architecture_id"},{"full_name":"hostgroup[medium_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"medium_id"},{"full_name":"hostgroup[ptable_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"ptable_id"},{"full_name":"hostgroup[puppet_ca_proxy_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"puppet_ca_proxy_id"},{"full_name":"hostgroup[subnet_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"subnet_id"},{"full_name":"hostgroup[domain_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"domain_id"},{"full_name":"hostgroup[puppet_proxy_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"puppet_proxy_id"}],"expected_type":"hash","allow_nil":false,"description":"","name":"hostgroup"}],"examples":["POST /api/hostgroups\n{\n \"hostgroup\": {\n \"name\": \"TestHostgroup\"\n }\n}\n200\n{\n \"hostgroup\": {\n \"domain_id\": null,\n \"subnet_id\": null,\n \"environment_id\": null,\n \"puppetclass_ids\": [],\n \"label\": \"TestHostgroup\",\n \"parameters\": {},\n \"ancestry\": null,\n \"id\": 866317116,\n \"name\": \"TestHostgroup\",\n \"operatingsystem_id\": null\n }\n}"],"apis":[{"api_url":"/api/hostgroups","short_description":"Create an hostgroup.","http_method":"POST"}],"errors":[],"see":[],"name":"create","formats":null,"doc_url":"/apidoc/v2/hostgroups/create"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"},{"validator":"Must be a Hash","required":true,"full_name":"hostgroup","params":[{"full_name":"hostgroup[name]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"name"},{"full_name":"hostgroup[parent_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"parent_id"},{"full_name":"hostgroup[environment_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"environment_id"},{"full_name":"hostgroup[operatingsystem_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"operatingsystem_id"},{"full_name":"hostgroup[architecture_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"architecture_id"},{"full_name":"hostgroup[medium_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"medium_id"},{"full_name":"hostgroup[ptable_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"ptable_id"},{"full_name":"hostgroup[puppet_ca_proxy_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"puppet_ca_proxy_id"},{"full_name":"hostgroup[subnet_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"subnet_id"},{"full_name":"hostgroup[domain_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"domain_id"},{"full_name":"hostgroup[puppet_proxy_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"puppet_proxy_id"}],"expected_type":"hash","allow_nil":false,"description":"","name":"hostgroup"}],"examples":["PUT /api/hostgroups/636252244-common\n{\n \"hostgroup\": {}\n}\n200\n{\n \"hostgroup\": {\n \"domain_id\": 22495316,\n \"subnet_id\": null,\n \"environment_id\": 334344675,\n \"puppetclass_ids\": [\n 980190962\n ],\n \"label\": \"Common\",\n \"parameters\": {\n \"group1\": \"group1\"\n },\n \"ancestry\": null,\n \"id\": 636252244,\n \"name\": \"Common\",\n \"operatingsystem_id\": 309172073\n }\n}"],"apis":[{"api_url":"/api/hostgroups/:id","short_description":"Update an hostgroup.","http_method":"PUT"}],"errors":[],"see":[],"name":"update","formats":null,"doc_url":"/apidoc/v2/hostgroups/update"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["DELETE /api/hostgroups/636252244-common\n200\n{\n \"hostgroup\": {\n \"domain_id\": 22495316,\n \"subnet_id\": null,\n \"environment_id\": 334344675,\n \"puppetclass_ids\": [],\n \"label\": \"Common\",\n \"parameters\": {},\n \"ancestry\": null,\n \"id\": 636252244,\n \"name\": \"Common\",\n \"operatingsystem_id\": 309172073\n }\n}"],"apis":[{"api_url":"/api/hostgroups/:id","short_description":"Delete an hostgroup.","http_method":"DELETE"}],"errors":[],"see":[],"name":"destroy","formats":null,"doc_url":"/apidoc/v2/hostgroups/destroy"}],"short_description":null,"name":"Hostgroups","doc_url":"/apidoc/v2/hostgroups","formats":null},"subnets":{"api_url":"/api","full_description":null,"version":"v2","methods":[{"full_description":"","params":[{"validator":"Must be String","required":false,"full_name":"search","expected_type":"string","allow_nil":false,"description":"Filter results
","name":"search"},{"validator":"Must be String","required":false,"full_name":"order","expected_type":"string","allow_nil":false,"description":"Sort results
","name":"order"},{"validator":"Must be String","required":false,"full_name":"page","expected_type":"string","allow_nil":false,"description":"paginate results
","name":"page"},{"validator":"Must be String","required":false,"full_name":"per_page","expected_type":"string","allow_nil":false,"description":"number of entries per request
","name":"per_page"}],"examples":["GET /api/subnets\n200\n[\n {\n \"subnet\": {\n \"vlanid\": \"41\",\n \"gateway\": null,\n \"dhcp_id\": 980190962,\n \"tftp_id\": 298486374,\n \"mask\": \"255.255.255.0\",\n \"dns_primary\": null,\n \"dns_id\": 113629430,\n \"to\": null,\n \"from\": null,\n \"id\": 980190962,\n \"domain_ids\": [\n 822172901\n ],\n \"dns_secondary\": null,\n \"network\": \"2.3.4.0\",\n \"name\": \"one\",\n \"priority\": null\n }\n },\n {\n \"subnet\": {\n \"vlanid\": \"42\",\n \"gateway\": null,\n \"dhcp_id\": 980190962,\n \"tftp_id\": 298486374,\n \"mask\": \"255.255.255.0\",\n \"dns_primary\": null,\n \"dns_id\": null,\n \"to\": null,\n \"from\": null,\n \"id\": 298486374,\n \"domain_ids\": [\n 534821992\n ],\n \"dns_secondary\": null,\n \"network\": \"3.3.4.0\",\n \"name\": \"two\",\n \"priority\": null\n }\n },\n {\n \"subnet\": {\n \"vlanid\": \"43\",\n \"gateway\": null,\n \"dhcp_id\": 980190962,\n \"tftp_id\": 298486374,\n \"mask\": \"255.255.255.0\",\n \"dns_primary\": null,\n \"dns_id\": null,\n \"to\": null,\n \"from\": null,\n \"id\": 113629430,\n \"domain_ids\": [],\n \"dns_secondary\": null,\n \"network\": \"3.3.4.3\",\n \"name\": \"three\",\n \"priority\": null\n }\n }\n]"],"apis":[{"api_url":"/api/subnets","short_description":"List of subnets","http_method":"GET"}],"errors":[],"see":[],"name":"index","formats":null,"doc_url":"/apidoc/v2/subnets/index"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["GET /api/subnets/980190962\n200\n{\n \"subnet\": {\n \"dns\": {\n \"url\": \"http://else.where:4567\",\n \"id\": 113629430,\n \"name\": \"DNS Proxy\"\n },\n \"vlanid\": \"41\",\n \"gateway\": null,\n \"dhcp_id\": 980190962,\n \"tftp_id\": 298486374,\n \"mask\": \"255.255.255.0\",\n \"dns_primary\": null,\n \"dns_id\": 113629430,\n \"to\": null,\n \"from\": null,\n \"id\": 980190962,\n \"domain_ids\": [\n 822172901\n ],\n \"dns_secondary\": null,\n \"network\": \"2.3.4.0\",\n \"name\": \"one\",\n \"tftp\": {\n \"url\": \"http://somewhere.else\",\n \"id\": 298486374,\n \"name\": \"TFTP Proxy\"\n },\n \"dhcp\": {\n \"url\": \"https://somewhere.net:8443\",\n \"id\": 980190962,\n \"name\": \"DHCP Proxy\"\n },\n \"priority\": null\n }\n}"],"apis":[{"api_url":"/api/subnets/:id","short_description":"Show a subnet.","http_method":"GET"}],"errors":[],"see":[],"name":"show","formats":null,"doc_url":"/apidoc/v2/subnets/show"},{"full_description":"","params":[{"validator":"Must be a Hash","required":true,"full_name":"subnet","params":[{"full_name":"subnet[name]","required":true,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"Subnet name
","name":"name"},{"full_name":"subnet[network]","required":true,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"Subnet network
","name":"network"},{"full_name":"subnet[mask]","required":true,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"Netmask for this subnet
","name":"mask"},{"full_name":"subnet[gateway]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"Primary DNS for this subnet
","name":"gateway"},{"full_name":"subnet[dns_primary]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"Primary DNS for this subnet
","name":"dns_primary"},{"full_name":"subnet[dns_secondary]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"Secondary DNS for this subnet
","name":"dns_secondary"},{"full_name":"subnet[from]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"Starting IP Address for IP auto suggestion
","name":"from"},{"full_name":"subnet[to]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"Ending IP Address for IP auto suggestion
","name":"to"},{"full_name":"subnet[vlanid]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"VLAN ID for this subnet
","name":"vlanid"},{"full_name":"subnet[domain_ids]","required":false,"validator":"Must be Array","expected_type":"array","allow_nil":false,"description":"Domains in which this subnet is part
","name":"domain_ids"},{"full_name":"subnet[dhcp_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"DHCP Proxy to use within this subnet
","name":"dhcp_id"},{"full_name":"subnet[tftp_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"TFTP Proxy to use within this subnet
","name":"tftp_id"},{"full_name":"subnet[dns_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"DNS Proxy to use within this subnet
","name":"dns_id"}],"expected_type":"hash","allow_nil":false,"description":"","name":"subnet"}],"examples":["POST /api/subnets\n{\n \"subnet\": {\n \"mask\": \"255.255.255.0\",\n \"network\": \"10.35.2.27\",\n \"name\": \"QA2\"\n }\n}\n200\n{\n \"subnet\": {\n \"dns\": null,\n \"vlanid\": null,\n \"gateway\": null,\n \"dhcp_id\": null,\n \"tftp_id\": null,\n \"mask\": \"255.255.255.0\",\n \"dns_primary\": null,\n \"dns_id\": null,\n \"to\": null,\n \"from\": null,\n \"id\": 980190963,\n \"domain_ids\": [],\n \"dns_secondary\": null,\n \"network\": \"10.35.2.27\",\n \"name\": \"QA2\",\n \"tftp\": null,\n \"dhcp\": null,\n \"priority\": null\n }\n}"],"apis":[{"api_url":"/api/subnets","short_description":"Create a subnet","http_method":"POST"}],"errors":[],"see":[],"name":"create","formats":null,"doc_url":"/apidoc/v2/subnets/create"},{"full_description":"","params":[{"validator":"Must be a number.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"Subnet numeric identifier
","name":"id"},{"validator":"Must be a Hash","required":true,"full_name":"subnet","params":[{"full_name":"subnet[name]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"Subnet name
","name":"name"},{"full_name":"subnet[network]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"Subnet network
","name":"network"},{"full_name":"subnet[mask]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"Netmask for this subnet
","name":"mask"},{"full_name":"subnet[gateway]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":true,"description":"Primary DNS for this subnet
","name":"gateway"},{"full_name":"subnet[dns_primary]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":true,"description":"Primary DNS for this subnet
","name":"dns_primary"},{"full_name":"subnet[dns_secondary]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":true,"description":"Secondary DNS for this subnet
","name":"dns_secondary"},{"full_name":"subnet[from]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":true,"description":"Starting IP Address for IP auto suggestion
","name":"from"},{"full_name":"subnet[to]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":true,"description":"Ending IP Address for IP auto suggestion
","name":"to"},{"full_name":"subnet[vlanid]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":true,"description":"VLAN ID for this subnet
","name":"vlanid"},{"full_name":"subnet[domain_ids]","required":false,"validator":"Must be Array","expected_type":"array","allow_nil":true,"description":"Domains in which this subnet is part
","name":"domain_ids"},{"full_name":"subnet[dhcp_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":true,"description":"DHCP Proxy to use within this subnet
","name":"dhcp_id"},{"full_name":"subnet[tftp_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":true,"description":"TFTP Proxy to use within this subnet
","name":"tftp_id"},{"full_name":"subnet[dns_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":true,"description":"DNS Proxy to use within this subnet
","name":"dns_id"}],"expected_type":"hash","allow_nil":false,"description":"","name":"subnet"}],"examples":["PUT /api/subnets/980190962\n{\n \"subnet\": {}\n}\n200\n{\n \"subnet\": {\n \"dns\": {\n \"url\": \"http://else.where:4567\",\n \"id\": 113629430,\n \"name\": \"DNS Proxy\"\n },\n \"vlanid\": \"41\",\n \"gateway\": null,\n \"dhcp_id\": 980190962,\n \"tftp_id\": 298486374,\n \"mask\": \"255.255.255.0\",\n \"dns_primary\": null,\n \"dns_id\": 113629430,\n \"to\": null,\n \"from\": null,\n \"id\": 980190962,\n \"domain_ids\": [\n 822172901\n ],\n \"dns_secondary\": null,\n \"network\": \"2.3.4.0\",\n \"name\": \"one\",\n \"tftp\": {\n \"url\": \"http://somewhere.else\",\n \"id\": 298486374,\n \"name\": \"TFTP Proxy\"\n },\n \"dhcp\": {\n \"url\": \"https://somewhere.net:8443\",\n \"id\": 980190962,\n \"name\": \"DHCP Proxy\"\n },\n \"priority\": null\n }\n}"],"apis":[{"api_url":"/api/subnets/:id","short_description":"Update a subnet","http_method":"PUT"}],"errors":[],"see":[],"name":"update","formats":null,"doc_url":"/apidoc/v2/subnets/update"},{"full_description":"","params":[{"validator":"Must be a number.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"Subnet numeric identifier
","name":"id"}],"examples":["DELETE /api/subnets/980190962\n422\n{\n \"subnet\": {\n \"full_messages\": [\n \"2.3.4.0/24 is used by temp-01.yourdomain.net\",\n \"2.3.4.0/24 is used by suse01.yourdomain.net\",\n \"2.3.4.0/24 is used by temp01.yourdomain.net\",\n \"2.3.4.0/24 is used by anotherfullhost\",\n \"2.3.4.0/24 is used by temp.yourdomain.net\",\n \"2.3.4.0/24 is used by my5name.mydomain.net\",\n \"2.3.4.0/24 is used by dhcp.mydomain.net\",\n \"2.3.4.0/24 is used by otherfullhost\",\n \"2.3.4.0/24 is used by sdhcp.mydomain.net\",\n \"2.3.4.0/24 is used by sol10host\",\n \"2.3.4.0/24 is used by sdhcp.mydomain.net\"\n ],\n \"errors\": {\n \"base\": [\n \"2.3.4.0/24 is used by temp-01.yourdomain.net\",\n \"2.3.4.0/24 is used by suse01.yourdomain.net\",\n \"2.3.4.0/24 is used by temp01.yourdomain.net\",\n \"2.3.4.0/24 is used by anotherfullhost\",\n \"2.3.4.0/24 is used by temp.yourdomain.net\",\n \"2.3.4.0/24 is used by my5name.mydomain.net\",\n \"2.3.4.0/24 is used by dhcp.mydomain.net\",\n \"2.3.4.0/24 is used by otherfullhost\",\n \"2.3.4.0/24 is used by sdhcp.mydomain.net\",\n \"2.3.4.0/24 is used by sol10host\",\n \"2.3.4.0/24 is used by sdhcp.mydomain.net\"\n ]\n },\n \"id\": 980190962\n }\n}"],"apis":[{"api_url":"/api/subnets/:id","short_description":"Delete a subnet","http_method":"DELETE"}],"errors":[],"see":[],"name":"destroy","formats":null,"doc_url":"/apidoc/v2/subnets/destroy"}],"short_description":null,"name":"Subnets","doc_url":"/apidoc/v2/subnets","formats":null},"roles":{"api_url":"/api","full_description":null,"version":"v2","methods":[{"full_description":"","params":[{"validator":"Must be String","required":false,"full_name":"page","expected_type":"string","allow_nil":false,"description":"paginate results
","name":"page"},{"validator":"Must be String","required":false,"full_name":"per_page","expected_type":"string","allow_nil":false,"description":"number of entries per request
","name":"per_page"}],"examples":[],"apis":[{"api_url":"/api/roles","short_description":"List all roles.","http_method":"GET"}],"errors":[],"see":[],"name":"index","formats":null,"doc_url":"/apidoc/v2/roles/index"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["GET /api/roles/1\n200\n{\n \"role\": {\n \"builtin\": 0,\n \"permissions\": [\n \"view_architectures\",\n \"create_architectures\",\n \"edit_architectures\",\n \"destroy_architectures\",\n \"view_authenticators\",\n \"create_authenticators\",\n \"edit_authenticators\",\n \"destroy_authenticators\",\n \"view_environments\",\n \"create_environments\",\n \"edit_environments\",\n \"destroy_environments\",\n \"import_environments\",\n \"view_external_variables\",\n \"create_external_variables\",\n \"edit_external_variables\",\n \"destroy_external_variables\",\n \"view_domains\",\n \"create_domain\",\n \"edit_domains\",\n \"destroy_domains\",\n \"view_globals\",\n \"create_globals\",\n \"edit_globals\",\n \"destroy_globals\",\n \"view_hostgroups\",\n \"create_hostgroups\",\n \"edit_hostgroups\",\n \"destroy_hostgroups\",\n \"view_hosts\",\n \"create_hosts\",\n \"edit_hosts\",\n \"destroy_hosts\",\n \"view_media\",\n \"create_media\",\n \"edit_media\",\n \"destroy_media\",\n \"view_models\",\n \"create_models\",\n \"edit_models\",\n \"destroy_models\",\n \"view_operatingsystems\",\n \"create_operatingsystems\",\n \"edit_operatingsystems\",\n \"destroy_operatingsystems\",\n \"view_ptables\",\n \"create_ptables\",\n \"edit_ptables\",\n \"destroy_ptables\",\n \"view_puppetclasses\",\n \"create_puppetclasses\",\n \"edit_puppetclasses\",\n \"destroy_puppetclasses\",\n \"import_puppetclasses\",\n \"view_usergroups\",\n \"create_usergroups\",\n \"edit_usergroups\",\n \"destroy_usergroups\",\n \"view_users\",\n \"create_users\",\n \"edit_users\",\n \"destroy_users\",\n \"access_settings\",\n \"access_dashboard\",\n \"view_reports\",\n \"destroy_reports\",\n \"view_facts\",\n \"view_audit_logs\",\n \"view_statistics\",\n \"view_locations\",\n \"edit_locations\",\n \"create_locations\",\n \"destroy_locations\",\n \"view_organizations\",\n \"edit_organizations\",\n \"create_organizations\",\n \"destroy_organizations\"\n ],\n \"id\": 1,\n \"name\": \"Manager\"\n }\n}"],"apis":[{"api_url":"/api/roles/:id","short_description":"Show an role.","http_method":"GET"}],"errors":[],"see":[],"name":"show","formats":null,"doc_url":"/apidoc/v2/roles/show"},{"full_description":"","params":[{"validator":"Must be a Hash","required":true,"full_name":"role","params":[{"full_name":"role[name]","required":true,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"name"}],"expected_type":"hash","allow_nil":false,"description":"","name":"role"}],"examples":["POST /api/roles\n{\n \"role\": {\n \"name\": \"staff\"\n }\n}\n200\n{\n \"role\": {\n \"builtin\": 0,\n \"permissions\": [],\n \"id\": 11,\n \"name\": \"staff\"\n }\n}"],"apis":[{"api_url":"/api/roles","short_description":"Create an role.","http_method":"POST"}],"errors":[],"see":[],"name":"create","formats":null,"doc_url":"/apidoc/v2/roles/create"},{"full_description":"","params":[{"validator":"Must be String","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"},{"validator":"Must be a Hash","required":true,"full_name":"role","params":[{"full_name":"role[name]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"name"}],"expected_type":"hash","allow_nil":false,"description":"","name":"role"}],"examples":["PUT /api/roles/1\n{\n \"role\": {}\n}\n200\n{\n \"role\": {\n \"builtin\": 0,\n \"permissions\": [\n \"view_architectures\",\n \"create_architectures\",\n \"edit_architectures\",\n \"destroy_architectures\",\n \"view_authenticators\",\n \"create_authenticators\",\n \"edit_authenticators\",\n \"destroy_authenticators\",\n \"view_environments\",\n \"create_environments\",\n \"edit_environments\",\n \"destroy_environments\",\n \"import_environments\",\n \"view_external_variables\",\n \"create_external_variables\",\n \"edit_external_variables\",\n \"destroy_external_variables\",\n \"view_domains\",\n \"create_domain\",\n \"edit_domains\",\n \"destroy_domains\",\n \"view_globals\",\n \"create_globals\",\n \"edit_globals\",\n \"destroy_globals\",\n \"view_hostgroups\",\n \"create_hostgroups\",\n \"edit_hostgroups\",\n \"destroy_hostgroups\",\n \"view_hosts\",\n \"create_hosts\",\n \"edit_hosts\",\n \"destroy_hosts\",\n \"view_media\",\n \"create_media\",\n \"edit_media\",\n \"destroy_media\",\n \"view_models\",\n \"create_models\",\n \"edit_models\",\n \"destroy_models\",\n \"view_operatingsystems\",\n \"create_operatingsystems\",\n \"edit_operatingsystems\",\n \"destroy_operatingsystems\",\n \"view_ptables\",\n \"create_ptables\",\n \"edit_ptables\",\n \"destroy_ptables\",\n \"view_puppetclasses\",\n \"create_puppetclasses\",\n \"edit_puppetclasses\",\n \"destroy_puppetclasses\",\n \"import_puppetclasses\",\n \"view_usergroups\",\n \"create_usergroups\",\n \"edit_usergroups\",\n \"destroy_usergroups\",\n \"view_users\",\n \"create_users\",\n \"edit_users\",\n \"destroy_users\",\n \"access_settings\",\n \"access_dashboard\",\n \"view_reports\",\n \"destroy_reports\",\n \"view_facts\",\n \"view_audit_logs\",\n \"view_statistics\",\n \"view_locations\",\n \"edit_locations\",\n \"create_locations\",\n \"destroy_locations\",\n \"view_organizations\",\n \"edit_organizations\",\n \"create_organizations\",\n \"destroy_organizations\"\n ],\n \"id\": 1,\n \"name\": \"Manager\"\n }\n}"],"apis":[{"api_url":"/api/roles/:id","short_description":"Update an role.","http_method":"PUT"}],"errors":[],"see":[],"name":"update","formats":null,"doc_url":"/apidoc/v2/roles/update"},{"full_description":"","params":[{"validator":"Must be String","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["DELETE /api/roles/1\n200\n{\n \"role\": {\n \"builtin\": 0,\n \"permissions\": [\n \"view_architectures\",\n \"create_architectures\",\n \"edit_architectures\",\n \"destroy_architectures\",\n \"view_authenticators\",\n \"create_authenticators\",\n \"edit_authenticators\",\n \"destroy_authenticators\",\n \"view_environments\",\n \"create_environments\",\n \"edit_environments\",\n \"destroy_environments\",\n \"import_environments\",\n \"view_external_variables\",\n \"create_external_variables\",\n \"edit_external_variables\",\n \"destroy_external_variables\",\n \"view_domains\",\n \"create_domain\",\n \"edit_domains\",\n \"destroy_domains\",\n \"view_globals\",\n \"create_globals\",\n \"edit_globals\",\n \"destroy_globals\",\n \"view_hostgroups\",\n \"create_hostgroups\",\n \"edit_hostgroups\",\n \"destroy_hostgroups\",\n \"view_hosts\",\n \"create_hosts\",\n \"edit_hosts\",\n \"destroy_hosts\",\n \"view_media\",\n \"create_media\",\n \"edit_media\",\n \"destroy_media\",\n \"view_models\",\n \"create_models\",\n \"edit_models\",\n \"destroy_models\",\n \"view_operatingsystems\",\n \"create_operatingsystems\",\n \"edit_operatingsystems\",\n \"destroy_operatingsystems\",\n \"view_ptables\",\n \"create_ptables\",\n \"edit_ptables\",\n \"destroy_ptables\",\n \"view_puppetclasses\",\n \"create_puppetclasses\",\n \"edit_puppetclasses\",\n \"destroy_puppetclasses\",\n \"import_puppetclasses\",\n \"view_usergroups\",\n \"create_usergroups\",\n \"edit_usergroups\",\n \"destroy_usergroups\",\n \"view_users\",\n \"create_users\",\n \"edit_users\",\n \"destroy_users\",\n \"access_settings\",\n \"access_dashboard\",\n \"view_reports\",\n \"destroy_reports\",\n \"view_facts\",\n \"view_audit_logs\",\n \"view_statistics\",\n \"view_locations\",\n \"edit_locations\",\n \"create_locations\",\n \"destroy_locations\",\n \"view_organizations\",\n \"edit_organizations\",\n \"create_organizations\",\n \"destroy_organizations\"\n ],\n \"id\": 1,\n \"name\": \"Manager\"\n }\n}"],"apis":[{"api_url":"/api/roles/:id","short_description":"Delete an role.","http_method":"DELETE"}],"errors":[],"see":[],"name":"destroy","formats":null,"doc_url":"/apidoc/v2/roles/destroy"}],"short_description":null,"name":"Roles","doc_url":"/apidoc/v2/roles","formats":null},"auth_source_ldaps":{"api_url":"/api","full_description":null,"version":"v2","methods":[{"full_description":"","params":[{"validator":"Must be String","required":false,"full_name":"page","expected_type":"string","allow_nil":false,"description":"paginate results
","name":"page"},{"validator":"Must be String","required":false,"full_name":"per_page","expected_type":"string","allow_nil":false,"description":"number of entries per request
","name":"per_page"}],"examples":["GET /api/auth_source_ldaps\n200\n[\n {\n \"auth_source_ldap\": {\n \"host\": \"ldap\",\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"account\": null,\n \"attr_mail\": \"mail\",\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"tls\": true,\n \"onthefly_register\": true,\n \"attr_login\": \"uid\",\n \"attr_lastname\": \"sn\",\n \"base_dn\": \"dn=x,dn=y\",\n \"port\": 123,\n \"type\": \"AuthSourceLdap\",\n \"id\": 980190962,\n \"name\": \"ldap\",\n \"attr_firstname\": \"givenName\"\n }\n }\n]"],"apis":[{"api_url":"/api/auth_source_ldaps","short_description":"List all authsource ldaps","http_method":"GET"}],"errors":[],"see":[],"name":"index","formats":null,"doc_url":"/apidoc/v2/auth_source_ldaps/index"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["GET /api/auth_source_ldaps/980190962\n200\n{\n \"auth_source_ldap\": {\n \"host\": \"ldap\",\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"account\": null,\n \"attr_mail\": \"mail\",\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"tls\": true,\n \"onthefly_register\": true,\n \"attr_login\": \"uid\",\n \"attr_lastname\": \"sn\",\n \"base_dn\": \"dn=x,dn=y\",\n \"port\": 123,\n \"type\": \"AuthSourceLdap\",\n \"id\": 980190962,\n \"name\": \"ldap\",\n \"attr_firstname\": \"givenName\"\n }\n}"],"apis":[{"api_url":"/api/auth_source_ldaps/:id","short_description":"Show an authsource ldap.","http_method":"GET"}],"errors":[],"see":[],"name":"show","formats":null,"doc_url":"/apidoc/v2/auth_source_ldaps/show"},{"full_description":"","params":[{"validator":"Must be a Hash","required":true,"full_name":"auth_source_ldap","params":[{"full_name":"auth_source_ldap[name]","required":true,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"name"},{"full_name":"auth_source_ldap[host]","required":true,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"host"},{"full_name":"auth_source_ldap[port]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"defaults to 389
","name":"port"},{"full_name":"auth_source_ldap[account]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"account"},{"full_name":"auth_source_ldap[base_dn]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"base_dn"},{"full_name":"auth_source_ldap[account_password]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"required if onthefly_register is true
","name":"account_password"},{"full_name":"auth_source_ldap[attr_login]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"required if onthefly_register is true
","name":"attr_login"},{"full_name":"auth_source_ldap[attr_firstname]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"required if onthefly_register is true
","name":"attr_firstname"},{"full_name":"auth_source_ldap[attr_lastname]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"required if onthefly_register is true
","name":"attr_lastname"},{"full_name":"auth_source_ldap[attr_mail]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"required if onthefly_register is true
","name":"attr_mail"},{"full_name":"auth_source_ldap[onthefly_register]","required":false,"validator":"Must be 'true' or 'false'","expected_type":"string","allow_nil":false,"description":"","name":"onthefly_register"},{"full_name":"auth_source_ldap[tls]","required":false,"validator":"Must be 'true' or 'false'","expected_type":"string","allow_nil":false,"description":"","name":"tls"}],"expected_type":"hash","allow_nil":false,"description":"","name":"auth_source_ldap"}],"examples":["POST /api/auth_source_ldaps\n{\n \"auth_source_ldap\": {\n \"host\": \"ldap2\",\n \"name\": \"ldap2\"\n }\n}\n201\n{\n \"auth_source_ldap\": {\n \"host\": \"ldap2\",\n \"created_at\": \"2012-12-18T15:24:44Z\",\n \"account\": null,\n \"attr_mail\": null,\n \"updated_at\": \"2012-12-18T15:24:44Z\",\n \"tls\": false,\n \"onthefly_register\": false,\n \"attr_lastname\": null,\n \"attr_login\": null,\n \"base_dn\": null,\n \"port\": 389,\n \"account_password\": null,\n \"id\": 980190963,\n \"name\": \"ldap2\",\n \"attr_firstname\": null\n }\n}"],"apis":[{"api_url":"/api/auth_source_ldaps","short_description":"Create an auth_source_ldap.","http_method":"POST"}],"errors":[],"see":[],"name":"create","formats":null,"doc_url":"/apidoc/v2/auth_source_ldaps/create"},{"full_description":"","params":[{"validator":"Must be String","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"},{"validator":"Must be a Hash","required":true,"full_name":"auth_source_ldap","params":[{"full_name":"auth_source_ldap[name]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"name"},{"full_name":"auth_source_ldap[host]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"host"},{"full_name":"auth_source_ldap[port]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"defaults to 389
","name":"port"},{"full_name":"auth_source_ldap[account]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"account"},{"full_name":"auth_source_ldap[base_dn]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"base_dn"},{"full_name":"auth_source_ldap[account_password]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"required if onthefly_register is true
","name":"account_password"},{"full_name":"auth_source_ldap[attr_login]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"required if onthefly_register is true
","name":"attr_login"},{"full_name":"auth_source_ldap[attr_firstname]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"required if onthefly_register is true
","name":"attr_firstname"},{"full_name":"auth_source_ldap[attr_lastname]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"required if onthefly_register is true
","name":"attr_lastname"},{"full_name":"auth_source_ldap[attr_mail]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"required if onthefly_register is true
","name":"attr_mail"},{"full_name":"auth_source_ldap[onthefly_register]","required":false,"validator":"Must be 'true' or 'false'","expected_type":"string","allow_nil":false,"description":"","name":"onthefly_register"},{"full_name":"auth_source_ldap[tls]","required":false,"validator":"Must be 'true' or 'false'","expected_type":"string","allow_nil":false,"description":"","name":"tls"}],"expected_type":"hash","allow_nil":false,"description":"","name":"auth_source_ldap"}],"examples":["PUT /api/auth_source_ldaps/980190962\n{\n \"auth_source_ldap\": {}\n}\n200\n{\n \"auth_source_ldap\": {\n \"host\": \"ldap\",\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"account\": null,\n \"attr_mail\": \"mail\",\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"tls\": true,\n \"onthefly_register\": true,\n \"attr_lastname\": \"sn\",\n \"attr_login\": \"uid\",\n \"base_dn\": \"dn=x,dn=y\",\n \"port\": 123,\n \"account_password\": null,\n \"id\": 980190962,\n \"name\": \"ldap\",\n \"attr_firstname\": \"givenName\"\n }\n}"],"apis":[{"api_url":"/api/auth_source_ldaps/:id","short_description":"Update an auth_source_ldap.","http_method":"PUT"}],"errors":[],"see":[],"name":"update","formats":null,"doc_url":"/apidoc/v2/auth_source_ldaps/update"},{"full_description":"","params":[{"validator":"Must be String","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["DELETE /api/auth_source_ldaps/980190962\n200\n{\n \"auth_source_ldap\": {\n \"host\": \"ldap\",\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"account\": null,\n \"attr_mail\": \"mail\",\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"tls\": true,\n \"onthefly_register\": true,\n \"attr_lastname\": \"sn\",\n \"attr_login\": \"uid\",\n \"base_dn\": \"dn=x,dn=y\",\n \"port\": 123,\n \"account_password\": null,\n \"id\": 980190962,\n \"name\": \"ldap\",\n \"attr_firstname\": \"givenName\"\n }\n}"],"apis":[{"api_url":"/api/auth_source_ldaps/:id","short_description":"Delete an auth_source_ldap.","http_method":"DELETE"}],"errors":[],"see":[],"name":"destroy","formats":null,"doc_url":"/apidoc/v2/auth_source_ldaps/destroy"}],"short_description":null,"name":"Auth source ldaps","doc_url":"/apidoc/v2/auth_source_ldaps","formats":null},"domains":{"api_url":"/api","full_description":"Foreman considers a domain and a DNS zone as the same thing. That is, if you are planning to manage a site where all the machines are or the form hostname.somewhere.com then the domain is somewhere.com. This allows Foreman to associate a puppet variable with a domain/site and automatically append this variable to all external node requests made by machines at that site.
","version":"v2","methods":[{"full_description":"","params":[{"validator":"Must be String","required":false,"full_name":"search","expected_type":"string","allow_nil":false,"description":"Filter results
","name":"search"},{"validator":"Must be String","required":false,"full_name":"order","expected_type":"string","allow_nil":false,"description":"Sort results
","name":"order"},{"validator":"Must be String","required":false,"full_name":"page","expected_type":"string","allow_nil":false,"description":"paginate results
","name":"page"},{"validator":"Must be String","required":false,"full_name":"per_page","expected_type":"string","allow_nil":false,"description":"number of entries per request
","name":"per_page"}],"examples":["GET /api/domains\n200\n[\n {\n \"domain\": {\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"fullname\": null,\n \"dns_id\": 113629430,\n \"id\": 22495316,\n \"name\": \"mydomain.net\"\n }\n },\n {\n \"domain\": {\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"fullname\": \"somewhare that is never used\",\n \"dns_id\": 113629430,\n \"id\": 759776763,\n \"name\": \"unused.net\"\n }\n },\n {\n \"domain\": {\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"fullname\": null,\n \"dns_id\": null,\n \"id\": 229305443,\n \"name\": \"useless.net\"\n }\n },\n {\n \"domain\": {\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"fullname\": \"somewhere in yourdomain\",\n \"dns_id\": 113629430,\n \"id\": 589326610,\n \"name\": \"yourdomain.net\"\n }\n }\n]"],"apis":[{"api_url":"/api/domains","short_description":"List of domains","http_method":"GET"}],"errors":[],"see":[],"name":"index","formats":null,"doc_url":"/apidoc/v2/domains/index"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"May be numerical id or domain name
","name":"id"}],"examples":["GET /api/domains/mydomain.net\n200\n{\n \"domain\": {\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"fullname\": null,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"dns_id\": 113629430,\n \"id\": 22495316,\n \"name\": \"mydomain.net\"\n }\n}"],"apis":[{"api_url":"/api/domains/:id","short_description":"Show a domain.","http_method":"GET"}],"errors":[],"see":[],"name":"show","formats":null,"doc_url":"/apidoc/v2/domains/show"},{"full_description":"The fullname field is used for human readability in reports and other pages that refer to domains, and also available as an external node parameter
","params":[{"validator":"Must be a Hash","required":true,"full_name":"domain","params":[{"full_name":"domain[name]","required":true,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"The full DNS Domain name
","name":"name"},{"full_name":"domain[fullname]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":true,"description":"Full name describing the domain
","name":"fullname"},{"full_name":"domain[dns_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":true,"description":"DNS Proxy to use within this domain
","name":"dns_id"},{"full_name":"domain[domain_parameters_attributes]","required":false,"validator":"Must be Array","expected_type":"array","allow_nil":false,"description":"Array of parameters (name, value)
","name":"domain_parameters_attributes"}],"expected_type":"hash","allow_nil":false,"description":"","name":"domain"}],"examples":["POST /api/domains\n{\n \"domain\": {\n \"name\": \"domain.net\"\n }\n}\n201\n{\n \"domain\": {\n \"id\": 759776764,\n \"name\": \"domain.net\"\n }\n}"],"apis":[{"api_url":"/api/domains","short_description":"Create a domain.","http_method":"POST"}],"errors":[],"see":[],"name":"create","formats":null,"doc_url":"/apidoc/v2/domains/create"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"},{"validator":"Must be a Hash","required":true,"full_name":"domain","params":[{"full_name":"domain[name]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":true,"description":"The full DNS Domain name
","name":"name"},{"full_name":"domain[fullname]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":true,"description":"Full name describing the domain
","name":"fullname"},{"full_name":"domain[dns_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":true,"description":"DNS Proxy to use within this domain
","name":"dns_id"},{"full_name":"domain[domain_parameters_attributes]","required":false,"validator":"Must be Array","expected_type":"array","allow_nil":false,"description":"Array of parameters (name, value)
","name":"domain_parameters_attributes"}],"expected_type":"hash","allow_nil":false,"description":"","name":"domain"}],"examples":["PUT /api/domains/mydomain.net\n{\n \"domain\": {\n \"name\": \"\"\n }\n}\n422\n{\n \"domain\": {\n \"full_messages\": [\n \"Name can't be blank\"\n ],\n \"errors\": {\n \"name\": [\n \"can't be blank\"\n ]\n },\n \"id\": 22495316\n }\n}"],"apis":[{"api_url":"/api/domains/:id","short_description":"Update a domain.","http_method":"PUT"}],"errors":[],"see":[],"name":"update","formats":null,"doc_url":"/apidoc/v2/domains/update"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["DELETE /api/domains/mydomain.net\n200\n{\n \"domain\": {\n \"id\": 22495316,\n \"name\": \"mydomain.net\"\n }\n}"],"apis":[{"api_url":"/api/domains/:id","short_description":"Delete a domain.","http_method":"DELETE"}],"errors":[],"see":[],"name":"destroy","formats":null,"doc_url":"/apidoc/v2/domains/destroy"}],"short_description":null,"name":"Domains","doc_url":"/apidoc/v2/domains","formats":null},"images":{"api_url":"/api","full_description":null,"version":"v2","methods":[{"full_description":"","params":[{"validator":"Must be String","required":false,"full_name":"search","expected_type":"string","allow_nil":false,"description":"filter results
","name":"search"},{"validator":"Must be String","required":false,"full_name":"order","expected_type":"string","allow_nil":false,"description":"sort results
","name":"order"},{"validator":"Must be String","required":false,"full_name":"page","expected_type":"string","allow_nil":false,"description":"paginate results
","name":"page"},{"validator":"Must be String","required":false,"full_name":"per_page","expected_type":"string","allow_nil":false,"description":"number of entries per request
","name":"per_page"},{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"compute_resource_id","expected_type":"string","allow_nil":false,"description":"","name":"compute_resource_id"}],"examples":["GET /api/compute_resources/980190962/images\n200\n[\n {\n \"image\": {\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"username\": \"MyString\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"architecture_id\": 501905019,\n \"uuid\": \"MyString2\",\n \"compute_resource_id\": 980190962,\n \"id\": 298486374,\n \"name\": \"centos-2\",\n \"operatingsystem_id\": 309172073\n }\n },\n {\n \"image\": {\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"username\": \"root\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"architecture_id\": 501905019,\n \"uuid\": \"string-of-uuid\",\n \"compute_resource_id\": 980190962,\n \"id\": 980190962,\n \"name\": \"centos-1\",\n \"operatingsystem_id\": 309172073\n }\n }\n]"],"apis":[{"api_url":"/api/compute_resources/:compute_resource_id/images","short_description":"List all images for compute resource","http_method":"GET"}],"errors":[],"see":[],"name":"index","formats":null,"doc_url":"/apidoc/v2/images/index"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"},{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"compute_resource_id","expected_type":"string","allow_nil":false,"description":"","name":"compute_resource_id"}],"examples":["GET /api/compute_resources/980190962/images/980190962\n200\n{\n \"image\": {\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"username\": \"root\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"architecture_id\": 501905019,\n \"uuid\": \"string-of-uuid\",\n \"compute_resource_id\": 980190962,\n \"id\": 980190962,\n \"name\": \"centos-1\",\n \"operatingsystem_id\": 309172073\n }\n}"],"apis":[{"api_url":"/api/compute_resources/:compute_resource_id/images/:id","short_description":"Show an image","http_method":"GET"}],"errors":[],"see":[],"name":"show","formats":null,"doc_url":"/apidoc/v2/images/show"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"compute_resource_id","expected_type":"string","allow_nil":false,"description":"","name":"compute_resource_id"},{"validator":"Must be a Hash","required":true,"full_name":"image","params":[{"full_name":"image[name]","required":true,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"name"},{"full_name":"image[username]","required":true,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"username"},{"full_name":"image[uuid]","required":true,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"uuid"},{"full_name":"image[compute_resource_id]","required":true,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"compute_resource_id"},{"full_name":"image[architecture_id]","required":true,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"architecture_id"},{"full_name":"image[operatingsystem_id]","required":true,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"operatingsystem_id"}],"expected_type":"hash","allow_nil":false,"description":"","name":"image"}],"examples":["POST /api/compute_resources/980190962/images\n{\n \"image\": {\n \"username\": \"ec2-user\",\n \"architecture_id\": 381564594,\n \"uuid\": \"abcdef\",\n \"compute_resource_id\": 367690737,\n \"name\": \"TestImage\",\n \"operatingsystem_id\": 309172073\n }\n}\n201\n{\n \"compute_resource\": {\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"attrs\": null,\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"url\": \"qemu://stam/system\",\n \"uuid\": \"MyString\",\n \"user\": \"MyString\",\n \"description\": \"MyString\",\n \"id\": 980190962,\n \"name\": \"MyString\"\n }\n}"],"apis":[{"api_url":"/api/compute_resources/:compute_resource_id/images","short_description":"Create a image","http_method":"POST"}],"errors":[],"see":[],"name":"create","formats":null,"doc_url":"/apidoc/v2/images/create"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"compute_resource_id","expected_type":"string","allow_nil":false,"description":"","name":"compute_resource_id"},{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"},{"validator":"Must be a Hash","required":true,"full_name":"image","params":[{"full_name":"image[name]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"name"},{"full_name":"image[username]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"username"},{"full_name":"image[uuid]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"uuid"},{"full_name":"image[compute_resource_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"compute_resource_id"},{"full_name":"image[architecture_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"architecture_id"},{"full_name":"image[operatingsystem_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"operatingsystem_id"}],"expected_type":"hash","allow_nil":false,"description":"","name":"image"}],"examples":["PUT /api/compute_resources/980190962/images/980190962\n{\n \"image\": {}\n}\n200\n{\n \"image\": {\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"username\": \"root\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"architecture_id\": 501905019,\n \"uuid\": \"string-of-uuid\",\n \"compute_resource_id\": 980190962,\n \"id\": 980190962,\n \"name\": \"centos-1\",\n \"operatingsystem_id\": 309172073\n }\n}"],"apis":[{"api_url":"/api/compute_resources/:compute_resource_id/images/:id","short_description":"Update a image.","http_method":"PUT"}],"errors":[],"see":[],"name":"update","formats":null,"doc_url":"/apidoc/v2/images/update"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"compute_resource_id","expected_type":"string","allow_nil":false,"description":"","name":"compute_resource_id"},{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["DELETE /api/compute_resources/980190962/images/980190962\n200\n{\n \"image\": {\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"username\": \"root\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"architecture_id\": 501905019,\n \"uuid\": \"string-of-uuid\",\n \"compute_resource_id\": 980190962,\n \"id\": 980190962,\n \"name\": \"centos-1\",\n \"operatingsystem_id\": 309172073\n }\n}"],"apis":[{"api_url":"/api/compute_resources/:compute_resource_id/images/:id","short_description":"Delete an image.","http_method":"DELETE"}],"errors":[],"see":[],"name":"destroy","formats":null,"doc_url":"/apidoc/v2/images/destroy"}],"short_description":null,"name":"Images","doc_url":"/apidoc/v2/images","formats":null},"ptables":{"api_url":"/api","full_description":null,"version":"v2","methods":[{"full_description":"","params":[{"validator":"Must be String","required":false,"full_name":"search","expected_type":"string","allow_nil":false,"description":"filter results
","name":"search"},{"validator":"Must be String","required":false,"full_name":"order","expected_type":"string","allow_nil":false,"description":"sort results
","name":"order"},{"validator":"Must be String","required":false,"full_name":"page","expected_type":"string","allow_nil":false,"description":"paginate results
","name":"page"},{"validator":"Must be String","required":false,"full_name":"per_page","expected_type":"string","allow_nil":false,"description":"number of entries per request
","name":"per_page"}],"examples":["GET /api/ptables\n200\n[\n {\n \"ptable\": {\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"id\": 980190962,\n \"name\": \"default\"\n }\n },\n {\n \"ptable\": {\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"id\": 281110143,\n \"name\": \"four\"\n }\n },\n {\n \"ptable\": {\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"id\": 859751735,\n \"name\": \"suse default\"\n }\n },\n {\n \"ptable\": {\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"id\": 1011586618,\n \"name\": \"ubuntu default\"\n }\n }\n]"],"apis":[{"api_url":"/api/ptables","short_description":"List all ptables.","http_method":"GET"}],"errors":[],"see":[],"name":"index","formats":null,"doc_url":"/apidoc/v2/ptables/index"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["GET /api/ptables/980190962\n200\n{\n \"ptable\": {\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"id\": 980190962,\n \"name\": \"default\"\n }\n}"],"apis":[{"api_url":"/api/ptables/:id","short_description":"Show a ptable.","http_method":"GET"}],"errors":[],"see":[],"name":"show","formats":null,"doc_url":"/apidoc/v2/ptables/show"},{"full_description":"","params":[{"validator":"Must be a Hash","required":true,"full_name":"ptable","params":[{"full_name":"ptable[name]","required":true,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"name"},{"full_name":"ptable[layout]","required":true,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"layout"},{"full_name":"ptable[os_family]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"os_family"}],"expected_type":"hash","allow_nil":false,"description":"","name":"ptable"}],"examples":["POST /api/ptables\n{\n \"ptable\": {\n \"name\": \"ptable_test\",\n \"layout\": \"d-i partman-auto/disk\"\n }\n}\n201\n{\n \"ptable\": {\n \"id\": 1011586619,\n \"name\": \"ptable_test\"\n }\n}"],"apis":[{"api_url":"/api/ptables","short_description":"Create a ptable.","http_method":"POST"}],"errors":[],"see":[],"name":"create","formats":null,"doc_url":"/apidoc/v2/ptables/create"},{"full_description":"","params":[{"validator":"Must be String","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"},{"validator":"Must be a Hash","required":true,"full_name":"ptable","params":[{"full_name":"ptable[name]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"name"},{"full_name":"ptable[layout]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"layout"},{"full_name":"ptable[os_family]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"os_family"}],"expected_type":"hash","allow_nil":false,"description":"","name":"ptable"}],"examples":["PUT /api/ptables/980190962\n{\n \"ptable\": {}\n}\n200\n{\n \"ptable\": {\n \"id\": 980190962,\n \"name\": \"default\"\n }\n}"],"apis":[{"api_url":"/api/ptables/:id","short_description":"Update a ptable.","http_method":"PUT"}],"errors":[],"see":[],"name":"update","formats":null,"doc_url":"/apidoc/v2/ptables/update"},{"full_description":"","params":[{"validator":"Must be String","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["DELETE /api/ptables/980190962\n422\n{\n \"ptable\": {\n \"full_messages\": [\n \"default is used by temp01.yourdomain.net\",\n \"default is used by temp.yourdomain.net\",\n \"default is used by my5name.mydomain.net\",\n \"default is used by dhcp.mydomain.net\",\n \"default is used by sdhcp.mydomain.net\"\n ],\n \"errors\": {\n \"base\": [\n \"default is used by temp01.yourdomain.net\",\n \"default is used by temp.yourdomain.net\",\n \"default is used by my5name.mydomain.net\",\n \"default is used by dhcp.mydomain.net\",\n \"default is used by sdhcp.mydomain.net\"\n ]\n },\n \"id\": 980190962\n }\n}"],"apis":[{"api_url":"/api/ptables/:id","short_description":"Delete a ptable.","http_method":"DELETE"}],"errors":[],"see":[],"name":"destroy","formats":null,"doc_url":"/apidoc/v2/ptables/destroy"}],"short_description":null,"name":"Ptables","doc_url":"/apidoc/v2/ptables","formats":null},"organizations":{"api_url":"/api","full_description":null,"version":"v2","methods":[{"full_description":"","params":[{"validator":"Must be String","required":false,"full_name":"search","expected_type":"string","allow_nil":false,"description":"filter results
","name":"search"},{"validator":"Must be String","required":false,"full_name":"order","expected_type":"string","allow_nil":false,"description":"sort results
","name":"order"},{"validator":"Must be String","required":false,"full_name":"page","expected_type":"string","allow_nil":false,"description":"paginate results
","name":"page"},{"validator":"Must be String","required":false,"full_name":"per_page","expected_type":"string","allow_nil":false,"description":"number of entries per request
","name":"per_page"}],"examples":[],"apis":[{"api_url":"/api/organization_id","short_description":"List all organization_id","http_method":"GET"}],"errors":[],"see":[],"name":"index","formats":null,"doc_url":"/apidoc/v2/organizations/index"},{"full_description":"","params":[],"examples":[],"apis":[{"api_url":"/api/organization_id/:id","short_description":"Show an organization","http_method":"GET"}],"errors":[],"see":[],"name":"show","formats":null,"doc_url":"/apidoc/v2/organizations/show"},{"full_description":"","params":[{"validator":"Must be a Hash","required":true,"full_name":"organization","params":[{"full_name":"organization[name]","required":true,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"name"}],"expected_type":"hash","allow_nil":false,"description":"","name":"organization"}],"examples":[],"apis":[{"api_url":"/api/organization_id","short_description":"Create an organization","http_method":"POST"}],"errors":[],"see":[],"name":"create","formats":null,"doc_url":"/apidoc/v2/organizations/create"},{"full_description":"","params":[{"validator":"Must be a Hash","required":true,"full_name":"organization","params":[{"full_name":"organization[name]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"name"}],"expected_type":"hash","allow_nil":false,"description":"","name":"organization"}],"examples":[],"apis":[{"api_url":"/api/organization_id/:id","short_description":"Update an organization","http_method":"PUT"}],"errors":[],"see":[],"name":"update","formats":null,"doc_url":"/apidoc/v2/organizations/update"},{"full_description":"","params":[],"examples":[],"apis":[{"api_url":"/api/organization_id/:id","short_description":"Delete an organization","http_method":"DELETE"}],"errors":[],"see":[],"name":"destroy","formats":null,"doc_url":"/apidoc/v2/organizations/destroy"}],"short_description":null,"name":"Organizations","doc_url":"/apidoc/v2/organizations","formats":null},"lookup_keys":{"api_url":"/api","full_description":null,"version":"v2","methods":[{"full_description":"","params":[{"validator":"Must be String","required":false,"full_name":"search","expected_type":"string","allow_nil":false,"description":"filter results
","name":"search"},{"validator":"Must be String","required":false,"full_name":"order","expected_type":"string","allow_nil":false,"description":"sort results
","name":"order"},{"validator":"Must be String","required":false,"full_name":"page","expected_type":"string","allow_nil":false,"description":"paginate results
","name":"page"},{"validator":"Must be String","required":false,"full_name":"per_page","expected_type":"string","allow_nil":false,"description":"number of entries per request
","name":"per_page"}],"examples":["GET /api/lookup_keys\n200\n[\n {\n \"lookup_key\": {\n \"required\": false,\n \"override\": false,\n \"key\": \"port\",\n \"default_value\": \"80\",\n \"description\": null,\n \"id\": 980190962,\n \"is_param\": true\n }\n },\n {\n \"lookup_key\": {\n \"required\": false,\n \"override\": true,\n \"key\": \"ssl\",\n \"default_value\": \"t\",\n \"description\": null,\n \"id\": 113629430,\n \"is_param\": true\n }\n },\n {\n \"lookup_key\": {\n \"required\": false,\n \"override\": false,\n \"key\": \"ssl_port\",\n \"default_value\": \"443\",\n \"description\": null,\n \"id\": 298486374,\n \"is_param\": false\n }\n }\n]"],"apis":[{"api_url":"/api/smart_variables","short_description":"List all smart variables (smart parameters and smart class parameters).","http_method":"GET"}],"errors":[],"see":[],"name":"index","formats":null,"doc_url":"/apidoc/v2/lookup_keys/index"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["GET /api/lookup_keys/980190962-port\n200\n{\n \"lookup_key\": {\n \"required\": false,\n \"override\": false,\n \"key\": \"port\",\n \"default_value\": \"80\",\n \"description\": null,\n \"id\": 980190962,\n \"is_param\": true\n }\n}"],"apis":[{"api_url":"/api/smart_variables/:id","short_description":"Show a smart variable (smart parameter or smart class parameter).","http_method":"GET"}],"errors":[],"see":[],"name":"show","formats":null,"doc_url":"/apidoc/v2/lookup_keys/show"},{"full_description":"","params":[{"validator":"Must be a Hash","required":true,"full_name":"lookup_key","params":[{"full_name":"lookup_key[key]","required":true,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"key"},{"full_name":"lookup_key[puppetclass_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"puppetclass_id"},{"full_name":"lookup_key[default_value]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"default_value"},{"full_name":"lookup_key[path]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"path"},{"full_name":"lookup_key[description]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"description"},{"full_name":"lookup_key[validator_type]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"validator_type"},{"full_name":"lookup_key[validator_rule]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"validator_rule"},{"full_name":"lookup_key[is_param]","required":false,"validator":"Must be 'true' or 'false'","expected_type":"string","allow_nil":false,"description":"","name":"is_param"},{"full_name":"lookup_key[key_type]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"key_type"},{"full_name":"lookup_key[override]","required":false,"validator":"Must be 'true' or 'false'","expected_type":"string","allow_nil":false,"description":"","name":"override"},{"full_name":"lookup_key[required]","required":false,"validator":"Must be 'true' or 'false'","expected_type":"string","allow_nil":false,"description":"","name":"required"}],"expected_type":"hash","allow_nil":false,"description":"","name":"lookup_key"}],"examples":["POST /api/lookup_keys\n{\n \"lookup_key\": {\n \"key\": \"testkey\",\n \"is_param\": true\n }\n}\n201\n{\n \"lookup_key\": {\n \"required\": false,\n \"override\": false,\n \"key\": \"testkey\",\n \"default_value\": null,\n \"description\": null,\n \"id\": 980190963,\n \"is_param\": true\n }\n}"],"apis":[{"api_url":"/api/smart_variables","short_description":"Create a smart variable.","http_method":"POST"}],"errors":[],"see":[],"name":"create","formats":null,"doc_url":"/apidoc/v2/lookup_keys/create"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"},{"validator":"Must be a Hash","required":true,"full_name":"lookup_key","params":[{"full_name":"lookup_key[key]","required":true,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"key"},{"full_name":"lookup_key[puppetclass_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"puppetclass_id"},{"full_name":"lookup_key[default_value]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"default_value"},{"full_name":"lookup_key[path]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"path"},{"full_name":"lookup_key[description]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"description"},{"full_name":"lookup_key[validator_type]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"validator_type"},{"full_name":"lookup_key[validator_rule]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"validator_rule"},{"full_name":"lookup_key[is_param]","required":false,"validator":"Must be 'true' or 'false'","expected_type":"string","allow_nil":false,"description":"","name":"is_param"},{"full_name":"lookup_key[key_type]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"key_type"},{"full_name":"lookup_key[override]","required":false,"validator":"Must be 'true' or 'false'","expected_type":"string","allow_nil":false,"description":"","name":"override"},{"full_name":"lookup_key[required]","required":false,"validator":"Must be 'true' or 'false'","expected_type":"string","allow_nil":false,"description":"","name":"required"}],"expected_type":"hash","allow_nil":false,"description":"","name":"lookup_key"}],"examples":["PUT /api/lookup_keys/980190962-port\n{\n \"lookup_key\": {\n \"default_value\": 8080\n }\n}\n200\n{\n \"lookup_key\": {\n \"required\": false,\n \"override\": false,\n \"key\": \"port\",\n \"default_value\": 8080,\n \"description\": null,\n \"id\": 980190962,\n \"is_param\": true\n }\n}"],"apis":[{"api_url":"/api/smart_variables/:id","short_description":"Update a smart variable.","http_method":"PUT"}],"errors":[],"see":[],"name":"update","formats":null,"doc_url":"/apidoc/v2/lookup_keys/update"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["DELETE /api/lookup_keys/980190962-port\n200\n{\n \"lookup_key\": {\n \"required\": false,\n \"override\": false,\n \"key\": \"port\",\n \"default_value\": \"80\",\n \"description\": null,\n \"id\": 980190962,\n \"is_param\": true\n }\n}"],"apis":[{"api_url":"/api/smart_variables/:id","short_description":"Delete a smart variable.","http_method":"DELETE"}],"errors":[],"see":[],"name":"destroy","formats":null,"doc_url":"/apidoc/v2/lookup_keys/destroy"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":false,"full_name":"host_id","expected_type":"string","allow_nil":false,"description":"","name":"host_id"},{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":false,"full_name":"hostgroup_id","expected_type":"string","allow_nil":false,"description":"","name":"hostgroup_id"},{"validator":"Must be String","required":false,"full_name":"page","expected_type":"string","allow_nil":false,"description":"paginate results
","name":"page"},{"validator":"Must be String","required":false,"full_name":"per_page","expected_type":"string","allow_nil":false,"description":"number of entries per request
","name":"per_page"}],"examples":[],"apis":[{"api_url":"/api/hosts/:host_id/smart_parameters","short_description":"List of smart parameters for a specific host","http_method":"GET"},{"api_url":"/api/hostgroups/:hostgroup_id/smart_parameters","short_description":"List of smart parameters for a specific hostgroup","http_method":"GET"}],"errors":[],"see":[],"name":"host_or_hostgroup_smart_parameters","formats":null,"doc_url":"/apidoc/v2/lookup_keys/host_or_hostgroup_smart_parameters"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":false,"full_name":"host_id","expected_type":"string","allow_nil":false,"description":"","name":"host_id"},{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":false,"full_name":"hostgroup_id","expected_type":"string","allow_nil":false,"description":"","name":"hostgroup_id"},{"validator":"Must be String","required":false,"full_name":"page","expected_type":"string","allow_nil":false,"description":"paginate results
","name":"page"},{"validator":"Must be String","required":false,"full_name":"per_page","expected_type":"string","allow_nil":false,"description":"number of entries per request
","name":"per_page"}],"examples":[],"apis":[{"api_url":"/api/hosts/:host_id/smart_class_parameters","short_description":"List of smart class parameters for a specific host","http_method":"GET"},{"api_url":"/api/hostgroups/:hostgroup_id/smart_class_parameters","short_description":"List of smart class parameters for a specific hostgroup","http_method":"GET"}],"errors":[],"see":[],"name":"host_or_hostgroup_smart_class_parameters","formats":null,"doc_url":"/apidoc/v2/lookup_keys/host_or_hostgroup_smart_class_parameters"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"puppetclass_id","expected_type":"string","allow_nil":false,"description":"","name":"puppetclass_id"},{"validator":"Must be String","required":false,"full_name":"order","expected_type":"string","allow_nil":false,"description":"sort results
","name":"order"},{"validator":"Must be String","required":false,"full_name":"page","expected_type":"string","allow_nil":false,"description":"paginate results
","name":"page"},{"validator":"Must be String","required":false,"full_name":"per_page","expected_type":"string","allow_nil":false,"description":"number of entries per request
","name":"per_page"}],"examples":[],"apis":[{"api_url":"/api/puppetclasses/:puppetclass_id/smart_parameters","short_description":"List of smart parameters for a specific puppetclass","http_method":"GET"}],"errors":[],"see":[],"name":"puppet_smart_parameters","formats":null,"doc_url":"/apidoc/v2/lookup_keys/puppet_smart_parameters"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"puppetclass_id","expected_type":"string","allow_nil":false,"description":"","name":"puppetclass_id"},{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"environment_id","expected_type":"string","allow_nil":false,"description":"","name":"environment_id"},{"validator":"Must be String","required":false,"full_name":"order","expected_type":"string","allow_nil":false,"description":"sort results
","name":"order"},{"validator":"Must be String","required":false,"full_name":"page","expected_type":"string","allow_nil":false,"description":"paginate results
","name":"page"},{"validator":"Must be String","required":false,"full_name":"per_page","expected_type":"string","allow_nil":false,"description":"number of entries per request
","name":"per_page"}],"examples":[],"apis":[{"api_url":"/api/puppetclasses/:puppetclass_id/environments/:environment_id/smart_class_parameters","short_description":"List of smart class parameters for a specific puppetclass and environment","http_method":"GET"}],"errors":[],"see":[],"name":"puppet_smart_class_parameters","formats":null,"doc_url":"/apidoc/v2/lookup_keys/puppet_smart_class_parameters"}],"short_description":null,"name":"Lookup keys","doc_url":"/apidoc/v2/lookup_keys","formats":null},"media":{"api_url":"/api","full_description":null,"version":"v2","methods":[{"full_description":"","params":[{"validator":"Must be String","required":false,"full_name":"search","expected_type":"string","allow_nil":false,"description":"filter results
","name":"search"},{"validator":"Must be String","required":false,"full_name":"order","expected_type":"string","allow_nil":false,"description":"for example, name ASC, or name DESC
","name":"order"},{"validator":"Must be String","required":false,"full_name":"page","expected_type":"string","allow_nil":false,"description":"paginate results
","name":"page"},{"validator":"Must be String","required":false,"full_name":"per_page","expected_type":"string","allow_nil":false,"description":"number of entries per request
","name":"per_page"}],"examples":["GET /api/media\n200\n[\n {\n \"medium\": {\n \"path\": \"http://mirror.averse.net/centos/6.0/os/$arch\",\n \"id\": 980190962,\n \"name\": \"CentOS 5.4\"\n }\n },\n {\n \"medium\": {\n \"path\": \"http://mirror.isoc.org.il/pub/opensuse/distribution/$major.$minor/repo/oss\",\n \"id\": 859751735,\n \"name\": \"OpenSuse Mirror\"\n }\n },\n {\n \"medium\": {\n \"path\": \"http://brsla01/vol/solgi_5.10/sol$minor_$release_$arch\",\n \"id\": 442321401,\n \"name\": \"Solaris 10\"\n }\n },\n {\n \"medium\": {\n \"path\": \"http://sg.archive.ubuntu.com\",\n \"id\": 1011586618,\n \"name\": \"Ubuntu Mirror\"\n }\n },\n {\n \"medium\": {\n \"path\": \"http://nothing.intersting.com\",\n \"id\": 338446587,\n \"name\": \"unused\"\n }\n }\n]"],"apis":[{"api_url":"/api/media","short_description":"List all media.","http_method":"GET"}],"errors":[],"see":[],"name":"index","formats":null,"doc_url":"/apidoc/v2/media/index"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["GET /api/media/980190962\n200\n{\n \"medium\": {\n \"path\": \"http://mirror.averse.net/centos/6.0/os/$arch\",\n \"id\": 980190962,\n \"name\": \"CentOS 5.4\"\n }\n}"],"apis":[{"api_url":"/api/media/:id","short_description":"Show a medium.","http_method":"GET"}],"errors":[],"see":[],"name":"show","formats":null,"doc_url":"/apidoc/v2/media/show"},{"full_description":"","params":[{"validator":"Must be a Hash","required":true,"full_name":"medium","params":[{"full_name":"medium[name]","required":true,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"Name of media
","name":"name"},{"full_name":"medium[path]","required":true,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"The path to the medium, can be a URL or a valid NFS server (exclusive of the architecture).
\n\nfor example http://mirror.averse.net/centos/$version/os/$arch where $arch will be substituted for the host’s actual OS architecture and $version, $major and $minor will be substituted for the version of the operating system.
\n\nSolaris and Debian media may also use $release.
","name":"path"},{"full_name":"medium[os_family]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"The family that the operating system belongs to.
\n\nAvailable families:
\n\nName of media
","name":"name"},{"full_name":"medium[path]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"The path to the medium, can be a URL or a valid NFS server (exclusive of the architecture).
\n\nfor example http://mirror.averse.net/centos/$version/os/$arch where $arch will be substituted for the host’s actual OS architecture and $version, $major and $minor will be substituted for the version of the operating system.
\n\nSolaris and Debian media may also use $release.
","name":"path"},{"full_name":"medium[os_family]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":true,"description":"The family that the operating system belongs to.
\n\nAvailable families:
\n\nFilter results
","name":"search"},{"validator":"Must be String","required":false,"full_name":"order","expected_type":"string","allow_nil":false,"description":"Sort results
","name":"order"},{"validator":"Must be String","required":false,"full_name":"page","expected_type":"string","allow_nil":false,"description":"paginate results
","name":"page"},{"validator":"Must be String","required":false,"full_name":"per_page","expected_type":"string","allow_nil":false,"description":"number of entries per request
","name":"per_page"}],"examples":["GET /api/hosts\n200\n[\n {\n \"host\": {\n \"hostgroup_id\": null,\n \"id\": 55602819,\n \"name\": \"anotherfullhost\",\n \"operatingsystem_id\": 1073012828\n }\n },\n {\n \"host\": {\n \"hostgroup_id\": null,\n \"id\": 219245707,\n \"name\": \"dhcp.mydomain.net\",\n \"operatingsystem_id\": 1073012828\n }\n },\n {\n \"host\": {\n \"hostgroup_id\": null,\n \"id\": 980190962,\n \"name\": \"my5name.mydomain.net\",\n \"operatingsystem_id\": 1073012828\n }\n },\n {\n \"host\": {\n \"hostgroup_id\": null,\n \"id\": 1053842695,\n \"name\": \"myfullname.mydomain.net\",\n \"operatingsystem_id\": 309172073\n }\n },\n {\n \"host\": {\n \"hostgroup_id\": null,\n \"id\": 661942085,\n \"name\": \"otherfullhost\",\n \"operatingsystem_id\": 1073012828\n }\n },\n {\n \"host\": {\n \"hostgroup_id\": null,\n \"id\": 500757383,\n \"name\": \"sdhcp.mydomain.net\",\n \"operatingsystem_id\": 1073012828\n }\n },\n {\n \"host\": {\n \"hostgroup_id\": null,\n \"id\": 715054938,\n \"name\": \"sol10host\",\n \"operatingsystem_id\": 442321401\n }\n },\n {\n \"host\": {\n \"hostgroup_id\": null,\n \"id\": 859751735,\n \"name\": \"suse01.yourdomain.net\",\n \"operatingsystem_id\": 859751735\n }\n },\n {\n \"host\": {\n \"hostgroup_id\": null,\n \"id\": 1011586618,\n \"name\": \"temp-01.yourdomain.net\",\n \"operatingsystem_id\": 331303656\n }\n },\n {\n \"host\": {\n \"hostgroup_id\": null,\n \"id\": 1073012828,\n \"name\": \"temp01.yourdomain.net\",\n \"operatingsystem_id\": 1073012828\n }\n },\n {\n \"host\": {\n \"hostgroup_id\": null,\n \"id\": 3666571,\n \"name\": \"temp-02.useless.net\",\n \"operatingsystem_id\": 331303656\n }\n },\n {\n \"host\": {\n \"hostgroup_id\": null,\n \"id\": 298486374,\n \"name\": \"temp.yourdomain.net\",\n \"operatingsystem_id\": 309172073\n }\n }\n]"],"apis":[{"api_url":"/api/hosts","short_description":"List all hosts.","http_method":"GET"}],"errors":[],"see":[],"name":"index","formats":null,"doc_url":"/apidoc/v2/hosts/index"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["GET /api/hosts/my5name.mydomain.net\n200\n{\n \"host\": {\n \"ptable_id\": 980190962,\n \"sp_subnet_id\": null,\n \"domain_id\": 22495316,\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"sp_ip\": \"\",\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"sp_name\": \"\",\n \"image_file\": \"\",\n \"puppet_proxy_id\": 182953976,\n \"environment\": {\n \"environment\": {\n \"id\": 334344675,\n \"name\": \"production\"\n }\n },\n \"subnet_id\": 980190962,\n \"architecture_id\": 501905019,\n \"environment_id\": 334344675,\n \"use_image\": null,\n \"last_report\": null,\n \"uuid\": null,\n \"sp_mac\": \"\",\n \"image_id\": null,\n \"hostgroup_id\": null,\n \"build\": false,\n \"host_parameters\": [\n {\n \"host_parameter\": {\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"reference_id\": 980190962,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"value\": \"host1\",\n \"id\": 254219264,\n \"name\": \"host1\",\n \"priority\": 4\n }\n }\n ],\n \"model_id\": null,\n \"managed\": true,\n \"disk\": null,\n \"comment\": null,\n \"medium_id\": null,\n \"certname\": \"my5name.mydomain.net\",\n \"installed_at\": null,\n \"compute_resource_id\": 980190962,\n \"owner_type\": null,\n \"puppet_ca_proxy_id\": null,\n \"id\": 980190962,\n \"ip\": \"2.3.4.1\",\n \"enabled\": true,\n \"name\": \"my5name.mydomain.net\",\n \"owner_id\": null,\n \"operatingsystem_id\": 1073012828,\n \"mac\": \"aabbCCddeeee\"\n }\n}"],"apis":[{"api_url":"/api/hosts/:id","short_description":"Show a host.","http_method":"GET"}],"errors":[],"see":[],"name":"show","formats":null,"doc_url":"/apidoc/v2/hosts/show"},{"full_description":"","params":[{"validator":"Must be a Hash","required":true,"full_name":"host","params":[{"full_name":"host[name]","required":true,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"name"},{"full_name":"host[environment_id]","required":true,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"environment_id"},{"full_name":"host[ip]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"not required if using a subnet with dhcp proxy
","name":"ip"},{"full_name":"host[mac]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"not required if its a virtual machine
","name":"mac"},{"full_name":"host[architecture_id]","required":true,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"architecture_id"},{"full_name":"host[domain_id]","required":true,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"domain_id"},{"full_name":"host[puppet_proxy_id]","required":true,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"puppet_proxy_id"},{"full_name":"host[puppet_class_ids]","required":false,"validator":"Must be Array","expected_type":"array","allow_nil":false,"description":"","name":"puppet_class_ids"},{"full_name":"host[operatingsystem_id]","required":true,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"operatingsystem_id"},{"full_name":"host[medium_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"medium_id"},{"full_name":"host[ptable_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"ptable_id"},{"full_name":"host[subnet_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"subnet_id"},{"full_name":"host[compute_resource_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"compute_resource_id"},{"full_name":"host[sp_subnet_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"sp_subnet_id"},{"full_name":"host[model_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"model_id"},{"full_name":"host[hostgroup_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"hostgroup_id"},{"full_name":"host[owner_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"owner_id"},{"full_name":"host[puppet_ca_proxy_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"puppet_ca_proxy_id"},{"full_name":"host[image_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"image_id"},{"full_name":"host[host_parameters_attributes]","required":false,"validator":"Must be Array","expected_type":"array","allow_nil":false,"description":"","name":"host_parameters_attributes"},{"full_name":"host[build]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"build"},{"full_name":"host[enabled]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"enabled"},{"full_name":"host[provision_method]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"provision_method"},{"full_name":"host[managed]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"managed"},{"full_name":"host[capabilities]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"capabilities"},{"full_name":"host[compute_attributes]","required":false,"validator":"Must be a Hash","params":[{"validator":"Must be a number.","required":false,"full_name":"host[compute_attributes][flavour_ref]","expected_type":"string","allow_nil":false,"description":"","name":"flavour_ref"},{"validator":"Must be String","required":false,"full_name":"host[compute_attributes][image_ref]","expected_type":"string","allow_nil":false,"description":"","name":"image_ref"},{"validator":"Must be String","required":false,"full_name":"host[compute_attributes][tenant_id]","expected_type":"string","allow_nil":false,"description":"","name":"tenant_id"},{"validator":"Must be String","required":false,"full_name":"host[compute_attributes][security_groups]","expected_type":"string","allow_nil":false,"description":"","name":"security_groups"},{"validator":"Must be String","required":false,"full_name":"host[compute_attributes][network]","expected_type":"string","allow_nil":false,"description":"","name":"network"},{"validator":"Must be a number.","required":false,"full_name":"host[compute_attributes][cpus]","expected_type":"string","allow_nil":false,"description":"","name":"cpus"},{"validator":"Must be a number.","required":false,"full_name":"host[compute_attributes][memory]","expected_type":"string","allow_nil":false,"description":"","name":"memory"},{"validator":"Must be a number.","required":false,"full_name":"host[compute_attributes][start]","expected_type":"string","allow_nil":false,"description":"","name":"start"}],"expected_type":"hash","allow_nil":false,"description":"","name":"compute_attributes"},{"full_name":"host[interfaces_attributes]","required":false,"validator":"Must be a Hash","params":[{"validator":"Must be a Hash","required":false,"full_name":"host[interfaces_attributes][new_interfaces]","params":[{"full_name":"host[interfaces_attributes][new_interfaces][provider]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"provider"},{"full_name":"host[interfaces_attributes][new_interfaces][type]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"type"}],"expected_type":"hash","allow_nil":false,"description":"","name":"new_interfaces"}],"expected_type":"hash","allow_nil":false,"description":"","name":"interfaces_attributes"}],"expected_type":"hash","allow_nil":false,"description":"","name":"host"}],"examples":["POST /api/hosts\n{\n \"host\": {\n \"domain_id\": 22495316,\n \"puppet_proxy_id\": 7,\n \"architecture_id\": 501905019,\n \"environment_id\": 334344675,\n \"ip\": \"10.0.0.20\",\n \"name\": \"testhost11\",\n \"operatingsystem_id\": 1073012828,\n \"mac\": \"52:53:00:1e:85:93\"\n }\n}\n200\n{\n \"host\": {\n \"ptable_id\": null,\n \"sp_subnet_id\": null,\n \"domain_id\": 22495316,\n \"created_at\": \"2012-12-18T15:24:48Z\",\n \"sp_ip\": \"\",\n \"updated_at\": \"2012-12-18T15:24:48Z\",\n \"image_file\": \"\",\n \"sp_name\": \"\",\n \"puppet_proxy_id\": 7,\n \"environment\": {\n \"environment\": {\n \"id\": 334344675,\n \"name\": \"production\"\n }\n },\n \"subnet_id\": null,\n \"architecture_id\": 501905019,\n \"environment_id\": 334344675,\n \"use_image\": null,\n \"last_report\": null,\n \"uuid\": null,\n \"sp_mac\": \"\",\n \"image_id\": null,\n \"hostgroup_id\": null,\n \"build\": false,\n \"host_parameters\": [],\n \"model_id\": null,\n \"managed\": true,\n \"disk\": null,\n \"comment\": null,\n \"medium_id\": null,\n \"certname\": \"fcfce82c-33d1-4565-843a-4f58ff8e371a\",\n \"installed_at\": null,\n \"compute_resource_id\": null,\n \"owner_type\": \"User\",\n \"puppet_ca_proxy_id\": null,\n \"ip\": \"10.0.0.20\",\n \"id\": 1073012829,\n \"enabled\": true,\n \"name\": \"testhost11.mydomain.net\",\n \"owner_id\": 886836129,\n \"operatingsystem_id\": 1073012828,\n \"mac\": \"52:53:00:1e:85:93\"\n }\n}"],"apis":[{"api_url":"/api/hosts","short_description":"Create a host.","http_method":"POST"}],"errors":[],"see":[],"name":"create","formats":null,"doc_url":"/apidoc/v2/hosts/create"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"},{"validator":"Must be a Hash","required":true,"full_name":"host","params":[{"full_name":"host[name]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"name"},{"full_name":"host[environment_id]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"environment_id"},{"full_name":"host[ip]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"not required if using a subnet with dhcp proxy
","name":"ip"},{"full_name":"host[mac]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"not required if its a virtual machine
","name":"mac"},{"full_name":"host[architecture_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"architecture_id"},{"full_name":"host[domain_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"domain_id"},{"full_name":"host[puppet_proxy_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"puppet_proxy_id"},{"full_name":"host[operatingsystem_id]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"operatingsystem_id"},{"full_name":"host[puppet_class_ids]","required":false,"validator":"Must be Array","expected_type":"array","allow_nil":false,"description":"","name":"puppet_class_ids"},{"full_name":"host[medium_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"medium_id"},{"full_name":"host[ptable_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"ptable_id"},{"full_name":"host[subnet_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"subnet_id"},{"full_name":"host[compute_resource_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"compute_resource_id"},{"full_name":"host[sp_subnet_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"sp_subnet_id"},{"full_name":"host[model_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"model_id"},{"full_name":"host[hostgroup_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"hostgroup_id"},{"full_name":"host[owner_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"owner_id"},{"full_name":"host[puppet_ca_proxy_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"puppet_ca_proxy_id"},{"full_name":"host[image_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"image_id"},{"full_name":"host[host_parameters_attributes]","required":false,"validator":"Must be Array","expected_type":"array","allow_nil":false,"description":"","name":"host_parameters_attributes"},{"full_name":"host[build]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"build"},{"full_name":"host[enabled]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":false,"description":"","name":"enabled"},{"full_name":"host[provision_method]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"provision_method"},{"full_name":"host[managed]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"managed"},{"full_name":"host[capabilities]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"capabilities"},{"full_name":"host[compute_attributes]","required":false,"validator":"Must be a Hash","params":[{"validator":"Must be a number.","required":false,"full_name":"host[compute_attributes][flavour_ref]","expected_type":"string","allow_nil":false,"description":"","name":"flavour_ref"},{"validator":"Must be String","required":false,"full_name":"host[compute_attributes][image_ref]","expected_type":"string","allow_nil":false,"description":"","name":"image_ref"},{"validator":"Must be String","required":false,"full_name":"host[compute_attributes][tenant_id]","expected_type":"string","allow_nil":false,"description":"","name":"tenant_id"},{"validator":"Must be String","required":false,"full_name":"host[compute_attributes][security_groups]","expected_type":"string","allow_nil":false,"description":"","name":"security_groups"},{"validator":"Must be String","required":false,"full_name":"host[compute_attributes][network]","expected_type":"string","allow_nil":false,"description":"","name":"network"},{"validator":"Must be a number.","required":false,"full_name":"host[compute_attributes][cpus]","expected_type":"string","allow_nil":false,"description":"","name":"cpus"},{"validator":"Must be a number.","required":false,"full_name":"host[compute_attributes][memory]","expected_type":"string","allow_nil":false,"description":"","name":"memory"},{"validator":"Must be a number.","required":false,"full_name":"host[compute_attributes][start]","expected_type":"string","allow_nil":false,"description":"","name":"start"}],"expected_type":"hash","allow_nil":false,"description":"","name":"compute_attributes"}],"expected_type":"hash","allow_nil":false,"description":"","name":"host"}],"examples":["PUT /api/hosts/temp.yourdomain.net\n{\n \"host\": {}\n}\n200\n{\n \"host\": {\n \"ptable_id\": 980190962,\n \"domain_id\": 589326610,\n \"sp_subnet_id\": null,\n \"last_compile\": null,\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"sp_ip\": \"\",\n \"puppet_status\": 0,\n \"location_id\": null,\n \"root_pass\": \"xybxa6JUkz63w\",\n \"updated_at\": \"2012-12-18T15:24:48Z\",\n \"image_file\": \"\",\n \"sp_name\": \"\",\n \"last_freshcheck\": null,\n \"puppet_proxy_id\": 182953976,\n \"environment\": {\n \"environment\": {\n \"id\": 334344675,\n \"name\": \"production\"\n }\n },\n \"subnet_id\": 980190962,\n \"architecture_id\": 501905019,\n \"environment_id\": 334344675,\n \"use_image\": null,\n \"last_report\": null,\n \"organization_id\": null,\n \"uuid\": null,\n \"sp_mac\": \"\",\n \"image_id\": null,\n \"hostgroup_id\": null,\n \"build\": false,\n \"serial\": null,\n \"model_id\": null,\n \"managed\": null,\n \"disk\": null,\n \"comment\": null,\n \"certname\": \"temp.yourdomain.net\",\n \"medium_id\": 980190962,\n \"installed_at\": null,\n \"compute_resource_id\": 980190962,\n \"owner_type\": \"User\",\n \"id\": 298486374,\n \"ip\": \"2.3.4.5\",\n \"puppet_ca_proxy_id\": null,\n \"enabled\": true,\n \"name\": \"temp.yourdomain.net\",\n \"source_file_id\": null,\n \"operatingsystem_id\": 309172073,\n \"owner_id\": 886836129,\n \"mac\": \"aa:bb:cc:dd:ee:ff\"\n }\n}"],"apis":[{"api_url":"/api/hosts/:id","short_description":"Update a host.","http_method":"PUT"}],"errors":[],"see":[],"name":"update","formats":null,"doc_url":"/apidoc/v2/hosts/update"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["DELETE /api/hosts/my5name.mydomain.net\n200\n{\n \"host\": {\n \"ptable_id\": 980190962,\n \"domain_id\": 22495316,\n \"sp_subnet_id\": null,\n \"last_compile\": null,\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"sp_ip\": \"\",\n \"puppet_status\": 0,\n \"location_id\": null,\n \"root_pass\": \"xybxa6JUkz63w\",\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"image_file\": \"\",\n \"sp_name\": \"\",\n \"last_freshcheck\": null,\n \"puppet_proxy_id\": 182953976,\n \"environment\": {\n \"environment\": {\n \"id\": 334344675,\n \"name\": \"production\"\n }\n },\n \"subnet_id\": 980190962,\n \"architecture_id\": 501905019,\n \"environment_id\": 334344675,\n \"use_image\": null,\n \"last_report\": null,\n \"organization_id\": null,\n \"uuid\": null,\n \"sp_mac\": \"\",\n \"image_id\": null,\n \"hostgroup_id\": null,\n \"build\": false,\n \"serial\": null,\n \"model_id\": null,\n \"managed\": true,\n \"disk\": null,\n \"comment\": null,\n \"certname\": \"my5name.mydomain.net\",\n \"medium_id\": null,\n \"installed_at\": null,\n \"compute_resource_id\": 980190962,\n \"owner_type\": null,\n \"id\": 980190962,\n \"ip\": \"2.3.4.1\",\n \"puppet_ca_proxy_id\": null,\n \"enabled\": true,\n \"name\": \"my5name.mydomain.net\",\n \"source_file_id\": null,\n \"operatingsystem_id\": 1073012828,\n \"owner_id\": null,\n \"mac\": \"aabbCCddeeee\"\n }\n}"],"apis":[{"api_url":"/api/hosts/:id","short_description":"Delete an host.","http_method":"DELETE"}],"errors":[],"see":[],"name":"destroy","formats":null,"doc_url":"/apidoc/v2/hosts/destroy"},{"full_description":"Return value may either be one of the following:
\n\npaginate results
","name":"page"},{"validator":"Must be String","required":false,"full_name":"per_page","expected_type":"string","allow_nil":false,"description":"number of entries per request
","name":"per_page"}],"examples":["GET /api/bookmarks\n200\n[\n {\n \"bookmark\": {\n \"controller\": \"hosts\",\n \"query\": \"bar=car\",\n \"public\": false,\n \"owner_type\": null,\n \"id\": 298486374,\n \"name\": \"bar\",\n \"owner_id\": null\n }\n },\n {\n \"bookmark\": {\n \"controller\": \"hosts\",\n \"query\": \"foo=boo\",\n \"public\": true,\n \"owner_type\": null,\n \"id\": 980190962,\n \"name\": \"foo\",\n \"owner_id\": null\n }\n }\n]"],"apis":[{"api_url":"/api/bookmarks","short_description":"List all bookmarks.","http_method":"GET"}],"errors":[],"see":[],"name":"index","formats":null,"doc_url":"/apidoc/v2/bookmarks/index"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["GET /api/bookmarks/foo\n200\n{\n \"bookmark\": {\n \"controller\": \"hosts\",\n \"query\": \"foo=boo\",\n \"public\": true,\n \"owner_type\": null,\n \"id\": 980190962,\n \"name\": \"foo\",\n \"owner_id\": null\n }\n}"],"apis":[{"api_url":"/api/bookmarks/:id","short_description":"Show a bookmark.","http_method":"GET"}],"errors":[],"see":[],"name":"show","formats":null,"doc_url":"/apidoc/v2/bookmarks/show"},{"full_description":"","params":[{"validator":"Must be a Hash","required":true,"full_name":"bookmark","params":[{"full_name":"bookmark[name]","required":true,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"name"},{"full_name":"bookmark[controller]","required":true,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"controller"},{"full_name":"bookmark[query]","required":true,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"query"},{"full_name":"bookmark[public]","required":false,"validator":"Must be 'true' or 'false'","expected_type":"string","allow_nil":false,"description":"","name":"public"}],"expected_type":"hash","allow_nil":false,"description":"","name":"bookmark"}],"examples":["POST /api/bookmarks\n{\n \"bookmark\": {\n \"controller\": \"hosts\",\n \"query\": \"bar\",\n \"public\": false,\n \"name\": \"foo-bar\"\n }\n}\n200\n{\n \"bookmark\": {\n \"controller\": \"hosts\",\n \"query\": \"bar\",\n \"public\": false,\n \"owner_type\": \"User\",\n \"id\": 980190963,\n \"name\": \"foo-bar\",\n \"owner_id\": 886836129\n }\n}"],"apis":[{"api_url":"/api/bookmarks","short_description":"Create a bookmark.","http_method":"POST"}],"errors":[],"see":[],"name":"create","formats":null,"doc_url":"/apidoc/v2/bookmarks/create"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"},{"validator":"Must be a Hash","required":true,"full_name":"bookmark","params":[{"full_name":"bookmark[name]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"name"},{"full_name":"bookmark[controller]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"controller"},{"full_name":"bookmark[query]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"query"},{"full_name":"bookmark[public]","required":false,"validator":"Must be 'true' or 'false'","expected_type":"string","allow_nil":false,"description":"","name":"public"}],"expected_type":"hash","allow_nil":false,"description":"","name":"bookmark"}],"examples":["PUT /api/bookmarks/foo\n{\n \"bookmark\": {}\n}\n200\n{\n \"bookmark\": {\n \"controller\": \"hosts\",\n \"query\": \"foo=boo\",\n \"public\": true,\n \"user\": {\n \"login\": \"apiadmin\",\n \"email\": \"apiadmin@someware.com\",\n \"name\": \"apiadmin User\"\n },\n \"id\": 980190962,\n \"name\": \"foo\"\n }\n}"],"apis":[{"api_url":"/api/bookmarks/:id","short_description":"Update a bookmark.","http_method":"PUT"}],"errors":[],"see":[],"name":"update","formats":null,"doc_url":"/apidoc/v2/bookmarks/update"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["DELETE /api/bookmarks/foo\n200\n{\n \"bookmark\": {\n \"controller\": \"hosts\",\n \"query\": \"foo=boo\",\n \"public\": true,\n \"owner_type\": null,\n \"id\": 980190962,\n \"name\": \"foo\",\n \"owner_id\": null\n }\n}"],"apis":[{"api_url":"/api/bookmarks/:id","short_description":"Delete a bookmark.","http_method":"DELETE"}],"errors":[],"see":[],"name":"destroy","formats":null,"doc_url":"/apidoc/v2/bookmarks/destroy"}],"short_description":null,"name":"Bookmarks","doc_url":"/apidoc/v2/bookmarks","formats":null},"usergroups":{"api_url":"/api","full_description":null,"version":"v2","methods":[{"full_description":"","params":[{"validator":"Must be String","required":false,"full_name":"page","expected_type":"string","allow_nil":false,"description":"paginate results
","name":"page"},{"validator":"Must be String","required":false,"full_name":"per_page","expected_type":"string","allow_nil":false,"description":"number of entries per request
","name":"per_page"},{"validator":"Must be String","required":false,"full_name":"search","expected_type":"string","allow_nil":false,"description":"filter results
","name":"search"},{"validator":"Must be String","required":false,"full_name":"order","expected_type":"string","allow_nil":false,"description":"sort results
","name":"order"}],"examples":["GET /api/usergroups\n200\n[\n {\n \"usergroup\": {\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"id\": 980190962,\n \"name\": \"MyString\"\n }\n },\n {\n \"usergroup\": {\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"id\": 298486374,\n \"name\": \"MyString2\"\n }\n }\n]"],"apis":[{"api_url":"/api/usergroups","short_description":"List all usergroups.","http_method":"GET"}],"errors":[],"see":[],"name":"index","formats":null,"doc_url":"/apidoc/v2/usergroups/index"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["GET /api/usergroups/980190962\n200\n{\n \"usergroup\": {\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"id\": 980190962,\n \"name\": \"MyString\"\n }\n}"],"apis":[{"api_url":"/api/usergroups/:id","short_description":"Show a usergroup.","http_method":"GET"}],"errors":[],"see":[],"name":"show","formats":null,"doc_url":"/apidoc/v2/usergroups/show"},{"full_description":"","params":[{"validator":"Must be a Hash","required":true,"full_name":"usergroup","params":[{"full_name":"usergroup[name]","required":true,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"name"}],"expected_type":"hash","allow_nil":false,"description":"","name":"usergroup"}],"examples":["POST /api/usergroups\n{\n \"usergroup\": {\n \"name\": \"test_usergroup\"\n }\n}\n201\n{\n \"usergroup\": {\n \"id\": 980190963,\n \"name\": \"test_usergroup\"\n }\n}"],"apis":[{"api_url":"/api/usergroups","short_description":"Create a usergroup.","http_method":"POST"}],"errors":[],"see":[],"name":"create","formats":null,"doc_url":"/apidoc/v2/usergroups/create"},{"full_description":"","params":[{"validator":"Must be String","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"},{"validator":"Must be a Hash","required":true,"full_name":"usergroup","params":[{"full_name":"usergroup[name]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"name"}],"expected_type":"hash","allow_nil":false,"description":"","name":"usergroup"}],"examples":["PUT /api/usergroups/980190962\n{\n \"usergroup\": {}\n}\n200\n{\n \"usergroup\": {\n \"id\": 980190962,\n \"name\": \"MyString\"\n }\n}"],"apis":[{"api_url":"/api/usergroups/:id","short_description":"Update a usergroup.","http_method":"PUT"}],"errors":[],"see":[],"name":"update","formats":null,"doc_url":"/apidoc/v2/usergroups/update"},{"full_description":"","params":[{"validator":"Must be String","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["DELETE /api/usergroups/980190962\n200\n{\n \"usergroup\": {\n \"id\": 980190962,\n \"name\": \"MyString\"\n }\n}"],"apis":[{"api_url":"/api/usergroups/:id","short_description":"Delete a usergroup.","http_method":"DELETE"}],"errors":[],"see":[],"name":"destroy","formats":null,"doc_url":"/apidoc/v2/usergroups/destroy"}],"short_description":null,"name":"Usergroups","doc_url":"/apidoc/v2/usergroups","formats":null},"compute_resources":{"api_url":"/api","full_description":null,"version":"v2","methods":[{"full_description":"","params":[{"validator":"Must be String","required":false,"full_name":"search","expected_type":"string","allow_nil":false,"description":"filter results
","name":"search"},{"validator":"Must be String","required":false,"full_name":"order","expected_type":"string","allow_nil":false,"description":"sort results
","name":"order"},{"validator":"Must be String","required":false,"full_name":"page","expected_type":"string","allow_nil":false,"description":"paginate results
","name":"page"},{"validator":"Must be String","required":false,"full_name":"per_page","expected_type":"string","allow_nil":false,"description":"number of entries per request
","name":"per_page"}],"examples":["GET /api/compute_resources\n200\n[\n {\n \"compute_resource\": {\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"url\": \"test:///default\",\n \"provider\": \"Libvirt\",\n \"user\": \"MyString\",\n \"description\": \"mycompute\",\n \"id\": 367690737,\n \"name\": \"mycompute\"\n }\n },\n {\n \"compute_resource\": {\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"url\": \"qemu://stam/system\",\n \"provider\": \"Libvirt\",\n \"user\": \"MyString\",\n \"description\": \"MyString\",\n \"id\": 980190962,\n \"name\": \"MyString\"\n }\n },\n {\n \"compute_resource\": {\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"url\": \"test:///default\",\n \"provider\": \"Libvirt\",\n \"user\": \"MyString\",\n \"description\": \"yourcompute\",\n \"id\": 932571420,\n \"name\": \"yourcompute\"\n }\n }\n]"],"apis":[{"api_url":"/api/compute_resources","short_description":"List all compute resources.","http_method":"GET"}],"errors":[],"see":[],"name":"index","formats":null,"doc_url":"/apidoc/v2/compute_resources/index"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["GET /api/compute_resources/980190962-mystring\n200\n{\n \"compute_resource\": {\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"url\": \"qemu://stam/system\",\n \"provider\": \"Libvirt\",\n \"user\": \"MyString\",\n \"description\": \"MyString\",\n \"id\": 980190962,\n \"name\": \"MyString\"\n }\n}"],"apis":[{"api_url":"/api/compute_resources/:id","short_description":"Show an compute resource.","http_method":"GET"}],"errors":[],"see":[],"name":"show","formats":null,"doc_url":"/apidoc/v2/compute_resources/show"},{"full_description":"","params":[{"validator":"Must be a Hash","required":true,"full_name":"compute_resource","params":[{"full_name":"compute_resource[name]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"name"},{"full_name":"compute_resource[provider]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"Providers include Libvirt, Ovirt, EC2, Vmware, Openstack, Rackspace
","name":"provider"},{"full_name":"compute_resource[url]","required":true,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"URL for Libvirt, Ovirt, and Openstack
","name":"url"},{"full_name":"compute_resource[description]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"description"},{"full_name":"compute_resource[user]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"Username for Ovirt, EC2, Vmware, Openstack. Access Key for EC2.
","name":"user"},{"full_name":"compute_resource[password]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"Password for Ovirt, EC2, Vmware, Openstack. Secret key for EC2
","name":"password"},{"full_name":"compute_resource[uuid]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"for Ovirt, Vmware Datacenter
","name":"uuid"},{"full_name":"compute_resource[region]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"for EC2 only
","name":"region"},{"full_name":"compute_resource[tenant]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"for Openstack only
","name":"tenant"},{"full_name":"compute_resource[server]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"for Vmware
","name":"server"}],"expected_type":"hash","allow_nil":false,"description":"","name":"compute_resource"}],"examples":["POST /api/compute_resources\n{\n \"compute_resource\": {\n \"password\": \"secret\",\n \"provider\": \"EC2\",\n \"user\": \"user@example.com\",\n \"region\": \"eu-west-1\",\n \"name\": \"special_compute\"\n }\n}\n200\n{\n \"compute_resource\": {\n \"created_at\": \"2012-12-18T15:24:44Z\",\n \"updated_at\": \"2012-12-18T15:24:44Z\",\n \"url\": \"eu-west-1\",\n \"provider\": \"EC2\",\n \"user\": \"user@example.com\",\n \"description\": null,\n \"id\": 980190963,\n \"name\": \"special_compute\"\n }\n}"],"apis":[{"api_url":"/api/compute_resources","short_description":"Create a compute resource.","http_method":"POST"}],"errors":[],"see":[],"name":"create","formats":null,"doc_url":"/apidoc/v2/compute_resources/create"},{"full_description":"","params":[{"validator":"Must be String","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"},{"validator":"Must be a Hash","required":true,"full_name":"compute_resource","params":[{"full_name":"compute_resource[name]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"name"},{"full_name":"compute_resource[provider]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"Providers include Libvirt, Ovirt, EC2, Vmware, Openstack, Rackspace
","name":"provider"},{"full_name":"compute_resource[url]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"URL for Libvirt, Ovirt, and Openstack
","name":"url"},{"full_name":"compute_resource[description]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"description"},{"full_name":"compute_resource[user]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"Username for Ovirt, EC2, Vmware, Openstack. Access Key for EC2.
","name":"user"},{"full_name":"compute_resource[password]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"Password for Ovirt, EC2, Vmware, Openstack. Secret key for EC2
","name":"password"},{"full_name":"compute_resource[uuid]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"for Ovirt, Vmware Datacenter
","name":"uuid"},{"full_name":"compute_resource[region]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"for EC2 only
","name":"region"},{"full_name":"compute_resource[tenant]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"for Openstack only
","name":"tenant"},{"full_name":"compute_resource[server]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"for Vmware
","name":"server"}],"expected_type":"hash","allow_nil":false,"description":"","name":"compute_resource"}],"examples":["PUT /api/compute_resources/367690737-mycompute\n{\n \"compute_resource\": {\n \"description\": \"new_description\"\n }\n}\n200\n{\n \"compute_resource\": {\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"attrs\": {},\n \"updated_at\": \"2012-12-18T15:24:45Z\",\n \"url\": \"test:///default\",\n \"uuid\": \"mycompute\",\n \"user\": \"MyString\",\n \"description\": \"new_description\",\n \"id\": 367690737,\n \"name\": \"mycompute\"\n }\n}"],"apis":[{"api_url":"/api/compute_resources/:id","short_description":"Update a compute resource.","http_method":"PUT"}],"errors":[],"see":[],"name":"update","formats":null,"doc_url":"/apidoc/v2/compute_resources/update"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["DELETE /api/compute_resources/932571420\n200\n{\n \"compute_resource\": {\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"attrs\": null,\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"url\": \"test:///default\",\n \"uuid\": \"yourcompute\",\n \"user\": \"MyString\",\n \"description\": \"yourcompute\",\n \"id\": 932571420,\n \"name\": \"yourcompute\"\n }\n}"],"apis":[{"api_url":"/api/compute_resources/:id","short_description":"Delete a compute resource.","http_method":"DELETE"}],"errors":[],"see":[],"name":"destroy","formats":null,"doc_url":"/apidoc/v2/compute_resources/destroy"}],"short_description":null,"name":"Compute resources","doc_url":"/apidoc/v2/compute_resources","formats":null},"template_combinations":{"api_url":"/api","full_description":null,"version":"v2","methods":[{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"config_template_id","expected_type":"string","allow_nil":false,"description":"","name":"config_template_id"}],"examples":[],"apis":[{"api_url":"/api/config_templates/:config_template_id/template_combinations","short_description":"List Template Combination","http_method":"GET"}],"errors":[],"see":[],"name":"index","formats":null,"doc_url":"/apidoc/v2/template_combinations/index"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"config_template_id","expected_type":"string","allow_nil":false,"description":"","name":"config_template_id"},{"validator":"Must be a Hash","required":true,"full_name":"template_combination","params":[{"full_name":"template_combination[environment_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":true,"description":"environment id
","name":"environment_id"},{"full_name":"template_combination[hostgroup_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":true,"description":"hostgroup id
","name":"hostgroup_id"}],"expected_type":"hash","allow_nil":false,"description":"","name":"template_combination"}],"examples":[],"apis":[{"api_url":"/api/config_templates/:config_template_id/template_combinations","short_description":"Add a Template Combination","http_method":"POST"}],"errors":[],"see":[],"name":"create","formats":null,"doc_url":"/apidoc/v2/template_combinations/create"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":[],"apis":[{"api_url":"/api/template_combinations/:id","short_description":"Show Template Combination","http_method":"GET"}],"errors":[],"see":[],"name":"show","formats":null,"doc_url":"/apidoc/v2/template_combinations/show"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":[],"apis":[{"api_url":"/api/template_combinations/:id","short_description":"Delete a template","http_method":"DELETE"}],"errors":[],"see":[],"name":"destroy","formats":null,"doc_url":"/apidoc/v2/template_combinations/destroy"}],"short_description":null,"name":"Template combinations","doc_url":"/apidoc/v2/template_combinations","formats":null},"parameters":{"api_url":"/api","full_description":"These API calls are related to nested parameters for host, domain, hostgroup, operating system. If you are looking for global parameters, go to this link.
","version":"v2","methods":[{"full_description":"","params":[{"validator":"Must be String","required":false,"full_name":"host_id","expected_type":"string","allow_nil":false,"description":"id of host
","name":"host_id"},{"validator":"Must be String","required":false,"full_name":"hostgroup_id","expected_type":"string","allow_nil":false,"description":"id of hostgroup
","name":"hostgroup_id"},{"validator":"Must be String","required":false,"full_name":"domain_id","expected_type":"string","allow_nil":false,"description":"id of domain
","name":"domain_id"},{"validator":"Must be String","required":false,"full_name":"operatingsystem_id","expected_type":"string","allow_nil":false,"description":"id of operating system
","name":"operatingsystem_id"},{"validator":"Must be String","required":false,"full_name":"page","expected_type":"string","allow_nil":false,"description":"paginate results
","name":"page"},{"validator":"Must be String","required":false,"full_name":"per_page","expected_type":"string","allow_nil":false,"description":"number of entries per request
","name":"per_page"}],"examples":[],"apis":[{"api_url":"/api/hosts/:host_id/parameters","short_description":"List all parameters for host","http_method":"GET"},{"api_url":"/api/hostgroups/:hostgroup_id/parameters","short_description":"List all parameters for hostgroup","http_method":"GET"},{"api_url":"/api/domains/:domain_id/parameters","short_description":"List all parameters for domain","http_method":"GET"},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters","short_description":"List all parameters for operating system","http_method":"GET"}],"errors":[],"see":[],"name":"index","formats":null,"doc_url":"/apidoc/v2/parameters/index"},{"full_description":"","params":[{"validator":"Must be String","required":false,"full_name":"host_id","expected_type":"string","allow_nil":false,"description":"id of host
","name":"host_id"},{"validator":"Must be String","required":false,"full_name":"hostgroup_id","expected_type":"string","allow_nil":false,"description":"id of hostgroup
","name":"hostgroup_id"},{"validator":"Must be String","required":false,"full_name":"domain_id","expected_type":"string","allow_nil":false,"description":"id of domain
","name":"domain_id"},{"validator":"Must be String","required":false,"full_name":"operatingsystem_id","expected_type":"string","allow_nil":false,"description":"id of operating system
","name":"operatingsystem_id"},{"validator":"Must be String","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"id of parameter
","name":"id"}],"examples":[],"apis":[{"api_url":"/api/hosts/:host_id/parameters/:id","short_description":"Show a nested parameter for host","http_method":"GET"},{"api_url":"/api/hostgroups/:hostgroup_id/parameters/:id","short_description":"Show a nested parameter for hostgroup","http_method":"GET"},{"api_url":"/api/domains/:domain_id/parameters/:id","short_description":"Show a nested parameter for domain","http_method":"GET"},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters/:id","short_description":"Show a nested parameter for operating system","http_method":"GET"}],"errors":[],"see":[],"name":"show","formats":null,"doc_url":"/apidoc/v2/parameters/show"},{"full_description":"","params":[{"validator":"Must be String","required":false,"full_name":"host_id","expected_type":"string","allow_nil":false,"description":"id of host
","name":"host_id"},{"validator":"Must be String","required":false,"full_name":"hostgroup_id","expected_type":"string","allow_nil":false,"description":"id of hostgroup
","name":"hostgroup_id"},{"validator":"Must be String","required":false,"full_name":"domain_id","expected_type":"string","allow_nil":false,"description":"id of domain
","name":"domain_id"},{"validator":"Must be String","required":false,"full_name":"operatingsystem_id","expected_type":"string","allow_nil":false,"description":"id of operating system
","name":"operatingsystem_id"},{"validator":"Must be a Hash","required":true,"full_name":"parameter","params":[{"full_name":"parameter[name]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"name"},{"full_name":"parameter[value]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"value"}],"expected_type":"hash","allow_nil":false,"description":"","name":"parameter"}],"examples":[],"apis":[{"api_url":"/api/hosts/:host_id/parameters","short_description":"Create a nested parameter for host","http_method":"POST"},{"api_url":"/api/hostgroups/:hostgroup_id/parameters","short_description":"Create a nested parameter for hostgroup","http_method":"POST"},{"api_url":"/api/domains/:domain_id/parameters","short_description":"Create a nested parameter for domain","http_method":"POST"},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters","short_description":"Create a nested parameter for operating system","http_method":"POST"}],"errors":[],"see":[],"name":"create","formats":null,"doc_url":"/apidoc/v2/parameters/create"},{"full_description":"","params":[{"validator":"Must be String","required":false,"full_name":"host_id","expected_type":"string","allow_nil":false,"description":"id of host
","name":"host_id"},{"validator":"Must be String","required":false,"full_name":"hostgroup_id","expected_type":"string","allow_nil":false,"description":"id of hostgroup
","name":"hostgroup_id"},{"validator":"Must be String","required":false,"full_name":"domain_id","expected_type":"string","allow_nil":false,"description":"id of domain
","name":"domain_id"},{"validator":"Must be String","required":false,"full_name":"operatingsystem_id","expected_type":"string","allow_nil":false,"description":"id of operating system
","name":"operatingsystem_id"},{"validator":"Must be String","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"id of parameter
","name":"id"},{"validator":"Must be a Hash","required":true,"full_name":"parameter","params":[{"full_name":"parameter[name]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"name"},{"full_name":"parameter[value]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"value"}],"expected_type":"hash","allow_nil":false,"description":"","name":"parameter"}],"examples":[],"apis":[{"api_url":"/api/hosts/:host_id/parameters/:id","short_description":"Update a nested parameter for host","http_method":"PUT"},{"api_url":"/api/hostgroups/:hostgroup_id/parameters/:id","short_description":"Update a nested parameter for hostgroup","http_method":"PUT"},{"api_url":"/api/domains/:domain_id/parameters/:id","short_description":"Update a nested parameter for domain","http_method":"PUT"},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters/:id","short_description":"Update a nested parameter for operating system","http_method":"PUT"}],"errors":[],"see":[],"name":"update","formats":null,"doc_url":"/apidoc/v2/parameters/update"},{"full_description":"","params":[{"validator":"Must be String","required":false,"full_name":"host_id","expected_type":"string","allow_nil":false,"description":"id of host
","name":"host_id"},{"validator":"Must be String","required":false,"full_name":"hostgroup_id","expected_type":"string","allow_nil":false,"description":"id of hostgroup
","name":"hostgroup_id"},{"validator":"Must be String","required":false,"full_name":"domain_id","expected_type":"string","allow_nil":false,"description":"id of domain
","name":"domain_id"},{"validator":"Must be String","required":false,"full_name":"operatingsystem_id","expected_type":"string","allow_nil":false,"description":"id of operating system
","name":"operatingsystem_id"},{"validator":"Must be String","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"id of parameter
","name":"id"}],"examples":[],"apis":[{"api_url":"/api/hosts/:host_id/parameters/:id","short_description":"Delete a nested parameter for host","http_method":"DELETE"},{"api_url":"/api/hostgroups/:hostgroup_id/parameters/:id","short_description":"Delete a nested parameter for hostgroup","http_method":"DELETE"},{"api_url":"/api/domains/:domain_id/parameters/:id","short_description":"Delete a nested parameter for domain","http_method":"DELETE"},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters/:id","short_description":"Delete a nested parameter for operating system","http_method":"DELETE"}],"errors":[],"see":[],"name":"destroy","formats":null,"doc_url":"/apidoc/v2/parameters/destroy"},{"full_description":"","params":[],"examples":[],"apis":[{"api_url":"/api/hosts/:host_id/parameters","short_description":"Delete all nested parameters for host","http_method":"DELETE"},{"api_url":"/api/hostgroups/:hostgroup_id/parameters","short_description":"Delete all nested parameters for hostgroup","http_method":"DELETE"},{"api_url":"/api/domains/:domain_id/parameters","short_description":"Delete all nested parameters for domain","http_method":"DELETE"},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters","short_description":"Delete all nested parameters for operating system","http_method":"DELETE"}],"errors":[],"see":[],"name":"reset","formats":null,"doc_url":"/apidoc/v2/parameters/reset"}],"short_description":null,"name":"Parameters","doc_url":"/apidoc/v2/parameters","formats":null},"config_templates":{"api_url":"/api","full_description":null,"version":"v2","methods":[{"full_description":"","params":[{"validator":"Must be String","required":false,"full_name":"search","expected_type":"string","allow_nil":false,"description":"filter results
","name":"search"},{"validator":"Must be String","required":false,"full_name":"order","expected_type":"string","allow_nil":false,"description":"sort results
","name":"order"},{"validator":"Must be String","required":false,"full_name":"page","expected_type":"string","allow_nil":false,"description":"paginate results
","name":"page"},{"validator":"Must be String","required":false,"full_name":"per_page","expected_type":"string","allow_nil":false,"description":"number of entries per request
","name":"per_page"}],"examples":["GET /api/config_templates\n200\n[\n {\n \"config_template\": {\n \"audit_comment\": null,\n \"template\": \"default linux~label linux~kernel <%= @kernel %>~append initrd=<%= @initrd %> ks=<%= foreman_url(\\\"kickstart\\\")%> ksdevice=bootif network kssendmac\",\n \"snippet\": null,\n \"template_kind\": {\n \"id\": 452984334,\n \"name\": \"PXELinux\"\n },\n \"id\": 1007981701,\n \"name\": \"centos5_3_pxelinux\"\n }\n },\n {\n \"config_template\": {\n \"audit_comment\": null,\n \"template\": \"MyFinish\",\n \"snippet\": null,\n \"template_kind\": {\n \"id\": 550103832,\n \"name\": \"finish\"\n },\n \"id\": 104314179,\n \"name\": \"MyFinish\"\n }\n },\n {\n \"config_template\": {\n \"audit_comment\": null,\n \"template\": \"MyText\",\n \"snippet\": null,\n \"template_kind\": {\n \"id\": 478250810,\n \"name\": \"script\"\n },\n \"id\": 981457253,\n \"name\": \"MyScript\"\n }\n },\n {\n \"config_template\": {\n \"audit_comment\": null,\n \"template\": \"MyText\",\n \"snippet\": null,\n \"template_kind\": {\n \"id\": 158998239,\n \"name\": \"gPXE\"\n },\n \"id\": 943779058,\n \"name\": \"MyString\"\n }\n },\n {\n \"config_template\": {\n \"audit_comment\": null,\n \"template\": \"MyText\",\n \"snippet\": null,\n \"template_kind\": {\n \"id\": 983253650,\n \"name\": \"provision\"\n },\n \"id\": 269958254,\n \"name\": \"MyString2\"\n }\n },\n {\n \"config_template\": {\n \"audit_comment\": null,\n \"template\": \"default linux~label linux~kernel <%= @kernel %>~append initrd=<%= @initrd %> ksdevice=bootif network kssendmac\",\n \"snippet\": null,\n \"template_kind\": {\n \"id\": 452984334,\n \"name\": \"PXELinux\"\n },\n \"id\": 352050261,\n \"name\": \"PXE Default File\"\n }\n },\n {\n \"config_template\": {\n \"\": null,\n \"audit_comment\": null,\n \"template\": \"FOO\",\n \"snippet\": null,\n \"id\": 684651467,\n \"name\": \"PXE Default Menu\"\n }\n },\n {\n \"config_template\": {\n \"audit_comment\": null,\n \"template\": \"DEFAULT menu~PROMPT 0~MENU TITLE PXE Menu~TIMEOUT 200~TOTALTIMEOUT 6000~ONTIMEOUT local~~LABEL local~MENU LABEL (local)~MENU DEFAULT~LOCALBOOT 0\",\n \"snippet\": null,\n \"template_kind\": {\n \"id\": 452984334,\n \"name\": \"PXELinux\"\n },\n \"id\": 821548108,\n \"name\": \"PXE Localboot Default\"\n }\n }\n]"],"apis":[{"api_url":"/api/config_templates","short_description":"List templates","http_method":"GET"}],"errors":[],"see":[],"name":"index","formats":null,"doc_url":"/apidoc/v2/config_templates/index"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["GET /api/config_templates/centos5_3_pxelinux\n200\n{\n \"config_template\": {\n \"audit_comment\": null,\n \"template\": \"default linux~label linux~kernel <%= @kernel %>~append initrd=<%= @initrd %> ks=<%= foreman_url(\\\"kickstart\\\")%> ksdevice=bootif network kssendmac\",\n \"snippet\": null,\n \"template_kind\": {\n \"id\": 452984334,\n \"name\": \"PXELinux\"\n },\n \"id\": 1007981701,\n \"name\": \"centos5_3_pxelinux\"\n }\n}"],"apis":[{"api_url":"/api/config_templates/:id","short_description":"Show template details","http_method":"GET"}],"errors":[],"see":[],"name":"show","formats":null,"doc_url":"/apidoc/v2/config_templates/show"},{"full_description":"","params":[{"validator":"Must be a Hash","required":true,"full_name":"config_template","params":[{"full_name":"config_template[name]","required":true,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"template name
","name":"name"},{"full_name":"config_template[template]","required":true,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"template"},{"full_name":"config_template[snippet]","required":false,"validator":"Must be 'true' or 'false'","expected_type":"string","allow_nil":true,"description":"","name":"snippet"},{"full_name":"config_template[audit_comment]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":true,"description":"","name":"audit_comment"},{"full_name":"config_template[template_kind_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":true,"description":"not relevant for snippet
","name":"template_kind_id"},{"full_name":"config_template[template_combinations_attributes]","required":false,"validator":"Must be Array","expected_type":"array","allow_nil":false,"description":"Array of template combinations (hostgroup_id, environment_id)
","name":"template_combinations_attributes"},{"full_name":"config_template[operatingsystem_ids]","required":false,"validator":"Must be Array","expected_type":"array","allow_nil":false,"description":"Array of operating systems ID to associate the template with
","name":"operatingsystem_ids"}],"expected_type":"hash","allow_nil":false,"description":"","name":"config_template"}],"examples":["POST /api/config_templates\n{\n \"config_template\": {\n \"template_kind_id\": 1,\n \"template\": \"This is a test template\",\n \"name\": \"RandomName\"\n }\n}\n200\n{\n \"config_template\": {\n \"\": null,\n \"audit_comment\": null,\n \"template\": \"This is a test template\",\n \"snippet\": null,\n \"id\": 1007981702,\n \"name\": \"RandomName\"\n }\n}"],"apis":[{"api_url":"/api/config_templates","short_description":"Create a template","http_method":"POST"}],"errors":[],"see":[],"name":"create","formats":null,"doc_url":"/apidoc/v2/config_templates/create"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"},{"validator":"Must be a Hash","required":true,"full_name":"config_template","params":[{"full_name":"config_template[name]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"template name
","name":"name"},{"full_name":"config_template[template]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"template"},{"full_name":"config_template[snippet]","required":false,"validator":"Must be 'true' or 'false'","expected_type":"string","allow_nil":false,"description":"","name":"snippet"},{"full_name":"config_template[audit_comment]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":true,"description":"","name":"audit_comment"},{"full_name":"config_template[template_kind_id]","required":false,"validator":"Must be a number.","expected_type":"string","allow_nil":true,"description":"not relevant for snippet
","name":"template_kind_id"},{"full_name":"config_template[template_combinations_attributes]","required":false,"validator":"Must be Array","expected_type":"array","allow_nil":false,"description":"Array of template combinations (hostgroup_id, environment_id)
","name":"template_combinations_attributes"},{"full_name":"config_template[operatingsystem_ids]","required":false,"validator":"Must be Array","expected_type":"array","allow_nil":false,"description":"Array of operating systems ID to associate the template with
","name":"operatingsystem_ids"}],"expected_type":"hash","allow_nil":false,"description":"","name":"config_template"}],"examples":["PUT /api/config_templates/centos5_3_pxelinux\n{\n \"config_template\": {\n \"audit_comment\": \"aha\",\n \"template\": \"tmp\"\n }\n}\n200\n{\n \"config_template\": {\n \"snippet\": null,\n \"template\": \"tmp\",\n \"template_kind\": {\n \"id\": 452984334,\n \"name\": \"PXELinux\"\n },\n \"id\": 1007981701,\n \"name\": \"centos5_3_pxelinux\"\n }\n}"],"apis":[{"api_url":"/api/config_templates/:id","short_description":"Update a template","http_method":"PUT"}],"errors":[],"see":[],"name":"update","formats":null,"doc_url":"/apidoc/v2/config_templates/update"},{"full_description":"","params":[{"validator":"Must be String","required":false,"full_name":"version","expected_type":"string","allow_nil":false,"description":"template version
","name":"version"}],"examples":[],"apis":[{"api_url":"/api/config_templates/revision","short_description":null,"http_method":"GET"}],"errors":[],"see":[],"name":"revision","formats":null,"doc_url":"/apidoc/v2/config_templates/revision"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["DELETE /api/config_templates/centos5_3_pxelinux\n200\n{\n \"config_template\": {\n \"snippet\": null,\n \"template\": \"default linux~label linux~kernel <%= @kernel %>~append initrd=<%= @initrd %> ks=<%= foreman_url(\\\"kickstart\\\")%> ksdevice=bootif network kssendmac\",\n \"template_kind\": {\n \"id\": 452984334,\n \"name\": \"PXELinux\"\n },\n \"id\": 1007981701,\n \"name\": \"centos5_3_pxelinux\"\n }\n}"],"apis":[{"api_url":"/api/config_templates/:id","short_description":"Delete a template","http_method":"DELETE"}],"errors":[],"see":[],"name":"destroy","formats":null,"doc_url":"/apidoc/v2/config_templates/destroy"},{"full_description":"","params":[],"examples":["GET /api/config_templates/build_pxe_default\n200\nPXE Default file has been deployed to all Smart Proxies"],"apis":[{"api_url":"/api/config_templates/build_pxe_default","short_description":"Change the default PXE menu on all configured TFTP servers","http_method":"GET"}],"errors":[],"see":[],"name":"build_pxe_default","formats":null,"doc_url":"/apidoc/v2/config_templates/build_pxe_default"}],"short_description":null,"name":"Config templates","doc_url":"/apidoc/v2/config_templates","formats":null},"audits":{"api_url":"/api","full_description":null,"version":"v2","methods":[{"full_description":"","params":[{"validator":"Must be String","required":false,"full_name":"search","expected_type":"string","allow_nil":false,"description":"filter results
","name":"search"},{"validator":"Must be String","required":false,"full_name":"order","expected_type":"string","allow_nil":false,"description":"sort results
","name":"order"},{"validator":"Must be String","required":false,"full_name":"page","expected_type":"string","allow_nil":false,"description":"paginate results
","name":"page"},{"validator":"Must be String","required":false,"full_name":"per_page","expected_type":"string","allow_nil":false,"description":"number of entries per request
","name":"per_page"}],"examples":["GET /api/audits\n200\n[\n {\n \"audit\": {\n \"action\": \"update\",\n \"created_at\": \"2009-12-14T08:01:17Z\",\n \"version\": 1,\n \"associated_type\": \"Host\",\n \"auditable_type\": \"Host\",\n \"remote_address\": null,\n \"auditable_id\": 0,\n \"user_id\": null,\n \"associated_name\": null,\n \"user_type\": null,\n \"audited_changes\": {\n \"architecture_id\": [\n 10463,\n 10466\n ]\n },\n \"comment\": null,\n \"id\": 1,\n \"auditable_name\": null,\n \"associated_id\": 272\n }\n }\n]"],"apis":[{"api_url":"/api/audits","short_description":"List all audits.","http_method":"GET"},{"api_url":"/api/hosts/:host_id/audits","short_description":"List all audits for a given host.","http_method":"GET"}],"errors":[],"see":[],"name":"index","formats":null,"doc_url":"/apidoc/v2/audits/index"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["GET /api/audits/1\n200\n{\n \"audit\": {\n \"action\": \"update\",\n \"created_at\": \"2009-12-14T08:01:17Z\",\n \"version\": 1,\n \"associated_type\": \"Host\",\n \"auditable_type\": \"Host\",\n \"remote_address\": null,\n \"auditable_id\": 0,\n \"user_id\": null,\n \"associated_name\": null,\n \"user_type\": null,\n \"audited_changes\": {\n \"architecture_id\": [\n 10463,\n 10466\n ]\n },\n \"comment\": null,\n \"id\": 1,\n \"auditable_name\": null,\n \"associated_id\": 272\n }\n}"],"apis":[{"api_url":"/api/audits/:id","short_description":"Show an audit","http_method":"GET"}],"errors":[],"see":[],"name":"show","formats":null,"doc_url":"/apidoc/v2/audits/show"}],"short_description":null,"name":"Audits","doc_url":"/apidoc/v2/audits","formats":null},"puppetclasses":{"api_url":"/api","full_description":null,"version":"v2","methods":[{"full_description":"","params":[{"validator":"Must be String","required":false,"full_name":"host_id","expected_type":"string","allow_nil":false,"description":"id of nested host
","name":"host_id"},{"validator":"Must be String","required":false,"full_name":"hostgroup_id","expected_type":"string","allow_nil":false,"description":"id of nested hostgroup
","name":"hostgroup_id"},{"validator":"Must be String","required":false,"full_name":"environment_id","expected_type":"string","allow_nil":false,"description":"id of nested environment
","name":"environment_id"}],"examples":["GET /api/puppetclasses\n200\n{\n \"base\": [\n {\n \"puppetclass\": {\n \"lookup_keys\": [\n {\n \"id\": 298486374\n }\n ],\n \"id\": 980190962,\n \"name\": \"base\"\n }\n }\n ],\n \"apache\": [\n {\n \"puppetclass\": {\n \"lookup_keys\": [],\n \"id\": 298486374,\n \"name\": \"apache\"\n }\n }\n ]\n}"],"apis":[{"api_url":"/api/puppetclasses","short_description":"List all puppetclasses.","http_method":"GET"},{"api_url":"/api/hosts/:host_id/puppetclasses","short_description":"List all puppetclasses for host","http_method":"GET"},{"api_url":"/api/hostgroups/:hostgroup_id/puppetclasses","short_description":"List all puppetclasses for hostgroup","http_method":"GET"},{"api_url":"/api/environments/:environment_id/puppetclasses","short_description":"List all puppetclasses for environment","http_method":"GET"}],"errors":[],"see":[],"name":"index","formats":null,"doc_url":"/apidoc/v2/puppetclasses/index"},{"full_description":"","params":[{"validator":"Must be String","required":false,"full_name":"host_id","expected_type":"string","allow_nil":false,"description":"id of nested host
","name":"host_id"},{"validator":"Must be String","required":false,"full_name":"hostgroup_id","expected_type":"string","allow_nil":false,"description":"id of nested hostgroup
","name":"hostgroup_id"},{"validator":"Must be String","required":false,"full_name":"environment_id","expected_type":"string","allow_nil":false,"description":"id of nested environment
","name":"environment_id"},{"validator":"Must be String","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"id of puppetclass
","name":"id"}],"examples":["GET /api/puppetclasses/base\n200\n{\n \"puppetclass\": {\n \"lookup_keys\": [\n {\n \"lookup_key\": {\n \"required\": false,\n \"override\": false,\n \"key\": \"ssl_port\",\n \"default_value\": \"443\",\n \"description\": null,\n \"id\": 298486374,\n \"is_param\": false\n }\n }\n ],\n \"id\": 980190962,\n \"name\": \"base\"\n }\n}"],"apis":[{"api_url":"/api/puppetclasses/:id","short_description":"Show a puppetclass","http_method":"GET"},{"api_url":"/api/hosts/:host_id/puppetclasses/:id","short_description":"Show a puppetclass for host","http_method":"GET"},{"api_url":"/api/hostgroups/:hostgroup_id/puppetclasses/:id","short_description":"Show a puppetclass for hostgroup","http_method":"GET"},{"api_url":"/api/environments/:environment_id/puppetclasses/:id","short_description":"Show a puppetclass for environment","http_method":"GET"}],"errors":[],"see":[],"name":"show","formats":null,"doc_url":"/apidoc/v2/puppetclasses/show"},{"full_description":"","params":[{"validator":"Must be a Hash","required":true,"full_name":"puppetclass","params":[{"full_name":"puppetclass[name]","required":true,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"name"}],"expected_type":"hash","allow_nil":false,"description":"","name":"puppetclass"}],"examples":["POST /api/puppetclasses\n{\n \"puppetclass\": {\n \"name\": \"test_puppetclass\"\n }\n}\n201\n{\n \"puppetclass\": {\n \"lookup_keys\": [],\n \"id\": 980190963,\n \"name\": \"test_puppetclass\"\n }\n}"],"apis":[{"api_url":"/api/puppetclasses","short_description":"Create a puppetclass.","http_method":"POST"}],"errors":[],"see":[],"name":"create","formats":null,"doc_url":"/apidoc/v2/puppetclasses/create"},{"full_description":"","params":[{"validator":"Must be String","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"},{"validator":"Must be a Hash","required":true,"full_name":"puppetclass","params":[{"full_name":"puppetclass[name]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"name"}],"expected_type":"hash","allow_nil":false,"description":"","name":"puppetclass"}],"examples":["PUT /api/puppetclasses/base\n{\n \"puppetclass\": {}\n}\n200\n{\n \"puppetclass\": {\n \"lookup_keys\": [\n {\n \"id\": 298486374\n }\n ],\n \"id\": 980190962,\n \"name\": \"base\"\n }\n}"],"apis":[{"api_url":"/api/puppetclasses/:id","short_description":"Update a puppetclass.","http_method":"PUT"}],"errors":[],"see":[],"name":"update","formats":null,"doc_url":"/apidoc/v2/puppetclasses/update"},{"full_description":"","params":[{"validator":"Must be String","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["DELETE /api/puppetclasses/base\n200\n{\n \"puppetclass\": {\n \"lookup_keys\": [\n {\n \"id\": 298486374\n }\n ],\n \"id\": 980190962,\n \"name\": \"base\"\n }\n}"],"apis":[{"api_url":"/api/puppetclasses/:id","short_description":"Delete a puppetclass.","http_method":"DELETE"}],"errors":[],"see":[],"name":"destroy","formats":null,"doc_url":"/apidoc/v2/puppetclasses/destroy"}],"short_description":null,"name":"Puppetclasses","doc_url":"/apidoc/v2/puppetclasses","formats":null},"environments":{"api_url":"/api","full_description":null,"version":"v2","methods":[{"full_description":"","params":[{"validator":"Must be String","required":false,"full_name":"search","expected_type":"string","allow_nil":false,"description":"Filter results
","name":"search"},{"validator":"Must be String","required":false,"full_name":"order","expected_type":"string","allow_nil":false,"description":"Sort results
","name":"order"},{"validator":"Must be String","required":false,"full_name":"page","expected_type":"string","allow_nil":false,"description":"paginate results
","name":"page"},{"validator":"Must be String","required":false,"full_name":"per_page","expected_type":"string","allow_nil":false,"description":"number of entries per request
","name":"per_page"}],"examples":["GET /api/environments\n200\n[\n {\n \"environment\": {\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"id\": 153855663,\n \"name\": \"global_puppetmaster\"\n }\n },\n {\n \"environment\": {\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"id\": 334344675,\n \"name\": \"production\"\n }\n },\n {\n \"environment\": {\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"id\": 687036937,\n \"name\": \"testing\"\n }\n }\n]"],"apis":[{"api_url":"/api/environments","short_description":"List all environments.","http_method":"GET"}],"errors":[],"see":[],"name":"index","formats":null,"doc_url":"/apidoc/v2/environments/index"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["GET /api/environments/production\n200\n{\n \"environment\": {\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"id\": 334344675,\n \"name\": \"production\"\n }\n}"],"apis":[{"api_url":"/api/environments/:id","short_description":"Show an environment.","http_method":"GET"}],"errors":[],"see":[],"name":"show","formats":null,"doc_url":"/apidoc/v2/environments/show"},{"full_description":"","params":[{"validator":"Must be a Hash","required":true,"full_name":"environment","params":[{"full_name":"environment[name]","required":true,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"name"}],"expected_type":"hash","allow_nil":false,"description":"","name":"environment"}],"examples":["POST /api/environments\n{\n \"environment\": {\n \"name\": \"Development\"\n }\n}\n200\n{\n \"environment\": {\n \"created_at\": \"2012-12-18T15:24:46Z\",\n \"updated_at\": \"2012-12-18T15:24:46Z\",\n \"id\": 687036938,\n \"name\": \"Development\"\n }\n}"],"apis":[{"api_url":"/api/environments","short_description":"Create an environment.","http_method":"POST"}],"errors":[],"see":[],"name":"create","formats":null,"doc_url":"/apidoc/v2/environments/create"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"},{"validator":"Must be a Hash","required":true,"full_name":"environment","params":[{"full_name":"environment[name]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"name"}],"expected_type":"hash","allow_nil":false,"description":"","name":"environment"}],"examples":["PUT /api/environments/production\n{\n \"environment\": {}\n}\n200\n{\n \"environment\": {\n \"id\": 334344675,\n \"name\": \"production\"\n }\n}"],"apis":[{"api_url":"/api/environments/:id","short_description":"Update an environment.","http_method":"PUT"}],"errors":[],"see":[],"name":"update","formats":null,"doc_url":"/apidoc/v2/environments/update"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["DELETE /api/environments/testing\n200\n{\n \"environment\": {\n \"id\": 687036937,\n \"name\": \"testing\"\n }\n}"],"apis":[{"api_url":"/api/environments/:id","short_description":"Delete an environment.","http_method":"DELETE"}],"errors":[],"see":[],"name":"destroy","formats":null,"doc_url":"/apidoc/v2/environments/destroy"}],"short_description":null,"name":"Environments","doc_url":"/apidoc/v2/environments","formats":null},"hostgroup_classes":{"api_url":"/api","full_description":null,"version":"v2","methods":[{"full_description":"","params":[],"examples":[],"apis":[{"api_url":"/api/hostgroups/:hostgroup_id/puppetclass_ids","short_description":"List all puppetclass id's for hostgroup","http_method":"GET"}],"errors":[],"see":[],"name":"index","formats":null,"doc_url":"/apidoc/v2/hostgroup_classes/index"},{"full_description":"","params":[{"validator":"Must be String","required":true,"full_name":"hostgroup_id","expected_type":"string","allow_nil":false,"description":"id of hostgroup
","name":"hostgroup_id"},{"validator":"Must be String","required":true,"full_name":"puppetclass_id","expected_type":"string","allow_nil":false,"description":"id of puppetclass
","name":"puppetclass_id"}],"examples":[],"apis":[{"api_url":"/api/hostgroups/:hostgroup_id/puppetclass_ids","short_description":"Add a puppetclass to hostgroup","http_method":"POST"}],"errors":[],"see":[],"name":"create","formats":null,"doc_url":"/apidoc/v2/hostgroup_classes/create"},{"full_description":"","params":[{"validator":"Must be String","required":true,"full_name":"hostgroup_id","expected_type":"string","allow_nil":false,"description":"id of hostgroup
","name":"hostgroup_id"},{"validator":"Must be String","required":true,"full_name":"puppetclass_id","expected_type":"string","allow_nil":false,"description":"id of puppetclass
","name":"puppetclass_id"}],"examples":[],"apis":[{"api_url":"/api/hostgroups/:hostgroup_id/puppetclass_ids/:id","short_description":"Remove a puppetclass from hostgroup","http_method":"DELETE"}],"errors":[],"see":[],"name":"destroy","formats":null,"doc_url":"/apidoc/v2/hostgroup_classes/destroy"}],"short_description":null,"name":"Hostgroup classes","doc_url":"/apidoc/v2/hostgroup_classes","formats":null},"settings":{"api_url":"/api","full_description":null,"version":"v2","methods":[{"full_description":"","params":[{"validator":"Must be String","required":false,"full_name":"search","expected_type":"string","allow_nil":false,"description":"Filter results
","name":"search"},{"validator":"Must be String","required":false,"full_name":"order","expected_type":"string","allow_nil":false,"description":"Sort results
","name":"order"},{"validator":"Must be String","required":false,"full_name":"page","expected_type":"string","allow_nil":false,"description":"paginate results
","name":"page"},{"validator":"Must be String","required":false,"full_name":"per_page","expected_type":"string","allow_nil":false,"description":"number of entries per request
","name":"per_page"}],"examples":[],"apis":[{"api_url":"/api/settings","short_description":"List all settings.","http_method":"GET"}],"errors":[],"see":[],"name":"index","formats":null,"doc_url":"/apidoc/v2/settings/index"},{"full_description":"","params":[{"validator":"Must be String","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["GET /api/settings/333972760\n200\n{\n \"setting\": {\n \"category\": \"General\",\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"settings_type\": null,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"default\": \"root@some.host.fqdn\",\n \"value\": \"root@some.host.fqdn\",\n \"description\": \"The Default administrator email address\",\n \"id\": 333972760,\n \"name\": \"administrator\"\n }\n}"],"apis":[{"api_url":"/api/settings/:id","short_description":"Show an setting.","http_method":"GET"}],"errors":[],"see":[],"name":"show","formats":null,"doc_url":"/apidoc/v2/settings/show"},{"full_description":"","params":[{"validator":"Must be String","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"},{"validator":"Must be a Hash","required":true,"full_name":"setting","params":[{"full_name":"setting[value]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"value"}],"expected_type":"hash","allow_nil":false,"description":"","name":"setting"}],"examples":["PUT /api/settings/333972760\n{\n \"setting\": {}\n}\n200\n{\n \"setting\": {\n \"category\": \"General\",\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"settings_type\": null,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"default\": \"root@some.host.fqdn\",\n \"value\": \"root@some.host.fqdn\",\n \"description\": \"The Default administrator email address\",\n \"id\": 333972760,\n \"name\": \"administrator\"\n }\n}"],"apis":[{"api_url":"/api/settings/:id","short_description":"Update a setting.","http_method":"PUT"}],"errors":[],"see":[],"name":"update","formats":null,"doc_url":"/apidoc/v2/settings/update"}],"short_description":null,"name":"Settings","doc_url":"/apidoc/v2/settings","formats":null},"users":{"api_url":"/api","full_description":null,"version":"v2","methods":[{"full_description":"","params":[{"validator":"Must be String","required":false,"full_name":"search","expected_type":"string","allow_nil":false,"description":"filter results
","name":"search"},{"validator":"Must be String","required":false,"full_name":"order","expected_type":"string","allow_nil":false,"description":"sort results
","name":"order"},{"validator":"Must be String","required":false,"full_name":"page","expected_type":"string","allow_nil":false,"description":"paginate results
","name":"page"},{"validator":"Must be String","required":false,"full_name":"per_page","expected_type":"string","allow_nil":false,"description":"number of entries per request
","name":"per_page"}],"examples":["GET /api/users\n200\n[\n {\n \"user\": {\n \"filter_on_owner\": null,\n \"domains_andor\": \"or\",\n \"facts_andor\": \"or\",\n \"firstname\": \"Admin\",\n \"login\": \"admin\",\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"lastname\": \"User\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"auth_source_id\": 980190962,\n \"last_login_on\": \"2009-10-12T21:50:04Z\",\n \"admin\": true,\n \"mail\": \"admin@someware.com\",\n \"hostgroups_andor\": \"or\",\n \"role_id\": null,\n \"compute_resources_andor\": \"or\",\n \"id\": 135138680\n }\n },\n {\n \"user\": {\n \"filter_on_owner\": null,\n \"domains_andor\": \"or\",\n \"facts_andor\": \"or\",\n \"firstname\": \"apiadmin\",\n \"login\": \"apiadmin\",\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"lastname\": \"User\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"auth_source_id\": 200482051,\n \"last_login_on\": \"2009-10-12T21:50:04Z\",\n \"admin\": true,\n \"mail\": \"apiadmin@someware.com\",\n \"hostgroups_andor\": \"or\",\n \"role_id\": null,\n \"compute_resources_andor\": \"or\",\n \"id\": 886836129\n }\n },\n {\n \"user\": {\n \"filter_on_owner\": null,\n \"domains_andor\": \"or\",\n \"facts_andor\": \"or\",\n \"firstname\": \"One\",\n \"login\": \"one\",\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"lastname\": \"User\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"auth_source_id\": 980190962,\n \"last_login_on\": \"2009-10-12T21:50:04Z\",\n \"admin\": false,\n \"mail\": \"userone@someware.com\",\n \"hostgroups_andor\": \"or\",\n \"role_id\": null,\n \"compute_resources_andor\": \"or\",\n \"id\": 980190962\n }\n },\n {\n \"user\": {\n \"filter_on_owner\": null,\n \"domains_andor\": \"or\",\n \"facts_andor\": \"or\",\n \"firstname\": \"test\",\n \"login\": \"test\",\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"lastname\": \"User\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"auth_source_id\": 200482051,\n \"last_login_on\": \"2009-10-12T21:50:04Z\",\n \"admin\": false,\n \"mail\": \"testuser@someware.com\",\n \"hostgroups_andor\": \"or\",\n \"role_id\": null,\n \"compute_resources_andor\": \"or\",\n \"id\": 200482051\n }\n },\n {\n \"user\": {\n \"filter_on_owner\": null,\n \"domains_andor\": \"or\",\n \"facts_andor\": \"or\",\n \"firstname\": \"Two\",\n \"login\": \"two\",\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"lastname\": \"User\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"auth_source_id\": 980190962,\n \"last_login_on\": \"2009-10-12T21:50:04Z\",\n \"admin\": false,\n \"mail\": \"usertwo@someware.com\",\n \"hostgroups_andor\": \"or\",\n \"role_id\": null,\n \"compute_resources_andor\": \"or\",\n \"id\": 298486374\n }\n }\n]"],"apis":[{"api_url":"/api/users","short_description":"List all users.","http_method":"GET"}],"errors":[],"see":[],"name":"index","formats":null,"doc_url":"/apidoc/v2/users/index"},{"full_description":"","params":[{"validator":"Must be String","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["GET /api/users/980190962-one\n200\n{\n \"user\": {\n \"filter_on_owner\": null,\n \"domains_andor\": \"or\",\n \"facts_andor\": \"or\",\n \"firstname\": \"One\",\n \"login\": \"one\",\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"lastname\": \"User\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"auth_source_id\": 980190962,\n \"roles\": [\n {\n \"role\": {\n \"builtin\": 0,\n \"permissions\": [\n \"view_architectures\",\n \"view_audit_logs\",\n \"view_authenticators\",\n \"access_dashboard\",\n \"view_domains\",\n \"view_environments\",\n \"view_external_variables\",\n \"view_facts\",\n \"view_globals\",\n \"view_hostgroups\",\n \"view_hosts\",\n \"view_locations\",\n \"view_media\",\n \"view_models\",\n \"view_operatingsystems\",\n \"view_ptables\",\n \"view_puppetclasses\",\n \"view_reports\",\n \"access_settings\",\n \"view_statistics\",\n \"view_organizations\",\n \"view_usergroups\",\n \"view_users\"\n ],\n \"id\": 5,\n \"name\": \"Viewer\"\n }\n },\n {\n \"role\": {\n \"builtin\": 2,\n \"permissions\": [\n \"view_hosts\"\n ],\n \"id\": 7,\n \"name\": \"Anonymous\"\n }\n }\n ],\n \"last_login_on\": \"2009-10-12T21:50:04Z\",\n \"admin\": false,\n \"auth_source_ldap\": {\n \"host\": \"ldap\",\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"account\": null,\n \"attr_mail\": \"mail\",\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"tls\": true,\n \"onthefly_register\": true,\n \"attr_lastname\": \"sn\",\n \"attr_login\": \"uid\",\n \"base_dn\": \"dn=x,dn=y\",\n \"port\": 123,\n \"type\": \"AuthSourceLdap\",\n \"id\": 980190962,\n \"name\": \"ldap\",\n \"attr_firstname\": \"givenName\"\n },\n \"mail\": \"userone@someware.com\",\n \"hostgroups_andor\": \"or\",\n \"role_id\": null,\n \"compute_resources_andor\": \"or\",\n \"id\": 980190962\n }\n}"],"apis":[{"api_url":"/api/users/:id","short_description":"Show an user.","http_method":"GET"}],"errors":[],"see":[],"name":"show","formats":null,"doc_url":"/apidoc/v2/users/show"},{"full_description":"Adds role ‘Anonymous’ to the user by default
","params":[{"validator":"Must be a Hash","required":true,"full_name":"user","params":[{"full_name":"user[login]","required":true,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"login"},{"full_name":"user[firstname]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"firstname"},{"full_name":"user[lastname]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"lastname"},{"full_name":"user[mail]","required":true,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"mail"},{"full_name":"user[admin]","required":false,"validator":"Must be 'true' or 'false'","expected_type":"string","allow_nil":false,"description":"Is an admin account?
","name":"admin"},{"full_name":"user[password]","required":true,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"password"},{"full_name":"user[auth_source_id]","required":true,"validator":"Must be Integer","expected_type":"numeric","allow_nil":false,"description":"","name":"auth_source_id"}],"expected_type":"hash","allow_nil":false,"description":"","name":"user"}],"examples":[],"apis":[{"api_url":"/api/users","short_description":"Create an user.","http_method":"POST"}],"errors":[],"see":[],"name":"create","formats":null,"doc_url":"/apidoc/v2/users/create"},{"full_description":"Adds role ‘Anonymous’ to the user if it is not already present. Only admin can set admin account.
","params":[{"validator":"Must be String","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"},{"validator":"Must be a Hash","required":true,"full_name":"user","params":[{"full_name":"user[login]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"login"},{"full_name":"user[firstname]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":true,"description":"","name":"firstname"},{"full_name":"user[lastname]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":true,"description":"","name":"lastname"},{"full_name":"user[mail]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"mail"},{"full_name":"user[admin]","required":false,"validator":"Must be 'true' or 'false'","expected_type":"string","allow_nil":false,"description":"Is an admin account?
","name":"admin"},{"full_name":"user[password]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"password"}],"expected_type":"hash","allow_nil":false,"description":"","name":"user"}],"examples":["PUT /api/users/980190963\n{\n \"user\": {\n \"password_confirmation\": \"DUMMY\",\n \"login\": \"johnsmith\",\n \"password\": \"dummy\"\n }\n}\n422\n{\n \"user\": {\n \"full_messages\": [\n \"Password doesn't match confirmation\"\n ],\n \"errors\": {\n \"password\": [\n \"doesn't match confirmation\"\n ]\n },\n \"id\": 980190963\n }\n}"],"apis":[{"api_url":"/api/users/:id","short_description":"Update an user.","http_method":"PUT"}],"errors":[],"see":[],"name":"update","formats":null,"doc_url":"/apidoc/v2/users/update"},{"full_description":"","params":[{"validator":"Must be String","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["DELETE /api/users/980190962\n200\n{\n \"user\": {\n \"domains_andor\": \"or\",\n \"filter_on_owner\": null,\n \"facts_andor\": \"or\",\n \"firstname\": \"One\",\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"login\": \"one\",\n \"locations_andor\": \"or\",\n \"lastname\": \"User\",\n \"password_hash\": null,\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"auth_source_id\": 980190962,\n \"password_salt\": null,\n \"last_login_on\": \"2009-10-12T21:50:04Z\",\n \"admin\": false,\n \"mail\": \"userone@someware.com\",\n \"hostgroups_andor\": \"or\",\n \"role_id\": null,\n \"compute_resources_andor\": \"or\",\n \"id\": 980190962,\n \"organizations_andor\": \"or\"\n }\n}"],"apis":[{"api_url":"/api/users/:id","short_description":"Delete an user.","http_method":"DELETE"}],"errors":[],"see":[],"name":"destroy","formats":null,"doc_url":"/apidoc/v2/users/destroy"}],"short_description":null,"name":"Users","doc_url":"/apidoc/v2/users","formats":null},"models":{"api_url":"/api","full_description":null,"version":"v2","methods":[{"full_description":"","params":[{"validator":"Must be String","required":false,"full_name":"search","expected_type":"string","allow_nil":false,"description":"filter results
","name":"search"},{"validator":"Must be String","required":false,"full_name":"order","expected_type":"string","allow_nil":false,"description":"sort results
","name":"order"},{"validator":"Must be String","required":false,"full_name":"page","expected_type":"string","allow_nil":false,"description":"paginate results
","name":"page"},{"validator":"Must be String","required":false,"full_name":"per_page","expected_type":"string","allow_nil":false,"description":"number of entries per request
","name":"per_page"}],"examples":["GET /api/models\n200\n[\n {\n \"model\": {\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"vendor_class\": null,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"hardware_model\": null,\n \"info\": \"Virtual Machine\",\n \"id\": 980190962,\n \"name\": \"KVM\"\n }\n },\n {\n \"model\": {\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"vendor_class\": \"Sun-Fire-V210\",\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"hardware_model\": \"SUN4U\",\n \"info\": null,\n \"id\": 139037058,\n \"name\": \"SUN V210\"\n }\n }\n]"],"apis":[{"api_url":"/api/models","short_description":"List all models.","http_method":"GET"}],"errors":[],"see":[],"name":"index","formats":null,"doc_url":"/apidoc/v2/models/index"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["GET /api/models/980190962\n200\n{\n \"model\": {\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"vendor_class\": null,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"hardware_model\": null,\n \"info\": \"Virtual Machine\",\n \"id\": 980190962,\n \"name\": \"KVM\"\n }\n}"],"apis":[{"api_url":"/api/models/:id","short_description":"Show a model.","http_method":"GET"}],"errors":[],"see":[],"name":"show","formats":null,"doc_url":"/apidoc/v2/models/show"},{"full_description":"","params":[{"validator":"Must be a Hash","required":true,"full_name":"model","params":[{"full_name":"model[name]","required":true,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"name"},{"full_name":"model[info]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"info"},{"full_name":"model[vendor_class]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"vendor_class"},{"full_name":"model[hardware_model]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"hardware_model"}],"expected_type":"hash","allow_nil":false,"description":"","name":"model"}],"examples":["POST /api/models\n{\n \"model\": {\n \"name\": \"new model\"\n }\n}\n201\n{\n \"model\": {\n \"created_at\": \"2012-12-18T15:24:49Z\",\n \"vendor_class\": null,\n \"updated_at\": \"2012-12-18T15:24:49Z\",\n \"hardware_model\": null,\n \"info\": null,\n \"id\": 980190963,\n \"name\": \"new model\"\n }\n}"],"apis":[{"api_url":"/api/models","short_description":"Create a model.","http_method":"POST"}],"errors":[],"see":[],"name":"create","formats":null,"doc_url":"/apidoc/v2/models/create"},{"full_description":"","params":[{"validator":"Must be String","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"},{"validator":"Must be a Hash","required":true,"full_name":"model","params":[{"full_name":"model[name]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"name"},{"full_name":"model[info]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"info"},{"full_name":"model[vendor_class]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"vendor_class"},{"full_name":"model[hardware_model]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"hardware_model"}],"expected_type":"hash","allow_nil":false,"description":"","name":"model"}],"examples":["PUT /api/models/980190962\n{\n \"name\": \"KVM\"\n}\n200\n{\n \"model\": {\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"vendor_class\": null,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"hardware_model\": null,\n \"info\": \"Virtual Machine\",\n \"id\": 980190962,\n \"name\": \"KVM\"\n }\n}"],"apis":[{"api_url":"/api/models/:id","short_description":"Update a model.","http_method":"PUT"}],"errors":[],"see":[],"name":"update","formats":null,"doc_url":"/apidoc/v2/models/update"},{"full_description":"","params":[{"validator":"Must be String","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["DELETE /api/models/980190962\n200\n{\n \"model\": {\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"vendor_class\": null,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"hardware_model\": null,\n \"info\": \"Virtual Machine\",\n \"id\": 980190962,\n \"name\": \"KVM\"\n }\n}"],"apis":[{"api_url":"/api/models/:id","short_description":"Delete a model.","http_method":"DELETE"}],"errors":[],"see":[],"name":"destroy","formats":null,"doc_url":"/apidoc/v2/models/destroy"}],"short_description":null,"name":"Models","doc_url":"/apidoc/v2/models","formats":null},"host_classes":{"api_url":"/api","full_description":null,"version":"v2","methods":[{"full_description":"","params":[],"examples":[],"apis":[{"api_url":"/api/hosts/:host_id/puppetclass_ids","short_description":"List all puppetclass id's for host","http_method":"GET"}],"errors":[],"see":[],"name":"index","formats":null,"doc_url":"/apidoc/v2/host_classes/index"},{"full_description":"","params":[{"validator":"Must be String","required":true,"full_name":"host_id","expected_type":"string","allow_nil":false,"description":"id of host
","name":"host_id"},{"validator":"Must be String","required":true,"full_name":"puppetclass_id","expected_type":"string","allow_nil":false,"description":"id of puppetclass
","name":"puppetclass_id"}],"examples":[],"apis":[{"api_url":"/api/hosts/:host_id/puppetclass_ids","short_description":"Add a puppetclass to host","http_method":"POST"}],"errors":[],"see":[],"name":"create","formats":null,"doc_url":"/apidoc/v2/host_classes/create"},{"full_description":"","params":[{"validator":"Must be String","required":true,"full_name":"host_id","expected_type":"string","allow_nil":false,"description":"id of host
","name":"host_id"},{"validator":"Must be String","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"id of puppetclass
","name":"id"}],"examples":[],"apis":[{"api_url":"/api/hosts/:host_id/puppetclass_ids/:id","short_description":"Remove a puppetclass from host","http_method":"DELETE"}],"errors":[],"see":[],"name":"destroy","formats":null,"doc_url":"/apidoc/v2/host_classes/destroy"}],"short_description":null,"name":"Host classes","doc_url":"/apidoc/v2/host_classes","formats":null},"smart_proxies":{"api_url":"/api","full_description":null,"version":"v2","methods":[{"full_description":"","params":[{"validator":"Must be String","required":false,"full_name":"type","expected_type":"string","allow_nil":false,"description":"filter by type
","name":"type"},{"validator":"Must be String","required":false,"full_name":"page","expected_type":"string","allow_nil":false,"description":"paginate results
","name":"page"},{"validator":"Must be String","required":false,"full_name":"per_page","expected_type":"string","allow_nil":false,"description":"number of entries per request
","name":"per_page"}],"examples":["GET /api/smart_proxies?type=unknown_type\n500\n{\n \"error\": {\n \"message\": \"Invalid feature type. Select one of: TFTP, BMC, DNS, DHCP, Puppetca, Puppet.\"\n }\n}"],"apis":[{"api_url":"/api/smart_proxies","short_description":"List all smart_proxies.","http_method":"GET"}],"errors":[],"see":[],"name":"index","formats":null,"doc_url":"/apidoc/v2/smart_proxies/index"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["GET /api/smart_proxies/980190962-dhcp-proxy\n200\n{\n \"smart_proxy\": {\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"features\": [],\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"url\": \"https://somewhere.net:8443\",\n \"id\": 980190962,\n \"name\": \"DHCP Proxy\"\n }\n}"],"apis":[{"api_url":"/api/smart_proxies/:id","short_description":"Show a smart proxy.","http_method":"GET"}],"errors":[],"see":[],"name":"show","formats":null,"doc_url":"/apidoc/v2/smart_proxies/show"},{"full_description":"","params":[{"validator":"Must be a Hash","required":true,"full_name":"smart_proxy","params":[{"full_name":"smart_proxy[name]","required":true,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"name"},{"full_name":"smart_proxy[url]","required":true,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"url"}],"expected_type":"hash","allow_nil":false,"description":"","name":"smart_proxy"}],"examples":["POST /api/smart_proxies\n{\n \"smart_proxy\": {\n \"url\": \"http://server:8443\",\n \"name\": \"master02\"\n }\n}\n201\n{\n \"smart_proxy\": {\n \"created_at\": \"2012-12-18T15:24:52Z\",\n \"updated_at\": \"2012-12-18T15:24:52Z\",\n \"url\": \"http://server:8443\",\n \"id\": 980190963,\n \"name\": \"master02\"\n }\n}"],"apis":[{"api_url":"/api/smart_proxies","short_description":"Create a smart proxy.","http_method":"POST"}],"errors":[],"see":[],"name":"create","formats":null,"doc_url":"/apidoc/v2/smart_proxies/create"},{"full_description":"","params":[{"validator":"Must be String","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"},{"validator":"Must be a Hash","required":true,"full_name":"smart_proxy","params":[{"full_name":"smart_proxy[name]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"name"},{"full_name":"smart_proxy[url]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"url"}],"expected_type":"hash","allow_nil":false,"description":"","name":"smart_proxy"}],"examples":["PUT /api/smart_proxies/980190962-dhcp-proxy\n{\n \"smart_proxy\": {}\n}\n200\n{\n \"smart_proxy\": {\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"url\": \"https://somewhere.net:8443\",\n \"id\": 980190962,\n \"name\": \"DHCP Proxy\"\n }\n}"],"apis":[{"api_url":"/api/smart_proxies/:id","short_description":"Update a smart proxy.","http_method":"PUT"}],"errors":[],"see":[],"name":"update","formats":null,"doc_url":"/apidoc/v2/smart_proxies/update"},{"full_description":"","params":[{"validator":"Must be String","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["DELETE /api/smart_proxies/281110143-unused-proxy\n200\n{\n \"smart_proxy\": {\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"url\": \"http://else.where:4567\",\n \"id\": 281110143,\n \"name\": \"Unused Proxy\"\n }\n}"],"apis":[{"api_url":"/api/smart_proxies/:id","short_description":"Delete a smart_proxy.","http_method":"DELETE"}],"errors":[],"see":[],"name":"destroy","formats":null,"doc_url":"/apidoc/v2/smart_proxies/destroy"}],"short_description":null,"name":"Smart proxies","doc_url":"/apidoc/v2/smart_proxies","formats":null},"architectures":{"api_url":"/api","full_description":null,"version":"v2","methods":[{"full_description":"","params":[{"validator":"Must be String","required":false,"full_name":"search","expected_type":"string","allow_nil":false,"description":"filter results
","name":"search"},{"validator":"Must be String","required":false,"full_name":"order","expected_type":"string","allow_nil":false,"description":"sort results
","name":"order"},{"validator":"Must be String","required":false,"full_name":"page","expected_type":"string","allow_nil":false,"description":"paginate results
","name":"page"},{"validator":"Must be String","required":false,"full_name":"per_page","expected_type":"string","allow_nil":false,"description":"number of entries per request
","name":"per_page"}],"examples":["GET /api/architectures\n200\n[\n {\n \"architecture\": {\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"operatingsystem_ids\": [],\n \"id\": 381564594,\n \"name\": \"s390\"\n }\n },\n {\n \"architecture\": {\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"operatingsystem_ids\": [\n 442321401\n ],\n \"id\": 331892513,\n \"name\": \"sparc\"\n }\n },\n {\n \"architecture\": {\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"operatingsystem_ids\": [\n 331303656,\n 309172073,\n 1073012828\n ],\n \"id\": 501905019,\n \"name\": \"x86_64\"\n }\n }\n]"],"apis":[{"api_url":"/api/architectures","short_description":"List all architectures.","http_method":"GET"}],"errors":[],"see":[],"name":"index","formats":null,"doc_url":"/apidoc/v2/architectures/index"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["GET /api/architectures/x86_64\n200\n{\n \"architecture\": {\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"operatingsystem_ids\": [\n 309172073,\n 1073012828,\n 331303656\n ],\n \"id\": 501905019,\n \"name\": \"x86_64\"\n }\n}"],"apis":[{"api_url":"/api/architectures/:id","short_description":"Show an architecture.","http_method":"GET"}],"errors":[],"see":[],"name":"show","formats":null,"doc_url":"/apidoc/v2/architectures/show"},{"full_description":"","params":[{"validator":"Must be a Hash","required":true,"full_name":"architecture","params":[{"full_name":"architecture[name]","required":true,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"name"},{"full_name":"architecture[operatingsystem_ids]","required":false,"validator":"Must be Array","expected_type":"array","allow_nil":false,"description":"Operatingsystem ID’s
","name":"operatingsystem_ids"}],"expected_type":"hash","allow_nil":false,"description":"","name":"architecture"}],"examples":["POST /api/architectures\n{\n \"architecture\": {\n \"name\": \"i386\"\n }\n}\n200\n{\n \"architecture\": {\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"operatingsystem_ids\": [],\n \"id\": 501905020,\n \"name\": \"i386\"\n }\n}"],"apis":[{"api_url":"/api/architectures","short_description":"Create an architecture.","http_method":"POST"}],"errors":[],"see":[],"name":"create","formats":null,"doc_url":"/apidoc/v2/architectures/create"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"},{"validator":"Must be a Hash","required":true,"full_name":"architecture","params":[{"full_name":"architecture[name]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"name"},{"full_name":"architecture[operatingsystem_ids]","required":false,"validator":"Must be Array","expected_type":"array","allow_nil":false,"description":"Operatingsystem ID’s
","name":"operatingsystem_ids"}],"expected_type":"hash","allow_nil":false,"description":"","name":"architecture"}],"examples":["PUT /api/architectures/x86_64\n{\n \"architecture\": {}\n}\n200\n{\n \"architecture\": {\n \"id\": 501905019,\n \"name\": \"x86_64\"\n }\n}"],"apis":[{"api_url":"/api/architectures/:id","short_description":"Update an architecture.","http_method":"PUT"}],"errors":[],"see":[],"name":"update","formats":null,"doc_url":"/apidoc/v2/architectures/update"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["DELETE /api/architectures/s390\n200\n{\n \"architecture\": {\n \"id\": 381564594,\n \"name\": \"s390\"\n }\n}"],"apis":[{"api_url":"/api/architectures/:id","short_description":"Delete an architecture.","http_method":"DELETE"}],"errors":[],"see":[],"name":"destroy","formats":null,"doc_url":"/apidoc/v2/architectures/destroy"}],"short_description":null,"name":"Architectures","doc_url":"/apidoc/v2/architectures","formats":null},"common_parameters":{"api_url":"/api","full_description":null,"version":"v2","methods":[{"full_description":"","params":[{"validator":"Must be String","required":false,"full_name":"search","expected_type":"string","allow_nil":false,"description":"filter results
","name":"search"},{"validator":"Must be String","required":false,"full_name":"order","expected_type":"string","allow_nil":false,"description":"sort results
","name":"order"},{"validator":"Must be String","required":false,"full_name":"page","expected_type":"string","allow_nil":false,"description":"paginate results
","name":"page"},{"validator":"Must be String","required":false,"full_name":"per_page","expected_type":"string","allow_nil":false,"description":"number of entries per request
","name":"per_page"}],"examples":["GET /api/common_parameters\n200\n[\n {\n \"common_parameter\": {\n \"value\": \"myvalue\",\n \"id\": 636252244,\n \"name\": \"test\"\n }\n }\n]"],"apis":[{"api_url":"/api/common_parameters","short_description":"List all common parameters.","http_method":"GET"}],"errors":[],"see":[],"name":"index","formats":null,"doc_url":"/apidoc/v2/common_parameters/index"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["GET /api/common_parameters/636252244\n200\n{\n \"common_parameter\": {\n \"value\": \"myvalue\",\n \"id\": 636252244,\n \"name\": \"test\"\n }\n}"],"apis":[{"api_url":"/api/common_parameters/:id","short_description":"Show a common parameter.","http_method":"GET"}],"errors":[],"see":[],"name":"show","formats":null,"doc_url":"/apidoc/v2/common_parameters/show"},{"full_description":"","params":[{"validator":"Must be a Hash","required":true,"full_name":"common_parameter","params":[{"full_name":"common_parameter[name]","required":true,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"name"},{"full_name":"common_parameter[value]","required":true,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"value"}],"expected_type":"hash","allow_nil":false,"description":"","name":"common_parameter"}],"examples":["POST /api/common_parameters\n{\n \"common_parameter\": {\n \"value\": \"123\",\n \"name\": \"special_key\"\n }\n}\n200\n{\n \"common_parameter\": {\n \"value\": \"123\",\n \"id\": 767575239,\n \"name\": \"special_key\"\n }\n}"],"apis":[{"api_url":"/api/common_parameters","short_description":"Create a common_parameter","http_method":"POST"}],"errors":[],"see":[],"name":"create","formats":null,"doc_url":"/apidoc/v2/common_parameters/create"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"},{"validator":"Must be a Hash","required":true,"full_name":"common_parameter","params":[{"full_name":"common_parameter[name]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"name"},{"full_name":"common_parameter[value]","required":false,"validator":"Must be String","expected_type":"string","allow_nil":false,"description":"","name":"value"}],"expected_type":"hash","allow_nil":false,"description":"","name":"common_parameter"}],"examples":["PUT /api/common_parameters/636252244\n{\n \"common_parameter\": {}\n}\n200\n{\n \"common_parameter\": {\n \"value\": \"myvalue\",\n \"id\": 636252244,\n \"name\": \"test\"\n }\n}"],"apis":[{"api_url":"/api/common_parameters/:id","short_description":"Update a common_parameter","http_method":"PUT"}],"errors":[],"see":[],"name":"update","formats":null,"doc_url":"/apidoc/v2/common_parameters/update"},{"full_description":"","params":[{"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","required":true,"full_name":"id","expected_type":"string","allow_nil":false,"description":"","name":"id"}],"examples":["DELETE /api/common_parameters/636252244\n200\n{\n \"common_parameter\": {\n \"value\": \"myvalue\",\n \"id\": 636252244,\n \"name\": \"test\"\n }\n}"],"apis":[{"api_url":"/api/common_parameters/:id","short_description":"Delete a common_parameter","http_method":"DELETE"}],"errors":[],"see":[],"name":"destroy","formats":null,"doc_url":"/apidoc/v2/common_parameters/destroy"}],"short_description":null,"name":"Common parameters","doc_url":"/apidoc/v2/common_parameters","formats":null}},"copyright":"","info":"Another API description","name":"Foreman","doc_url":"/apidoc/v2"}}