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