{"docs":{"name":"Foreman","info":"\n

Foreman v2 is stable and recommended for use. You may use v2 by either passing \u2018version=2\u2019 in the Accept Header or using api/v2/ in the URL.

\n","copyright":"","doc_url":"../apidoc/v2","api_url":"/api","resources":{"realms":{"doc_url":"../apidoc/v2/realms","api_url":"/api","name":"Realms","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/realms/index","name":"index","apis":[{"api_url":"/api/realms","http_method":"GET","short_description":"List of realms","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n

Scope by locations

\n","required":false,"allow_nil":false,"validator":"Must be Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"organization_id","full_name":"organization_id","description":"\n

Scope by organizations

\n","required":false,"allow_nil":false,"validator":"Must be Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"search","full_name":"search","description":"\n

filter results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n

sort results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n

paginate results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n

number of entries per request

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/realms/show","name":"show","apis":[{"api_url":"/api/realms/:id","http_method":"GET","short_description":"Show a realm","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n

Numerical ID or realm name

\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","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/realms/create","name":"create","apis":[{"api_url":"/api/realms","http_method":"POST","short_description":"Create a realm","deprecated":null}],"formats":null,"full_description":"\n

The name field is used for the name of the realm.

\n","errors":[],"params":[{"name":"realm","full_name":"realm","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"realm[name]","description":"\n

The realm name, e.g. EXAMPLE.COM

\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"realm_proxy_id","full_name":"realm[realm_proxy_id]","description":"\n

Proxy to use for this realm

\n","required":true,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"realm_type","full_name":"realm[realm_type]","description":"\n

Realm type, e.g. FreeIPA or Active Directory

\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"location_ids","full_name":"realm[location_ids]","description":"\n

REPLACE locations with given ids

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"organization_ids","full_name":"realm[organization_ids]","description":"\n

REPLACE organizations with given ids.

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/realms/update","name":"update","apis":[{"api_url":"/api/realms/:id","http_method":"PUT","short_description":"Update a realm","deprecated":null}],"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","metadata":null,"show":true},{"name":"realm","full_name":"realm","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"realm[name]","description":"\n

The realm name, e.g. EXAMPLE.COM

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"realm_proxy_id","full_name":"realm[realm_proxy_id]","description":"\n

Proxy to use for this realm

\n","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"realm_type","full_name":"realm[realm_type]","description":"\n

Realm type, e.g. FreeIPA or Active Directory

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"location_ids","full_name":"realm[location_ids]","description":"\n

REPLACE locations with given ids

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"organization_ids","full_name":"realm[organization_ids]","description":"\n

REPLACE organizations with given ids.

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/realms/destroy","name":"destroy","apis":[{"api_url":"/api/realms/:id","http_method":"DELETE","short_description":"Delete a realm","deprecated":null}],"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","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[]}]},"reports":{"doc_url":"../apidoc/v2/reports","api_url":"/api","name":"Reports","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/reports/index","name":"index","apis":[{"api_url":"/api/reports","http_method":"GET","short_description":"List all reports","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"\n

filter results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n

sort results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n

paginate results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n

number of entries per request

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/reports\n200\n[\n {\n \"report\": {\n \"summary\": \"Success\",\n \"status\": {\n \"skipped\": 0,\n \"failed_restarts\": 0,\n \"failed\": 0,\n \"pending\": 0,\n \"restarted\": 0,\n \"applied\": 0\n },\n \"id\": 70219655,\n \"reported_at\": \"2012-12-11T15:24:42Z\",\n \"metrics\": {\n \"events\": {\n \"total\": 0\n },\n \"time\": {\n \"package\": 0.003989,\n \"schedule\": 0.00083,\n \"cron\": 0.000419,\n \"exec\": 0.000299,\n \"service\": 0.149739,\n \"config_retrieval\": 16.3637869358063,\n \"file\": 0.007025,\n \"filebucket\": 0.000171,\n \"mailalias\": 0.000283\n },\n \"resources\": {\n \"total\": 33\n },\n \"changes\": {}\n },\n \"logs\": []\n }\n }\n]"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/reports/show","name":"show","apis":[{"api_url":"/api/reports/:id","http_method":"GET","short_description":"Show a report","deprecated":null}],"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","metadata":null,"show":true}],"examples":["GET /api/reports/70219655\n200\n{\n \"report\": {\n \"summary\": \"Success\",\n \"status\": {\n \"skipped\": 0,\n \"failed_restarts\": 0,\n \"failed\": 0,\n \"pending\": 0,\n \"restarted\": 0,\n \"applied\": 0\n },\n \"id\": 70219655,\n \"reported_at\": \"2012-12-11T15:24:42Z\",\n \"metrics\": {\n \"events\": {\n \"total\": 0\n },\n \"time\": {\n \"package\": 0.003989,\n \"schedule\": 0.00083,\n \"cron\": 0.000419,\n \"exec\": 0.000299,\n \"service\": 0.149739,\n \"config_retrieval\": 16.3637869358063,\n \"file\": 0.007025,\n \"filebucket\": 0.000171,\n \"mailalias\": 0.000283\n },\n \"resources\": {\n \"total\": 33\n },\n \"changes\": {}\n },\n \"logs\": []\n }\n}"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/reports/create","name":"create","apis":[{"api_url":"/api/reports","http_method":"POST","short_description":"Create a report","deprecated":null}],"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","metadata":null,"show":true,"params":[{"name":"host","full_name":"report[host]","description":"\n

Hostname or certname

\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"reported_at","full_name":"report[reported_at]","description":"\n

UTC time of report

\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"status","full_name":"report[status]","description":"\n

Hash of status type totals

\n","required":true,"allow_nil":false,"validator":"Must be Hash","expected_type":"hash","metadata":null,"show":true},{"name":"metrics","full_name":"report[metrics]","description":"\n

Hash of report metrics, can be just {}

\n","required":true,"allow_nil":false,"validator":"Must be Hash","expected_type":"hash","metadata":null,"show":true},{"name":"logs","full_name":"report[logs]","description":"\n

Optional array of log hashes

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/reports/destroy","name":"destroy","apis":[{"api_url":"/api/reports/:id","http_method":"DELETE","short_description":"Delete a report","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["DELETE /api/reports/70219655\n200\n{\n \"report\": {\n \"summary\": \"Success\",\n \"status\": {\n \"skipped\": 0,\n \"failed_restarts\": 0,\n \"failed\": 0,\n \"pending\": 0,\n \"restarted\": 0,\n \"applied\": 0\n },\n \"id\": 70219655,\n \"host\": \"my5name.mydomain.net\",\n \"reported_at\": \"2012-12-11T15:24:42Z\",\n \"logs\": [],\n \"metrics\": {\n \"events\": {\n \"total\": 0\n },\n \"time\": {\n \"package\": 0.003989,\n \"schedule\": 0.00083,\n \"cron\": 0.000419,\n \"service\": 0.149739,\n \"exec\": 0.000299,\n \"config_retrieval\": 16.3637869358063,\n \"file\": 0.007025,\n \"mailalias\": 0.000283,\n \"filebucket\": 0.000171\n },\n \"changes\": {},\n \"resources\": {\n \"total\": 33\n }\n }\n }\n}"],"metadata":null,"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 host","deprecated":null}],"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","metadata":null,"show":true}],"examples":["GET /api/reports/last\n200\n{\n \"report\": {\n \"summary\": \"Success\",\n \"status\": {\n \"skipped\": 0,\n \"failed_restarts\": 0,\n \"failed\": 0,\n \"pending\": 0,\n \"restarted\": 0,\n \"applied\": 0\n },\n \"id\": 70219655,\n \"reported_at\": \"2012-12-11T15:24:42Z\",\n \"metrics\": {\n \"events\": {\n \"total\": 0\n },\n \"time\": {\n \"package\": 0.003989,\n \"schedule\": 0.00083,\n \"cron\": 0.000419,\n \"exec\": 0.000299,\n \"service\": 0.149739,\n \"config_retrieval\": 16.3637869358063,\n \"file\": 0.007025,\n \"filebucket\": 0.000171,\n \"mailalias\": 0.000283\n },\n \"resources\": {\n \"total\": 33\n },\n \"changes\": {}\n },\n \"logs\": []\n }\n}"],"metadata":null,"see":[]}]},"parameters":{"doc_url":"../apidoc/v2/parameters","api_url":"/api","name":"Parameters","short_description":null,"full_description":"\n

These API calls are related to nested parameters for a host, domain, host group, operating system. If you are looking for global parameters, go to this link.

\n","version":"v2","formats":null,"metadata":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 a host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/parameters","http_method":"GET","short_description":"List all parameters for a host group","deprecated":null},{"api_url":"/api/domains/:domain_id/parameters","http_method":"GET","short_description":"List all parameters for a domain","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters","http_method":"GET","short_description":"List all parameters for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/parameters","http_method":"GET","short_description":"List all parameters for a location","deprecated":null},{"api_url":"/api/organizations/:organization_id/parameters","http_method":"GET","short_description":"List all parameters for an organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n

ID of host

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n

ID of hostgroup

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"domain_id","full_name":"domain_id","description":"\n

ID of domain

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n

ID of operating system

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"location_id","full_name":"location_id","description":"\n

ID of location

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"organization_id","full_name":"organization_id","description":"\n

ID of organization

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"search","full_name":"search","description":"\n

filter results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n

sort results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n

paginate results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n

number of entries per request

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"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 a host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for a host group","deprecated":null},{"api_url":"/api/domains/:domain_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for a domain","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for a location","deprecated":null},{"api_url":"/api/organizations/:organization_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for an organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n

ID of host

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n

ID of hostgroup

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"domain_id","full_name":"domain_id","description":"\n

ID of domain

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n

ID of operating system

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"location_id","full_name":"location_id","description":"\n

ID of location

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"organization_id","full_name":"organization_id","description":"\n

ID of organization

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"id","full_name":"id","description":"\n

ID of parameter

\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"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 a host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/parameters","http_method":"POST","short_description":"Create a nested parameter for a host group","deprecated":null},{"api_url":"/api/domains/:domain_id/parameters","http_method":"POST","short_description":"Create a nested parameter for a domain","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters","http_method":"POST","short_description":"Create a nested parameter for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/parameters","http_method":"POST","short_description":"Create a nested parameter for a location","deprecated":null},{"api_url":"/api/organizations/:organization_id/parameters","http_method":"POST","short_description":"Create a nested parameter for an organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n

ID of host

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n

ID of hostgroup

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"domain_id","full_name":"domain_id","description":"\n

ID of domain

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n

ID of operating system

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"location_id","full_name":"location_id","description":"\n

ID of location

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"organization_id","full_name":"organization_id","description":"\n

ID of organization

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"parameter","full_name":"parameter","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"parameter[name]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"value","full_name":"parameter[value]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}]}],"examples":[],"metadata":null,"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 a host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for a host group","deprecated":null},{"api_url":"/api/domains/:domain_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for a domain","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for a location","deprecated":null},{"api_url":"/api/organizations/:organization_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for an organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n

ID of host

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n

ID of hostgroup

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"domain_id","full_name":"domain_id","description":"\n

ID of domain

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n

ID of operating system

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"location_id","full_name":"location_id","description":"\n

ID of location

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"organization_id","full_name":"organization_id","description":"\n

ID of organization

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"id","full_name":"id","description":"\n

ID of parameter

\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"parameter","full_name":"parameter","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"parameter[name]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"value","full_name":"parameter[value]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}]}],"examples":[],"metadata":null,"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 a host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for a host group","deprecated":null},{"api_url":"/api/domains/:domain_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for a domain","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for a location","deprecated":null},{"api_url":"/api/organizations/:organization_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for an organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n

ID of host

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n

ID of hostgroup

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"domain_id","full_name":"domain_id","description":"\n

ID of domain

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n

ID of operating system

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"location_id","full_name":"location_id","description":"\n

ID of location

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"organization_id","full_name":"organization_id","description":"\n

ID of organization

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"id","full_name":"id","description":"\n

ID of parameter

\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"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 a host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameters for a host group","deprecated":null},{"api_url":"/api/domains/:domain_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameters for a domain","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameters for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameter for a location","deprecated":null},{"api_url":"/api/organizations/:organization_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameter for an organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n

ID of host

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n

ID of hostgroup

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"domain_id","full_name":"domain_id","description":"\n

ID of domain

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n

ID of operating system

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"location_id","full_name":"location_id","description":"\n

ID of location

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"organization_id","full_name":"organization_id","description":"\n

ID of organization

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"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,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/smart_proxies/import_puppetclasses","name":"import_puppetclasses","apis":[{"api_url":"/api/smart_proxies/:id/import_puppetclasses","http_method":"POST","short_description":"Import puppet classes from puppet proxy.","deprecated":null},{"api_url":"/api/smart_proxies/:smart_proxy_id/environments/:id/import_puppetclasses","http_method":"POST","short_description":"Import puppet classes from puppet proxy for an environment","deprecated":null},{"api_url":"/api/environments/:environment_id/smart_proxies/:id/import_puppetclasses","http_method":"POST","short_description":"Import puppet classes from puppet proxy for an environment","deprecated":null}],"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","metadata":null,"show":true},{"name":"smart_proxy_id","full_name":"smart_proxy_id","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"environment_id","full_name":"environment_id","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"dryrun","full_name":"dryrun","description":"","required":false,"allow_nil":false,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true},{"name":"except","full_name":"except","description":"\n

Optional comma-delimited string containing either \u2018new\u2019, \u2018updated\u2019, or \u2018obsolete\u2019 that is used to limit the imported Puppet classes

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"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","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n

Scope by locations

\n","required":false,"allow_nil":false,"validator":"Must be Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"organization_id","full_name":"organization_id","description":"\n

Scope by organizations

\n","required":false,"allow_nil":false,"validator":"Must be Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"search","full_name":"search","description":"\n

filter results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n

sort results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n

paginate results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n

number of entries per request

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/smart_proxies?type=unknown_type\n500\n{\n \"error\": {\n \"message\": \"Invalid feature type. Select one of: TFTP, BMC, DNS, DHCP, Puppetca, Puppet.\"\n }\n}"],"metadata":null,"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","deprecated":null}],"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","metadata":null,"show":true}],"examples":["GET /api/smart_proxies/980190962-dhcp-proxy\n200\n{\n \"smart_proxy\": {\n \"name\": \"DHCP Proxy\",\n \"features\": [],\n \"url\": \"https://somewhere.net:8443\",\n \"id\": 980190962,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"created_at\": \"2012-12-18T15:24:43Z\"\n }\n}"],"metadata":null,"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","deprecated":null}],"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","metadata":null,"show":true,"params":[{"name":"name","full_name":"smart_proxy[name]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"url","full_name":"smart_proxy[url]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"location_ids","full_name":"smart_proxy[location_ids]","description":"\n

REPLACE locations with given ids

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"organization_ids","full_name":"smart_proxy[organization_ids]","description":"\n

REPLACE organizations with given ids.

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":["POST /api/smart_proxies\n{\n \"smart_proxy\": {\n \"url\": \"http://server:8443\",\n \"name\": \"master02\"\n }\n}\n201\n{\n \"smart_proxy\": {\n \"url\": \"http://server:8443\",\n \"name\": \"master02\",\n \"id\": 980190963,\n \"updated_at\": \"2012-12-18T15:24:52Z\",\n \"created_at\": \"2012-12-18T15:24:52Z\"\n }\n}"],"metadata":null,"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","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"smart_proxy","full_name":"smart_proxy","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"smart_proxy[name]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"url","full_name":"smart_proxy[url]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"location_ids","full_name":"smart_proxy[location_ids]","description":"\n

REPLACE locations with given ids

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"organization_ids","full_name":"smart_proxy[organization_ids]","description":"\n

REPLACE organizations with given ids.

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":["PUT /api/smart_proxies/980190962-dhcp-proxy\n{\n \"smart_proxy\": {}\n}\n200\n{\n \"smart_proxy\": {\n \"url\": \"https://somewhere.net:8443\",\n \"name\": \"DHCP Proxy\",\n \"id\": 980190962,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"created_at\": \"2012-12-18T15:24:43Z\"\n }\n}"],"metadata":null,"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","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["DELETE /api/smart_proxies/281110143-unused-proxy\n200\n{\n \"smart_proxy\": {\n \"url\": \"http://else.where:4567\",\n \"name\": \"Unused Proxy\",\n \"id\": 281110143,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"created_at\": \"2012-12-18T15:24:43Z\"\n }\n}"],"metadata":null,"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","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"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,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/common_parameters/index","name":"index","apis":[{"api_url":"/api/common_parameters","http_method":"GET","short_description":"List all global parameters.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"\n

filter results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n

sort results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n

paginate results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n

number of entries per request

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/common_parameters\n200\n[\n {\n \"common_parameter\": {\n \"name\": \"test\",\n \"value\": \"myvalue\",\n \"id\": 636252244\n }\n }\n]"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/common_parameters/show","name":"show","apis":[{"api_url":"/api/common_parameters/:id","http_method":"GET","short_description":"Show a global parameter","deprecated":null}],"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","metadata":null,"show":true}],"examples":["GET /api/common_parameters/636252244\n200\n{\n \"common_parameter\": {\n \"name\": \"test\",\n \"value\": \"myvalue\",\n \"id\": 636252244\n }\n}"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/common_parameters/create","name":"create","apis":[{"api_url":"/api/common_parameters","http_method":"POST","short_description":"Create a global parameter","deprecated":null}],"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","metadata":null,"show":true,"params":[{"name":"name","full_name":"common_parameter[name]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"value","full_name":"common_parameter[value]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"hidden_value","full_name":"common_parameter[hidden_value]","description":"","required":false,"allow_nil":true,"validator":"Must be one of: true, false.","expected_type":"string","metadata":null,"show":true}]}],"examples":["POST /api/common_parameters\n{\n \"common_parameter\": {\n \"name\": \"special_key\",\n \"value\": \"123\"\n }\n}\n200\n{\n \"common_parameter\": {\n \"name\": \"special_key\",\n \"value\": \"123\",\n \"id\": 767575239\n }\n}"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/common_parameters/update","name":"update","apis":[{"api_url":"/api/common_parameters/:id","http_method":"PUT","short_description":"Update a global parameter","deprecated":null}],"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","metadata":null,"show":true},{"name":"common_parameter","full_name":"common_parameter","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"common_parameter[name]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"value","full_name":"common_parameter[value]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"hidden_value","full_name":"common_parameter[hidden_value]","description":"","required":false,"allow_nil":true,"validator":"Must be one of: true, false.","expected_type":"string","metadata":null,"show":true}]}],"examples":["PUT /api/common_parameters/636252244\n{\n \"common_parameter\": {}\n}\n200\n{\n \"common_parameter\": {\n \"name\": \"test\",\n \"value\": \"myvalue\",\n \"id\": 636252244\n }\n}"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/common_parameters/destroy","name":"destroy","apis":[{"api_url":"/api/common_parameters/:id","http_method":"DELETE","short_description":"Delete a global parameter","deprecated":null}],"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","metadata":null,"show":true}],"examples":["DELETE /api/common_parameters/636252244\n200\n{\n \"common_parameter\": {\n \"name\": \"test\",\n \"value\": \"myvalue\",\n \"id\": 636252244\n }\n}"],"metadata":null,"see":[]}]},"roles":{"doc_url":"../apidoc/v2/roles","api_url":"/api","name":"Roles","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/roles/index","name":"index","apis":[{"api_url":"/api/roles","http_method":"GET","short_description":"List all roles","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"\n

filter results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n

sort results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n

paginate results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n

number of entries per request

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/roles/show","name":"show","apis":[{"api_url":"/api/roles/:id","http_method":"GET","short_description":"Show a role","deprecated":null}],"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","metadata":null,"show":true}],"examples":["GET /api/roles/1\n200\n{\n \"role\": {\n \"name\": \"Manager\",\n \"id\": 1,\n \"builtin\": 0,\n \"permissions\": [\n \"view_architectures\",\n \"create_architectures\",\n \"edit_architectures\",\n \"destroy_architectures\",\n \"view_authenticators\",\n \"create_authenticators\",\n \"edit_authenticators\",\n \"destroy_authenticators\",\n \"view_environments\",\n \"create_environments\",\n \"edit_environments\",\n \"destroy_environments\",\n \"import_environments\",\n \"view_external_variables\",\n \"create_external_variables\",\n \"edit_external_variables\",\n \"destroy_external_variables\",\n \"view_domains\",\n \"create_domain\",\n \"edit_domains\",\n \"destroy_domains\",\n \"view_globals\",\n \"create_globals\",\n \"edit_globals\",\n \"destroy_globals\",\n \"view_hostgroups\",\n \"create_hostgroups\",\n \"edit_hostgroups\",\n \"destroy_hostgroups\",\n \"view_hosts\",\n \"create_hosts\",\n \"edit_hosts\",\n \"destroy_hosts\",\n \"view_media\",\n \"create_media\",\n \"edit_media\",\n \"destroy_media\",\n \"view_models\",\n \"create_models\",\n \"edit_models\",\n \"destroy_models\",\n \"view_operatingsystems\",\n \"create_operatingsystems\",\n \"edit_operatingsystems\",\n \"destroy_operatingsystems\",\n \"view_ptables\",\n \"create_ptables\",\n \"edit_ptables\",\n \"destroy_ptables\",\n \"view_puppetclasses\",\n \"create_puppetclasses\",\n \"edit_puppetclasses\",\n \"destroy_puppetclasses\",\n \"import_puppetclasses\",\n \"view_usergroups\",\n \"create_usergroups\",\n \"edit_usergroups\",\n \"destroy_usergroups\",\n \"view_users\",\n \"create_users\",\n \"edit_users\",\n \"destroy_users\",\n \"access_settings\",\n \"access_dashboard\",\n \"view_reports\",\n \"destroy_reports\",\n \"view_facts\",\n \"view_audit_logs\",\n \"view_statistics\",\n \"view_locations\",\n \"edit_locations\",\n \"create_locations\",\n \"destroy_locations\",\n \"view_organizations\",\n \"edit_organizations\",\n \"create_organizations\",\n \"destroy_organizations\"\n ]\n }\n}"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/roles/create","name":"create","apis":[{"api_url":"/api/roles","http_method":"POST","short_description":"Create a role","deprecated":null}],"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","metadata":null,"show":true,"params":[{"name":"name","full_name":"role[name]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}]}],"examples":["POST /api/roles\n{\n \"role\": {\n \"name\": \"staff\"\n }\n}\n200\n{\n \"role\": {\n \"name\": \"staff\",\n \"id\": 11,\n \"builtin\": 0,\n \"permissions\": []\n }\n}"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/roles/update","name":"update","apis":[{"api_url":"/api/roles/:id","http_method":"PUT","short_description":"Update a role","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"role","full_name":"role","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"role[name]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}]}],"examples":["PUT /api/roles/1\n{\n \"role\": {}\n}\n200\n{\n \"role\": {\n \"name\": \"Manager\",\n \"id\": 1,\n \"builtin\": 0,\n \"permissions\": [\n \"view_architectures\",\n \"create_architectures\",\n \"edit_architectures\",\n \"destroy_architectures\",\n \"view_authenticators\",\n \"create_authenticators\",\n \"edit_authenticators\",\n \"destroy_authenticators\",\n \"view_environments\",\n \"create_environments\",\n \"edit_environments\",\n \"destroy_environments\",\n \"import_environments\",\n \"view_external_variables\",\n \"create_external_variables\",\n \"edit_external_variables\",\n \"destroy_external_variables\",\n \"view_domains\",\n \"create_domain\",\n \"edit_domains\",\n \"destroy_domains\",\n \"view_globals\",\n \"create_globals\",\n \"edit_globals\",\n \"destroy_globals\",\n \"view_hostgroups\",\n \"create_hostgroups\",\n \"edit_hostgroups\",\n \"destroy_hostgroups\",\n \"view_hosts\",\n \"create_hosts\",\n \"edit_hosts\",\n \"destroy_hosts\",\n \"view_media\",\n \"create_media\",\n \"edit_media\",\n \"destroy_media\",\n \"view_models\",\n \"create_models\",\n \"edit_models\",\n \"destroy_models\",\n \"view_operatingsystems\",\n \"create_operatingsystems\",\n \"edit_operatingsystems\",\n \"destroy_operatingsystems\",\n \"view_ptables\",\n \"create_ptables\",\n \"edit_ptables\",\n \"destroy_ptables\",\n \"view_puppetclasses\",\n \"create_puppetclasses\",\n \"edit_puppetclasses\",\n \"destroy_puppetclasses\",\n \"import_puppetclasses\",\n \"view_usergroups\",\n \"create_usergroups\",\n \"edit_usergroups\",\n \"destroy_usergroups\",\n \"view_users\",\n \"create_users\",\n \"edit_users\",\n \"destroy_users\",\n \"access_settings\",\n \"access_dashboard\",\n \"view_reports\",\n \"destroy_reports\",\n \"view_facts\",\n \"view_audit_logs\",\n \"view_statistics\",\n \"view_locations\",\n \"edit_locations\",\n \"create_locations\",\n \"destroy_locations\",\n \"view_organizations\",\n \"edit_organizations\",\n \"create_organizations\",\n \"destroy_organizations\"\n ]\n }\n}"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/roles/destroy","name":"destroy","apis":[{"api_url":"/api/roles/:id","http_method":"DELETE","short_description":"Delete a role","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["DELETE /api/roles/1\n200\n{\n \"role\": {\n \"name\": \"Manager\",\n \"id\": 1,\n \"builtin\": 0,\n \"permissions\": [\n \"view_architectures\",\n \"create_architectures\",\n \"edit_architectures\",\n \"destroy_architectures\",\n \"view_authenticators\",\n \"create_authenticators\",\n \"edit_authenticators\",\n \"destroy_authenticators\",\n \"view_environments\",\n \"create_environments\",\n \"edit_environments\",\n \"destroy_environments\",\n \"import_environments\",\n \"view_external_variables\",\n \"create_external_variables\",\n \"edit_external_variables\",\n \"destroy_external_variables\",\n \"view_domains\",\n \"create_domain\",\n \"edit_domains\",\n \"destroy_domains\",\n \"view_globals\",\n \"create_globals\",\n \"edit_globals\",\n \"destroy_globals\",\n \"view_hostgroups\",\n \"create_hostgroups\",\n \"edit_hostgroups\",\n \"destroy_hostgroups\",\n \"view_hosts\",\n \"create_hosts\",\n \"edit_hosts\",\n \"destroy_hosts\",\n \"view_media\",\n \"create_media\",\n \"edit_media\",\n \"destroy_media\",\n \"view_models\",\n \"create_models\",\n \"edit_models\",\n \"destroy_models\",\n \"view_operatingsystems\",\n \"create_operatingsystems\",\n \"edit_operatingsystems\",\n \"destroy_operatingsystems\",\n \"view_ptables\",\n \"create_ptables\",\n \"edit_ptables\",\n \"destroy_ptables\",\n \"view_puppetclasses\",\n \"create_puppetclasses\",\n \"edit_puppetclasses\",\n \"destroy_puppetclasses\",\n \"import_puppetclasses\",\n \"view_usergroups\",\n \"create_usergroups\",\n \"edit_usergroups\",\n \"destroy_usergroups\",\n \"view_users\",\n \"create_users\",\n \"edit_users\",\n \"destroy_users\",\n \"access_settings\",\n \"access_dashboard\",\n \"view_reports\",\n \"destroy_reports\",\n \"view_facts\",\n \"view_audit_logs\",\n \"view_statistics\",\n \"view_locations\",\n \"edit_locations\",\n \"create_locations\",\n \"destroy_locations\",\n \"view_organizations\",\n \"edit_organizations\",\n \"create_organizations\",\n \"destroy_organizations\"\n ]\n }\n}"],"metadata":null,"see":[]}]},"operatingsystems":{"doc_url":"../apidoc/v2/operatingsystems","api_url":"/api","name":"Operating systems","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/operatingsystems/index","name":"index","apis":[{"api_url":"/api/operatingsystems","http_method":"GET","short_description":"List all operating systems","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"\n

filter results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n

sort results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n

paginate results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n

number of entries per request

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/operatingsystems/show","name":"show","apis":[{"api_url":"/api/operatingsystems/:id","http_method":"GET","short_description":"Show an OS","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/operatingsystems/1073012828\n200\n{\n \"operatingsystem\": {\n \"name\": \"Redhat\",\n \"minor\": \"1\",\n \"id\": 1073012828,\n \"family\": \"Redhat\",\n \"ptables\": [\n {\n \"ptable\": {\n \"name\": \"default\",\n \"id\": 980190962\n }\n }\n ],\n \"os_default_templates\": [],\n \"architectures\": [\n {\n \"architecture\": {\n \"name\": \"x86_64\",\n \"id\": 501905019\n }\n }\n ],\n \"config_templates\": [\n {\n \"config_template\": {\n \"name\": \"centos5_3_pxelinux\",\n \"id\": 1007981701\n }\n },\n {\n \"config_template\": {\n \"name\": \"MyFinish\",\n \"id\": 104314179\n }\n },\n {\n \"config_template\": {\n \"name\": \"MyScript\",\n \"id\": 981457253\n }\n },\n {\n \"config_template\": {\n \"name\": \"MyString\",\n \"id\": 943779058\n }\n },\n {\n \"config_template\": {\n \"name\": \"MyString2\",\n \"id\": 269958254\n }\n },\n {\n \"config_template\": {\n \"name\": \"PXE Default File\",\n \"id\": 352050261\n }\n },\n {\n \"config_template\": {\n \"name\": \"PXE Localboot Default\",\n \"id\": 821548108\n }\n }\n ],\n \"release_name\": null,\n \"major\": \"6\",\n \"media\": [\n {\n \"medium\": {\n \"name\": \"CentOS 5.4\",\n \"id\": 980190962\n }\n }\n ]\n }\n}"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/operatingsystems/create","name":"create","apis":[{"api_url":"/api/operatingsystems","http_method":"POST","short_description":"Create an OS","deprecated":null}],"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","metadata":null,"show":true,"params":[{"name":"name","full_name":"operatingsystem[name]","description":"","required":true,"allow_nil":false,"validator":"Must match regular expression /\\A(\\S+)\\Z/.","expected_type":"string","metadata":null,"show":true},{"name":"major","full_name":"operatingsystem[major]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"minor","full_name":"operatingsystem[minor]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"description","full_name":"operatingsystem[description]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"family","full_name":"operatingsystem[family]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"release_name","full_name":"operatingsystem[release_name]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}]}],"examples":["POST /api/operatingsystems\n{\n \"operatingsystem\": {\n \"minor\": \"2\",\n \"name\": \"awsome_os\",\n \"major\": \"1\"\n }\n}\n200\n{\n \"operatingsystem\": {\n \"name\": \"awsome_os\",\n \"minor\": \"2\",\n \"id\": 1073012829,\n \"family\": null,\n \"ptables\": [],\n \"os_default_templates\": [],\n \"release_name\": null,\n \"config_templates\": [],\n \"architectures\": [],\n \"major\": \"1\",\n \"media\": []\n }\n}"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/operatingsystems/update","name":"update","apis":[{"api_url":"/api/operatingsystems/:id","http_method":"PUT","short_description":"Update an OS","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"operatingsystem","full_name":"operatingsystem","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"operatingsystem[name]","description":"","required":false,"allow_nil":false,"validator":"Must match regular expression /\\A(\\S+)\\Z/.","expected_type":"string","metadata":null,"show":true},{"name":"major","full_name":"operatingsystem[major]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"minor","full_name":"operatingsystem[minor]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"description","full_name":"operatingsystem[description]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"family","full_name":"operatingsystem[family]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"release_name","full_name":"operatingsystem[release_name]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}]}],"examples":["PUT /api/operatingsystems/1073012828\n{\n \"operatingsystem\": {\n \"name\": \"new_name\"\n }\n}\n200\n{\n \"operatingsystem\": {\n \"name\": \"new_name\",\n \"minor\": \"1\",\n \"id\": 1073012828,\n \"family\": \"Redhat\",\n \"ptables\": [\n {\n \"ptable\": {\n \"name\": \"default\",\n \"id\": 980190962\n }\n }\n ],\n \"os_default_templates\": [],\n \"config_templates\": [\n {\n \"config_template\": {\n \"name\": \"centos5_3_pxelinux\",\n \"id\": 1007981701\n }\n },\n {\n \"config_template\": {\n \"name\": \"MyFinish\",\n \"id\": 104314179\n }\n },\n {\n \"config_template\": {\n \"name\": \"MyScript\",\n \"id\": 981457253\n }\n },\n {\n \"config_template\": {\n \"name\": \"MyString\",\n \"id\": 943779058\n }\n },\n {\n \"config_template\": {\n \"name\": \"MyString2\",\n \"id\": 269958254\n }\n },\n {\n \"config_template\": {\n \"name\": \"PXE Default File\",\n \"id\": 352050261\n }\n },\n {\n \"config_template\": {\n \"name\": \"PXE Localboot Default\",\n \"id\": 821548108\n }\n }\n ],\n \"architectures\": [\n {\n \"architecture\": {\n \"name\": \"x86_64\",\n \"id\": 501905019\n }\n }\n ],\n \"release_name\": null,\n \"media\": [\n {\n \"medium\": {\n \"name\": \"CentOS 5.4\",\n \"id\": 980190962\n }\n }\n ],\n \"major\": \"6\"\n }\n}"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/operatingsystems/destroy","name":"destroy","apis":[{"api_url":"/api/operatingsystems/:id","http_method":"DELETE","short_description":"Delete an OS","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["DELETE /api/operatingsystems/775246587\n200\n{\n \"operatingsystem\": {\n \"name\": \"NoHosts 1.1\",\n \"id\": 775246587,\n \"ptables\": [],\n \"architectures\": [],\n \"config_templates\": [],\n \"media\": []\n }\n}"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/operatingsystems/bootfiles","name":"bootfiles","apis":[{"api_url":"/api/operatingsystems/:id/bootfiles","http_method":"GET","short_description":"List boot files for an OS","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"medium","full_name":"medium","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"architecture","full_name":"architecture","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[]}]},"compute_profiles":{"doc_url":"../apidoc/v2/compute_profiles","api_url":"/api","name":"Compute profiles","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/compute_profiles/index","name":"index","apis":[{"api_url":"/api/compute_profiles","http_method":"GET","short_description":"List of compute profiles","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"\n

filter results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n

sort results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n

paginate results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n

number of entries per request

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/compute_profiles/show","name":"show","apis":[{"api_url":"/api/compute_profiles/:id","http_method":"GET","short_description":"Show a compute profile","deprecated":null}],"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","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/compute_profiles/create","name":"create","apis":[{"api_url":"/api/compute_profiles","http_method":"POST","short_description":"Create a compute profile","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"compute_profile","full_name":"compute_profile","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"compute_profile[name]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/compute_profiles/update","name":"update","apis":[{"api_url":"/api/compute_profiles/:id","http_method":"PUT","short_description":"Update a compute profile","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"compute_profile","full_name":"compute_profile","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"compute_profile[name]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/compute_profiles/destroy","name":"destroy","apis":[{"api_url":"/api/compute_profiles/:id","http_method":"DELETE","short_description":"Delete a compute profile","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[]}]},"domains":{"doc_url":"../apidoc/v2/domains","api_url":"/api","name":"Domains","short_description":null,"full_description":"\n

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.

\n","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/domains/index","name":"index","apis":[{"api_url":"/api/domains","http_method":"GET","short_description":"List of domains","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n

Scope by locations

\n","required":false,"allow_nil":false,"validator":"Must be Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"organization_id","full_name":"organization_id","description":"\n

Scope by organizations

\n","required":false,"allow_nil":false,"validator":"Must be Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"search","full_name":"search","description":"\n

filter results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n

sort results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n

paginate results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n

number of entries per request

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/domains\n200\n[\n {\n \"domain\": {\n \"name\": \"mydomain.net\",\n \"id\": 22495316,\n \"dns_id\": 113629430,\n \"fullname\": null,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"created_at\": \"2012-12-18T15:24:43Z\"\n }\n },\n {\n \"domain\": {\n \"name\": \"unused.net\",\n \"id\": 759776763,\n \"dns_id\": 113629430,\n \"fullname\": \"somewhare that is never used\",\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"created_at\": \"2012-12-18T15:24:43Z\"\n }\n },\n {\n \"domain\": {\n \"name\": \"useless.net\",\n \"id\": 229305443,\n \"dns_id\": null,\n \"fullname\": null,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"created_at\": \"2012-12-18T15:24:43Z\"\n }\n },\n {\n \"domain\": {\n \"name\": \"yourdomain.net\",\n \"id\": 589326610,\n \"dns_id\": 113629430,\n \"fullname\": \"somewhere in yourdomain\",\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"created_at\": \"2012-12-18T15:24:43Z\"\n }\n }\n]"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/domains/show","name":"show","apis":[{"api_url":"/api/domains/:id","http_method":"GET","short_description":"Show a domain","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n

Numerical ID or domain name

\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","metadata":null,"show":true}],"examples":["GET /api/domains/mydomain.net\n200\n{\n \"domain\": {\n \"name\": \"mydomain.net\",\n \"id\": 22495316,\n \"dns_id\": 113629430,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"fullname\": null,\n \"created_at\": \"2012-12-18T15:24:43Z\"\n }\n}"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/domains/create","name":"create","apis":[{"api_url":"/api/domains","http_method":"POST","short_description":"Create a domain","deprecated":null}],"formats":null,"full_description":"\n

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

\n","errors":[],"params":[{"name":"domain","full_name":"domain","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"domain[name]","description":"\n

The full DNS domain name

\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"fullname","full_name":"domain[fullname]","description":"\n

Description of the domain

\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"dns_id","full_name":"domain[dns_id]","description":"\n

DNS proxy to use within this domain

\n","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"domain_parameters_attributes","full_name":"domain[domain_parameters_attributes]","description":"\n

Array of parameters (name, value)

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"location_ids","full_name":"domain[location_ids]","description":"\n

REPLACE locations with given ids

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"organization_ids","full_name":"domain[organization_ids]","description":"\n

REPLACE organizations with given ids.

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":["POST /api/domains\n{\n \"domain\": {\n \"name\": \"domain.net\"\n }\n}\n201\n{\n \"domain\": {\n \"name\": \"domain.net\",\n \"id\": 759776764\n }\n}"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/domains/update","name":"update","apis":[{"api_url":"/api/domains/:id","http_method":"PUT","short_description":"Update a domain","deprecated":null}],"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","metadata":null,"show":true},{"name":"domain","full_name":"domain","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"domain[name]","description":"\n

The full DNS domain name

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"fullname","full_name":"domain[fullname]","description":"\n

Description of the domain

\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"dns_id","full_name":"domain[dns_id]","description":"\n

DNS proxy to use within this domain

\n","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"domain_parameters_attributes","full_name":"domain[domain_parameters_attributes]","description":"\n

Array of parameters (name, value)

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"location_ids","full_name":"domain[location_ids]","description":"\n

REPLACE locations with given ids

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"organization_ids","full_name":"domain[organization_ids]","description":"\n

REPLACE organizations with given ids.

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":["PUT /api/domains/mydomain.net\n{\n \"domain\": {\n \"name\": \"\"\n }\n}\n422\n{\n \"domain\": {\n \"id\": 22495316,\n \"errors\": {\n \"name\": [\n \"can't be blank\"\n ]\n },\n \"full_messages\": [\n \"Name can't be blank\"\n ]\n }\n}"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/domains/destroy","name":"destroy","apis":[{"api_url":"/api/domains/:id","http_method":"DELETE","short_description":"Delete a domain","deprecated":null}],"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","metadata":null,"show":true}],"examples":["DELETE /api/domains/mydomain.net\n200\n{\n \"domain\": {\n \"name\": \"mydomain.net\",\n \"id\": 22495316\n }\n}"],"metadata":null,"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,"metadata":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","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n

Scope by locations

\n","required":false,"allow_nil":false,"validator":"Must be Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"organization_id","full_name":"organization_id","description":"\n

Scope by organizations

\n","required":false,"allow_nil":false,"validator":"Must be Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"search","full_name":"search","description":"\n

filter results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n

sort results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n

paginate results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n

number of entries per request

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/compute_resources\n200\n[\n {\n \"compute_resource\": {\n \"name\": \"mycompute\",\n \"url\": \"test:///default\",\n \"user\": \"MyString\",\n \"provider\": \"Libvirt\",\n \"id\": 367690737,\n \"description\": \"mycompute\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"created_at\": \"2012-12-18T15:24:42Z\"\n }\n },\n {\n \"compute_resource\": {\n \"name\": \"MyString\",\n \"url\": \"qemu://stam/system\",\n \"user\": \"MyString\",\n \"provider\": \"Libvirt\",\n \"id\": 980190962,\n \"description\": \"MyString\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"created_at\": \"2012-12-18T15:24:42Z\"\n }\n },\n {\n \"compute_resource\": {\n \"name\": \"yourcompute\",\n \"url\": \"test:///default\",\n \"user\": \"MyString\",\n \"provider\": \"Libvirt\",\n \"id\": 932571420,\n \"description\": \"yourcompute\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"created_at\": \"2012-12-18T15:24:42Z\"\n }\n }\n]"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/compute_resources/show","name":"show","apis":[{"api_url":"/api/compute_resources/:id","http_method":"GET","short_description":"Show a compute resource","deprecated":null}],"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","metadata":null,"show":true}],"examples":["GET /api/compute_resources/980190962-mystring\n200\n{\n \"compute_resource\": {\n \"name\": \"MyString\",\n \"url\": \"qemu://stam/system\",\n \"user\": \"MyString\",\n \"provider\": \"Libvirt\",\n \"id\": 980190962,\n \"description\": \"MyString\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"created_at\": \"2012-12-18T15:24:42Z\"\n }\n}"],"metadata":null,"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","deprecated":null}],"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","metadata":null,"show":true,"params":[{"name":"name","full_name":"compute_resource[name]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"provider","full_name":"compute_resource[provider]","description":"\n

Providers include %{providers}

\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"url","full_name":"compute_resource[url]","description":"\n

URL for Libvirt, Ovirt, and Openstack

\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"description","full_name":"compute_resource[description]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"user","full_name":"compute_resource[user]","description":"\n

Username for Ovirt, EC2, Vmware, Openstack. Access Key for EC2.

\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"password","full_name":"compute_resource[password]","description":"\n

Password for Ovirt, EC2, Vmware, Openstack. Secret key for EC2

\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"uuid","full_name":"compute_resource[uuid]","description":"\n

for Ovirt, Vmware Datacenter

\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"region","full_name":"compute_resource[region]","description":"\n

for EC2 only

\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"tenant","full_name":"compute_resource[tenant]","description":"\n

for Openstack only

\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"server","full_name":"compute_resource[server]","description":"\n

for Vmware

\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"set_console_password","full_name":"compute_resource[set_console_password]","description":"\n

for Libvirt and Vmware only

\n","required":false,"allow_nil":true,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true},{"name":"location_ids","full_name":"compute_resource[location_ids]","description":"\n

REPLACE locations with given ids

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"organization_ids","full_name":"compute_resource[organization_ids]","description":"\n

REPLACE organizations with given ids.

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":["POST /api/compute_resources\n{\n \"compute_resource\": {\n \"name\": \"special_compute\",\n \"user\": \"user@example.com\",\n \"provider\": \"EC2\",\n \"password\": \"secret\",\n \"region\": \"eu-west-1\"\n }\n}\n200\n{\n \"compute_resource\": {\n \"name\": \"special_compute\",\n \"url\": \"eu-west-1\",\n \"user\": \"user@example.com\",\n \"provider\": \"EC2\",\n \"id\": 980190963,\n \"description\": null,\n \"updated_at\": \"2012-12-18T15:24:44Z\",\n \"created_at\": \"2012-12-18T15:24:44Z\"\n }\n}"],"metadata":null,"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","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"compute_resource","full_name":"compute_resource","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"compute_resource[name]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"provider","full_name":"compute_resource[provider]","description":"\n

Providers include %{providers}

\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"url","full_name":"compute_resource[url]","description":"\n

URL for Libvirt, Ovirt, and Openstack

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"description","full_name":"compute_resource[description]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"user","full_name":"compute_resource[user]","description":"\n

Username for Ovirt, EC2, Vmware, Openstack. Access Key for EC2.

\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"password","full_name":"compute_resource[password]","description":"\n

Password for Ovirt, EC2, Vmware, Openstack. Secret key for EC2

\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"uuid","full_name":"compute_resource[uuid]","description":"\n

for Ovirt, Vmware Datacenter

\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"region","full_name":"compute_resource[region]","description":"\n

for EC2 only

\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"tenant","full_name":"compute_resource[tenant]","description":"\n

for Openstack only

\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"server","full_name":"compute_resource[server]","description":"\n

for Vmware

\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"set_console_password","full_name":"compute_resource[set_console_password]","description":"\n

for Libvirt and Vmware only

\n","required":false,"allow_nil":true,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true},{"name":"location_ids","full_name":"compute_resource[location_ids]","description":"\n

REPLACE locations with given ids

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"organization_ids","full_name":"compute_resource[organization_ids]","description":"\n

REPLACE organizations with given ids.

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":["PUT /api/compute_resources/367690737-mycompute\n{\n \"compute_resource\": {\n \"description\": \"new_description\"\n }\n}\n200\n{\n \"compute_resource\": {\n \"url\": \"test:///default\",\n \"name\": \"mycompute\",\n \"user\": \"MyString\",\n \"id\": 367690737,\n \"uuid\": \"mycompute\",\n \"updated_at\": \"2012-12-18T15:24:45Z\",\n \"description\": \"new_description\",\n \"attrs\": {},\n \"created_at\": \"2012-12-18T15:24:42Z\"\n }\n}"],"metadata":null,"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","deprecated":null}],"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","metadata":null,"show":true}],"examples":["DELETE /api/compute_resources/932571420\n200\n{\n \"compute_resource\": {\n \"url\": \"test:///default\",\n \"name\": \"yourcompute\",\n \"user\": \"MyString\",\n \"id\": 932571420,\n \"uuid\": \"yourcompute\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"description\": \"yourcompute\",\n \"attrs\": null,\n \"created_at\": \"2012-12-18T15:24:42Z\"\n }\n}"],"metadata":null,"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","deprecated":null}],"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","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/compute_resources/available_clusters","name":"available_clusters","apis":[{"api_url":"/api/compute_resources/:id/available_clusters","http_method":"GET","short_description":"List available clusters for a compute resource","deprecated":null}],"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","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/compute_resources/available_folders","name":"available_folders","apis":[{"api_url":"/api/compute_resources/:id/available_folders","http_method":"GET","short_description":"List available folders for a compute resource","deprecated":null}],"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","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/compute_resources/available_networks","name":"available_networks","apis":[{"api_url":"/api/compute_resources/:id/available_networks","http_method":"GET","short_description":"List available networks for a compute resource","deprecated":null},{"api_url":"/api/compute_resources/:id/available_clusters/:cluster_id/available_networks","http_method":"GET","short_description":"List available networks for a compute resource cluster","deprecated":null}],"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","metadata":null,"show":true},{"name":"cluster_id","full_name":"cluster_id","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/compute_resources/available_resource_pools","name":"available_resource_pools","apis":[{"api_url":"/api/compute_resources/:id/available_clusters/:cluster_id/available_resource_pools","http_method":"GET","short_description":"List resource pools for a compute resource cluster","deprecated":null}],"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","metadata":null,"show":true},{"name":"cluster_id","full_name":"cluster_id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/compute_resources/available_storage_domains","name":"available_storage_domains","apis":[{"api_url":"/api/compute_resources/:id/available_storage_domains","http_method":"GET","short_description":"List storage_domains for a compute resource","deprecated":null},{"api_url":"/api/compute_resources/:id/available_storage_domains","http_method":"GET","short_description":"List storage domains for a compute resource","deprecated":null},{"api_url":"/api/compute_resources/:id/available_storage_domains/:storage_domain","http_method":"GET","short_description":"List attributes for a given storage domain","deprecated":null}],"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","metadata":null,"show":true},{"name":"storage_domain","full_name":"storage_domain","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/compute_resources/associate","name":"associate","apis":[{"api_url":"/api/compute_resources/:id/associate","http_method":"PUT","short_description":"Associate VMs to Hosts","deprecated":null}],"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","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[]}]},"images":{"doc_url":"../apidoc/v2/images","api_url":"/api","name":"Images","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":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 a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"\n

filter results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n

sort results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n

paginate results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n

number of entries per request

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"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","metadata":null,"show":true}],"examples":["GET /api/compute_resources/980190962/images\n200\n[\n {\n \"image\": {\n \"name\": \"centos-2\",\n \"id\": 298486374,\n \"uuid\": \"MyString2\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"operatingsystem_id\": 309172073,\n \"username\": \"MyString\",\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"architecture_id\": 501905019,\n \"compute_resource_id\": 980190962\n }\n },\n {\n \"image\": {\n \"name\": \"centos-1\",\n \"id\": 980190962,\n \"uuid\": \"string-of-uuid\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"operatingsystem_id\": 309172073,\n \"username\": \"root\",\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"architecture_id\": 501905019,\n \"compute_resource_id\": 980190962\n }\n }\n]"],"metadata":null,"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","deprecated":null}],"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","metadata":null,"show":true},{"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","metadata":null,"show":true}],"examples":["GET /api/compute_resources/980190962/images/980190962\n200\n{\n \"image\": {\n \"name\": \"centos-1\",\n \"id\": 980190962,\n \"uuid\": \"string-of-uuid\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"operatingsystem_id\": 309172073,\n \"username\": \"root\",\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"architecture_id\": 501905019,\n \"compute_resource_id\": 980190962\n }\n}"],"metadata":null,"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 an image","deprecated":null}],"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","metadata":null,"show":true},{"name":"image","full_name":"image","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"image[name]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"username","full_name":"image[username]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"uuid","full_name":"image[uuid]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"compute_resource_id","full_name":"image[compute_resource_id]","description":"","required":true,"allow_nil":false,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"architecture_id","full_name":"image[architecture_id]","description":"","required":true,"allow_nil":false,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"operatingsystem_id","full_name":"image[operatingsystem_id]","description":"","required":true,"allow_nil":false,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true}]}],"examples":["POST /api/compute_resources/980190962/images\n{\n \"image\": {\n \"name\": \"TestImage\",\n \"uuid\": \"abcdef\",\n \"username\": \"ec2-user\",\n \"operatingsystem_id\": 309172073,\n \"compute_resource_id\": 367690737,\n \"architecture_id\": 381564594\n }\n}\n201\n{\n \"compute_resource\": {\n \"url\": \"qemu://stam/system\",\n \"name\": \"MyString\",\n \"user\": \"MyString\",\n \"id\": 980190962,\n \"uuid\": \"MyString\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"description\": \"MyString\",\n \"attrs\": null,\n \"created_at\": \"2012-12-18T15:24:42Z\"\n }\n}"],"metadata":null,"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 an image","deprecated":null}],"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","metadata":null,"show":true},{"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","metadata":null,"show":true},{"name":"image","full_name":"image","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"image[name]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"username","full_name":"image[username]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"uuid","full_name":"image[uuid]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"compute_resource_id","full_name":"image[compute_resource_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"architecture_id","full_name":"image[architecture_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"operatingsystem_id","full_name":"image[operatingsystem_id]","description":"","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true}]}],"examples":["PUT /api/compute_resources/980190962/images/980190962\n{\n \"image\": {}\n}\n200\n{\n \"image\": {\n \"name\": \"centos-1\",\n \"id\": 980190962,\n \"uuid\": \"string-of-uuid\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"username\": \"root\",\n \"operatingsystem_id\": 309172073,\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"compute_resource_id\": 980190962,\n \"architecture_id\": 501905019\n }\n}"],"metadata":null,"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","deprecated":null}],"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","metadata":null,"show":true},{"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","metadata":null,"show":true}],"examples":["DELETE /api/compute_resources/980190962/images/980190962\n200\n{\n \"image\": {\n \"name\": \"centos-1\",\n \"id\": 980190962,\n \"uuid\": \"string-of-uuid\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"username\": \"root\",\n \"operatingsystem_id\": 309172073,\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"compute_resource_id\": 980190962,\n \"architecture_id\": 501905019\n }\n}"],"metadata":null,"see":[]}]},"os_default_templates":{"doc_url":"../apidoc/v2/os_default_templates","api_url":"/api","name":"Os default templates","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/os_default_templates/index","name":"index","apis":[{"api_url":"/api/operatingsystems/:operatingsystem_id/os_default_templates","http_method":"GET","short_description":"List default templates combinations for an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n

ID of operating system

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n

paginate results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n

number of entries per request

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/os_default_templates/show","name":"show","apis":[{"api_url":"/api/operatingsystems/:operatingsystem_id/os_default_templates/:id","http_method":"GET","short_description":"Show a default template combination for an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n

ID of operating system

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/os_default_templates/create","name":"create","apis":[{"api_url":"/api/operatingsystems/:operatingsystem_id/os_default_templates","http_method":"POST","short_description":"Create a default template combination for an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n

ID of operating system

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"os_default_template","full_name":"os_default_template","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"template_kind_id","full_name":"os_default_template[template_kind_id]","description":"","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"config_template_id","full_name":"os_default_template[config_template_id]","description":"","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/os_default_templates/update","name":"update","apis":[{"api_url":"/api/operatingsystems/:operatingsystem_id/os_default_templates/:id","http_method":"PUT","short_description":"Update a default template combination for an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n

ID of operating system

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"os_default_template","full_name":"os_default_template","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"template_kind_id","full_name":"os_default_template[template_kind_id]","description":"","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"config_template_id","full_name":"os_default_template[config_template_id]","description":"","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/os_default_templates/destroy","name":"destroy","apis":[{"api_url":"/api/operatingsystems/:operatingsystem_id/os_default_templates/:id","http_method":"DELETE","short_description":"Delete a default template combination for an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n

ID of operating system

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"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,"metadata":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 LDAP authentication sources","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"page","full_name":"page","description":"\n

paginate results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n

number of entries per request

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/auth_source_ldaps\n200\n[\n {\n \"auth_source_ldap\": {\n \"name\": \"ldap\",\n \"attr_lastname\": \"sn\",\n \"port\": 123,\n \"attr_firstname\": \"givenName\",\n \"attr_login\": \"uid\",\n \"tls\": true,\n \"id\": 980190962,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"host\": \"ldap\",\n \"base_dn\": \"dn=x,dn=y\",\n \"attr_mail\": \"mail\",\n \"account\": null,\n \"type\": \"AuthSourceLdap\",\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"onthefly_register\": true\n }\n }\n]"],"metadata":null,"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 LDAP authentication source","deprecated":null}],"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","metadata":null,"show":true}],"examples":["GET /api/auth_source_ldaps/980190962\n200\n{\n \"auth_source_ldap\": {\n \"name\": \"ldap\",\n \"attr_lastname\": \"sn\",\n \"attr_firstname\": \"givenName\",\n \"port\": 123,\n \"attr_login\": \"uid\",\n \"tls\": true,\n \"id\": 980190962,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"host\": \"ldap\",\n \"base_dn\": \"dn=x,dn=y\",\n \"attr_mail\": \"mail\",\n \"account\": null,\n \"type\": \"AuthSourceLdap\",\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"onthefly_register\": true\n }\n}"],"metadata":null,"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 LDAP authentication source","deprecated":null}],"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","metadata":null,"show":true,"params":[{"name":"name","full_name":"auth_source_ldap[name]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"host","full_name":"auth_source_ldap[host]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"port","full_name":"auth_source_ldap[port]","description":"\n

defaults to 389

\n","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"account","full_name":"auth_source_ldap[account]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"base_dn","full_name":"auth_source_ldap[base_dn]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"account_password","full_name":"auth_source_ldap[account_password]","description":"\n

required if onthefly_register is true

\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"attr_login","full_name":"auth_source_ldap[attr_login]","description":"\n

required if onthefly_register is true

\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"attr_firstname","full_name":"auth_source_ldap[attr_firstname]","description":"\n

required if onthefly_register is true

\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"attr_lastname","full_name":"auth_source_ldap[attr_lastname]","description":"\n

required if onthefly_register is true

\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"attr_mail","full_name":"auth_source_ldap[attr_mail]","description":"\n

required if onthefly_register is true

\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"attr_photo","full_name":"auth_source_ldap[attr_photo]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"onthefly_register","full_name":"auth_source_ldap[onthefly_register]","description":"","required":false,"allow_nil":true,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true},{"name":"tls","full_name":"auth_source_ldap[tls]","description":"","required":false,"allow_nil":true,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true}]}],"examples":["POST /api/auth_source_ldaps\n{\n \"auth_source_ldap\": {\n \"name\": \"ldap2\",\n \"host\": \"ldap2\"\n }\n}\n201\n{\n \"auth_source_ldap\": {\n \"name\": \"ldap2\",\n \"tls\": false,\n \"port\": 389,\n \"attr_login\": null,\n \"attr_lastname\": null,\n \"attr_firstname\": null,\n \"id\": 980190963,\n \"updated_at\": \"2012-12-18T15:24:44Z\",\n \"host\": \"ldap2\",\n \"base_dn\": null,\n \"attr_mail\": null,\n \"account_password\": null,\n \"account\": null,\n \"onthefly_register\": false,\n \"created_at\": \"2012-12-18T15:24:44Z\"\n }\n}"],"metadata":null,"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 LDAP authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"auth_source_ldap","full_name":"auth_source_ldap","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"auth_source_ldap[name]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"host","full_name":"auth_source_ldap[host]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"port","full_name":"auth_source_ldap[port]","description":"\n

defaults to 389

\n","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"account","full_name":"auth_source_ldap[account]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"base_dn","full_name":"auth_source_ldap[base_dn]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"account_password","full_name":"auth_source_ldap[account_password]","description":"\n

required if onthefly_register is true

\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"attr_login","full_name":"auth_source_ldap[attr_login]","description":"\n

required if onthefly_register is true

\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"attr_firstname","full_name":"auth_source_ldap[attr_firstname]","description":"\n

required if onthefly_register is true

\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"attr_lastname","full_name":"auth_source_ldap[attr_lastname]","description":"\n

required if onthefly_register is true

\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"attr_mail","full_name":"auth_source_ldap[attr_mail]","description":"\n

required if onthefly_register is true

\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"attr_photo","full_name":"auth_source_ldap[attr_photo]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"onthefly_register","full_name":"auth_source_ldap[onthefly_register]","description":"","required":false,"allow_nil":true,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true},{"name":"tls","full_name":"auth_source_ldap[tls]","description":"","required":false,"allow_nil":true,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true}]}],"examples":["PUT /api/auth_source_ldaps/980190962\n{\n \"auth_source_ldap\": {}\n}\n200\n{\n \"auth_source_ldap\": {\n \"name\": \"ldap\",\n \"tls\": true,\n \"port\": 123,\n \"attr_login\": \"uid\",\n \"attr_lastname\": \"sn\",\n \"attr_firstname\": \"givenName\",\n \"id\": 980190962,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"host\": \"ldap\",\n \"base_dn\": \"dn=x,dn=y\",\n \"attr_mail\": \"mail\",\n \"account_password\": null,\n \"account\": null,\n \"onthefly_register\": true,\n \"created_at\": \"2012-12-18T15:24:43Z\"\n }\n}"],"metadata":null,"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 LDAP authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["DELETE /api/auth_source_ldaps/980190962\n200\n{\n \"auth_source_ldap\": {\n \"name\": \"ldap\",\n \"tls\": true,\n \"port\": 123,\n \"attr_login\": \"uid\",\n \"attr_lastname\": \"sn\",\n \"attr_firstname\": \"givenName\",\n \"id\": 980190962,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"host\": \"ldap\",\n \"base_dn\": \"dn=x,dn=y\",\n \"attr_mail\": \"mail\",\n \"account_password\": null,\n \"account\": null,\n \"onthefly_register\": true,\n \"created_at\": \"2012-12-18T15:24:43Z\"\n }\n}"],"metadata":null,"see":[]}]},"settings":{"doc_url":"../apidoc/v2/settings","api_url":"/api","name":"Settings","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/settings/index","name":"index","apis":[{"api_url":"/api/settings","http_method":"GET","short_description":"List all settings","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"\n

filter results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n

sort results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n

paginate results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n

number of entries per request

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/settings/show","name":"show","apis":[{"api_url":"/api/settings/:id","http_method":"GET","short_description":"Show a setting","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/settings/333972760\n200\n{\n \"setting\": {\n \"name\": \"administrator\",\n \"value\": \"root@some.host.fqdn\",\n \"id\": 333972760,\n \"description\": \"The Default administrator email address\",\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"category\": \"General\",\n \"settings_type\": null,\n \"default\": \"root@some.host.fqdn\",\n \"created_at\": \"2012-12-18T15:24:43Z\"\n }\n}"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/settings/update","name":"update","apis":[{"api_url":"/api/settings/:id","http_method":"PUT","short_description":"Update a setting","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"setting","full_name":"setting","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"value","full_name":"setting[value]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}]}],"examples":["PUT /api/settings/333972760\n{\n \"setting\": {}\n}\n200\n{\n \"setting\": {\n \"name\": \"administrator\",\n \"value\": \"root@some.host.fqdn\",\n \"id\": 333972760,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"description\": \"The Default administrator email address\",\n \"settings_type\": null,\n \"category\": \"General\",\n \"default\": \"root@some.host.fqdn\",\n \"created_at\": \"2012-12-18T15:24:43Z\"\n }\n}"],"metadata":null,"see":[]}]},"filters":{"doc_url":"../apidoc/v2/filters","api_url":"/api","name":"Filters","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/filters/index","name":"index","apis":[{"api_url":"/api/filters","http_method":"GET","short_description":"List all filters","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"\n

filter results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n

sort results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n

paginate results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n

number of entries per request

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/filters/show","name":"show","apis":[{"api_url":"/api/filters/:id","http_method":"GET","short_description":"Show a filter","deprecated":null}],"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","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/filters/create","name":"create","apis":[{"api_url":"/api/filters","http_method":"POST","short_description":"Create a filter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"filter","full_name":"filter","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"role_id","full_name":"filter[role_id]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"search","full_name":"filter[search]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"permission_ids","full_name":"filter[permission_ids]","description":"","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"organization_ids","full_name":"filter[organization_ids]","description":"","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"location_ids","full_name":"filter[location_ids]","description":"","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/filters/update","name":"update","apis":[{"api_url":"/api/filters/:id","http_method":"PUT","short_description":"Update a filter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"filter","full_name":"filter","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"role_id","full_name":"filter[role_id]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"search","full_name":"filter[search]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"permission_ids","full_name":"filter[permission_ids]","description":"","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"organization_ids","full_name":"filter[organization_ids]","description":"","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"location_ids","full_name":"filter[location_ids]","description":"","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/filters/destroy","name":"destroy","apis":[{"api_url":"/api/filters/:id","http_method":"DELETE","short_description":"Delete a filter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[]}]},"subnets":{"doc_url":"../apidoc/v2/subnets","api_url":"/api","name":"Subnets","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/subnets/index","name":"index","apis":[{"api_url":"/api/subnets","http_method":"GET","short_description":"List of subnets","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n

Scope by locations

\n","required":false,"allow_nil":false,"validator":"Must be Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"organization_id","full_name":"organization_id","description":"\n

Scope by organizations

\n","required":false,"allow_nil":false,"validator":"Must be Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"search","full_name":"search","description":"\n

filter results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n

sort results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n

paginate results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n

number of entries per request

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/subnets\n200\n[\n {\n \"subnet\": {\n \"priority\": null,\n \"name\": \"one\",\n \"network\": \"2.3.4.0\",\n \"dns_secondary\": null,\n \"domain_ids\": [\n 822172901\n ],\n \"tftp_id\": 298486374,\n \"id\": 980190962,\n \"dhcp_id\": 980190962,\n \"dns_id\": 113629430,\n \"dns_primary\": null,\n \"vlanid\": \"41\",\n \"mask\": \"255.255.255.0\",\n \"from\": null,\n \"gateway\": null,\n \"to\": null\n }\n },\n {\n \"subnet\": {\n \"priority\": null,\n \"name\": \"two\",\n \"network\": \"3.3.4.0\",\n \"dns_secondary\": null,\n \"domain_ids\": [\n 534821992\n ],\n \"tftp_id\": 298486374,\n \"id\": 298486374,\n \"dhcp_id\": 980190962,\n \"dns_id\": null,\n \"dns_primary\": null,\n \"vlanid\": \"42\",\n \"mask\": \"255.255.255.0\",\n \"from\": null,\n \"gateway\": null,\n \"to\": null\n }\n },\n {\n \"subnet\": {\n \"priority\": null,\n \"name\": \"three\",\n \"network\": \"3.3.4.3\",\n \"dns_secondary\": null,\n \"domain_ids\": [],\n \"tftp_id\": 298486374,\n \"id\": 113629430,\n \"dhcp_id\": 980190962,\n \"dns_id\": null,\n \"dns_primary\": null,\n \"vlanid\": \"43\",\n \"mask\": \"255.255.255.0\",\n \"from\": null,\n \"gateway\": null,\n \"to\": null\n }\n }\n]"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/subnets/show","name":"show","apis":[{"api_url":"/api/subnets/:id","http_method":"GET","short_description":"Show a subnet","deprecated":null}],"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","metadata":null,"show":true}],"examples":["GET /api/subnets/980190962\n200\n{\n \"subnet\": {\n \"priority\": null,\n \"name\": \"one\",\n \"network\": \"2.3.4.0\",\n \"dns\": {\n \"url\": \"http://else.where:4567\",\n \"name\": \"DNS Proxy\",\n \"id\": 113629430\n },\n \"dns_secondary\": null,\n \"domain_ids\": [\n 822172901\n ],\n \"tftp_id\": 298486374,\n \"id\": 980190962,\n \"dhcp_id\": 980190962,\n \"dns_id\": 113629430,\n \"dhcp\": {\n \"url\": \"https://somewhere.net:8443\",\n \"name\": \"DHCP Proxy\",\n \"id\": 980190962\n },\n \"dns_primary\": null,\n \"vlanid\": \"41\",\n \"mask\": \"255.255.255.0\",\n \"tftp\": {\n \"url\": \"http://somewhere.else\",\n \"name\": \"TFTP Proxy\",\n \"id\": 298486374\n },\n \"from\": null,\n \"gateway\": null,\n \"to\": null\n }\n}"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/subnets/create","name":"create","apis":[{"api_url":"/api/subnets","http_method":"POST","short_description":"Create a subnet","deprecated":null}],"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","metadata":null,"show":true,"params":[{"name":"name","full_name":"subnet[name]","description":"\n

Subnet name

\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"network","full_name":"subnet[network]","description":"\n

Subnet network

\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"mask","full_name":"subnet[mask]","description":"\n

Netmask for this subnet

\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"gateway","full_name":"subnet[gateway]","description":"\n

Primary DNS for this subnet

\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"dns_primary","full_name":"subnet[dns_primary]","description":"\n

Primary DNS for this subnet

\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"dns_secondary","full_name":"subnet[dns_secondary]","description":"\n

Secondary DNS for this subnet

\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"ipam","full_name":"subnet[ipam]","description":"\n

IP Address auto suggestion mode for this subnet, valid values are \u201cDHCP\u201d, \u201cInternal DB\u201d, \u201cNone\u201d

\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"from","full_name":"subnet[from]","description":"\n

Starting IP Address for IP auto suggestion

\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"to","full_name":"subnet[to]","description":"\n

Ending IP Address for IP auto suggestion

\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"vlanid","full_name":"subnet[vlanid]","description":"\n

VLAN ID for this subnet

\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"domain_ids","full_name":"subnet[domain_ids]","description":"\n

Domains in which this subnet is part

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"dhcp_id","full_name":"subnet[dhcp_id]","description":"\n

DHCP Proxy to use within this subnet

\n","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"tftp_id","full_name":"subnet[tftp_id]","description":"\n

TFTP Proxy to use within this subnet

\n","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"dns_id","full_name":"subnet[dns_id]","description":"\n

DNS Proxy to use within this subnet

\n","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"boot_mode","full_name":"subnet[boot_mode]","description":"\n

Default boot mode for interfaces assigned to this subnet, valid values are \u201cStatic\u201d, \u201cDHCP\u201d

\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"location_ids","full_name":"subnet[location_ids]","description":"\n

REPLACE locations with given ids

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"organization_ids","full_name":"subnet[organization_ids]","description":"\n

REPLACE organizations with given ids.

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":["POST /api/subnets\n{\n \"subnet\": {\n \"name\": \"QA2\",\n \"network\": \"10.35.2.27\",\n \"mask\": \"255.255.255.0\"\n }\n}\n200\n{\n \"subnet\": {\n \"priority\": null,\n \"name\": \"QA2\",\n \"dns\": null,\n \"network\": \"10.35.2.27\",\n \"dns_secondary\": null,\n \"domain_ids\": [],\n \"id\": 980190963,\n \"tftp_id\": null,\n \"dhcp_id\": null,\n \"dns_id\": null,\n \"dhcp\": null,\n \"dns_primary\": null,\n \"vlanid\": null,\n \"mask\": \"255.255.255.0\",\n \"tftp\": null,\n \"gateway\": null,\n \"from\": null,\n \"to\": null\n }\n}"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/subnets/update","name":"update","apis":[{"api_url":"/api/subnets/:id","http_method":"PUT","short_description":"Update a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n

Subnet numeric identifier

\n","required":true,"allow_nil":false,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"subnet","full_name":"subnet","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"subnet[name]","description":"\n

Subnet name

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"network","full_name":"subnet[network]","description":"\n

Subnet network

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"mask","full_name":"subnet[mask]","description":"\n

Netmask for this subnet

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"gateway","full_name":"subnet[gateway]","description":"\n

Primary DNS for this subnet

\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"dns_primary","full_name":"subnet[dns_primary]","description":"\n

Primary DNS for this subnet

\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"dns_secondary","full_name":"subnet[dns_secondary]","description":"\n

Secondary DNS for this subnet

\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"ipam","full_name":"subnet[ipam]","description":"\n

IP Address auto suggestion mode for this subnet, valid values are \u201cDHCP\u201d, \u201cInternal DB\u201d, \u201cNone\u201d

\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"from","full_name":"subnet[from]","description":"\n

Starting IP Address for IP auto suggestion

\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"to","full_name":"subnet[to]","description":"\n

Ending IP Address for IP auto suggestion

\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"vlanid","full_name":"subnet[vlanid]","description":"\n

VLAN ID for this subnet

\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"domain_ids","full_name":"subnet[domain_ids]","description":"\n

Domains in which this subnet is part

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"dhcp_id","full_name":"subnet[dhcp_id]","description":"\n

DHCP Proxy to use within this subnet

\n","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"tftp_id","full_name":"subnet[tftp_id]","description":"\n

TFTP Proxy to use within this subnet

\n","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"dns_id","full_name":"subnet[dns_id]","description":"\n

DNS Proxy to use within this subnet

\n","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"boot_mode","full_name":"subnet[boot_mode]","description":"\n

Default boot mode for interfaces assigned to this subnet, valid values are \u201cStatic\u201d, \u201cDHCP\u201d

\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"location_ids","full_name":"subnet[location_ids]","description":"\n

REPLACE locations with given ids

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"organization_ids","full_name":"subnet[organization_ids]","description":"\n

REPLACE organizations with given ids.

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":["PUT /api/subnets/980190962\n{\n \"subnet\": {}\n}\n200\n{\n \"subnet\": {\n \"priority\": null,\n \"name\": \"one\",\n \"dns\": {\n \"url\": \"http://else.where:4567\",\n \"name\": \"DNS Proxy\",\n \"id\": 113629430\n },\n \"network\": \"2.3.4.0\",\n \"dns_secondary\": null,\n \"domain_ids\": [\n 822172901\n ],\n \"id\": 980190962,\n \"tftp_id\": 298486374,\n \"dhcp_id\": 980190962,\n \"dns_id\": 113629430,\n \"dhcp\": {\n \"url\": \"https://somewhere.net:8443\",\n \"name\": \"DHCP Proxy\",\n \"id\": 980190962\n },\n \"dns_primary\": null,\n \"vlanid\": \"41\",\n \"mask\": \"255.255.255.0\",\n \"tftp\": {\n \"url\": \"http://somewhere.else\",\n \"name\": \"TFTP Proxy\",\n \"id\": 298486374\n },\n \"gateway\": null,\n \"from\": null,\n \"to\": null\n }\n}"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/subnets/destroy","name":"destroy","apis":[{"api_url":"/api/subnets/:id","http_method":"DELETE","short_description":"Delete a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n

Subnet numeric identifier

\n","required":true,"allow_nil":false,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true}],"examples":["DELETE /api/subnets/980190962\n422\n{\n \"subnet\": {\n \"id\": 980190962,\n \"errors\": {\n \"base\": [\n \"2.3.4.0/24 is used by temp-01.yourdomain.net\",\n \"2.3.4.0/24 is used by suse01.yourdomain.net\",\n \"2.3.4.0/24 is used by temp01.yourdomain.net\",\n \"2.3.4.0/24 is used by anotherfullhost\",\n \"2.3.4.0/24 is used by temp.yourdomain.net\",\n \"2.3.4.0/24 is used by my5name.mydomain.net\",\n \"2.3.4.0/24 is used by dhcp.mydomain.net\",\n \"2.3.4.0/24 is used by otherfullhost\",\n \"2.3.4.0/24 is used by sdhcp.mydomain.net\",\n \"2.3.4.0/24 is used by sol10host\",\n \"2.3.4.0/24 is used by sdhcp.mydomain.net\"\n ]\n },\n \"full_messages\": [\n \"2.3.4.0/24 is used by temp-01.yourdomain.net\",\n \"2.3.4.0/24 is used by suse01.yourdomain.net\",\n \"2.3.4.0/24 is used by temp01.yourdomain.net\",\n \"2.3.4.0/24 is used by anotherfullhost\",\n \"2.3.4.0/24 is used by temp.yourdomain.net\",\n \"2.3.4.0/24 is used by my5name.mydomain.net\",\n \"2.3.4.0/24 is used by dhcp.mydomain.net\",\n \"2.3.4.0/24 is used by otherfullhost\",\n \"2.3.4.0/24 is used by sdhcp.mydomain.net\",\n \"2.3.4.0/24 is used by sol10host\",\n \"2.3.4.0/24 is used by sdhcp.mydomain.net\"\n ]\n }\n}"],"metadata":null,"see":[]}]},"locations":{"doc_url":"../apidoc/v2/locations","api_url":"/api","name":"Locations","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/locations/index","name":"index","apis":[{"api_url":"/api/locations","http_method":"GET","short_description":"List all locations","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"\n

filter results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n

sort results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n

paginate results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n

number of entries per request

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/locations/show","name":"show","apis":[{"api_url":"/api/locations/:id","http_method":"GET","short_description":"Show a location","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/locations/create","name":"create","apis":[{"api_url":"/api/locations","http_method":"POST","short_description":"Create a location","deprecated":null}],"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","metadata":null,"show":true,"params":[{"name":"name","full_name":"location[name]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"user_ids","full_name":"location[user_ids]","description":"\n

User IDs

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"smart_proxy_ids","full_name":"location[smart_proxy_ids]","description":"\n

Smart proxy IDs

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"compute_resource_ids","full_name":"location[compute_resource_ids]","description":"\n

Compute resource IDs

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"media_ids","full_name":"location[media_ids]","description":"\n

Media IDs

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"config_template_ids","full_name":"location[config_template_ids]","description":"\n

Provisioning template IDs

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"domain_ids","full_name":"location[domain_ids]","description":"\n

Domain IDs

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"realm_ids","full_name":"location[realm_ids]","description":"\n

Realm IDs

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"hostgroup_ids","full_name":"location[hostgroup_ids]","description":"\n

Host group IDs

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"environment_ids","full_name":"location[environment_ids]","description":"\n

Environment IDs

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"subnet_ids","full_name":"location[subnet_ids]","description":"\n

Subnet IDs

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/locations/update","name":"update","apis":[{"api_url":"/api/locations/:id","http_method":"PUT","short_description":"Update a location","deprecated":null}],"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","metadata":null,"show":true,"params":[{"name":"name","full_name":"location[name]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"user_ids","full_name":"location[user_ids]","description":"\n

User IDs

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"smart_proxy_ids","full_name":"location[smart_proxy_ids]","description":"\n

Smart proxy IDs

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"compute_resource_ids","full_name":"location[compute_resource_ids]","description":"\n

Compute resource IDs

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"media_ids","full_name":"location[media_ids]","description":"\n

Media IDs

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"config_template_ids","full_name":"location[config_template_ids]","description":"\n

Provisioning template IDs

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"domain_ids","full_name":"location[domain_ids]","description":"\n

Domain IDs

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"realm_ids","full_name":"location[realm_ids]","description":"\n

Realm IDs

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"hostgroup_ids","full_name":"location[hostgroup_ids]","description":"\n

Host group IDs

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"environment_ids","full_name":"location[environment_ids]","description":"\n

Environment IDs

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"subnet_ids","full_name":"location[subnet_ids]","description":"\n

Subnet IDs

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/locations/destroy","name":"destroy","apis":[{"api_url":"/api/locations/:id","http_method":"DELETE","short_description":"Delete a location","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"metadata":null,"see":[]}]},"architectures":{"doc_url":"../apidoc/v2/architectures","api_url":"/api","name":"Architectures","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/architectures/index","name":"index","apis":[{"api_url":"/api/architectures","http_method":"GET","short_description":"List all architectures","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"\n

filter results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n

sort results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n

paginate results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n

number of entries per request

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/architectures\n200\n[\n {\n \"architecture\": {\n \"name\": \"s390\",\n \"id\": 381564594,\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"operatingsystem_ids\": [],\n \"created_at\": \"2012-12-18T15:24:42Z\"\n }\n },\n {\n \"architecture\": {\n \"name\": \"sparc\",\n \"id\": 331892513,\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"operatingsystem_ids\": [\n 442321401\n ],\n \"created_at\": \"2012-12-18T15:24:42Z\"\n }\n },\n {\n \"architecture\": {\n \"name\": \"x86_64\",\n \"id\": 501905019,\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"operatingsystem_ids\": [\n 331303656,\n 309172073,\n 1073012828\n ],\n \"created_at\": \"2012-12-18T15:24:42Z\"\n }\n }\n]"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/architectures/show","name":"show","apis":[{"api_url":"/api/architectures/:id","http_method":"GET","short_description":"Show an architecture","deprecated":null}],"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","metadata":null,"show":true}],"examples":["GET /api/architectures/x86_64\n200\n{\n \"architecture\": {\n \"name\": \"x86_64\",\n \"id\": 501905019,\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"operatingsystem_ids\": [\n 309172073,\n 1073012828,\n 331303656\n ],\n \"created_at\": \"2012-12-18T15:24:42Z\"\n }\n}"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/architectures/create","name":"create","apis":[{"api_url":"/api/architectures","http_method":"POST","short_description":"Create an architecture","deprecated":null}],"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","metadata":null,"show":true,"params":[{"name":"name","full_name":"architecture[name]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"operatingsystem_ids","full_name":"architecture[operatingsystem_ids]","description":"\n

Operatingsystem IDs

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":["POST /api/architectures\n{\n \"architecture\": {\n \"name\": \"i386\"\n }\n}\n200\n{\n \"architecture\": {\n \"name\": \"i386\",\n \"id\": 501905020,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"operatingsystem_ids\": [],\n \"created_at\": \"2012-12-18T15:24:43Z\"\n }\n}"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/architectures/update","name":"update","apis":[{"api_url":"/api/architectures/:id","http_method":"PUT","short_description":"Update an architecture","deprecated":null}],"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","metadata":null,"show":true},{"name":"architecture","full_name":"architecture","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"architecture[name]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"operatingsystem_ids","full_name":"architecture[operatingsystem_ids]","description":"\n

Operatingsystem IDs

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":["PUT /api/architectures/x86_64\n{\n \"architecture\": {}\n}\n200\n{\n \"architecture\": {\n \"name\": \"x86_64\",\n \"id\": 501905019\n }\n}"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/architectures/destroy","name":"destroy","apis":[{"api_url":"/api/architectures/:id","http_method":"DELETE","short_description":"Delete an architecture","deprecated":null}],"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","metadata":null,"show":true}],"examples":["DELETE /api/architectures/s390\n200\n{\n \"architecture\": {\n \"name\": \"s390\",\n \"id\": 381564594\n }\n}"],"metadata":null,"see":[]}]},"external_usergroups":{"doc_url":"../apidoc/v2/external_usergroups","api_url":"/api","name":"External usergroups","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/external_usergroups/index","name":"index","apis":[{"api_url":"/api/usergroups/:usergroup_id/external_usergroups","http_method":"GET","short_description":"List all external user groups for user group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"usergroup_id","full_name":"usergroup_id","description":"\n

ID or name of user group

\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/external_usergroups/show","name":"show","apis":[{"api_url":"/api/usergroups/:usergroup_id/external_usergroups/:id","http_method":"GET","short_description":"Show an external user group for user group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"usergroup_id","full_name":"usergroup_id","description":"\n

ID or name of user group

\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"id","full_name":"id","description":"\n

ID or name of external user group

\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/external_usergroups/create","name":"create","apis":[{"api_url":"/api/usergroups/:usergroup_id/external_usergroups","http_method":"POST","short_description":"Create an external user group linked to a user group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"usergroup_id","full_name":"usergroup_id","description":"\n

ID or name of user group

\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"external_usergroup","full_name":"external_usergroup","description":"\n

External user group information

\n","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"external_usergroup[name]","description":"\n

External user group name

\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"auth_source_id","full_name":"external_usergroup[auth_source_id]","description":"\n

ID of linked auth source

\n","required":true,"allow_nil":false,"validator":"Must be Fixnum","expected_type":"numeric","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/external_usergroups/update","name":"update","apis":[{"api_url":"/api/usergroups/:usergroup_id/external_usergroups/:id","http_method":"PUT","short_description":"Update external user group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"usergroup_id","full_name":"usergroup_id","description":"\n

ID or name of user group

\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"id","full_name":"id","description":"\n

ID or name of external user group

\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"external_usergroup","full_name":"external_usergroup","description":"\n

External user group information

\n","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"external_usergroup[name]","description":"\n

External user group name

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"auth_source_id","full_name":"external_usergroup[auth_source_id]","description":"\n

ID of linked auth source

\n","required":false,"allow_nil":false,"validator":"Must be Fixnum","expected_type":"numeric","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/external_usergroups/refresh","name":"refresh","apis":[{"api_url":"/api/usergroups/:usergroup_id/external_usergroups/:id/refresh","http_method":"PUT","short_description":"Refresh external user group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"usergroup_id","full_name":"usergroup_id","description":"\n

ID or name of user group

\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"id","full_name":"id","description":"\n

ID or name of external user group

\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/external_usergroups/destroy","name":"destroy","apis":[{"api_url":"/api/usergroups/:usergroup_id/external_usergroups/:id","http_method":"DELETE","short_description":"Delete an external user group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"usergroup_id","full_name":"usergroup_id","description":"\n

ID or name of user group

\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"id","full_name":"id","description":"\n

ID or name external user group

\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"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,"metadata":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 Puppet class IDs for host group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"metadata":null,"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 Puppet class to host group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n

ID of host group

\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"puppetclass_id","full_name":"puppetclass_id","description":"\n

ID of Puppet class

\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"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 Puppet class from host group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n

ID of host group

\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"id","full_name":"id","description":"\n

ID of Puppet class

\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[]}]},"config_groups":{"doc_url":"../apidoc/v2/config_groups","api_url":"/api","name":"Config groups","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/config_groups/index","name":"index","apis":[{"api_url":"/api/config_groups","http_method":"GET","short_description":"List of config groups","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"\n

filter results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n

sort results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n

paginate results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n

number of entries per request

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/config_groups/show","name":"show","apis":[{"api_url":"/api/config_groups/:id","http_method":"GET","short_description":"Show a config group","deprecated":null}],"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","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/config_groups/create","name":"create","apis":[{"api_url":"/api/config_groups","http_method":"POST","short_description":"Create a config group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"config_group","full_name":"config_group","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"config_group[name]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/config_groups/update","name":"update","apis":[{"api_url":"/api/config_groups/:id","http_method":"PUT","short_description":"Update a config group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"config_group","full_name":"config_group","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"config_group[name]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/config_groups/destroy","name":"destroy","apis":[{"api_url":"/api/config_groups/:id","http_method":"DELETE","short_description":"Delete a config group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[]}]},"home":{"doc_url":"../apidoc/v2/home","api_url":"/api","name":"Home","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/home/index","name":"index","apis":[{"api_url":"/api","http_method":"GET","short_description":"Show available API links","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":["GET /api\n200\n{\n \"links\": {\n \"List all hosts\": \"/api/hosts\",\n \"List all compute resources\": \"/api/compute_resources\",\n \"List of subnets\": \"/api/subnets\",\n \"List all fact values\": \"/api/fact_values\",\n \"List all authsource ldaps\": \"/api/auth_source_ldaps\",\n \"List all settings\": \"/api/settings\",\n \"List of domains\": \"/api/domains\",\n \"List all operating systems\": \"/api/operatingsystems\",\n \"List all images for compute resource\": \"/api/compute_resources/:compute_resource_id/images\",\n \"List all smart_proxies\": \"/api/smart_proxies\",\n \"List all models\": \"/api/models\",\n \"List templates\": \"/api/config_templates\",\n \"List all architectures\": \"/api/architectures\",\n \"List all hostgroups\": \"/api/hostgroups\",\n \"List all environments\": \"/api/environments\",\n \"List all ptables\": \"/api/ptables\",\n \"List all users\": \"/api/users\",\n \"List all usergroups\": \"/api/usergroups\",\n \"List all common parameters\": \"/api/common_parameters\",\n \"List all puppetclasses\": \"/api/puppetclasses\",\n \"Show status\": \"/api/status\",\n \"List all media\": \"/api/media\",\n \"List all bookmarks\": \"/api/bookmarks\",\n \"List all template kinds\": \"/api/template_kinds\",\n \"Get Dashboard results\": \"/api/dashboard\",\n \"List all reports\": \"/api/reports\",\n \"Show available links\": \"/api\",\n \"List all lookup_keys\": \"/api/lookup_keys\",\n \"List all roles\": \"/api/roles\",\n \"List all audits\": \"/api/audits\"\n }\n}"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/home/status","name":"status","apis":[{"api_url":"/api/status","http_method":"GET","short_description":"Show status","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"metadata":null,"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,"metadata":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","deprecated":null},{"api_url":"/api/hosts/:host_id/smart_class_parameters","http_method":"GET","short_description":"List of smart class parameters for a specific host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/smart_class_parameters","http_method":"GET","short_description":"List of smart class parameters for a specific host group","deprecated":null},{"api_url":"/api/puppetclasses/:puppetclass_id/smart_class_parameters","http_method":"GET","short_description":"List of smart class parameters for a specific Puppet class","deprecated":null},{"api_url":"/api/environments/:environment_id/smart_class_parameters","http_method":"GET","short_description":"List of smart class parameters for a specific environment","deprecated":null},{"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/Puppet class combination","deprecated":null}],"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","metadata":null,"show":true},{"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","metadata":null,"show":true},{"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","metadata":null,"show":true},{"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","metadata":null,"show":true},{"name":"search","full_name":"search","description":"\n

filter results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n

sort results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n

paginate results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n

number of entries per request

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"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","deprecated":null}],"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","metadata":null,"show":true}],"examples":[],"metadata":null,"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","deprecated":null}],"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","metadata":null,"show":true},{"name":"smart_class_parameter","full_name":"smart_class_parameter","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"override","full_name":"smart_class_parameter[override]","description":"","required":false,"allow_nil":false,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true},{"name":"description","full_name":"smart_class_parameter[description]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"default_value","full_name":"smart_class_parameter[default_value]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"path","full_name":"smart_class_parameter[path]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"validator_type","full_name":"smart_class_parameter[validator_type]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"validator_rule","full_name":"smart_class_parameter[validator_rule]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"override_value_order","full_name":"smart_class_parameter[override_value_order]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"parameter_type","full_name":"smart_class_parameter[parameter_type]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"required","full_name":"smart_class_parameter[required]","description":"","required":false,"allow_nil":false,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[]}]},"environments":{"doc_url":"../apidoc/v2/environments","api_url":"/api","name":"Environments","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/environments/import_puppetclasses","name":"import_puppetclasses","apis":[{"api_url":"/api/smart_proxies/:id/import_puppetclasses","http_method":"POST","short_description":"Import puppet classes from puppet proxy.","deprecated":null},{"api_url":"/api/smart_proxies/:smart_proxy_id/environments/:id/import_puppetclasses","http_method":"POST","short_description":"Import puppet classes from puppet proxy for an environment","deprecated":null},{"api_url":"/api/environments/:environment_id/smart_proxies/:id/import_puppetclasses","http_method":"POST","short_description":"Import puppet classes from puppet proxy for an environment","deprecated":null}],"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","metadata":null,"show":true},{"name":"smart_proxy_id","full_name":"smart_proxy_id","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"environment_id","full_name":"environment_id","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"dryrun","full_name":"dryrun","description":"","required":false,"allow_nil":false,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true},{"name":"except","full_name":"except","description":"\n

Optional comma-delimited string containing either \u2018new\u2019, \u2018updated\u2019, or \u2018obsolete\u2019 that is used to limit the imported Puppet classes

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/environments/index","name":"index","apis":[{"api_url":"/api/environments","http_method":"GET","short_description":"List all environments","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n

Scope by locations

\n","required":false,"allow_nil":false,"validator":"Must be Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"organization_id","full_name":"organization_id","description":"\n

Scope by organizations

\n","required":false,"allow_nil":false,"validator":"Must be Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"search","full_name":"search","description":"\n

filter results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n

sort results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n

paginate results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n

number of entries per request

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/environments\n200\n[\n {\n \"environment\": {\n \"name\": \"global_puppetmaster\",\n \"id\": 153855663,\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"created_at\": \"2012-12-18T15:24:42Z\"\n }\n },\n {\n \"environment\": {\n \"name\": \"production\",\n \"id\": 334344675,\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"created_at\": \"2012-12-18T15:24:42Z\"\n }\n },\n {\n \"environment\": {\n \"name\": \"testing\",\n \"id\": 687036937,\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"created_at\": \"2012-12-18T15:24:42Z\"\n }\n }\n]"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/environments/show","name":"show","apis":[{"api_url":"/api/environments/:id","http_method":"GET","short_description":"Show an environment","deprecated":null}],"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","metadata":null,"show":true}],"examples":["GET /api/environments/production\n200\n{\n \"environment\": {\n \"name\": \"production\",\n \"id\": 334344675,\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"created_at\": \"2012-12-18T15:24:42Z\"\n }\n}"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/environments/create","name":"create","apis":[{"api_url":"/api/environments","http_method":"POST","short_description":"Create an environment","deprecated":null}],"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","metadata":null,"show":true,"params":[{"name":"name","full_name":"environment[name]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"location_ids","full_name":"environment[location_ids]","description":"\n

REPLACE locations with given ids

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"organization_ids","full_name":"environment[organization_ids]","description":"\n

REPLACE organizations with given ids.

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":["POST /api/environments\n{\n \"environment\": {\n \"name\": \"Development\"\n }\n}\n200\n{\n \"environment\": {\n \"name\": \"Development\",\n \"id\": 687036938,\n \"updated_at\": \"2012-12-18T15:24:46Z\",\n \"created_at\": \"2012-12-18T15:24:46Z\"\n }\n}"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/environments/update","name":"update","apis":[{"api_url":"/api/environments/:id","http_method":"PUT","short_description":"Update an environment","deprecated":null}],"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","metadata":null,"show":true},{"name":"environment","full_name":"environment","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"environment[name]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"location_ids","full_name":"environment[location_ids]","description":"\n

REPLACE locations with given ids

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"organization_ids","full_name":"environment[organization_ids]","description":"\n

REPLACE organizations with given ids.

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":["PUT /api/environments/production\n{\n \"environment\": {}\n}\n200\n{\n \"environment\": {\n \"name\": \"production\",\n \"id\": 334344675\n }\n}"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/environments/destroy","name":"destroy","apis":[{"api_url":"/api/environments/:id","http_method":"DELETE","short_description":"Delete an environment","deprecated":null}],"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","metadata":null,"show":true}],"examples":["DELETE /api/environments/testing\n200\n{\n \"environment\": {\n \"name\": \"testing\",\n \"id\": 687036937\n }\n}"],"metadata":null,"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,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/config_templates/index","name":"index","apis":[{"api_url":"/api/config_templates","http_method":"GET","short_description":"List provisioning templates","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n

Scope by locations

\n","required":false,"allow_nil":false,"validator":"Must be Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"organization_id","full_name":"organization_id","description":"\n

Scope by organizations

\n","required":false,"allow_nil":false,"validator":"Must be Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"search","full_name":"search","description":"\n

filter results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n

sort results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n

paginate results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n

number of entries per request

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/config_templates\n200\n[\n {\n \"config_template\": {\n \"name\": \"centos5_3_pxelinux\",\n \"audit_comment\": null,\n \"id\": 1007981701,\n \"snippet\": null,\n \"template\": \"default linux~label linux~kernel <%= @kernel %>~append initrd=<%= @initrd %> ks=<%= foreman_url(\\\"kickstart\\\")%> ksdevice=bootif network kssendmac\",\n \"template_kind\": {\n \"name\": \"PXELinux\",\n \"id\": 452984334\n }\n }\n },\n {\n \"config_template\": {\n \"name\": \"MyFinish\",\n \"audit_comment\": null,\n \"id\": 104314179,\n \"snippet\": null,\n \"template\": \"MyFinish\",\n \"template_kind\": {\n \"name\": \"finish\",\n \"id\": 550103832\n }\n }\n },\n {\n \"config_template\": {\n \"name\": \"MyScript\",\n \"audit_comment\": null,\n \"id\": 981457253,\n \"snippet\": null,\n \"template\": \"MyText\",\n \"template_kind\": {\n \"name\": \"script\",\n \"id\": 478250810\n }\n }\n },\n {\n \"config_template\": {\n \"name\": \"MyString\",\n \"audit_comment\": null,\n \"id\": 943779058,\n \"snippet\": null,\n \"template\": \"MyText\",\n \"template_kind\": {\n \"name\": \"gPXE\",\n \"id\": 158998239\n }\n }\n },\n {\n \"config_template\": {\n \"name\": \"MyString2\",\n \"audit_comment\": null,\n \"id\": 269958254,\n \"snippet\": null,\n \"template\": \"MyText\",\n \"template_kind\": {\n \"name\": \"provision\",\n \"id\": 983253650\n }\n }\n },\n {\n \"config_template\": {\n \"name\": \"PXE Default File\",\n \"audit_comment\": null,\n \"id\": 352050261,\n \"snippet\": null,\n \"template\": \"default linux~label linux~kernel <%= @kernel %>~append initrd=<%= @initrd %> ksdevice=bootif network kssendmac\",\n \"template_kind\": {\n \"name\": \"PXELinux\",\n \"id\": 452984334\n }\n }\n },\n {\n \"config_template\": {\n \"name\": \"PXE Default Menu\",\n \"audit_comment\": null,\n \"id\": 684651467,\n \"\": null,\n \"snippet\": null,\n \"template\": \"FOO\"\n }\n },\n {\n \"config_template\": {\n \"name\": \"PXE Localboot Default\",\n \"audit_comment\": null,\n \"id\": 821548108,\n \"snippet\": null,\n \"template\": \"DEFAULT menu~PROMPT 0~MENU TITLE PXE Menu~TIMEOUT 200~TOTALTIMEOUT 6000~ONTIMEOUT local~~LABEL local~MENU LABEL (local)~MENU DEFAULT~LOCALBOOT 0\",\n \"template_kind\": {\n \"name\": \"PXELinux\",\n \"id\": 452984334\n }\n }\n }\n]"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/config_templates/show","name":"show","apis":[{"api_url":"/api/config_templates/:id","http_method":"GET","short_description":"Show provisioning template details","deprecated":null}],"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","metadata":null,"show":true}],"examples":["GET /api/config_templates/centos5_3_pxelinux\n200\n{\n \"config_template\": {\n \"name\": \"centos5_3_pxelinux\",\n \"id\": 1007981701,\n \"audit_comment\": null,\n \"snippet\": null,\n \"template\": \"default linux~label linux~kernel <%= @kernel %>~append initrd=<%= @initrd %> ks=<%= foreman_url(\\\"kickstart\\\")%> ksdevice=bootif network kssendmac\",\n \"template_kind\": {\n \"name\": \"PXELinux\",\n \"id\": 452984334\n }\n }\n}"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/config_templates/create","name":"create","apis":[{"api_url":"/api/config_templates","http_method":"POST","short_description":"Create a provisioning template","deprecated":null}],"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","metadata":null,"show":true,"params":[{"name":"name","full_name":"config_template[name]","description":"\n

template name

\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"template","full_name":"config_template[template]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"snippet","full_name":"config_template[snippet]","description":"","required":false,"allow_nil":true,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true},{"name":"audit_comment","full_name":"config_template[audit_comment]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"template_kind_id","full_name":"config_template[template_kind_id]","description":"\n

not relevant for snippet

\n","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"template_combinations_attributes","full_name":"config_template[template_combinations_attributes]","description":"\n

Array of template combinations (hostgroup_id, environment_id)

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"operatingsystem_ids","full_name":"config_template[operatingsystem_ids]","description":"\n

Array of operating system IDs to associate with the template

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"locked","full_name":"config_template[locked]","description":"\n

Whether or not the template is locked for editing

\n","required":false,"allow_nil":true,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true},{"name":"location_ids","full_name":"config_template[location_ids]","description":"\n

REPLACE locations with given ids

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"organization_ids","full_name":"config_template[organization_ids]","description":"\n

REPLACE organizations with given ids.

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":["POST /api/config_templates\n{\n \"config_template\": {\n \"name\": \"RandomName\",\n \"template\": \"This is a test template\",\n \"template_kind_id\": 1\n }\n}\n200\n{\n \"config_template\": {\n \"name\": \"RandomName\",\n \"audit_comment\": null,\n \"id\": 1007981702,\n \"\": null,\n \"snippet\": null,\n \"template\": \"This is a test template\"\n }\n}"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/config_templates/update","name":"update","apis":[{"api_url":"/api/config_templates/:id","http_method":"PUT","short_description":"Update a provisioning template","deprecated":null}],"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","metadata":null,"show":true},{"name":"config_template","full_name":"config_template","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"config_template[name]","description":"\n

template name

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"template","full_name":"config_template[template]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"snippet","full_name":"config_template[snippet]","description":"","required":false,"allow_nil":true,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true},{"name":"audit_comment","full_name":"config_template[audit_comment]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"template_kind_id","full_name":"config_template[template_kind_id]","description":"\n

not relevant for snippet

\n","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"template_combinations_attributes","full_name":"config_template[template_combinations_attributes]","description":"\n

Array of template combinations (hostgroup_id, environment_id)

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"operatingsystem_ids","full_name":"config_template[operatingsystem_ids]","description":"\n

Array of operating system IDs to associate with the template

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"locked","full_name":"config_template[locked]","description":"\n

Whether or not the template is locked for editing

\n","required":false,"allow_nil":true,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true},{"name":"location_ids","full_name":"config_template[location_ids]","description":"\n

REPLACE locations with given ids

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"organization_ids","full_name":"config_template[organization_ids]","description":"\n

REPLACE organizations with given ids.

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":["PUT /api/config_templates/centos5_3_pxelinux\n{\n \"config_template\": {\n \"audit_comment\": \"aha\",\n \"template\": \"tmp\"\n }\n}\n200\n{\n \"config_template\": {\n \"name\": \"centos5_3_pxelinux\",\n \"id\": 1007981701,\n \"template\": \"tmp\",\n \"snippet\": null,\n \"template_kind\": {\n \"name\": \"PXELinux\",\n \"id\": 452984334\n }\n }\n}"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/config_templates/revision","name":"revision","apis":[{"api_url":"/api/config_templates/revision","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"version","full_name":"version","description":"\n

template version

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/config_templates/destroy","name":"destroy","apis":[{"api_url":"/api/config_templates/:id","http_method":"DELETE","short_description":"Delete a provisioning template","deprecated":null}],"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","metadata":null,"show":true}],"examples":["DELETE /api/config_templates/centos5_3_pxelinux\n200\n{\n \"config_template\": {\n \"name\": \"centos5_3_pxelinux\",\n \"id\": 1007981701,\n \"template\": \"default linux~label linux~kernel <%= @kernel %>~append initrd=<%= @initrd %> ks=<%= foreman_url(\\\"kickstart\\\")%> ksdevice=bootif network kssendmac\",\n \"snippet\": null,\n \"template_kind\": {\n \"name\": \"PXELinux\",\n \"id\": 452984334\n }\n }\n}"],"metadata":null,"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":"Update the default PXE menu on all configured TFTP servers","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":["GET /api/config_templates/build_pxe_default\n200\nPXE Default file has been deployed to all Smart Proxies"],"metadata":null,"see":[]}]},"bookmarks":{"doc_url":"../apidoc/v2/bookmarks","api_url":"/api","name":"Bookmarks","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/bookmarks/index","name":"index","apis":[{"api_url":"/api/bookmarks","http_method":"GET","short_description":"List all bookmarks","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"page","full_name":"page","description":"\n

paginate results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n

number of entries per request

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/bookmarks\n200\n[\n {\n \"bookmark\": {\n \"name\": \"bar\",\n \"query\": \"bar=car\",\n \"id\": 298486374,\n \"owner_id\": null,\n \"public\": false,\n \"controller\": \"hosts\",\n \"owner_type\": null\n }\n },\n {\n \"bookmark\": {\n \"name\": \"foo\",\n \"query\": \"foo=boo\",\n \"id\": 980190962,\n \"owner_id\": null,\n \"public\": true,\n \"controller\": \"hosts\",\n \"owner_type\": null\n }\n }\n]"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/bookmarks/show","name":"show","apis":[{"api_url":"/api/bookmarks/:id","http_method":"GET","short_description":"Show a bookmark","deprecated":null}],"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","metadata":null,"show":true}],"examples":["GET /api/bookmarks/foo\n200\n{\n \"bookmark\": {\n \"name\": \"foo\",\n \"query\": \"foo=boo\",\n \"id\": 980190962,\n \"owner_id\": null,\n \"public\": true,\n \"controller\": \"hosts\",\n \"owner_type\": null\n }\n}"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/bookmarks/create","name":"create","apis":[{"api_url":"/api/bookmarks","http_method":"POST","short_description":"Create a bookmark","deprecated":null}],"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","metadata":null,"show":true,"params":[{"name":"name","full_name":"bookmark[name]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"controller","full_name":"bookmark[controller]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"query","full_name":"bookmark[query]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"public","full_name":"bookmark[public]","description":"","required":false,"allow_nil":true,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true}]}],"examples":["POST /api/bookmarks\n{\n \"bookmark\": {\n \"query\": \"bar\",\n \"name\": \"foo-bar\",\n \"public\": false,\n \"controller\": \"hosts\"\n }\n}\n200\n{\n \"bookmark\": {\n \"name\": \"foo-bar\",\n \"query\": \"bar\",\n \"id\": 980190963,\n \"owner_id\": 886836129,\n \"public\": false,\n \"controller\": \"hosts\",\n \"owner_type\": \"User\"\n }\n}"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/bookmarks/update","name":"update","apis":[{"api_url":"/api/bookmarks/:id","http_method":"PUT","short_description":"Update a bookmark","deprecated":null}],"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","metadata":null,"show":true},{"name":"bookmark","full_name":"bookmark","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"bookmark[name]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"controller","full_name":"bookmark[controller]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"query","full_name":"bookmark[query]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"public","full_name":"bookmark[public]","description":"","required":false,"allow_nil":true,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true}]}],"examples":["PUT /api/bookmarks/foo\n{\n \"bookmark\": {}\n}\n200\n{\n \"bookmark\": {\n \"name\": \"foo\",\n \"query\": \"foo=boo\",\n \"user\": {\n \"name\": \"apiadmin User\",\n \"login\": \"apiadmin\",\n \"email\": \"apiadmin@someware.com\"\n },\n \"id\": 980190962,\n \"public\": true,\n \"controller\": \"hosts\"\n }\n}"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/bookmarks/destroy","name":"destroy","apis":[{"api_url":"/api/bookmarks/:id","http_method":"DELETE","short_description":"Delete a bookmark","deprecated":null}],"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","metadata":null,"show":true}],"examples":["DELETE /api/bookmarks/foo\n200\n{\n \"bookmark\": {\n \"query\": \"foo=boo\",\n \"name\": \"foo\",\n \"id\": 980190962,\n \"public\": true,\n \"owner_id\": null,\n \"controller\": \"hosts\",\n \"owner_type\": null\n }\n}"],"metadata":null,"see":[]}]},"autosign":{"doc_url":"../apidoc/v2/autosign","api_url":"/api","name":"Autosign","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/autosign/index","name":"index","apis":[{"api_url":"/api/smart_proxies/smart_proxy_id/autosign","http_method":"GET","short_description":"List all autosign entries","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"metadata":null,"see":[]}]},"puppetclasses":{"doc_url":"../apidoc/v2/puppetclasses","api_url":"/api","name":"Puppetclasses","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/puppetclasses/index","name":"index","apis":[{"api_url":"/api/puppetclasses","http_method":"GET","short_description":"List all Puppet classes","deprecated":null},{"api_url":"/api/hosts/:host_id/puppetclasses","http_method":"GET","short_description":"List all Puppet classes for a host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/puppetclasses","http_method":"GET","short_description":"List all Puppet classes for a host group","deprecated":null},{"api_url":"/api/environments/:environment_id/puppetclasses","http_method":"GET","short_description":"List all Puppet classes for an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n

ID of host

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n

ID of host group

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"environment_id","full_name":"environment_id","description":"\n

ID of environment

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"search","full_name":"search","description":"\n

filter results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n

sort results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n

paginate results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n

number of entries per request

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/puppetclasses\n200\n{\n \"base\": [\n {\n \"puppetclass\": {\n \"name\": \"base\",\n \"id\": 980190962,\n \"lookup_keys\": [\n {\n \"id\": 298486374\n }\n ]\n }\n }\n ],\n \"apache\": [\n {\n \"puppetclass\": {\n \"name\": \"apache\",\n \"id\": 298486374,\n \"lookup_keys\": []\n }\n }\n ]\n}"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/puppetclasses/show","name":"show","apis":[{"api_url":"/api/puppetclasses/:id","http_method":"GET","short_description":"Show a Puppet class","deprecated":null},{"api_url":"/api/hosts/:host_id/puppetclasses/:id","http_method":"GET","short_description":"Show a Puppet class for host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/puppetclasses/:id","http_method":"GET","short_description":"Show a Puppet class for a host group","deprecated":null},{"api_url":"/api/environments/:environment_id/puppetclasses/:id","http_method":"GET","short_description":"Show a Puppet class for an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n

ID of host

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n

ID of host group

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"environment_id","full_name":"environment_id","description":"\n

ID of environment

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"id","full_name":"id","description":"\n

ID of puppetclass

\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/puppetclasses/base\n200\n{\n \"puppetclass\": {\n \"name\": \"base\",\n \"id\": 980190962,\n \"lookup_keys\": [\n {\n \"lookup_key\": {\n \"required\": false,\n \"id\": 298486374,\n \"description\": null,\n \"key\": \"ssl_port\",\n \"is_param\": false,\n \"override\": false,\n \"default_value\": \"443\"\n }\n }\n ]\n }\n}"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/puppetclasses/create","name":"create","apis":[{"api_url":"/api/puppetclasses","http_method":"POST","short_description":"Create a Puppet class","deprecated":null}],"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","metadata":null,"show":true,"params":[{"name":"name","full_name":"puppetclass[name]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}]}],"examples":["POST /api/puppetclasses\n{\n \"puppetclass\": {\n \"name\": \"test_puppetclass\"\n }\n}\n201\n{\n \"puppetclass\": {\n \"name\": \"test_puppetclass\",\n \"id\": 980190963,\n \"lookup_keys\": []\n }\n}"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/puppetclasses/update","name":"update","apis":[{"api_url":"/api/puppetclasses/:id","http_method":"PUT","short_description":"Update a Puppet class","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"puppetclass","full_name":"puppetclass","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"puppetclass[name]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}]}],"examples":["PUT /api/puppetclasses/base\n{\n \"puppetclass\": {}\n}\n200\n{\n \"puppetclass\": {\n \"name\": \"base\",\n \"id\": 980190962,\n \"lookup_keys\": [\n {\n \"id\": 298486374\n }\n ]\n }\n}"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/puppetclasses/destroy","name":"destroy","apis":[{"api_url":"/api/puppetclasses/:id","http_method":"DELETE","short_description":"Delete a Puppet class","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["DELETE /api/puppetclasses/base\n200\n{\n \"puppetclass\": {\n \"name\": \"base\",\n \"id\": 980190962,\n \"lookup_keys\": [\n {\n \"id\": 298486374\n }\n ]\n }\n}"],"metadata":null,"see":[]}]},"plugins":{"doc_url":"../apidoc/v2/plugins","api_url":"/api","name":"Plugins","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/plugins/index","name":"index","apis":[{"api_url":"/api/plugins","http_method":"GET","short_description":"List installed plugins","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"metadata":null,"see":[]}]},"permissions":{"doc_url":"../apidoc/v2/permissions","api_url":"/api","name":"Permissions","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/permissions/index","name":"index","apis":[{"api_url":"/api/permissions","http_method":"GET","short_description":"List all permissions","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"page","full_name":"page","description":"\n

paginate results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n

number of entries per request

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"resource_type","full_name":"resource_type","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"name","full_name":"name","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/permissions/show","name":"show","apis":[{"api_url":"/api/permissions/:id","http_method":"GET","short_description":"Show a permission","deprecated":null}],"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","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/permissions/resource_types","name":"resource_types","apis":[{"api_url":"/api/permissions/resource_types","http_method":"GET","short_description":"List available resource types.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"metadata":null,"see":[]}]},"audits":{"doc_url":"../apidoc/v2/audits","api_url":"/api","name":"Audits","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/audits/index","name":"index","apis":[{"api_url":"/api/audits","http_method":"GET","short_description":"List all audits","deprecated":null},{"api_url":"/api/hosts/:host_id/audits","http_method":"GET","short_description":"List all audits for a given host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"\n

filter results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n

sort results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n

paginate results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n

number of entries per request

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/audits\n200\n[\n {\n \"audit\": {\n \"auditable_name\": null,\n \"user_id\": null,\n \"associated_id\": 272,\n \"associated_name\": null,\n \"id\": 1,\n \"comment\": null,\n \"auditable_id\": 0,\n \"auditable_type\": \"Host\",\n \"associated_type\": \"Host\",\n \"remote_address\": null,\n \"action\": \"update\",\n \"audited_changes\": {\n \"architecture_id\": [\n 10463,\n 10466\n ]\n },\n \"user_type\": null,\n \"version\": 1,\n \"created_at\": \"2009-12-14T08:01:17Z\"\n }\n }\n]"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/audits/show","name":"show","apis":[{"api_url":"/api/audits/:id","http_method":"GET","short_description":"Show an audit","deprecated":null}],"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","metadata":null,"show":true}],"examples":["GET /api/audits/1\n200\n{\n \"audit\": {\n \"auditable_name\": null,\n \"user_id\": null,\n \"associated_id\": 272,\n \"associated_name\": null,\n \"id\": 1,\n \"comment\": null,\n \"auditable_id\": 0,\n \"auditable_type\": \"Host\",\n \"associated_type\": \"Host\",\n \"remote_address\": null,\n \"action\": \"update\",\n \"audited_changes\": {\n \"architecture_id\": [\n 10463,\n 10466\n ]\n },\n \"user_type\": null,\n \"version\": 1,\n \"created_at\": \"2009-12-14T08:01:17Z\"\n }\n}"],"metadata":null,"see":[]}]},"tasks":{"doc_url":"../apidoc/v2/tasks","api_url":"/api","name":"Tasks","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/tasks/index","name":"index","apis":[{"api_url":"/api/orchestration/:id/tasks","http_method":"GET","short_description":"List all tasks for a given orchestration event","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"metadata":null,"see":[]}]},"statistics":{"doc_url":"../apidoc/v2/statistics","api_url":"/api","name":"Statistics","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/statistics/index","name":"index","apis":[{"api_url":"/api/statistics","http_method":"GET","short_description":"Get statistics","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"metadata":null,"see":[]}]},"hosts":{"doc_url":"../apidoc/v2/hosts","api_url":"/api","name":"Hosts","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/hosts/index","name":"index","apis":[{"api_url":"/api/hosts","http_method":"GET","short_description":"List all hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"\n

filter results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n

sort results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n

paginate results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n

number of entries per request

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/hosts\n200\n[\n {\n \"host\": {\n \"name\": \"anotherfullhost\",\n \"id\": 55602819,\n \"operatingsystem_id\": 1073012828,\n \"hostgroup_id\": null\n }\n },\n {\n \"host\": {\n \"name\": \"dhcp.mydomain.net\",\n \"id\": 219245707,\n \"operatingsystem_id\": 1073012828,\n \"hostgroup_id\": null\n }\n },\n {\n \"host\": {\n \"name\": \"my5name.mydomain.net\",\n \"id\": 980190962,\n \"operatingsystem_id\": 1073012828,\n \"hostgroup_id\": null\n }\n },\n {\n \"host\": {\n \"name\": \"myfullname.mydomain.net\",\n \"id\": 1053842695,\n \"operatingsystem_id\": 309172073,\n \"hostgroup_id\": null\n }\n },\n {\n \"host\": {\n \"name\": \"otherfullhost\",\n \"id\": 661942085,\n \"operatingsystem_id\": 1073012828,\n \"hostgroup_id\": null\n }\n },\n {\n \"host\": {\n \"name\": \"sdhcp.mydomain.net\",\n \"id\": 500757383,\n \"operatingsystem_id\": 1073012828,\n \"hostgroup_id\": null\n }\n },\n {\n \"host\": {\n \"name\": \"sol10host\",\n \"id\": 715054938,\n \"operatingsystem_id\": 442321401,\n \"hostgroup_id\": null\n }\n },\n {\n \"host\": {\n \"name\": \"suse01.yourdomain.net\",\n \"id\": 859751735,\n \"operatingsystem_id\": 859751735,\n \"hostgroup_id\": null\n }\n },\n {\n \"host\": {\n \"name\": \"temp-01.yourdomain.net\",\n \"id\": 1011586618,\n \"operatingsystem_id\": 331303656,\n \"hostgroup_id\": null\n }\n },\n {\n \"host\": {\n \"name\": \"temp01.yourdomain.net\",\n \"id\": 1073012828,\n \"operatingsystem_id\": 1073012828,\n \"hostgroup_id\": null\n }\n },\n {\n \"host\": {\n \"name\": \"temp-02.useless.net\",\n \"id\": 3666571,\n \"operatingsystem_id\": 331303656,\n \"hostgroup_id\": null\n }\n },\n {\n \"host\": {\n \"name\": \"temp.yourdomain.net\",\n \"id\": 298486374,\n \"operatingsystem_id\": 309172073,\n \"hostgroup_id\": null\n }\n }\n]"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/hosts/show","name":"show","apis":[{"api_url":"/api/hosts/:id","http_method":"GET","short_description":"Show a host","deprecated":null}],"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","metadata":null,"show":true}],"examples":["GET /api/hosts/my5name.mydomain.net\n200\n{\n \"host\": {\n \"host_parameters\": [\n {\n \"host_parameter\": {\n \"priority\": 4,\n \"name\": \"host1\",\n \"value\": \"host1\",\n \"id\": 254219264,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"reference_id\": 980190962,\n \"created_at\": \"2012-12-18T15:24:43Z\"\n }\n }\n ],\n \"name\": \"my5name.mydomain.net\",\n \"installed_at\": null,\n \"sp_ip\": \"\",\n \"image_file\": \"\",\n \"sp_name\": \"\",\n \"last_report\": null,\n \"enabled\": true,\n \"ip\": \"2.3.4.1\",\n \"id\": 980190962,\n \"puppet_ca_proxy_id\": null,\n \"certname\": \"my5name.mydomain.net\",\n \"medium_id\": null,\n \"sp_mac\": \"\",\n \"model_id\": null,\n \"comment\": null,\n \"uuid\": null,\n \"mac\": \"aabbCCddeeee\",\n \"use_image\": null,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"operatingsystem_id\": 1073012828,\n \"owner_id\": null,\n \"environment_id\": 334344675,\n \"build\": false,\n \"subnet_id\": 980190962,\n \"domain_id\": 22495316,\n \"environment\": {\n \"environment\": {\n \"name\": \"production\",\n \"id\": 334344675\n }\n },\n \"sp_subnet_id\": null,\n \"hostgroup_id\": null,\n \"puppet_proxy_id\": 182953976,\n \"owner_type\": null,\n \"ptable_id\": 980190962,\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"disk\": null,\n \"managed\": true,\n \"architecture_id\": 501905019,\n \"image_id\": null,\n \"compute_resource_id\": 980190962\n }\n}"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/hosts/create","name":"create","apis":[{"api_url":"/api/hosts","http_method":"POST","short_description":"Create a host","deprecated":null}],"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","metadata":null,"show":true,"params":[{"name":"name","full_name":"host[name]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"environment_id","full_name":"host[environment_id]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"location_id","full_name":"host[location_id]","description":"\n

required if locations are enabled

\n","required":true,"allow_nil":false,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"organization_id","full_name":"host[organization_id]","description":"\n

required if organizations are enabled

\n","required":true,"allow_nil":false,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"ip","full_name":"host[ip]","description":"\n

not required if using a subnet with DHCP proxy

\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"mac","full_name":"host[mac]","description":"\n

not required if it\u2019s a virtual machine

\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"architecture_id","full_name":"host[architecture_id]","description":"","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"domain_id","full_name":"host[domain_id]","description":"","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"realm_id","full_name":"host[realm_id]","description":"","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"puppet_proxy_id","full_name":"host[puppet_proxy_id]","description":"","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"puppet_class_ids","full_name":"host[puppet_class_ids]","description":"","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"operatingsystem_id","full_name":"host[operatingsystem_id]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"medium_id","full_name":"host[medium_id]","description":"","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"ptable_id","full_name":"host[ptable_id]","description":"","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"subnet_id","full_name":"host[subnet_id]","description":"","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"compute_resource_id","full_name":"host[compute_resource_id]","description":"","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"sp_subnet_id","full_name":"host[sp_subnet_id]","description":"","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"model_id","full_name":"host[model_id]","description":"","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"hostgroup_id","full_name":"host[hostgroup_id]","description":"","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"owner_id","full_name":"host[owner_id]","description":"","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"puppet_ca_proxy_id","full_name":"host[puppet_ca_proxy_id]","description":"","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"image_id","full_name":"host[image_id]","description":"","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"host_parameters_attributes","full_name":"host[host_parameters_attributes]","description":"","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"build","full_name":"host[build]","description":"","required":false,"allow_nil":true,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true},{"name":"enabled","full_name":"host[enabled]","description":"","required":false,"allow_nil":true,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true},{"name":"provision_method","full_name":"host[provision_method]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"managed","full_name":"host[managed]","description":"","required":false,"allow_nil":true,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true},{"name":"progress_report_id","full_name":"host[progress_report_id]","description":"\n

UUID to track orchestration tasks status, GET /api/orchestration/:UUID/tasks

\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"capabilities","full_name":"host[capabilities]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"compute_profile_id","full_name":"host[compute_profile_id]","description":"","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"compute_attributes","full_name":"host[compute_attributes]","description":"","required":false,"allow_nil":true,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[]}]}],"examples":["POST /api/hosts\n{\n \"host\": {\n \"name\": \"testhost11\",\n \"ip\": \"10.0.0.20\",\n \"mac\": \"52:53:00:1e:85:93\",\n \"operatingsystem_id\": 1073012828,\n \"environment_id\": 334344675,\n \"domain_id\": 22495316,\n \"puppet_proxy_id\": 7,\n \"architecture_id\": 501905019\n }\n}\n200\n{\n \"host\": {\n \"name\": \"testhost11.mydomain.net\",\n \"host_parameters\": [],\n \"installed_at\": null,\n \"sp_ip\": \"\",\n \"sp_name\": \"\",\n \"image_file\": \"\",\n \"last_report\": null,\n \"enabled\": true,\n \"id\": 1073012829,\n \"ip\": \"10.0.0.20\",\n \"puppet_ca_proxy_id\": null,\n \"certname\": \"fcfce82c-33d1-4565-843a-4f58ff8e371a\",\n \"medium_id\": null,\n \"sp_mac\": \"\",\n \"model_id\": null,\n \"comment\": null,\n \"uuid\": null,\n \"mac\": \"52:53:00:1e:85:93\",\n \"updated_at\": \"2012-12-18T15:24:48Z\",\n \"use_image\": null,\n \"operatingsystem_id\": 1073012828,\n \"owner_id\": 886836129,\n \"environment_id\": 334344675,\n \"build\": false,\n \"subnet_id\": null,\n \"environment\": {\n \"environment\": {\n \"name\": \"production\",\n \"id\": 334344675\n }\n },\n \"domain_id\": 22495316,\n \"sp_subnet_id\": null,\n \"hostgroup_id\": null,\n \"puppet_proxy_id\": 7,\n \"owner_type\": \"User\",\n \"ptable_id\": null,\n \"created_at\": \"2012-12-18T15:24:48Z\",\n \"disk\": null,\n \"managed\": true,\n \"architecture_id\": 501905019,\n \"compute_resource_id\": null,\n \"image_id\": null\n }\n}"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/hosts/update","name":"update","apis":[{"api_url":"/api/hosts/:id","http_method":"PUT","short_description":"Update a host","deprecated":null}],"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","metadata":null,"show":true},{"name":"host","full_name":"host","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"host[name]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"environment_id","full_name":"host[environment_id]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"location_id","full_name":"host[location_id]","description":"\n

required if locations are enabled

\n","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"organization_id","full_name":"host[organization_id]","description":"\n

required if organizations are enabled

\n","required":false,"allow_nil":false,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"ip","full_name":"host[ip]","description":"\n

not required if using a subnet with DHCP proxy

\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"mac","full_name":"host[mac]","description":"\n

not required if it\u2019s a virtual machine

\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"architecture_id","full_name":"host[architecture_id]","description":"","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"domain_id","full_name":"host[domain_id]","description":"","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"realm_id","full_name":"host[realm_id]","description":"","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"puppet_proxy_id","full_name":"host[puppet_proxy_id]","description":"","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"puppet_class_ids","full_name":"host[puppet_class_ids]","description":"","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"operatingsystem_id","full_name":"host[operatingsystem_id]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"medium_id","full_name":"host[medium_id]","description":"","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"ptable_id","full_name":"host[ptable_id]","description":"","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"subnet_id","full_name":"host[subnet_id]","description":"","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"compute_resource_id","full_name":"host[compute_resource_id]","description":"","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"sp_subnet_id","full_name":"host[sp_subnet_id]","description":"","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"model_id","full_name":"host[model_id]","description":"","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"hostgroup_id","full_name":"host[hostgroup_id]","description":"","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"owner_id","full_name":"host[owner_id]","description":"","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"puppet_ca_proxy_id","full_name":"host[puppet_ca_proxy_id]","description":"","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"image_id","full_name":"host[image_id]","description":"","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"host_parameters_attributes","full_name":"host[host_parameters_attributes]","description":"","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"build","full_name":"host[build]","description":"","required":false,"allow_nil":true,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true},{"name":"enabled","full_name":"host[enabled]","description":"","required":false,"allow_nil":true,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true},{"name":"provision_method","full_name":"host[provision_method]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"managed","full_name":"host[managed]","description":"","required":false,"allow_nil":true,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true},{"name":"progress_report_id","full_name":"host[progress_report_id]","description":"\n

UUID to track orchestration tasks status, GET /api/orchestration/:UUID/tasks

\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"capabilities","full_name":"host[capabilities]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"compute_profile_id","full_name":"host[compute_profile_id]","description":"","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"compute_attributes","full_name":"host[compute_attributes]","description":"","required":false,"allow_nil":true,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[]}]}],"examples":["PUT /api/hosts/temp.yourdomain.net\n{\n \"host\": {}\n}\n200\n{\n \"host\": {\n \"sp_name\": \"\",\n \"sp_ip\": \"\",\n \"serial\": null,\n \"name\": \"temp.yourdomain.net\",\n \"installed_at\": null,\n \"image_file\": \"\",\n \"last_report\": null,\n \"enabled\": true,\n \"sp_mac\": \"\",\n \"puppet_ca_proxy_id\": null,\n \"medium_id\": 980190962,\n \"ip\": \"2.3.4.5\",\n \"id\": 298486374,\n \"certname\": \"temp.yourdomain.net\",\n \"uuid\": null,\n \"use_image\": null,\n \"updated_at\": \"2012-12-18T15:24:48Z\",\n \"root_pass\": \"xybxa6JUkz63w\",\n \"model_id\": null,\n \"mac\": \"aa:bb:cc:dd:ee:ff\",\n \"last_compile\": null,\n \"comment\": null,\n \"owner_id\": 886836129,\n \"operatingsystem_id\": 309172073,\n \"location_id\": null,\n \"organization_id\": null,\n \"environment_id\": 334344675,\n \"build\": false,\n \"subnet_id\": 980190962,\n \"sp_subnet_id\": null,\n \"hostgroup_id\": null,\n \"environment\": {\n \"environment\": {\n \"name\": \"production\",\n \"id\": 334344675\n }\n },\n \"domain_id\": 589326610,\n \"source_file_id\": null,\n \"puppet_proxy_id\": 182953976,\n \"ptable_id\": 980190962,\n \"owner_type\": \"User\",\n \"puppet_status\": 0,\n \"disk\": null,\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"managed\": null,\n \"last_freshcheck\": null,\n \"image_id\": null,\n \"compute_resource_id\": 980190962,\n \"architecture_id\": 501905019\n }\n}"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/hosts/destroy","name":"destroy","apis":[{"api_url":"/api/hosts/:id","http_method":"DELETE","short_description":"Delete a host","deprecated":null}],"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","metadata":null,"show":true}],"examples":["DELETE /api/hosts/my5name.mydomain.net\n200\n{\n \"host\": {\n \"sp_name\": \"\",\n \"sp_ip\": \"\",\n \"serial\": null,\n \"name\": \"my5name.mydomain.net\",\n \"installed_at\": null,\n \"image_file\": \"\",\n \"last_report\": null,\n \"enabled\": true,\n \"sp_mac\": \"\",\n \"puppet_ca_proxy_id\": null,\n \"medium_id\": null,\n \"ip\": \"2.3.4.1\",\n \"id\": 980190962,\n \"certname\": \"my5name.mydomain.net\",\n \"uuid\": null,\n \"use_image\": null,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"root_pass\": \"xybxa6JUkz63w\",\n \"model_id\": null,\n \"mac\": \"aabbCCddeeee\",\n \"last_compile\": null,\n \"comment\": null,\n \"owner_id\": null,\n \"operatingsystem_id\": 1073012828,\n \"location_id\": null,\n \"organization_id\": null,\n \"environment_id\": 334344675,\n \"build\": false,\n \"subnet_id\": 980190962,\n \"sp_subnet_id\": null,\n \"hostgroup_id\": null,\n \"environment\": {\n \"environment\": {\n \"name\": \"production\",\n \"id\": 334344675\n }\n },\n \"domain_id\": 22495316,\n \"source_file_id\": null,\n \"puppet_proxy_id\": 182953976,\n \"ptable_id\": 980190962,\n \"owner_type\": null,\n \"puppet_status\": 0,\n \"disk\": null,\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"managed\": true,\n \"last_freshcheck\": null,\n \"image_id\": null,\n \"compute_resource_id\": 980190962,\n \"architecture_id\": 501905019\n }\n}"],"metadata":null,"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","deprecated":null}],"formats":null,"full_description":"\n

Return value may either be one of the following:

\n\n\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","metadata":null,"show":true}],"examples":["GET /api/hosts/my5name.mydomain.net/status\n200\n{\n \"status\": \"missing\"\n}"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/hosts/puppetrun","name":"puppetrun","apis":[{"api_url":"/api/hosts/:id/puppetrun","http_method":"PUT","short_description":"Force a Puppet agent run on the host","deprecated":null}],"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","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/hosts/disassociate","name":"disassociate","apis":[{"api_url":"/api/hosts/:id/disassociate","http_method":"PUT","short_description":"Disassociate the host from a VM","deprecated":null}],"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","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/hosts/power","name":"power","apis":[{"api_url":"/api/hosts/:id/power","http_method":"PUT","short_description":"Run a power operation on host","deprecated":null}],"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","metadata":null,"show":true},{"name":"power_action","full_name":"power_action","description":"\n

power action, valid actions are (on/start), (off/stop), (soft/reboot), (cycle/reset), (state/status)

\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"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","deprecated":null}],"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","metadata":null,"show":true},{"name":"device","full_name":"device","description":"\n

boot device, valid devices are disk, cdrom, pxe, bios

\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"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","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n

hostname of the host

\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"facts","full_name":"facts","description":"\n

hash containing the facts for the host

\n","required":true,"allow_nil":false,"validator":"Must be Hash","expected_type":"hash","metadata":null,"show":true},{"name":"certname","full_name":"certname","description":"\n

optional: certname of the host

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"type","full_name":"type","description":"\n

optional: the STI type of host to create

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[]}]},"dashboard":{"doc_url":"../apidoc/v2/dashboard","api_url":"/api","name":"Dashboard","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/dashboard/index","name":"index","apis":[{"api_url":"/api/dashboard","http_method":"GET","short_description":"Get dashboard details","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"\n

filter results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/dashboard\n200\n{\n \"disabled_hosts\": 0,\n \"ok_hosts\": 0,\n \"good_hosts\": 0,\n \"active_hosts_ok\": 0,\n \"pending_hosts_enabled\": 0,\n \"active_hosts_ok_enabled\": 0,\n \"good_hosts_enabled\": 0,\n \"active_hosts\": 0,\n \"percentage\": 0,\n \"out_of_sync_hosts\": 0,\n \"total_hosts\": 12,\n \"bad_hosts\": 0,\n \"out_of_sync_hosts_enabled\": 0,\n \"pending_hosts\": 0,\n \"bad_hosts_enabled\": 0,\n \"ok_hosts_enabled\": 0,\n \"reports_missing\": 12\n}"],"metadata":null,"see":[]}]},"interfaces":{"doc_url":"../apidoc/v2/interfaces","api_url":"/api","name":"Interfaces","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":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","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n

ID or name of host

\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"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","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n

ID or name of host

\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"id","full_name":"id","description":"\n

ID or name of interface

\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"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 on a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n

ID or name of host

\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"interface","full_name":"interface","description":"\n

interface information

\n","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"mac","full_name":"interface[mac]","description":"\n

MAC address of interface

\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"ip","full_name":"interface[ip]","description":"\n

IP address of interface

\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"type","full_name":"interface[type]","description":"\n

Interface type, e.g: Nic::BMC

\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"name","full_name":"interface[name]","description":"\n

Interface name

\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"subnet_id","full_name":"interface[subnet_id]","description":"\n

Foreman subnet ID of interface

\n","required":false,"allow_nil":true,"validator":"Must be Fixnum","expected_type":"numeric","metadata":null,"show":true},{"name":"domain_id","full_name":"interface[domain_id]","description":"\n

Foreman domain ID of interface

\n","required":false,"allow_nil":true,"validator":"Must be Fixnum","expected_type":"numeric","metadata":null,"show":true},{"name":"username","full_name":"interface[username]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"password","full_name":"interface[password]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"provider","full_name":"interface[provider]","description":"\n

Interface provider, e.g. IPMI

\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"managed","full_name":"interface[managed]","description":"\n

Should this interface be managed via DHCP and DNS smart proxy and should it be configured during provisioning?

\n","required":false,"allow_nil":true,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true},{"name":"virtual","full_name":"interface[virtual]","description":"\n

Alias or VLAN device

\n","required":false,"allow_nil":true,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true},{"name":"identifier","full_name":"interface[identifier]","description":"\n

Device identifier, e.g. eth0 or eth1.1

\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"tag","full_name":"interface[tag]","description":"\n

VLAN tag, this attribute has precedence over the subnet VLAN ID

\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"physical_device","full_name":"interface[physical_device]","description":"\n

Identifier of physical interface to which this interface belongs to. e.g. eth1

\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/interfaces/update","name":"update","apis":[{"api_url":"/api/hosts/:host_id/interfaces/:id","http_method":"PUT","short_description":"Update a host's interface","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n

ID or name of host

\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"id","full_name":"id","description":"\n

ID of interface

\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","metadata":null,"show":true},{"name":"interface","full_name":"interface","description":"\n

interface information

\n","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"mac","full_name":"interface[mac]","description":"\n

MAC address of interface

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"ip","full_name":"interface[ip]","description":"\n

IP address of interface

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"type","full_name":"interface[type]","description":"\n

Interface type, e.g: Nic::BMC

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"name","full_name":"interface[name]","description":"\n

Interface name

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"subnet_id","full_name":"interface[subnet_id]","description":"\n

Foreman subnet ID of interface

\n","required":false,"allow_nil":true,"validator":"Must be Fixnum","expected_type":"numeric","metadata":null,"show":true},{"name":"domain_id","full_name":"interface[domain_id]","description":"\n

Foreman domain ID of interface

\n","required":false,"allow_nil":true,"validator":"Must be Fixnum","expected_type":"numeric","metadata":null,"show":true},{"name":"username","full_name":"interface[username]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"password","full_name":"interface[password]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"provider","full_name":"interface[provider]","description":"\n

Interface provider, e.g. IPMI

\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"managed","full_name":"interface[managed]","description":"\n

Should this interface be managed via DHCP and DNS smart proxy and should it be configured during provisioning?

\n","required":false,"allow_nil":true,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true},{"name":"virtual","full_name":"interface[virtual]","description":"\n

Alias or VLAN device

\n","required":false,"allow_nil":true,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true},{"name":"identifier","full_name":"interface[identifier]","description":"\n

Device identifier, e.g. eth0 or eth1.1

\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"tag","full_name":"interface[tag]","description":"\n

VLAN tag, this attribute has precedence over the subnet VLAN ID

\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"physical_device","full_name":"interface[physical_device]","description":"\n

Identifier of physical interface to which this interface belongs to. e.g. eth1

\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}]}],"examples":[],"metadata":null,"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's interface","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n

ID or name of host

\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"id","full_name":"id","description":"\n

ID of interface

\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[]}]},"models":{"doc_url":"../apidoc/v2/models","api_url":"/api","name":"Models","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/models/index","name":"index","apis":[{"api_url":"/api/models","http_method":"GET","short_description":"List all hardware models","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"\n

filter results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n

sort results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n

paginate results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n

number of entries per request

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/models\n200\n[\n {\n \"model\": {\n \"name\": \"KVM\",\n \"id\": 980190962,\n \"vendor_class\": null,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"info\": \"Virtual Machine\",\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"hardware_model\": null\n }\n },\n {\n \"model\": {\n \"name\": \"SUN V210\",\n \"id\": 139037058,\n \"vendor_class\": \"Sun-Fire-V210\",\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"info\": null,\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"hardware_model\": \"SUN4U\"\n }\n }\n]"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/models/show","name":"show","apis":[{"api_url":"/api/models/:id","http_method":"GET","short_description":"Show a hardware model","deprecated":null}],"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","metadata":null,"show":true}],"examples":["GET /api/models/980190962\n200\n{\n \"model\": {\n \"name\": \"KVM\",\n \"id\": 980190962,\n \"vendor_class\": null,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"info\": \"Virtual Machine\",\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"hardware_model\": null\n }\n}"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/models/create","name":"create","apis":[{"api_url":"/api/models","http_method":"POST","short_description":"Create a hardware model","deprecated":null}],"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","metadata":null,"show":true,"params":[{"name":"name","full_name":"model[name]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"info","full_name":"model[info]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"vendor_class","full_name":"model[vendor_class]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"hardware_model","full_name":"model[hardware_model]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}]}],"examples":["POST /api/models\n{\n \"model\": {\n \"name\": \"new model\"\n }\n}\n201\n{\n \"model\": {\n \"name\": \"new model\",\n \"vendor_class\": null,\n \"id\": 980190963,\n \"updated_at\": \"2012-12-18T15:24:49Z\",\n \"info\": null,\n \"created_at\": \"2012-12-18T15:24:49Z\",\n \"hardware_model\": null\n }\n}"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/models/update","name":"update","apis":[{"api_url":"/api/models/:id","http_method":"PUT","short_description":"Update a hardware model","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"model","full_name":"model","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"model[name]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"info","full_name":"model[info]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"vendor_class","full_name":"model[vendor_class]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"hardware_model","full_name":"model[hardware_model]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}]}],"examples":["PUT /api/models/980190962\n{\n \"name\": \"KVM\"\n}\n200\n{\n \"model\": {\n \"name\": \"KVM\",\n \"vendor_class\": null,\n \"id\": 980190962,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"info\": \"Virtual Machine\",\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"hardware_model\": null\n }\n}"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/models/destroy","name":"destroy","apis":[{"api_url":"/api/models/:id","http_method":"DELETE","short_description":"Delete a hardware model","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["DELETE /api/models/980190962\n200\n{\n \"model\": {\n \"name\": \"KVM\",\n \"vendor_class\": null,\n \"id\": 980190962,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"info\": \"Virtual Machine\",\n \"created_at\": \"2012-12-18T15:24:43Z\",\n \"hardware_model\": null\n }\n}"],"metadata":null,"see":[]}]},"usergroups":{"doc_url":"../apidoc/v2/usergroups","api_url":"/api","name":"Usergroups","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/usergroups/index","name":"index","apis":[{"api_url":"/api/usergroups","http_method":"GET","short_description":"List all user groups","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"\n

filter results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n

sort results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n

paginate results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n

number of entries per request

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/usergroups\n200\n[\n {\n \"usergroup\": {\n \"name\": \"MyString\",\n \"id\": 980190962,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"created_at\": \"2012-12-18T15:24:43Z\"\n }\n },\n {\n \"usergroup\": {\n \"name\": \"MyString2\",\n \"id\": 298486374,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"created_at\": \"2012-12-18T15:24:43Z\"\n }\n }\n]"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/usergroups/show","name":"show","apis":[{"api_url":"/api/usergroups/:id","http_method":"GET","short_description":"Show a user group","deprecated":null}],"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","metadata":null,"show":true}],"examples":["GET /api/usergroups/980190962\n200\n{\n \"usergroup\": {\n \"name\": \"MyString\",\n \"id\": 980190962,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"created_at\": \"2012-12-18T15:24:43Z\"\n }\n}"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/usergroups/create","name":"create","apis":[{"api_url":"/api/usergroups","http_method":"POST","short_description":"Create a user group","deprecated":null}],"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","metadata":null,"show":true,"params":[{"name":"name","full_name":"usergroup[name]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"user_ids","full_name":"usergroup[user_ids]","description":"","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"usergroup_ids","full_name":"usergroup[usergroup_ids]","description":"","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"role_ids","full_name":"usergroup[role_ids]","description":"","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":["POST /api/usergroups\n{\n \"usergroup\": {\n \"name\": \"test_usergroup\"\n }\n}\n201\n{\n \"usergroup\": {\n \"name\": \"test_usergroup\",\n \"id\": 980190963\n }\n}"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/usergroups/update","name":"update","apis":[{"api_url":"/api/usergroups/:id","http_method":"PUT","short_description":"Update a user group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"usergroup","full_name":"usergroup","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"usergroup[name]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"user_ids","full_name":"usergroup[user_ids]","description":"","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"usergroup_ids","full_name":"usergroup[usergroup_ids]","description":"","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"role_ids","full_name":"usergroup[role_ids]","description":"","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":["PUT /api/usergroups/980190962\n{\n \"usergroup\": {}\n}\n200\n{\n \"usergroup\": {\n \"name\": \"MyString\",\n \"id\": 980190962\n }\n}"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/usergroups/destroy","name":"destroy","apis":[{"api_url":"/api/usergroups/:id","http_method":"DELETE","short_description":"Delete a user group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["DELETE /api/usergroups/980190962\n200\n{\n \"usergroup\": {\n \"name\": \"MyString\",\n \"id\": 980190962\n }\n}"],"metadata":null,"see":[]}]},"media":{"doc_url":"../apidoc/v2/media","api_url":"/api","name":"Media","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/media/index","name":"index","apis":[{"api_url":"/api/media","http_method":"GET","short_description":"List all installation media","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n

Scope by locations

\n","required":false,"allow_nil":false,"validator":"Must be Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"organization_id","full_name":"organization_id","description":"\n

Scope by organizations

\n","required":false,"allow_nil":false,"validator":"Must be Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"search","full_name":"search","description":"\n

filter results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n

sort results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n

paginate results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n

number of entries per request

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/media\n200\n[\n {\n \"medium\": {\n \"name\": \"CentOS 5.4\",\n \"id\": 980190962,\n \"path\": \"http://mirror.averse.net/centos/6.0/os/$arch\"\n }\n },\n {\n \"medium\": {\n \"name\": \"OpenSuse Mirror\",\n \"id\": 859751735,\n \"path\": \"http://mirror.isoc.org.il/pub/opensuse/distribution/$major.$minor/repo/oss\"\n }\n },\n {\n \"medium\": {\n \"name\": \"Solaris 10\",\n \"id\": 442321401,\n \"path\": \"http://brsla01/vol/solgi_5.10/sol$minor_$release_$arch\"\n }\n },\n {\n \"medium\": {\n \"name\": \"Ubuntu Mirror\",\n \"id\": 1011586618,\n \"path\": \"http://sg.archive.ubuntu.com\"\n }\n },\n {\n \"medium\": {\n \"name\": \"unused\",\n \"id\": 338446587,\n \"path\": \"http://nothing.intersting.com\"\n }\n }\n]"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/media/show","name":"show","apis":[{"api_url":"/api/media/:id","http_method":"GET","short_description":"Show a medium","deprecated":null}],"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","metadata":null,"show":true}],"examples":["GET /api/media/980190962\n200\n{\n \"medium\": {\n \"name\": \"CentOS 5.4\",\n \"id\": 980190962,\n \"path\": \"http://mirror.averse.net/centos/6.0/os/$arch\"\n }\n}"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/media/create","name":"create","apis":[{"api_url":"/api/media","http_method":"POST","short_description":"Create a medium","deprecated":null}],"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","metadata":null,"show":true,"params":[{"name":"name","full_name":"medium[name]","description":"\n

Name of media

\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"path","full_name":"medium[path]","description":"\n

The path to the medium, can be a URL or a valid NFS server (exclusive of the architecture).

\n\n

for example http://mirror.centos.org/centos/$version/os/$arch where $arch will be substituted for the host\u2019s actual OS architecture and $version, $major and $minor will be substituted for the version of the operating system.

\n\n

Solaris and Debian media may also use $release.

\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"os_family","full_name":"medium[os_family]","description":"\n

Operating system family, available values: %{operatingsystem_families}

\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"operatingsystem_ids","full_name":"medium[operatingsystem_ids]","description":"","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"location_ids","full_name":"medium[location_ids]","description":"\n

REPLACE locations with given ids

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"organization_ids","full_name":"medium[organization_ids]","description":"\n

REPLACE organizations with given ids.

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":["POST /api/media\n{\n \"medium\": {\n \"name\": \"new medium\",\n \"path\": \"http://www.newmedium.com/\"\n }\n}\n201\n{\n \"medium\": {\n \"name\": \"new medium\",\n \"id\": 1011586619\n }\n}"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/media/update","name":"update","apis":[{"api_url":"/api/media/:id","http_method":"PUT","short_description":"Update a medium","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"medium","full_name":"medium","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"medium[name]","description":"\n

Name of media

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"path","full_name":"medium[path]","description":"\n

The path to the medium, can be a URL or a valid NFS server (exclusive of the architecture).

\n\n

for example http://mirror.centos.org/centos/$version/os/$arch where $arch will be substituted for the host\u2019s actual OS architecture and $version, $major and $minor will be substituted for the version of the operating system.

\n\n

Solaris and Debian media may also use $release.

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"os_family","full_name":"medium[os_family]","description":"\n

Operating system family, available values: %{operatingsystem_families}

\n","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"operatingsystem_ids","full_name":"medium[operatingsystem_ids]","description":"","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"location_ids","full_name":"medium[location_ids]","description":"\n

REPLACE locations with given ids

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"organization_ids","full_name":"medium[organization_ids]","description":"\n

REPLACE organizations with given ids.

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":["PUT /api/media/980190962\n{\n \"name\": \"CentOS 5.4\"\n}\n200\n{\n \"medium\": {\n \"name\": \"CentOS 5.4\",\n \"id\": 980190962\n }\n}"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/media/destroy","name":"destroy","apis":[{"api_url":"/api/media/:id","http_method":"DELETE","short_description":"Delete a medium","deprecated":null}],"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","metadata":null,"show":true}],"examples":["DELETE /api/media/338446587\n200\n{\n \"medium\": {\n \"name\": \"unused\",\n \"id\": 338446587\n }\n}"],"metadata":null,"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,"metadata":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","deprecated":null},{"api_url":"/api/hosts/:host_id/facts","http_method":"GET","short_description":"List all fact values of a given host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"\n

filter results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n

sort results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n

paginate results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n

number of entries per request

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/hosts/my5name.mydomain.net/facts\n200\n{\n \"my5name.mydomain.net\": {\n \"ipaddress\": \"10.0.19.33\",\n \"kernelversion\": \"2.6.9\"\n }\n}"],"metadata":null,"see":[]}]},"hostgroups":{"doc_url":"../apidoc/v2/hostgroups","api_url":"/api","name":"Hostgroups","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/hostgroups/index","name":"index","apis":[{"api_url":"/api/hostgroups","http_method":"GET","short_description":"List all host groups","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n

Scope by locations

\n","required":false,"allow_nil":false,"validator":"Must be Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"organization_id","full_name":"organization_id","description":"\n

Scope by organizations

\n","required":false,"allow_nil":false,"validator":"Must be Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"search","full_name":"search","description":"\n

filter results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n

sort results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n

paginate results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n

number of entries per request

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/hostgroups\n200\n[\n {\n \"hostgroup\": {\n \"name\": \"db\",\n \"label\": \"db\",\n \"id\": 603241515,\n \"operatingsystem_id\": 309172073,\n \"ancestry\": null,\n \"environment_id\": 334344675,\n \"parameters\": {},\n \"subnet_id\": null,\n \"domain_id\": null,\n \"puppetclass_ids\": []\n }\n },\n {\n \"hostgroup\": {\n \"name\": \"Common\",\n \"label\": \"Common\",\n \"id\": 636252244,\n \"operatingsystem_id\": 309172073,\n \"ancestry\": null,\n \"environment_id\": 334344675,\n \"parameters\": {\n \"group1\": \"group1\"\n },\n \"subnet_id\": null,\n \"domain_id\": 22495316,\n \"puppetclass_ids\": [\n 980190962\n ]\n }\n },\n {\n \"hostgroup\": {\n \"name\": \"Unusual\",\n \"label\": \"Unusual\",\n \"id\": 866317115,\n \"operatingsystem_id\": null,\n \"ancestry\": null,\n \"environment_id\": null,\n \"parameters\": {},\n \"subnet_id\": null,\n \"domain_id\": null,\n \"puppetclass_ids\": []\n }\n }\n]"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/hostgroups/show","name":"show","apis":[{"api_url":"/api/hostgroups/:id","http_method":"GET","short_description":"Show a host group","deprecated":null}],"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","metadata":null,"show":true}],"examples":["GET /api/hostgroups/636252244-common\n200\n{\n \"hostgroup\": {\n \"name\": \"Common\",\n \"label\": \"Common\",\n \"id\": 636252244,\n \"operatingsystem_id\": 309172073,\n \"ancestry\": null,\n \"environment_id\": 334344675,\n \"parameters\": {\n \"group1\": \"group1\"\n },\n \"subnet_id\": null,\n \"domain_id\": 22495316,\n \"puppetclass_ids\": [\n 980190962\n ]\n }\n}"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/hostgroups/create","name":"create","apis":[{"api_url":"/api/hostgroups","http_method":"POST","short_description":"Create a host group","deprecated":null}],"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","metadata":null,"show":true,"params":[{"name":"name","full_name":"hostgroup[name]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"parent_id","full_name":"hostgroup[parent_id]","description":"","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"environment_id","full_name":"hostgroup[environment_id]","description":"","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"operatingsystem_id","full_name":"hostgroup[operatingsystem_id]","description":"","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"architecture_id","full_name":"hostgroup[architecture_id]","description":"","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"medium_id","full_name":"hostgroup[medium_id]","description":"","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"ptable_id","full_name":"hostgroup[ptable_id]","description":"","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"puppet_ca_proxy_id","full_name":"hostgroup[puppet_ca_proxy_id]","description":"","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"subnet_id","full_name":"hostgroup[subnet_id]","description":"","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"domain_id","full_name":"hostgroup[domain_id]","description":"","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"realm_id","full_name":"hostgroup[realm_id]","description":"","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"puppet_proxy_id","full_name":"hostgroup[puppet_proxy_id]","description":"","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"location_ids","full_name":"hostgroup[location_ids]","description":"\n

REPLACE locations with given ids

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"organization_ids","full_name":"hostgroup[organization_ids]","description":"\n

REPLACE organizations with given ids.

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":["POST /api/hostgroups\n{\n \"hostgroup\": {\n \"name\": \"TestHostgroup\"\n }\n}\n200\n{\n \"hostgroup\": {\n \"name\": \"TestHostgroup\",\n \"label\": \"TestHostgroup\",\n \"id\": 866317116,\n \"operatingsystem_id\": null,\n \"ancestry\": null,\n \"environment_id\": null,\n \"parameters\": {},\n \"subnet_id\": null,\n \"domain_id\": null,\n \"puppetclass_ids\": []\n }\n}"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/hostgroups/update","name":"update","apis":[{"api_url":"/api/hostgroups/:id","http_method":"PUT","short_description":"Update a host group","deprecated":null}],"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","metadata":null,"show":true},{"name":"hostgroup","full_name":"hostgroup","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"hostgroup[name]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"parent_id","full_name":"hostgroup[parent_id]","description":"","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"environment_id","full_name":"hostgroup[environment_id]","description":"","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"operatingsystem_id","full_name":"hostgroup[operatingsystem_id]","description":"","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"architecture_id","full_name":"hostgroup[architecture_id]","description":"","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"medium_id","full_name":"hostgroup[medium_id]","description":"","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"ptable_id","full_name":"hostgroup[ptable_id]","description":"","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"puppet_ca_proxy_id","full_name":"hostgroup[puppet_ca_proxy_id]","description":"","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"subnet_id","full_name":"hostgroup[subnet_id]","description":"","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"domain_id","full_name":"hostgroup[domain_id]","description":"","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"realm_id","full_name":"hostgroup[realm_id]","description":"","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"puppet_proxy_id","full_name":"hostgroup[puppet_proxy_id]","description":"","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"location_ids","full_name":"hostgroup[location_ids]","description":"\n

REPLACE locations with given ids

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"organization_ids","full_name":"hostgroup[organization_ids]","description":"\n

REPLACE organizations with given ids.

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":["PUT /api/hostgroups/636252244-common\n{\n \"hostgroup\": {}\n}\n200\n{\n \"hostgroup\": {\n \"name\": \"Common\",\n \"label\": \"Common\",\n \"id\": 636252244,\n \"operatingsystem_id\": 309172073,\n \"ancestry\": null,\n \"parameters\": {\n \"group1\": \"group1\"\n },\n \"environment_id\": 334344675,\n \"subnet_id\": null,\n \"domain_id\": 22495316,\n \"puppetclass_ids\": [\n 980190962\n ]\n }\n}"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/hostgroups/destroy","name":"destroy","apis":[{"api_url":"/api/hostgroups/:id","http_method":"DELETE","short_description":"Delete a host group","deprecated":null}],"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","metadata":null,"show":true}],"examples":["DELETE /api/hostgroups/636252244-common\n200\n{\n \"hostgroup\": {\n \"name\": \"Common\",\n \"label\": \"Common\",\n \"id\": 636252244,\n \"operatingsystem_id\": 309172073,\n \"ancestry\": null,\n \"parameters\": {},\n \"environment_id\": 334344675,\n \"subnet_id\": null,\n \"domain_id\": 22495316,\n \"puppetclass_ids\": []\n }\n}"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/hostgroups/clone","name":"clone","apis":[{"api_url":"/api/hostgroups/:id/clone","http_method":"POST","short_description":"Clone a host group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"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,"metadata":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","deprecated":null},{"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","deprecated":null}],"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","metadata":null,"show":true},{"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","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n

paginate results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n

number of entries per request

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"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","deprecated":null},{"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","deprecated":null}],"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","metadata":null,"show":true},{"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","metadata":null,"show":true},{"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","metadata":null,"show":true}],"examples":[],"metadata":null,"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","deprecated":null},{"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","deprecated":null}],"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","metadata":null,"show":true},{"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","metadata":null,"show":true},{"name":"override_value","full_name":"override_value","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"match","full_name":"override_value[match]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"value","full_name":"override_value[value]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}]}],"examples":[],"metadata":null,"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","deprecated":null},{"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","deprecated":null}],"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","metadata":null,"show":true},{"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","metadata":null,"show":true},{"name":"override_value","full_name":"override_value","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"match","full_name":"override_value[match]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"value","full_name":"override_value[value]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}]}],"examples":[],"metadata":null,"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","deprecated":null},{"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","deprecated":null}],"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","metadata":null,"show":true},{"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","metadata":null,"show":true},{"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","metadata":null,"show":true}],"examples":[],"metadata":null,"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,"metadata":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","deprecated":null},{"api_url":"/api/hosts/:host_id/smart_variables","http_method":"GET","short_description":"List of smart variables for a specific host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/smart_variables","http_method":"GET","short_description":"List of smart variables for a specific host group","deprecated":null},{"api_url":"/api/puppetclasses/:puppetclass_id/smart_variables","http_method":"GET","short_description":"List of smart variables for a specific Puppet class","deprecated":null}],"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","metadata":null,"show":true},{"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","metadata":null,"show":true},{"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","metadata":null,"show":true},{"name":"search","full_name":"search","description":"\n

filter results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n

sort results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n

paginate results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n

number of entries per request

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"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","deprecated":null}],"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","metadata":null,"show":true}],"examples":[],"metadata":null,"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","deprecated":null}],"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","metadata":null,"show":true,"params":[{"name":"variable","full_name":"smart_variable[variable]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"puppetclass_id","full_name":"smart_variable[puppetclass_id]","description":"","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"default_value","full_name":"smart_variable[default_value]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"override_value_order","full_name":"smart_variable[override_value_order]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"description","full_name":"smart_variable[description]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"validator_type","full_name":"smart_variable[validator_type]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"validator_rule","full_name":"smart_variable[validator_rule]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"variable_type","full_name":"smart_variable[variable_type]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}]}],"examples":[],"metadata":null,"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","deprecated":null}],"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","metadata":null,"show":true},{"name":"smart_variable","full_name":"smart_variable","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"variable","full_name":"smart_variable[variable]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"puppetclass_id","full_name":"smart_variable[puppetclass_id]","description":"","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"default_value","full_name":"smart_variable[default_value]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"override_value_order","full_name":"smart_variable[override_value_order]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"description","full_name":"smart_variable[description]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"validator_type","full_name":"smart_variable[validator_type]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"validator_rule","full_name":"smart_variable[validator_rule]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"variable_type","full_name":"smart_variable[variable_type]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}]}],"examples":[],"metadata":null,"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","deprecated":null}],"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","metadata":null,"show":true}],"examples":[],"metadata":null,"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,"metadata":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 Puppet class IDs for host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"metadata":null,"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 Puppet class to host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n

ID of host

\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"puppetclass_id","full_name":"puppetclass_id","description":"\n

ID of puppetclass

\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"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 Puppet class from host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n

ID of host

\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"id","full_name":"id","description":"\n

ID of Puppet class

\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[]}]},"compute_attributes":{"doc_url":"../apidoc/v2/compute_attributes","api_url":"/api","name":"Compute attributes","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/compute_attributes/create","name":"create","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/compute_profiles/:compute_profile_id/compute_attributes","http_method":"POST","short_description":"Create a compute attributes set","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_resources/:compute_resource_id/compute_attributes","http_method":"POST","short_description":"Create a compute attributes set","deprecated":null},{"api_url":"/api/compute_resources/:compute_resource_id/compute_attributes","http_method":"POST","short_description":"Create a compute attributes set","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_attributes","http_method":"POST","short_description":"Create a compute attributes set","deprecated":null},{"api_url":"/api/compute_attributes","http_method":"POST","short_description":"Create a compute attributes set","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"compute_profile_id","full_name":"compute_profile_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","metadata":null,"show":true},{"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","metadata":null,"show":true},{"name":"compute_attribute","full_name":"compute_attribute","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"vm_attrs","full_name":"compute_attribute[vm_attrs]","description":"","required":true,"allow_nil":false,"validator":"Must be Hash","expected_type":"hash","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/compute_attributes/update","name":"update","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/compute_profiles/:compute_profile_id/compute_attributes/:id","http_method":"PUT","short_description":"Update a compute attributes set","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_resources/:compute_resource_id/compute_attributes/:id","http_method":"PUT","short_description":"Update a compute attributes set","deprecated":null},{"api_url":"/api/compute_resources/:compute_resource_id/compute_attributes/:id","http_method":"PUT","short_description":"Update a compute attributes set","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_attributes/:id","http_method":"PUT","short_description":"Update a compute attributes set","deprecated":null},{"api_url":"/api/compute_attributes/:id","http_method":"PUT","short_description":"Update a compute attributes set","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"compute_profile_id","full_name":"compute_profile_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","metadata":null,"show":true},{"name":"compute_resource_id","full_name":"compute_resource_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","metadata":null,"show":true},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"compute_attribute","full_name":"compute_attribute","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"vm_attrs","full_name":"compute_attribute[vm_attrs]","description":"","required":false,"allow_nil":false,"validator":"Must be Hash","expected_type":"hash","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[]}]},"organizations":{"doc_url":"../apidoc/v2/organizations","api_url":"/api","name":"Organizations","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/organizations/index","name":"index","apis":[{"api_url":"/api/organizations","http_method":"GET","short_description":"List all organizations","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"\n

filter results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n

sort results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n

paginate results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n

number of entries per request

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/organizations/show","name":"show","apis":[{"api_url":"/api/organizations/:id","http_method":"GET","short_description":"Show an organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/organizations/create","name":"create","apis":[{"api_url":"/api/organizations","http_method":"POST","short_description":"Create an organization","deprecated":null}],"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","metadata":null,"show":true,"params":[{"name":"name","full_name":"organization[name]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"user_ids","full_name":"organization[user_ids]","description":"\n

User IDs

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"smart_proxy_ids","full_name":"organization[smart_proxy_ids]","description":"\n

Smart proxy IDs

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"compute_resource_ids","full_name":"organization[compute_resource_ids]","description":"\n

Compute resource IDs

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"media_ids","full_name":"organization[media_ids]","description":"\n

Media IDs

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"config_template_ids","full_name":"organization[config_template_ids]","description":"\n

Provisioning template IDs

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"domain_ids","full_name":"organization[domain_ids]","description":"\n

Domain IDs

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"realm_ids","full_name":"organization[realm_ids]","description":"\n

Realm IDs

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"hostgroup_ids","full_name":"organization[hostgroup_ids]","description":"\n

Host group IDs

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"environment_ids","full_name":"organization[environment_ids]","description":"\n

Environment IDs

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"subnet_ids","full_name":"organization[subnet_ids]","description":"\n

Subnet IDs

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/organizations/update","name":"update","apis":[{"api_url":"/api/organizations/:id","http_method":"PUT","short_description":"Update an organization","deprecated":null}],"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","metadata":null,"show":true,"params":[{"name":"name","full_name":"organization[name]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"user_ids","full_name":"organization[user_ids]","description":"\n

User IDs

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"smart_proxy_ids","full_name":"organization[smart_proxy_ids]","description":"\n

Smart proxy IDs

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"compute_resource_ids","full_name":"organization[compute_resource_ids]","description":"\n

Compute resource IDs

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"media_ids","full_name":"organization[media_ids]","description":"\n

Media IDs

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"config_template_ids","full_name":"organization[config_template_ids]","description":"\n

Provisioning template IDs

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"domain_ids","full_name":"organization[domain_ids]","description":"\n

Domain IDs

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"realm_ids","full_name":"organization[realm_ids]","description":"\n

Realm IDs

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"hostgroup_ids","full_name":"organization[hostgroup_ids]","description":"\n

Host group IDs

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"environment_ids","full_name":"organization[environment_ids]","description":"\n

Environment IDs

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"subnet_ids","full_name":"organization[subnet_ids]","description":"\n

Subnet IDs

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/organizations/destroy","name":"destroy","apis":[{"api_url":"/api/organizations/:id","http_method":"DELETE","short_description":"Delete an organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"metadata":null,"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,"metadata":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","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"\n

filter results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n

sort results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n

paginate results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n

number of entries per request

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/template_kinds\n200\n[\n {\n \"template_kind\": {\n \"name\": \"PXELinux\",\n \"id\": 452984334\n }\n },\n {\n \"template_kind\": {\n \"name\": \"script\",\n \"id\": 478250810\n }\n },\n {\n \"template_kind\": {\n \"name\": \"gPXE\",\n \"id\": 158998239\n }\n },\n {\n \"template_kind\": {\n \"name\": \"finish\",\n \"id\": 550103832\n }\n },\n {\n \"template_kind\": {\n \"name\": \"provision\",\n \"id\": 983253650\n }\n }\n]"],"metadata":null,"see":[]}]},"users":{"doc_url":"../apidoc/v2/users","api_url":"/api","name":"Users","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/users/index","name":"index","apis":[{"api_url":"/api/users","http_method":"GET","short_description":"List all users","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n

Scope by locations

\n","required":false,"allow_nil":false,"validator":"Must be Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"organization_id","full_name":"organization_id","description":"\n

Scope by organizations

\n","required":false,"allow_nil":false,"validator":"Must be Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"search","full_name":"search","description":"\n

filter results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n

sort results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n

paginate results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n

number of entries per request

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/users\n200\n[\n {\n \"user\": {\n \"domains_andor\": \"or\",\n \"filter_on_owner\": null,\n \"role_id\": null,\n \"mail\": \"admin@someware.com\",\n \"id\": 135138680,\n \"hostgroups_andor\": \"or\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"compute_resources_andor\": \"or\",\n \"admin\": true,\n \"last_login_on\": \"2009-10-12T21:50:04Z\",\n \"lastname\": \"User\",\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"login\": \"admin\",\n \"firstname\": \"Admin\",\n \"facts_andor\": \"or\",\n \"auth_source_id\": 980190962\n }\n },\n {\n \"user\": {\n \"domains_andor\": \"or\",\n \"filter_on_owner\": null,\n \"role_id\": null,\n \"mail\": \"apiadmin@someware.com\",\n \"id\": 886836129,\n \"hostgroups_andor\": \"or\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"compute_resources_andor\": \"or\",\n \"admin\": true,\n \"last_login_on\": \"2009-10-12T21:50:04Z\",\n \"lastname\": \"User\",\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"login\": \"apiadmin\",\n \"firstname\": \"apiadmin\",\n \"facts_andor\": \"or\",\n \"auth_source_id\": 200482051\n }\n },\n {\n \"user\": {\n \"domains_andor\": \"or\",\n \"filter_on_owner\": null,\n \"role_id\": null,\n \"mail\": \"userone@someware.com\",\n \"id\": 980190962,\n \"hostgroups_andor\": \"or\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"compute_resources_andor\": \"or\",\n \"admin\": false,\n \"last_login_on\": \"2009-10-12T21:50:04Z\",\n \"lastname\": \"User\",\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"login\": \"one\",\n \"firstname\": \"One\",\n \"facts_andor\": \"or\",\n \"auth_source_id\": 980190962\n }\n },\n {\n \"user\": {\n \"domains_andor\": \"or\",\n \"filter_on_owner\": null,\n \"role_id\": null,\n \"mail\": \"testuser@someware.com\",\n \"id\": 200482051,\n \"hostgroups_andor\": \"or\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"compute_resources_andor\": \"or\",\n \"admin\": false,\n \"last_login_on\": \"2009-10-12T21:50:04Z\",\n \"lastname\": \"User\",\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"login\": \"test\",\n \"firstname\": \"test\",\n \"facts_andor\": \"or\",\n \"auth_source_id\": 200482051\n }\n },\n {\n \"user\": {\n \"domains_andor\": \"or\",\n \"filter_on_owner\": null,\n \"role_id\": null,\n \"mail\": \"usertwo@someware.com\",\n \"id\": 298486374,\n \"hostgroups_andor\": \"or\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"compute_resources_andor\": \"or\",\n \"admin\": false,\n \"last_login_on\": \"2009-10-12T21:50:04Z\",\n \"lastname\": \"User\",\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"login\": \"two\",\n \"firstname\": \"Two\",\n \"facts_andor\": \"or\",\n \"auth_source_id\": 980190962\n }\n }\n]"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/users/show","name":"show","apis":[{"api_url":"/api/users/:id","http_method":"GET","short_description":"Show a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/users/980190962-one\n200\n{\n \"user\": {\n \"domains_andor\": \"or\",\n \"filter_on_owner\": null,\n \"roles\": [\n {\n \"role\": {\n \"name\": \"Viewer\",\n \"id\": 5,\n \"builtin\": 0,\n \"permissions\": [\n \"view_architectures\",\n \"view_audit_logs\",\n \"view_authenticators\",\n \"access_dashboard\",\n \"view_domains\",\n \"view_environments\",\n \"view_external_variables\",\n \"view_facts\",\n \"view_globals\",\n \"view_hostgroups\",\n \"view_hosts\",\n \"view_locations\",\n \"view_media\",\n \"view_models\",\n \"view_operatingsystems\",\n \"view_ptables\",\n \"view_puppetclasses\",\n \"view_reports\",\n \"access_settings\",\n \"view_statistics\",\n \"view_organizations\",\n \"view_usergroups\",\n \"view_users\"\n ]\n }\n },\n {\n \"role\": {\n \"name\": \"Anonymous\",\n \"id\": 7,\n \"builtin\": 2,\n \"permissions\": [\n \"view_hosts\"\n ]\n }\n }\n ],\n \"role_id\": null,\n \"auth_source_ldap\": {\n \"name\": \"ldap\",\n \"tls\": true,\n \"attr_login\": \"uid\",\n \"attr_firstname\": \"givenName\",\n \"port\": 123,\n \"attr_lastname\": \"sn\",\n \"id\": 980190962,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"attr_mail\": \"mail\",\n \"base_dn\": \"dn=x,dn=y\",\n \"host\": \"ldap\",\n \"account\": null,\n \"type\": \"AuthSourceLdap\",\n \"onthefly_register\": true,\n \"created_at\": \"2012-12-18T15:24:43Z\"\n },\n \"mail\": \"userone@someware.com\",\n \"id\": 980190962,\n \"hostgroups_andor\": \"or\",\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"compute_resources_andor\": \"or\",\n \"admin\": false,\n \"last_login_on\": \"2009-10-12T21:50:04Z\",\n \"lastname\": \"User\",\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"login\": \"one\",\n \"firstname\": \"One\",\n \"facts_andor\": \"or\",\n \"auth_source_id\": 980190962\n }\n}"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/users/create","name":"create","apis":[{"api_url":"/api/users","http_method":"POST","short_description":"Create a user","deprecated":null}],"formats":null,"full_description":"\n

Adds role \u2018Anonymous\u2019 to the user by default

\n","errors":[],"params":[{"name":"user","full_name":"user","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"login","full_name":"user[login]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"firstname","full_name":"user[firstname]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"lastname","full_name":"user[lastname]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"mail","full_name":"user[mail]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"admin","full_name":"user[admin]","description":"\n

is an admin account

\n","required":false,"allow_nil":true,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true},{"name":"password","full_name":"user[password]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"default_location_id","full_name":"user[default_location_id]","description":"","required":false,"allow_nil":true,"validator":"Must be Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"default_organization_id","full_name":"user[default_organization_id]","description":"","required":false,"allow_nil":true,"validator":"Must be Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"auth_source_id","full_name":"user[auth_source_id]","description":"","required":true,"allow_nil":false,"validator":"Must be Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"location_ids","full_name":"user[location_ids]","description":"\n

REPLACE locations with given ids

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"organization_ids","full_name":"user[organization_ids]","description":"\n

REPLACE organizations with given ids.

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/users/update","name":"update","apis":[{"api_url":"/api/users/:id","http_method":"PUT","short_description":"Update a user","deprecated":null}],"formats":null,"full_description":"\n

Adds role \u2018Anonymous\u2019 to the user if it is not already present. Only another admin can change the admin account attribute.

\n","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"user","full_name":"user","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"login","full_name":"user[login]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"firstname","full_name":"user[firstname]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"lastname","full_name":"user[lastname]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"mail","full_name":"user[mail]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"admin","full_name":"user[admin]","description":"\n

is an admin account

\n","required":false,"allow_nil":true,"validator":"Must be 'true' or 'false'","expected_type":"string","metadata":null,"show":true},{"name":"password","full_name":"user[password]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"default_location_id","full_name":"user[default_location_id]","description":"","required":false,"allow_nil":true,"validator":"Must be Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"default_organization_id","full_name":"user[default_organization_id]","description":"","required":false,"allow_nil":true,"validator":"Must be Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"auth_source_id","full_name":"user[auth_source_id]","description":"","required":false,"allow_nil":false,"validator":"Must be Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"location_ids","full_name":"user[location_ids]","description":"\n

REPLACE locations with given ids

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"organization_ids","full_name":"user[organization_ids]","description":"\n

REPLACE organizations with given ids.

\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":["PUT /api/users/980190963\n{\n \"user\": {\n \"password_confirmation\": \"DUMMY\",\n \"password\": \"dummy\",\n \"login\": \"johnsmith\"\n }\n}\n422\n{\n \"user\": {\n \"id\": 980190963,\n \"errors\": {\n \"password\": [\n \"doesn't match confirmation\"\n ]\n },\n \"full_messages\": [\n \"Password doesn't match confirmation\"\n ]\n }\n}"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/users/destroy","name":"destroy","apis":[{"api_url":"/api/users/:id","http_method":"DELETE","short_description":"Delete a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["DELETE /api/users/980190962\n200\n{\n \"user\": {\n \"filter_on_owner\": null,\n \"domains_andor\": \"or\",\n \"role_id\": null,\n \"organizations_andor\": \"or\",\n \"mail\": \"userone@someware.com\",\n \"id\": 980190962,\n \"updated_at\": \"2012-12-18T15:24:42Z\",\n \"hostgroups_andor\": \"or\",\n \"compute_resources_andor\": \"or\",\n \"admin\": false,\n \"password_hash\": null,\n \"last_login_on\": \"2009-10-12T21:50:04Z\",\n \"locations_andor\": \"or\",\n \"lastname\": \"User\",\n \"password_salt\": null,\n \"login\": \"one\",\n \"created_at\": \"2012-12-18T15:24:42Z\",\n \"firstname\": \"One\",\n \"facts_andor\": \"or\",\n \"auth_source_id\": 980190962\n }\n}"],"metadata":null,"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,"metadata":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","deprecated":null}],"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","metadata":null,"show":true}],"examples":[],"metadata":null,"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","deprecated":null}],"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","metadata":null,"show":true},{"name":"template_combination","full_name":"template_combination","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"environment_id","full_name":"template_combination[environment_id]","description":"\n

environment id

\n","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true},{"name":"hostgroup_id","full_name":"template_combination[hostgroup_id]","description":"\n

host group id

\n","required":false,"allow_nil":true,"validator":"Must be a number.","expected_type":"string","metadata":null,"show":true}]}],"examples":[],"metadata":null,"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","deprecated":null}],"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","metadata":null,"show":true}],"examples":[],"metadata":null,"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 combination","deprecated":null}],"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","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[]}]},"ptables":{"doc_url":"../apidoc/v2/ptables","api_url":"/api","name":"Ptables","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/ptables/index","name":"index","apis":[{"api_url":"/api/ptables","http_method":"GET","short_description":"List all partition tables","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"\n

filter results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n

sort results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n

paginate results

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n

number of entries per request

\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["GET /api/ptables\n200\n[\n {\n \"ptable\": {\n \"name\": \"default\",\n \"id\": 980190962,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"created_at\": \"2012-12-18T15:24:43Z\"\n }\n },\n {\n \"ptable\": {\n \"name\": \"four\",\n \"id\": 281110143,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"created_at\": \"2012-12-18T15:24:43Z\"\n }\n },\n {\n \"ptable\": {\n \"name\": \"suse default\",\n \"id\": 859751735,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"created_at\": \"2012-12-18T15:24:43Z\"\n }\n },\n {\n \"ptable\": {\n \"name\": \"ubuntu default\",\n \"id\": 1011586618,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"created_at\": \"2012-12-18T15:24:43Z\"\n }\n }\n]"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/ptables/show","name":"show","apis":[{"api_url":"/api/ptables/:id","http_method":"GET","short_description":"Show a partition table","deprecated":null}],"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","metadata":null,"show":true}],"examples":["GET /api/ptables/980190962\n200\n{\n \"ptable\": {\n \"name\": \"default\",\n \"id\": 980190962,\n \"updated_at\": \"2012-12-18T15:24:43Z\",\n \"created_at\": \"2012-12-18T15:24:43Z\"\n }\n}"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/ptables/create","name":"create","apis":[{"api_url":"/api/ptables","http_method":"POST","short_description":"Create a partition table","deprecated":null}],"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","metadata":null,"show":true,"params":[{"name":"name","full_name":"ptable[name]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"layout","full_name":"ptable[layout]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"os_family","full_name":"ptable[os_family]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}]}],"examples":["POST /api/ptables\n{\n \"ptable\": {\n \"name\": \"ptable_test\",\n \"layout\": \"d-i partman-auto/disk\"\n }\n}\n201\n{\n \"ptable\": {\n \"name\": \"ptable_test\",\n \"id\": 1011586619\n }\n}"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/ptables/update","name":"update","apis":[{"api_url":"/api/ptables/:id","http_method":"PUT","short_description":"Update a partition table","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"ptable","full_name":"ptable","description":"","required":true,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"ptable[name]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"layout","full_name":"ptable[layout]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"os_family","full_name":"ptable[os_family]","description":"","required":false,"allow_nil":true,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}]}],"examples":["PUT /api/ptables/980190962\n{\n \"ptable\": {}\n}\n200\n{\n \"ptable\": {\n \"name\": \"default\",\n \"id\": 980190962\n }\n}"],"metadata":null,"see":[]},{"doc_url":"../apidoc/v2/ptables/destroy","name":"destroy","apis":[{"api_url":"/api/ptables/:id","http_method":"DELETE","short_description":"Delete a partition table","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":["DELETE /api/ptables/980190962\n422\n{\n \"ptable\": {\n \"id\": 980190962,\n \"errors\": {\n \"base\": [\n \"default is used by temp01.yourdomain.net\",\n \"default is used by temp.yourdomain.net\",\n \"default is used by my5name.mydomain.net\",\n \"default is used by dhcp.mydomain.net\",\n \"default is used by sdhcp.mydomain.net\"\n ]\n },\n \"full_messages\": [\n \"default is used by temp01.yourdomain.net\",\n \"default is used by temp.yourdomain.net\",\n \"default is used by my5name.mydomain.net\",\n \"default is used by dhcp.mydomain.net\",\n \"default is used by sdhcp.mydomain.net\"\n ]\n }\n}"],"metadata":null,"see":[]}]}},"link_extension":".html"}}