hammer_cli_foreman 3.0.0 → 3.1.0

data/test/data/3.1/foreman_api.json

@@ -0,0 +1 @@
+{"docs":{"name":"Foreman","info":"\n\u003cp\u003eForeman API v2 is currently the default API version.\u003c/p\u003e\n","copyright":"","doc_url":"../apidoc/v2","api_url":"/api","resources":{"architectures":{"doc_url":"../apidoc/v2/architectures","id":"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},{"api_url":"/api/operatingsystems/:operatingsystem_id/architectures","http_method":"GET","short_description":"List all architectures for operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, ‘all’ to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["GET /api/architectures\n200\n{\n  \"total\": 21,\n  \"subtotal\": 21,\n  \"page\": 1,\n  \"per_page\": 21,\n  \"search\": null,\n  \"sort\": {\n    \"by\": null,\n    \"order\": null\n  },\n  \"results\": [\n    {\n      \"created_at\": \"2021-05-18 11:53:21 UTC\",\n      \"updated_at\": \"2021-05-18 11:53:21 UTC\",\n      \"name\": \"x86_64\",\n      \"id\": 501905019\n    },\n    {\n      \"created_at\": \"2021-05-18 11:53:21 UTC\",\n      \"updated_at\": \"2021-05-18 11:53:21 UTC\",\n      \"name\": \"sparc\",\n      \"id\": 331892513\n    },\n    {\n      \"created_at\": \"2021-05-18 11:53:21 UTC\",\n      \"updated_at\": \"2021-05-18 11:53:21 UTC\",\n      \"name\": \"s390\",\n      \"id\": 381564594\n    },\n    {\n      \"created_at\": \"2021-05-18 11:53:21 UTC\",\n      \"updated_at\": \"2021-05-18 11:53:21 UTC\",\n      \"name\": \"s390x\",\n      \"id\": 820784047\n    },\n    {\n      \"created_at\": \"2021-05-18 11:53:21 UTC\",\n      \"updated_at\": \"2021-05-18 11:53:21 UTC\",\n      \"name\": \"ASIC\",\n      \"id\": 578327757\n    },\n    {\n      \"created_at\": \"2021-05-18 11:53:21 UTC\",\n      \"updated_at\": \"2021-05-18 11:53:21 UTC\",\n      \"name\": \"ppc64\",\n      \"id\": 922134521\n    },\n    {\n      \"created_at\": \"2021-05-18 11:54:15 UTC\",\n      \"updated_at\": \"2021-05-18 11:54:15 UTC\",\n      \"name\": \"x86_64-83\",\n      \"id\": 922134569\n    },\n    {\n      \"created_at\": \"2021-05-18 11:54:15 UTC\",\n      \"updated_at\": \"2021-05-18 11:54:15 UTC\",\n      \"name\": \"x86_64-84\",\n      \"id\": 922134570\n    },\n    {\n      \"created_at\": \"2021-05-18 11:54:15 UTC\",\n      \"updated_at\": \"2021-05-18 11:54:15 UTC\",\n      \"name\": \"x86_64-85\",\n      \"id\": 922134571\n    },\n    {\n      \"created_at\": \"2021-05-18 11:54:15 UTC\",\n      \"updated_at\": \"2021-05-18 11:54:15 UTC\",\n      \"name\": \"x86_64-86\",\n      \"id\": 922134572\n    },\n    {\n      \"created_at\": \"2021-05-18 11:54:15 UTC\",\n      \"updated_at\": \"2021-05-18 11:54:15 UTC\",\n      \"name\": \"x86_64-87\",\n      \"id\": 922134573\n    },\n    {\n      \"created_at\": \"2021-05-18 11:54:15 UTC\",\n      \"updated_at\": \"2021-05-18 11:54:15 UTC\",\n      \"name\": \"x86_64-88\",\n      \"id\": 922134574\n    },\n    {\n      \"created_at\": \"2021-05-18 11:54:15 UTC\",\n      \"updated_at\": \"2021-05-18 11:54:15 UTC\",\n      \"name\": \"x86_64-89\",\n      \"id\": 922134575\n    },\n    {\n      \"created_at\": \"2021-05-18 11:54:15 UTC\",\n      \"updated_at\": \"2021-05-18 11:54:15 UTC\",\n      \"name\": \"x86_64-90\",\n      \"id\": 922134576\n    },\n    {\n      \"created_at\": \"2021-05-18 11:54:15 UTC\",\n      \"updated_at\": \"2021-05-18 11:54:15 UTC\",\n      \"name\": \"x86_64-91\",\n      \"id\": 922134577\n    },\n    {\n      \"created_at\": \"2021-05-18 11:54:15 UTC\",\n      \"updated_at\": \"2021-05-18 11:54:15 UTC\",\n      \"name\": \"x86_64-92\",\n      \"id\": 922134578\n    },\n    {\n      \"created_at\": \"2021-05-18 11:54:15 UTC\",\n      \"updated_at\": \"2021-05-18 11:54:15 UTC\",\n      \"name\": \"x86_64-93\",\n      \"id\": 922134579\n    },\n    {\n      \"created_at\": \"2021-05-18 11:54:15 UTC\",\n      \"updated_at\": \"2021-05-18 11:54:15 UTC\",\n      \"name\": \"x86_64-94\",\n      \"id\": 922134580\n    },\n    {\n      \"created_at\": \"2021-05-18 11:54:15 UTC\",\n      \"updated_at\": \"2021-05-18 11:54:15 UTC\",\n      \"name\": \"x86_64-95\",\n      \"id\": 922134581\n    },\n    {\n      \"created_at\": \"2021-05-18 11:54:15 UTC\",\n      \"updated_at\": \"2021-05-18 11:54:15 UTC\",\n      \"name\": \"x86_64-96\",\n      \"id\": 922134582\n    },\n    {\n      \"created_at\": \"2021-05-18 11:54:15 UTC\",\n      \"updated_at\": \"2021-05-18 11:54:15 UTC\",\n      \"name\": \"x86_64-97\",\n      \"id\": 922134583\n    }\n  ]\n}"],"metadata":{"search":[{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"architecture","full_name":"architecture","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"architecture[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_ids","full_name":"architecture[operatingsystem_ids]","description":"\n\u003cp\u003eOperating system IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]},{"name":"architecture","full_name":"architecture","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"architecture[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_ids","full_name":"architecture[operatingsystem_ids]","description":"\n\u003cp\u003eOperating system IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"audits":{"doc_url":"../apidoc/v2/audits","id":"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, ‘all’ to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"action","type":"string"},{"name":"auditable_id","type":"integer"},{"name":"authored_by_user","type":"string"},{"name":"authored_by_user.id","type":"integer"},{"name":"changes","type":"text"},{"name":"comment","type":"string"},{"name":"host","type":"string"},{"name":"hostgroup","type":"string"},{"name":"hostgroup_title","type":"string"},{"name":"id","type":"integer"},{"name":"interface_fqdn","type":"string"},{"name":"interface_ip","type":"string"},{"name":"interface_mac","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"os","type":"string"},{"name":"os_title","type":"string"},{"name":"parameter","type":"string"},{"name":"partition_table","type":"string"},{"name":"provisioning_template","type":"string"},{"name":"puppetclass","type":""},{"name":"remote_address","type":"string"},{"name":"request_uuid","type":"string"},{"name":"setting","type":"string"},{"name":"time","type":"datetime"},{"name":"type","values":["operatingsystem","role","setting","ptable","provisioning_template","user","filter","subnet","smart_proxy","usergroup","hostgroup","domain","realm","auth_source","compute_resource","host","interface","location","organization","os","override_value","parameter","partition_table","smart_class_parameter"]},{"name":"user","type":"string"},{"name":"username","type":"string"}]},"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"auth_source_externals":{"doc_url":"../apidoc/v2/auth_source_externals","id":"auth_source_externals","api_url":"/api","name":"Auth source externals","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/auth_source_externals/index","name":"index","apis":[{"api_url":"/api/auth_source_externals","http_method":"GET","short_description":"List external authentication sources","deprecated":null},{"api_url":"/api/locations/:location_id/auth_source_externals","http_method":"GET","short_description":"List external authentication sources per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/auth_source_externals","http_method":"GET","short_description":"List external authentication sources per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, ‘all’ to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/auth_source_externals/show","name":"show","apis":[{"api_url":"/api/auth_source_externals/:id","http_method":"GET","short_description":"Show an external authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/auth_source_externals/update","name":"update","apis":[{"api_url":"/api/auth_source_externals/:id","http_method":"PUT","short_description":"Update an external authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]},{"name":"auth_source_external","full_name":"auth_source_external","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"auth_source_external[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"auth_source_external[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"auth_source_external[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"auth_source_internals":{"doc_url":"../apidoc/v2/auth_source_internals","id":"auth_source_internals","api_url":"/api","name":"Auth source internals","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/auth_source_internals/index","name":"index","apis":[{"api_url":"/api/auth_source_internals","http_method":"GET","short_description":"List internal authentication sources","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, ‘all’ to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["GET /api/auth_source_internals\n200\n{\n  \"total\": 1,\n  \"subtotal\": 1,\n  \"page\": 1,\n  \"per_page\": 20,\n  \"search\": null,\n  \"sort\": {\n    \"by\": null,\n    \"order\": null\n  },\n  \"results\": [\n    {\n      \"created_at\": \"2021-05-18 11:57:49 UTC\",\n      \"updated_at\": \"2021-05-18 11:57:49 UTC\",\n      \"id\": 200482051,\n      \"name\": \"Internal\"\n    }\n  ]\n}"],"metadata":{"search":[{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/auth_source_internals/show","name":"show","apis":[{"api_url":"/api/auth_source_internals/:id","http_method":"GET","short_description":"Show an internal authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]}],"returns":[],"examples":["GET /api/auth_source_internals/200482051\n200\n{\n  \"created_at\": \"2021-05-18 11:57:49 UTC\",\n  \"updated_at\": \"2021-05-18 11:57:49 UTC\",\n  \"id\": 200482051,\n  \"name\": \"Internal\"\n}"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"auth_source_ldaps":{"doc_url":"../apidoc/v2/auth_source_ldaps","id":"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},{"api_url":"/api/locations/:location_id/auth_source_ldaps","http_method":"GET","short_description":"List LDAP authentication sources per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/auth_source_ldaps","http_method":"GET","short_description":"List LDAP authentication sources per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, ‘all’ to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"auth_source_ldap","full_name":"auth_source_ldap","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"auth_source_ldap[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"host","full_name":"auth_source_ldap[host]","description":"\n\u003cp\u003eThe hostname of the LDAP server\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"port","full_name":"auth_source_ldap[port]","description":"\n\u003cp\u003edefaults to 389\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"account","full_name":"auth_source_ldap[account]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"base_dn","full_name":"auth_source_ldap[base_dn]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"account_password","full_name":"auth_source_ldap[account_password]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_login","full_name":"auth_source_ldap[attr_login]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_firstname","full_name":"auth_source_ldap[attr_firstname]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_lastname","full_name":"auth_source_ldap[attr_lastname]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_mail","full_name":"auth_source_ldap[attr_mail]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_photo","full_name":"auth_source_ldap[attr_photo]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"onthefly_register","full_name":"auth_source_ldap[onthefly_register]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"usergroup_sync","full_name":"auth_source_ldap[usergroup_sync]","description":"\n\u003cp\u003esync external user groups on login\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"tls","full_name":"auth_source_ldap[tls]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"groups_base","full_name":"auth_source_ldap[groups_base]","description":"\n\u003cp\u003egroups base DN\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"use_netgroups","full_name":"auth_source_ldap[use_netgroups]","description":"\n\u003cp\u003euse NIS netgroups instead of posix groups, applicable only when server_type is posix or free_ipa\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"server_type","full_name":"auth_source_ldap[server_type]","description":"\n\u003cp\u003etype of the LDAP server\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003efree_ipa\u003c/code\u003e, \u003ccode\u003eactive_directory\u003c/code\u003e, \u003ccode\u003eposix\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ldap_filter","full_name":"auth_source_ldap[ldap_filter]","description":"\n\u003cp\u003eLDAP filter\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"auth_source_ldap[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"auth_source_ldap[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"auth_source_ldap","full_name":"auth_source_ldap","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"auth_source_ldap[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"host","full_name":"auth_source_ldap[host]","description":"\n\u003cp\u003eThe hostname of the LDAP server\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"port","full_name":"auth_source_ldap[port]","description":"\n\u003cp\u003edefaults to 389\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"account","full_name":"auth_source_ldap[account]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"base_dn","full_name":"auth_source_ldap[base_dn]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"account_password","full_name":"auth_source_ldap[account_password]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_login","full_name":"auth_source_ldap[attr_login]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_firstname","full_name":"auth_source_ldap[attr_firstname]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_lastname","full_name":"auth_source_ldap[attr_lastname]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_mail","full_name":"auth_source_ldap[attr_mail]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_photo","full_name":"auth_source_ldap[attr_photo]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"onthefly_register","full_name":"auth_source_ldap[onthefly_register]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"usergroup_sync","full_name":"auth_source_ldap[usergroup_sync]","description":"\n\u003cp\u003esync external user groups on login\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"tls","full_name":"auth_source_ldap[tls]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"groups_base","full_name":"auth_source_ldap[groups_base]","description":"\n\u003cp\u003egroups base DN\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"use_netgroups","full_name":"auth_source_ldap[use_netgroups]","description":"\n\u003cp\u003euse NIS netgroups instead of posix groups, applicable only when server_type is posix or free_ipa\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"server_type","full_name":"auth_source_ldap[server_type]","description":"\n\u003cp\u003etype of the LDAP server\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003efree_ipa\u003c/code\u003e, \u003ccode\u003eactive_directory\u003c/code\u003e, \u003ccode\u003eposix\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ldap_filter","full_name":"auth_source_ldap[ldap_filter]","description":"\n\u003cp\u003eLDAP filter\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"auth_source_ldap[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"auth_source_ldap[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/auth_source_ldaps/test","name":"test","apis":[{"api_url":"/api/auth_source_ldaps/:id/test","http_method":"PUT","short_description":"Test LDAP connection","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"auth_sources":{"doc_url":"../apidoc/v2/auth_sources","id":"auth_sources","api_url":"/api","name":"Auth sources","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/auth_sources/index","name":"index","apis":[{"api_url":"/api/auth_sources","http_method":"GET","short_description":"List all authentication sources","deprecated":null},{"api_url":"/api/locations/:location_id/auth_sources","http_method":"GET","short_description":"List all authentication sources per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/auth_sources","http_method":"GET","short_description":"List all authentication sources per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, ‘all’ to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"}]},"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"autosign":{"doc_url":"../apidoc/v2/autosign","id":"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":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["GET /api/smart_proxies/182953976/autosign\n200\n{\n  \"results\": [\n    \"a5809524-82fe-a8a4f3d6ebf4\",\n    \"5eed0cb7-9aa-00b7b9780f20\"\n  ]\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/autosign/create","name":"create","apis":[{"api_url":"/api/smart_proxies/:smart_proxy_id/autosign","http_method":"POST","short_description":"Create autosign entry","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eAutosign entry name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["POST /api/smart_proxies/182953976/autosign\n{\n  \"id\": \"test\",\n  \"autosign\": {\n    \"id\": \"test\"\n  }\n}\n500\n{\n  \"error\": \"ERF12-6986 [ProxyAPI::ProxyException]: Test exception ([RuntimeError]: RuntimeError) for proxy http://else.where:4567\"\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/autosign/destroy","name":"destroy","apis":[{"api_url":"/api/smart_proxies/:smart_proxy_id/autosign/:id","http_method":"DELETE","short_description":"Delete autosign entry","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eAutosign entry name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["POST /api/smart_proxies/182953976/autosign/test\n{\n  \"autosign\": {}\n}\n200\n{\n  \"results\": true\n}"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"bookmarks":{"doc_url":"../apidoc/v2/bookmarks","id":"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, ‘all’ to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"controller","type":"string"},{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"bookmark","full_name":"bookmark","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"bookmark[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"controller","full_name":"bookmark[controller]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"query","full_name":"bookmark[query]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"public","full_name":"bookmark[public]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]},{"name":"bookmark","full_name":"bookmark","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"bookmark[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"controller","full_name":"bookmark[controller]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"query","full_name":"bookmark[query]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"public","full_name":"bookmark[public]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"common_parameters":{"doc_url":"../apidoc/v2/common_parameters","id":"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"show_hidden","full_name":"show_hidden","description":"\n\u003cp\u003eDisplay hidden values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, ‘all’ to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"domain_name","type":"string"},{"name":"host_group_name","type":"string"},{"name":"host_name","type":"string"},{"name":"key_type","type":"string"},{"name":"location_name","type":"string"},{"name":"name","type":"string"},{"name":"organization_name","type":"string"},{"name":"os_name","type":"string"},{"name":"parameter_type","type":"string"},{"name":"subnet_name","type":"text"},{"name":"type","type":"string"},{"name":"value","type":"text"}]},"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"show_hidden","full_name":"show_hidden","description":"\n\u003cp\u003eDisplay hidden values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"common_parameter","full_name":"common_parameter","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"common_parameter[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"common_parameter[value]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"common_parameter[parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"common_parameter[hidden_value]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]},{"name":"common_parameter","full_name":"common_parameter","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"common_parameter[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"common_parameter[value]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"common_parameter[parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"common_parameter[hidden_value]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"compute_attributes":{"doc_url":"../apidoc/v2/compute_attributes","id":"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/index","name":"index","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/compute_profiles/:compute_profile_id/compute_attributes","http_method":"GET","short_description":"List of compute attributes for provided compute profile and compute resource","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_resources/:compute_resource_id/compute_attributes","http_method":"GET","short_description":"List of compute attributes for provided compute profile and compute resource","deprecated":null},{"api_url":"/api/compute_resources/:compute_resource_id/compute_attributes","http_method":"GET","short_description":"List of compute attributes for compute resource","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_attributes","http_method":"GET","short_description":"List of compute attributes for compute profile","deprecated":null},{"api_url":"/api/compute_attributes/:id","http_method":"GET","short_description":"List of compute attributes","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_profile_id","full_name":"compute_profile_id","description":"\n\u003cp\u003eID of compute profile\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"\n\u003cp\u003eID of compute_resource\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, ‘all’ to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"compute_profile","type":"string"},{"name":"compute_resource","type":"string"},{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_attributes/show","name":"show","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/compute_profiles/:compute_profile_id/compute_attributes/:id","http_method":"GET","short_description":"Show a compute attributes set","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_resources/:compute_resource_id/compute_attributes/:id","http_method":"GET","short_description":"Show a compute attributes set","deprecated":null},{"api_url":"/api/compute_resources/:compute_resource_id/compute_attributes/:id","http_method":"GET","short_description":"Show a compute attributes set","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_attributes/:id","http_method":"GET","short_description":"Show a compute attributes set","deprecated":null},{"api_url":"/api/compute_attributes/:id","http_method":"GET","short_description":"Show a compute attributes set","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_profile_id","full_name":"compute_profile_id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]},{"name":"compute_attribute","full_name":"compute_attribute","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"vm_attrs","full_name":"compute_attribute[vm_attrs]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_profile_id","full_name":"compute_profile_id","description":"","required":false,"allow_nil":false,"allow_blank":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,"validations":[]},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"","required":false,"allow_nil":false,"allow_blank":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,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_attribute","full_name":"compute_attribute","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"vm_attrs","full_name":"compute_attribute[vm_attrs]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"compute_profiles":{"doc_url":"../apidoc/v2/compute_profiles","id":"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, ‘all’ to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_profile","full_name":"compute_profile","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"compute_profile[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_profile","full_name":"compute_profile","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"compute_profile[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"config_reports":{"doc_url":"../apidoc/v2/config_reports","id":"config_reports","api_url":"/api","name":"Config reports","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/config_reports/index","name":"index","apis":[{"api_url":"/api/config_reports","http_method":"GET","short_description":"List all reports","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, ‘all’ to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["GET /api/config_reports\n200\n{\n  \"total\": 1,\n  \"subtotal\": 1,\n  \"page\": 1,\n  \"per_page\": 20,\n  \"search\": \"\",\n  \"sort\": {\n    \"by\": null,\n    \"order\": null\n  },\n  \"results\": [\n    {\n      \"metrics\": {\n        \"time\": {\n          \"schedule\": 0.00083,\n          \"service\": 0.149739,\n          \"mailalias\": 0.000283,\n          \"cron\": 0.000419,\n          \"config_retrieval\": 16.3637869358063,\n          \"package\": 0.003989,\n          \"filebucket\": 0.000171,\n          \"file\": 0.007025,\n          \"exec\": 0.000299\n        },\n        \"resources\": {\n          \"total\": 33\n        },\n        \"changes\": {},\n        \"events\": {\n          \"total\": 0\n        }\n      },\n      \"created_at\": \"2021-05-18 11:56:58 UTC\",\n      \"updated_at\": \"2021-05-18 11:56:58 UTC\",\n      \"id\": 1,\n      \"host_id\": 29,\n      \"host_name\": \"host463\",\n      \"reported_at\": \"2021-05-18 11:56:58 UTC\",\n      \"status\": {\n        \"applied\": 0,\n        \"restarted\": 0,\n        \"failed\": 0,\n        \"failed_restarts\": 0,\n        \"skipped\": 0,\n        \"pending\": 0\n      },\n      \"origin\": null\n    }\n  ]\n}"],"metadata":{"search":[{"name":"applied","type":"integer"},{"name":"eventful","values":["true","false"]},{"name":"failed","type":"integer"},{"name":"failed_restarts","type":"integer"},{"name":"host","type":"string"},{"name":"host_id","type":"integer"},{"name":"host_owner_id","type":"integer"},{"name":"hostgroup","type":"string"},{"name":"hostgroup_fullname","type":"string"},{"name":"hostgroup_title","type":"string"},{"name":"last_report","type":"datetime"},{"name":"location","type":"string"},{"name":"log","type":"text"},{"name":"organization","type":"string"},{"name":"origin","type":"string"},{"name":"pending","type":"integer"},{"name":"reported","type":"datetime"},{"name":"resource","type":"text"},{"name":"restarted","type":"integer"},{"name":"skipped","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/config_reports/show","name":"show","apis":[{"api_url":"/api/config_reports/:id","http_method":"GET","short_description":"Show a report","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/config_reports/create","name":"create","apis":[{"api_url":"/api/config_reports","http_method":"POST","short_description":"Create a report","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"config_report","full_name":"config_report","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"host","full_name":"config_report[host]","description":"\n\u003cp\u003eHostname or certname\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"reported_at","full_name":"config_report[reported_at]","description":"\n\u003cp\u003eUTC time of report\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"config_report[status]","description":"\n\u003cp\u003eHash of status type totals\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"metrics","full_name":"config_report[metrics]","description":"\n\u003cp\u003eHash of report metrics, can be just {}\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"logs","full_name":"config_report[logs]","description":"\n\u003cp\u003eOptional array of log hashes\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":["POST /api/reports\n{\n  \"config_report\": {}\n}\n403\n{\n  \"error\": {\n    \"message\": \"Access denied\",\n    \"details\": \"Missing one of the required permissions: upload_config_reports\",\n    \"missing_permissions\": [\n      \"upload_config_reports\"\n    ]\n  }\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/config_reports/destroy","name":"destroy","apis":[{"api_url":"/api/config_reports/:id","http_method":"DELETE","short_description":"Delete a report","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/config_reports/last","name":"last","apis":[{"api_url":"/api/hosts/:host_id/config_reports/last","http_method":"GET","short_description":"Show the last report for a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"dashboard":{"doc_url":"../apidoc/v2/dashboard","id":"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["GET /api/dashboard\n200\n{\n  \"total_hosts\": 0,\n  \"bad_hosts\": 0,\n  \"bad_hosts_enabled\": 0,\n  \"active_hosts\": 0,\n  \"active_hosts_ok\": 0,\n  \"active_hosts_ok_enabled\": 0,\n  \"ok_hosts\": 0,\n  \"ok_hosts_enabled\": 0,\n  \"disabled_hosts\": 0,\n  \"pending_hosts\": 0,\n  \"pending_hosts_enabled\": 0,\n  \"out_of_sync_hosts\": 0,\n  \"out_of_sync_hosts_enabled\": 0,\n  \"good_hosts\": 0,\n  \"good_hosts_enabled\": 0,\n  \"percentage\": 0,\n  \"reports_missing\": 0,\n  \"glossary\": {\n    \"total_hosts\": \"Total hosts count\",\n    \"bad_hosts\": \"Hosts with error state\",\n    \"bad_hosts_enabled\": \"Hosts with error state and alerts enabled\",\n    \"active_hosts\": \"Hosts which recently applied changes\",\n    \"active_hosts_ok\": \"Hosts which recently applied changes successfully\",\n    \"active_hosts_ok_enabled\": \"Hosts which recently applied changes successfully with alerts enabled\",\n    \"ok_hosts\": \"Hosts without changes or errors\",\n    \"ok_hosts_enabled\": \"Hosts without changes or errors, with alerts enabled\",\n    \"out_of_sync_hosts\": \"Out of sync hosts\",\n    \"out_of_sync_hosts_enabled\": \"Out of sync hosts with alerts enabled\",\n    \"disabled_hosts\": \"Hosts with alerts disabled\",\n    \"pending_hosts\": \"Hosts that had pending changes\",\n    \"pending_hosts_enabled\": \"Hosts that had pending changes with alerts enabled\",\n    \"good_hosts\": \"Hosts without errors\",\n    \"good_hosts_enabled\": \"Hosts without errors, with alerts enabled\",\n    \"percentage\": \"Hosts without errors percent\",\n    \"reports_missing\": \"Hosts which are not reporting\"\n  }\n}"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"domains":{"doc_url":"../apidoc/v2/domains","id":"domains","api_url":"/api","name":"Domains","short_description":null,"full_description":"\n\u003cp\u003eForeman 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 of the form \u003ci\u003ehostname\u003c/i\u003e.\u003cb\u003esomewhere.com\u003c/b\u003e then the domain is \u003cb\u003esomewhere.com\u003c/b\u003e. 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.\u003c/p\u003e\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},{"api_url":"/api/subnets/:subnet_id/domains","http_method":"GET","short_description":"List of domains per subnet","deprecated":null},{"api_url":"/api/locations/:location_id/domains","http_method":"GET","short_description":"List of domains per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/domains","http_method":"GET","short_description":"List of domains per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, ‘all’ to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["GET /api/locations/447626450/organizations/447626448/domains\n200\n{\n  \"total\": 1,\n  \"subtotal\": 1,\n  \"page\": 1,\n  \"per_page\": 20,\n  \"search\": null,\n  \"sort\": {\n    \"by\": null,\n    \"order\": null\n  },\n  \"results\": [\n    {\n      \"fullname\": \"example77.com\",\n      \"created_at\": \"2021-05-18 11:51:03 UTC\",\n      \"updated_at\": \"2021-05-18 11:51:03 UTC\",\n      \"id\": 759776778,\n      \"name\": \"example77.com\",\n      \"dns_id\": null,\n      \"dns\": null\n    }\n  ]\n}"],"metadata":{"search":[{"name":"fullname","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"params","type":"string"}]},"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eNumerical ID or domain name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":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,"validations":[]},{"name":"show_hidden_parameters","full_name":"show_hidden_parameters","description":"\n\u003cp\u003eDisplay hidden parameter values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["GET /api/domains/22495316-mydomain-net\n200\n{\n  \"fullname\": null,\n  \"created_at\": \"2021-05-18 11:54:47 UTC\",\n  \"updated_at\": \"2021-05-18 11:54:47 UTC\",\n  \"id\": 22495316,\n  \"name\": \"mydomain.net\",\n  \"dns_id\": 113629430,\n  \"dns\": {\n    \"name\": \"DNS Proxy\",\n    \"id\": 113629430,\n    \"url\": \"http://else.where:45671\"\n  },\n  \"subnets\": [\n    {\n      \"id\": 980190962,\n      \"name\": \"one\",\n      \"description\": null,\n      \"network_address\": \"2.3.4.0/24\"\n    }\n  ],\n  \"interfaces\": [],\n  \"parameters\": [\n    {\n      \"priority\": null,\n      \"created_at\": \"2021-05-18 11:54:47 UTC\",\n      \"updated_at\": \"2021-05-18 11:54:47 UTC\",\n      \"id\": 665394701,\n      \"name\": \"parameter\",\n      \"parameter_type\": \"string\",\n      \"value\": \"value1\"\n    }\n  ],\n  \"locations\": [\n    {\n      \"id\": 255093256,\n      \"name\": \"Location 1\",\n      \"title\": \"Location 1\",\n      \"description\": null\n    }\n  ],\n  \"organizations\": [\n    {\n      \"id\": 447626438,\n      \"name\": \"Organization 1\",\n      \"title\": \"Organization 1\",\n      \"description\": null\n    }\n  ]\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"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\u003cp\u003eThe \u003cb\u003efullname\u003c/b\u003e field is used for human readability in reports and other pages that refer to domains, and also available as an external node parameter\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain","full_name":"domain","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"domain[name]","description":"\n\u003cp\u003eThe full DNS domain name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fullname","full_name":"domain[fullname]","description":"\n\u003cp\u003eDescription of the domain\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dns_id","full_name":"domain[dns_id]","description":"\n\u003cp\u003eDNS proxy ID to use within this domain\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_parameters_attributes","full_name":"domain[domain_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters (name, value)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"domain[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"domain[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":["POST /api/domains\n{\n  \"organization_id\": 447626440,\n  \"domain\": {\n    \"name\": \"example71.com\",\n    \"organization_ids\": [\n      447626440\n    ],\n    \"location_ids\": [\n      447626442\n    ]\n  }\n}\n201\n{\n  \"fullname\": null,\n  \"created_at\": \"2021-05-18 11:51:01 UTC\",\n  \"updated_at\": \"2021-05-18 11:51:01 UTC\",\n  \"id\": 759776772,\n  \"name\": \"example71.com\",\n  \"dns_id\": null,\n  \"dns\": null,\n  \"subnets\": [],\n  \"interfaces\": [],\n  \"parameters\": [],\n  \"locations\": [\n    {\n      \"id\": 447626442,\n      \"name\": \"loc14\",\n      \"title\": \"loc14\",\n      \"description\": null\n    }\n  ],\n  \"organizations\": [\n    {\n      \"id\": 447626440,\n      \"name\": \"org11\",\n      \"title\": \"org11\",\n      \"description\": null\n    }\n  ]\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]},{"name":"domain","full_name":"domain","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"domain[name]","description":"\n\u003cp\u003eThe full DNS domain name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fullname","full_name":"domain[fullname]","description":"\n\u003cp\u003eDescription of the domain\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dns_id","full_name":"domain[dns_id]","description":"\n\u003cp\u003eDNS proxy ID to use within this domain\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_parameters_attributes","full_name":"domain[domain_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters (name, value)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"domain[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"domain[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":["PUT /api/domains/22495316-mydomain-net\n{\n  \"domain\": {\n    \"name\": \"\"\n  }\n}\n422\n{\n  \"error\": {\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":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]}],"returns":[],"examples":["DELETE /api/domains/22495316-mydomain-net\n{\n  \"domain\": {}\n}\n200\n{\n  \"id\": 22495316,\n  \"name\": \"mydomain.net\",\n  \"fullname\": null,\n  \"created_at\": \"2021-05-18T11:54:47.040Z\",\n  \"updated_at\": \"2021-05-18T11:54:47.040Z\",\n  \"dns_id\": 113629430\n}"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"external_usergroups":{"doc_url":"../apidoc/v2/external_usergroups","id":"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},{"api_url":"/api/auth_source_ldaps/:auth_source_ldap_id/external_usergroups","http_method":"GET","short_description":"List all external user groups for LDAP authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"usergroup_id","full_name":"usergroup_id","description":"\n\u003cp\u003eID or name of user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"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},{"api_url":"/api/auth_source_ldaps/:auth_source_ldap_id/external_usergroups/:id","http_method":"GET","short_description":"Show an external user group for LDAP authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"usergroup_id","full_name":"usergroup_id","description":"\n\u003cp\u003eID or name of user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID or name of external user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"usergroup_id","full_name":"usergroup_id","description":"\n\u003cp\u003eID or name of user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"external_usergroup","full_name":"external_usergroup","description":"\n\u003cp\u003eExternal user group information\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"external_usergroup[name]","description":"\n\u003cp\u003eExternal user group name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"auth_source_id","full_name":"external_usergroup[auth_source_id]","description":"\n\u003cp\u003eID of linked authentication source\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"usergroup_id","full_name":"usergroup_id","description":"\n\u003cp\u003eID or name of user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID or name of external user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"external_usergroup","full_name":"external_usergroup","description":"\n\u003cp\u003eExternal user group information\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"external_usergroup[name]","description":"\n\u003cp\u003eExternal user group name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"auth_source_id","full_name":"external_usergroup[auth_source_id]","description":"\n\u003cp\u003eID of linked authentication source\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"usergroup_id","full_name":"usergroup_id","description":"\n\u003cp\u003eID or name of user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID or name of external user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"usergroup_id","full_name":"usergroup_id","description":"\n\u003cp\u003eID or name of user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID or name external user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"fact_values":{"doc_url":"../apidoc/v2/fact_values","id":"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, ‘all’ to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["GET /api/hosts/41/facts\n200\n{\n  \"total\": 1,\n  \"subtotal\": 1,\n  \"page\": 1,\n  \"per_page\": 20,\n  \"search\": \" host = 41\",\n  \"sort\": {\n    \"by\": null,\n    \"order\": null\n  },\n  \"results\": {\n    \"host578\": {\n      \"kernelversion\": \"2.6.9\"\n    }\n  }\n}"],"metadata":{"search":[{"name":"fact","type":"string"},{"name":"fact_short_name","type":"string"},{"name":"facts","type":"string"},{"name":"host","type":"string"},{"name":"host.hostgroup","type":"string"},{"name":"host_id","type":"integer"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"origin","type":"string"},{"name":"reported_at","type":"datetime"},{"name":"short_name","type":"string"},{"name":"type","type":"string"},{"name":"value","type":"string"}]},"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"filters":{"doc_url":"../apidoc/v2/filters","id":"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, ‘all’ to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["GET /api/filters\n200\n{\n  \"total\": 62,\n  \"subtotal\": 62,\n  \"page\": 1,\n  \"per_page\": 20,\n  \"search\": null,\n  \"sort\": {\n    \"by\": null,\n    \"order\": null\n  },\n  \"results\": [\n    {\n      \"search\": null,\n      \"resource_type\": \"Architecture\",\n      \"resource_type_label\": \"Architecture\",\n      \"unlimited?\": true,\n      \"created_at\": \"2021-05-18 12:00:07 UTC\",\n      \"updated_at\": \"2021-05-18 12:00:07 UTC\",\n      \"override?\": false,\n      \"id\": 321349837,\n      \"role\": {\n        \"name\": \"Manager\",\n        \"id\": 1,\n        \"description\": null,\n        \"origin\": \"foreman\"\n      },\n      \"permissions\": [\n        {\n          \"name\": \"view_architectures\",\n          \"id\": 350275019,\n          \"resource_type\": \"Architecture\"\n        },\n        {\n          \"name\": \"create_architectures\",\n          \"id\": 912770095,\n          \"resource_type\": \"Architecture\"\n        },\n        {\n          \"name\": \"edit_architectures\",\n          \"id\": 874798611,\n          \"resource_type\": \"Architecture\"\n        },\n        {\n          \"name\": \"destroy_architectures\",\n          \"id\": 586604735,\n          \"resource_type\": \"Architecture\"\n        }\n      ]\n    },\n    {\n      \"search\": null,\n      \"resource_type\": \"AuthSource\",\n      \"resource_type_label\": \"Auth source\",\n      \"unlimited?\": true,\n      \"created_at\": \"2021-05-18 12:00:07 UTC\",\n      \"updated_at\": \"2021-05-18 12:00:07 UTC\",\n      \"override?\": false,\n      \"id\": 170801529,\n      \"role\": {\n        \"name\": \"Manager\",\n        \"id\": 1,\n        \"description\": null,\n        \"origin\": \"foreman\"\n      },\n      \"permissions\": [\n        {\n          \"name\": \"view_authenticators\",\n          \"id\": 687843582,\n          \"resource_type\": \"AuthSource\"\n        },\n        {\n          \"name\": \"create_authenticators\",\n          \"id\": 956119309,\n          \"resource_type\": \"AuthSource\"\n        },\n        {\n          \"name\": \"edit_authenticators\",\n          \"id\": 395314704,\n          \"resource_type\": \"AuthSource\"\n        },\n        {\n          \"name\": \"destroy_authenticators\",\n          \"id\": 1067518973,\n          \"resource_type\": \"AuthSource\"\n        }\n      ]\n    },\n    {\n      \"search\": null,\n      \"resource_type\": \"Environment\",\n      \"resource_type_label\": \"Environment\",\n      \"unlimited?\": true,\n      \"created_at\": \"2021-05-18 12:00:07 UTC\",\n      \"updated_at\": \"2021-05-18 12:00:07 UTC\",\n      \"override?\": false,\n      \"id\": 1026099682,\n      \"role\": {\n        \"name\": \"Manager\",\n        \"id\": 1,\n        \"description\": null,\n        \"origin\": \"foreman\"\n      },\n      \"permissions\": [\n        {\n          \"name\": \"view_environments\",\n          \"id\": 189359466,\n          \"resource_type\": \"Environment\"\n        },\n        {\n          \"name\": \"create_environments\",\n          \"id\": 290807607,\n          \"resource_type\": \"Environment\"\n        },\n        {\n          \"name\": \"edit_environments\",\n          \"id\": 1063021050,\n          \"resource_type\": \"Environment\"\n        },\n        {\n          \"name\": \"destroy_environments\",\n          \"id\": 505866180,\n          \"resource_type\": \"Environment\"\n        },\n        {\n          \"name\": \"import_environments\",\n          \"id\": 782644867,\n          \"resource_type\": \"Environment\"\n        }\n      ]\n    },\n    {\n      \"search\": null,\n      \"resource_type\": \"Domain\",\n      \"resource_type_label\": \"Domain\",\n      \"unlimited?\": true,\n      \"created_at\": \"2021-05-18 12:00:07 UTC\",\n      \"updated_at\": \"2021-05-18 12:00:07 UTC\",\n      \"override?\": false,\n      \"id\": 340438230,\n      \"role\": {\n        \"name\": \"Manager\",\n        \"id\": 1,\n        \"description\": null,\n        \"origin\": \"foreman\"\n      },\n      \"permissions\": [\n        {\n          \"name\": \"view_domains\",\n          \"id\": 623290985,\n          \"resource_type\": \"Domain\"\n        },\n        {\n          \"name\": \"create_domains\",\n          \"id\": 776153244,\n          \"resource_type\": \"Domain\"\n        },\n        {\n          \"name\": \"edit_domains\",\n          \"id\": 914687015,\n          \"resource_type\": \"Domain\"\n        },\n        {\n          \"name\": \"destroy_domains\",\n          \"id\": 808331307,\n          \"resource_type\": \"Domain\"\n        }\n      ]\n    },\n    {\n      \"search\": null,\n      \"resource_type\": \"CommonParameter\",\n      \"resource_type_label\": \"Common parameter\",\n      \"unlimited?\": true,\n      \"created_at\": \"2021-05-18 12:00:07 UTC\",\n      \"updated_at\": \"2021-05-18 12:00:07 UTC\",\n      \"override?\": false,\n      \"id\": 222559602,\n      \"role\": {\n        \"name\": \"Manager\",\n        \"id\": 1,\n        \"description\": null,\n        \"origin\": \"foreman\"\n      },\n      \"permissions\": [\n        {\n          \"name\": \"view_globals\",\n          \"id\": 101322209,\n          \"resource_type\": \"CommonParameter\"\n        },\n        {\n          \"name\": \"create_globals\",\n          \"id\": 225414942,\n          \"resource_type\": \"CommonParameter\"\n        },\n        {\n          \"name\": \"edit_globals\",\n          \"id\": 363439011,\n          \"resource_type\": \"CommonParameter\"\n        },\n        {\n          \"name\": \"destroy_globals\",\n          \"id\": 318934959,\n          \"resource_type\": \"CommonParameter\"\n        }\n      ]\n    },\n    {\n      \"search\": null,\n      \"resource_type\": \"Hostgroup\",\n      \"resource_type_label\": \"Hostgroup\",\n      \"unlimited?\": true,\n      \"created_at\": \"2021-05-18 12:00:07 UTC\",\n      \"updated_at\": \"2021-05-18 12:00:07 UTC\",\n      \"override?\": false,\n      \"id\": 977587707,\n      \"role\": {\n        \"name\": \"Manager\",\n        \"id\": 1,\n        \"description\": null,\n        \"origin\": \"foreman\"\n      },\n      \"permissions\": [\n        {\n          \"name\": \"view_hostgroups\",\n          \"id\": 51094894,\n          \"resource_type\": \"Hostgroup\"\n        },\n        {\n          \"name\": \"create_hostgroups\",\n          \"id\": 175778558,\n          \"resource_type\": \"Hostgroup\"\n        },\n        {\n          \"name\": \"edit_hostgroups\",\n          \"id\": 214584076,\n          \"resource_type\": \"Hostgroup\"\n        },\n        {\n          \"name\": \"destroy_hostgroups\",\n          \"id\": 1009240528,\n          \"resource_type\": \"Hostgroup\"\n        }\n      ]\n    },\n    {\n      \"search\": null,\n      \"resource_type\": \"Host\",\n      \"resource_type_label\": \"Host\",\n      \"unlimited?\": true,\n      \"created_at\": \"2021-05-18 12:00:07 UTC\",\n      \"updated_at\": \"2021-05-18 12:00:07 UTC\",\n      \"override?\": false,\n      \"id\": 721145960,\n      \"role\": {\n        \"name\": \"Manager\",\n        \"id\": 1,\n        \"description\": null,\n        \"origin\": \"foreman\"\n      },\n      \"permissions\": [\n        {\n          \"name\": \"view_hosts\",\n          \"id\": 988725676,\n          \"resource_type\": \"Host\"\n        },\n        {\n          \"name\": \"create_hosts\",\n          \"id\": 740433627,\n          \"resource_type\": \"Host\"\n        },\n        {\n          \"name\": \"edit_hosts\",\n          \"id\": 561976263,\n          \"resource_type\": \"Host\"\n        },\n        {\n          \"name\": \"destroy_hosts\",\n          \"id\": 619977594,\n          \"resource_type\": \"Host\"\n        }\n      ]\n    },\n    {\n      \"search\": null,\n      \"resource_type\": \"Medium\",\n      \"resource_type_label\": \"Medium\",\n      \"unlimited?\": true,\n      \"created_at\": \"2021-05-18 12:00:07 UTC\",\n      \"updated_at\": \"2021-05-18 12:00:07 UTC\",\n      \"override?\": false,\n      \"id\": 503111935,\n      \"role\": {\n        \"name\": \"Manager\",\n        \"id\": 1,\n        \"description\": null,\n        \"origin\": \"foreman\"\n      },\n      \"permissions\": [\n        {\n          \"name\": \"view_media\",\n          \"id\": 135202335,\n          \"resource_type\": \"Medium\"\n        },\n        {\n          \"name\": \"create_media\",\n          \"id\": 516151662,\n          \"resource_type\": \"Medium\"\n        },\n        {\n          \"name\": \"edit_media\",\n          \"id\": 329176178,\n          \"resource_type\": \"Medium\"\n        },\n        {\n          \"name\": \"destroy_media\",\n          \"id\": 370531533,\n          \"resource_type\": \"Medium\"\n        }\n      ]\n    },\n    {\n      \"search\": null,\n      \"resource_type\": \"Model\",\n      \"resource_type_label\": \"Model\",\n      \"unlimited?\": true,\n      \"created_at\": \"2021-05-18 12:00:07 UTC\",\n      \"updated_at\": \"2021-05-18 12:00:07 UTC\",\n      \"override?\": false,\n      \"id\": 643462867,\n      \"role\": {\n        \"name\": \"Manager\",\n        \"id\": 1,\n        \"description\": null,\n        \"origin\": \"foreman\"\n      },\n      \"permissions\": [\n        {\n          \"name\": \"view_models\",\n          \"id\": 537547377,\n          \"resource_type\": \"Model\"\n        },\n        {\n          \"name\": \"create_models\",\n          \"id\": 509054658,\n          \"resource_type\": \"Model\"\n        },\n        {\n          \"name\": \"edit_models\",\n          \"id\": 173772800,\n          \"resource_type\": \"Model\"\n        },\n        {\n          \"name\": \"destroy_models\",\n          \"id\": 147454802,\n          \"resource_type\": \"Model\"\n        }\n      ]\n    },\n    {\n      \"search\": null,\n      \"resource_type\": \"Operatingsystem\",\n      \"resource_type_label\": \"Operatingsystem\",\n      \"unlimited?\": true,\n      \"created_at\": \"2021-05-18 12:00:07 UTC\",\n      \"updated_at\": \"2021-05-18 12:00:07 UTC\",\n      \"override?\": false,\n      \"id\": 291325508,\n      \"role\": {\n        \"name\": \"Manager\",\n        \"id\": 1,\n        \"description\": null,\n        \"origin\": \"foreman\"\n      },\n      \"permissions\": [\n        {\n          \"name\": \"view_operatingsystems\",\n          \"id\": 940057595,\n          \"resource_type\": \"Operatingsystem\"\n        },\n        {\n          \"name\": \"create_operatingsystems\",\n          \"id\": 1038489107,\n          \"resource_type\": \"Operatingsystem\"\n        },\n        {\n          \"name\": \"edit_operatingsystems\",\n          \"id\": 887912542,\n          \"resource_type\": \"Operatingsystem\"\n        },\n        {\n          \"name\": \"destroy_operatingsystems\",\n          \"id\": 936871672,\n          \"resource_type\": \"Operatingsystem\"\n        }\n      ]\n    },\n    {\n      \"search\": null,\n      \"resource_type\": \"Ptable\",\n      \"resource_type_label\": \"Ptable\",\n      \"unlimited?\": true,\n      \"created_at\": \"2021-05-18 12:00:07 UTC\",\n      \"updated_at\": \"2021-05-18 12:00:07 UTC\",\n      \"override?\": false,\n      \"id\": 139728896,\n      \"role\": {\n        \"name\": \"Manager\",\n        \"id\": 1,\n        \"description\": null,\n        \"origin\": \"foreman\"\n      },\n      \"permissions\": [\n        {\n          \"name\": \"view_ptables\",\n          \"id\": 769440046,\n          \"resource_type\": \"Ptable\"\n        },\n        {\n          \"name\": \"create_ptables\",\n          \"id\": 649673681,\n          \"resource_type\": \"Ptable\"\n        },\n        {\n          \"name\": \"edit_ptables\",\n          \"id\": 1048516464,\n          \"resource_type\": \"Ptable\"\n        },\n        {\n          \"name\": \"destroy_ptables\",\n          \"id\": 953432930,\n          \"resource_type\": \"Ptable\"\n        }\n      ]\n    },\n    {\n      \"search\": null,\n      \"resource_type\": \"Puppetclass\",\n      \"resource_type_label\": \"Puppetclass\",\n      \"unlimited?\": true,\n      \"created_at\": \"2021-05-18 12:00:07 UTC\",\n      \"updated_at\": \"2021-05-18 12:00:07 UTC\",\n      \"override?\": false,\n      \"id\": 1062414187,\n      \"role\": {\n        \"name\": \"Manager\",\n        \"id\": 1,\n        \"description\": null,\n        \"origin\": \"foreman\"\n      },\n      \"permissions\": [\n        {\n          \"name\": \"view_puppetclasses\",\n          \"id\": 849307952,\n          \"resource_type\": \"Puppetclass\"\n        },\n        {\n          \"name\": \"create_puppetclasses\",\n          \"id\": 270035150,\n          \"resource_type\": \"Puppetclass\"\n        },\n        {\n          \"name\": \"edit_puppetclasses\",\n          \"id\": 308015866,\n          \"resource_type\": \"Puppetclass\"\n        },\n        {\n          \"name\": \"destroy_puppetclasses\",\n          \"id\": 76106844,\n          \"resource_type\": \"Puppetclass\"\n        },\n        {\n          \"name\": \"import_puppetclasses\",\n          \"id\": 849710366,\n          \"resource_type\": \"Puppetclass\"\n        }\n      ]\n    },\n    {\n      \"search\": null,\n      \"resource_type\": \"Usergroup\",\n      \"resource_type_label\": \"Usergroup\",\n      \"unlimited?\": true,\n      \"created_at\": \"2021-05-18 12:00:07 UTC\",\n      \"updated_at\": \"2021-05-18 12:00:07 UTC\",\n      \"override?\": false,\n      \"id\": 557298380,\n      \"role\": {\n        \"name\": \"Manager\",\n        \"id\": 1,\n        \"description\": null,\n        \"origin\": \"foreman\"\n      },\n      \"permissions\": [\n        {\n          \"name\": \"view_usergroups\",\n          \"id\": 44766150,\n          \"resource_type\": \"Usergroup\"\n        },\n        {\n          \"name\": \"create_usergroups\",\n          \"id\": 198876242,\n          \"resource_type\": \"Usergroup\"\n        },\n        {\n          \"name\": \"edit_usergroups\",\n          \"id\": 225115552,\n          \"resource_type\": \"Usergroup\"\n        },\n        {\n          \"name\": \"destroy_usergroups\",\n          \"id\": 1032290172,\n          \"resource_type\": \"Usergroup\"\n        }\n      ]\n    },\n    {\n      \"search\": null,\n      \"resource_type\": \"User\",\n      \"resource_type_label\": \"User\",\n      \"unlimited?\": true,\n      \"created_at\": \"2021-05-18 12:00:07 UTC\",\n      \"updated_at\": \"2021-05-18 12:00:07 UTC\",\n      \"override?\": false,\n      \"id\": 372277853,\n      \"role\": {\n        \"name\": \"Manager\",\n        \"id\": 1,\n        \"description\": null,\n        \"origin\": \"foreman\"\n      },\n      \"permissions\": [\n        {\n          \"name\": \"view_users\",\n          \"id\": 916456187,\n          \"resource_type\": \"User\"\n        },\n        {\n          \"name\": \"create_users\",\n          \"id\": 544005512,\n          \"resource_type\": \"User\"\n        },\n        {\n          \"name\": \"edit_users\",\n          \"id\": 758239380,\n          \"resource_type\": \"User\"\n        },\n        {\n          \"name\": \"destroy_users\",\n          \"id\": 683333673,\n          \"resource_type\": \"User\"\n        }\n      ]\n    },\n    {\n      \"search\": null,\n      \"resource_type\": null,\n      \"resource_type_label\": \"(Miscellaneous)\",\n      \"unlimited?\": true,\n      \"created_at\": \"2021-05-18 12:00:07 UTC\",\n      \"updated_at\": \"2021-05-18 12:00:07 UTC\",\n      \"override?\": false,\n      \"id\": 255448041,\n      \"role\": {\n        \"name\": \"Manager\",\n        \"id\": 1,\n        \"description\": null,\n        \"origin\": \"foreman\"\n      },\n      \"permissions\": [\n        {\n          \"name\": \"access_settings\",\n          \"id\": 139485686,\n          \"resource_type\": null\n        },\n        {\n          \"name\": \"access_dashboard\",\n          \"id\": 220719619,\n          \"resource_type\": null\n        }\n      ]\n    },\n    {\n      \"search\": null,\n      \"resource_type\": \"Report\",\n      \"resource_type_label\": \"Report\",\n      \"unlimited?\": true,\n      \"created_at\": \"2021-05-18 12:00:07 UTC\",\n      \"updated_at\": \"2021-05-18 12:00:07 UTC\",\n      \"override?\": false,\n      \"id\": 943645556,\n      \"role\": {\n        \"name\": \"Manager\",\n        \"id\": 1,\n        \"description\": null,\n        \"origin\": \"foreman\"\n      },\n      \"permissions\": [\n        {\n          \"name\": \"view_reports\",\n          \"id\": 407024322,\n          \"resource_type\": \"Report\"\n        },\n        {\n          \"name\": \"destroy_reports\",\n          \"id\": 222966002,\n          \"resource_type\": \"Report\"\n        }\n      ]\n    },\n    {\n      \"search\": null,\n      \"resource_type\": \"FactValue\",\n      \"resource_type_label\": \"Fact value\",\n      \"unlimited?\": true,\n      \"created_at\": \"2021-05-18 12:00:07 UTC\",\n      \"updated_at\": \"2021-05-18 12:00:07 UTC\",\n      \"override?\": false,\n      \"id\": 679608033,\n      \"role\": {\n        \"name\": \"Manager\",\n        \"id\": 1,\n        \"description\": null,\n        \"origin\": \"foreman\"\n      },\n      \"permissions\": [\n        {\n          \"name\": \"view_facts\",\n          \"id\": 958901131,\n          \"resource_type\": \"FactValue\"\n        }\n      ]\n    },\n    {\n      \"search\": null,\n      \"resource_type\": \"Audit\",\n      \"resource_type_label\": \"Audit\",\n      \"unlimited?\": true,\n      \"created_at\": \"2021-05-18 12:00:07 UTC\",\n      \"updated_at\": \"2021-05-18 12:00:07 UTC\",\n      \"override?\": false,\n      \"id\": 528928374,\n      \"role\": {\n        \"name\": \"Manager\",\n        \"id\": 1,\n        \"description\": null,\n        \"origin\": \"foreman\"\n      },\n      \"permissions\": [\n        {\n          \"name\": \"view_audit_logs\",\n          \"id\": 202577195,\n          \"resource_type\": \"Audit\"\n        }\n      ]\n    },\n    {\n      \"search\": null,\n      \"resource_type\": \"Location\",\n      \"resource_type_label\": \"Location\",\n      \"unlimited?\": true,\n      \"created_at\": \"2021-05-18 12:00:07 UTC\",\n      \"updated_at\": \"2021-05-18 12:00:07 UTC\",\n      \"override?\": false,\n      \"id\": 225912082,\n      \"role\": {\n        \"name\": \"Manager\",\n        \"id\": 1,\n        \"description\": null,\n        \"origin\": \"foreman\"\n      },\n      \"permissions\": [\n        {\n          \"name\": \"view_locations\",\n          \"id\": 342396477,\n          \"resource_type\": \"Location\"\n        },\n        {\n          \"name\": \"edit_locations\",\n          \"id\": 360701043,\n          \"resource_type\": \"Location\"\n        },\n        {\n          \"name\": \"create_locations\",\n          \"id\": 919402658,\n          \"resource_type\": \"Location\"\n        },\n        {\n          \"name\": \"destroy_locations\",\n          \"id\": 302614650,\n          \"resource_type\": \"Location\"\n        }\n      ]\n    },\n    {\n      \"search\": null,\n      \"resource_type\": \"Organization\",\n      \"resource_type_label\": \"Organization\",\n      \"unlimited?\": true,\n      \"created_at\": \"2021-05-18 12:00:07 UTC\",\n      \"updated_at\": \"2021-05-18 12:00:07 UTC\",\n      \"override?\": false,\n      \"id\": 980424071,\n      \"role\": {\n        \"name\": \"Manager\",\n        \"id\": 1,\n        \"description\": null,\n        \"origin\": \"foreman\"\n      },\n      \"permissions\": [\n        {\n          \"name\": \"view_organizations\",\n          \"id\": 277779683,\n          \"resource_type\": \"Organization\"\n        },\n        {\n          \"name\": \"edit_organizations\",\n          \"id\": 810159931,\n          \"resource_type\": \"Organization\"\n        },\n        {\n          \"name\": \"create_organizations\",\n          \"id\": 839488775,\n          \"resource_type\": \"Organization\"\n        },\n        {\n          \"name\": \"destroy_organizations\",\n          \"id\": 647541143,\n          \"resource_type\": \"Organization\"\n        }\n      ]\n    }\n  ]\n}"],"metadata":{"search":[{"name":"limited","values":["true","false"]},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"override","values":["true","false"]},{"name":"permission","type":"string"},{"name":"resource","type":"string"},{"name":"role","type":"string"},{"name":"role_id","type":"integer"},{"name":"search","type":"text"},{"name":"unlimited","values":["true","false"]}]},"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]}],"returns":[],"examples":["GET /api/filters/321349837\n200\n{\n  \"search\": null,\n  \"resource_type\": \"Architecture\",\n  \"resource_type_label\": \"Architecture\",\n  \"unlimited?\": true,\n  \"created_at\": \"2021-05-18 12:00:07 UTC\",\n  \"updated_at\": \"2021-05-18 12:00:07 UTC\",\n  \"override?\": false,\n  \"id\": 321349837,\n  \"role\": {\n    \"name\": \"Manager\",\n    \"id\": 1,\n    \"description\": null,\n    \"origin\": \"foreman\"\n  },\n  \"permissions\": [\n    {\n      \"name\": \"view_architectures\",\n      \"id\": 350275019,\n      \"resource_type\": \"Architecture\"\n    },\n    {\n      \"name\": \"create_architectures\",\n      \"id\": 912770095,\n      \"resource_type\": \"Architecture\"\n    },\n    {\n      \"name\": \"edit_architectures\",\n      \"id\": 874798611,\n      \"resource_type\": \"Architecture\"\n    },\n    {\n      \"name\": \"destroy_architectures\",\n      \"id\": 586604735,\n      \"resource_type\": \"Architecture\"\n    }\n  ],\n  \"locations\": [],\n  \"organizations\": []\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"filter","full_name":"filter","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"role_id","full_name":"filter[role_id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"filter[search]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"override","full_name":"filter[override]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"permission_ids","full_name":"filter[permission_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"filter[organization_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"filter[location_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":["POST /api/filters\n{\n  \"filter\": {\n    \"role_id\": 21,\n    \"permission_ids\": [\n      350275019\n    ]\n  },\n  \"organization_id\": 447626438\n}\n201\n{\n  \"search\": null,\n  \"resource_type\": \"Architecture\",\n  \"resource_type_label\": \"Architecture\",\n  \"unlimited?\": true,\n  \"created_at\": \"2021-05-18 12:00:22 UTC\",\n  \"updated_at\": \"2021-05-18 12:00:22 UTC\",\n  \"override?\": false,\n  \"id\": 1062414191,\n  \"role\": {\n    \"name\": \"role_test\",\n    \"id\": 21,\n    \"description\": null,\n    \"origin\": null\n  },\n  \"permissions\": [\n    {\n      \"name\": \"view_architectures\",\n      \"id\": 350275019,\n      \"resource_type\": \"Architecture\"\n    }\n  ],\n  \"locations\": [],\n  \"organizations\": []\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"filter","full_name":"filter","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"role_id","full_name":"filter[role_id]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"filter[search]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"override","full_name":"filter[override]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"permission_ids","full_name":"filter[permission_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"filter[organization_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"filter[location_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":["PUT /api/filters/10997177\n{\n  \"filter\": {\n    \"role_id\": 8,\n    \"permission_ids\": [\n      740433627\n    ]\n  }\n}\n200\n{\n  \"search\": null,\n  \"resource_type\": \"Host\",\n  \"resource_type_label\": \"Host\",\n  \"unlimited?\": true,\n  \"created_at\": \"2021-05-18 12:00:07 UTC\",\n  \"updated_at\": \"2021-05-18 12:00:07 UTC\",\n  \"override?\": false,\n  \"id\": 10997177,\n  \"role\": {\n    \"name\": \"Destroy hosts\",\n    \"id\": 8,\n    \"description\": null,\n    \"origin\": \"\"\n  },\n  \"permissions\": [\n    {\n      \"name\": \"create_hosts\",\n      \"id\": 740433627,\n      \"resource_type\": \"Host\"\n    }\n  ],\n  \"locations\": [],\n  \"organizations\": []\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["DELETE /api/filters/10997177\n{\n  \"filter\": {}\n}\n200\n{\n  \"id\": 10997177,\n  \"search\": null,\n  \"role_id\": 8,\n  \"created_at\": \"2021-05-18T12:00:07.184Z\",\n  \"updated_at\": \"2021-05-18T12:00:07.184Z\",\n  \"taxonomy_search\": null,\n  \"override\": false\n}"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"home":{"doc_url":"../apidoc/v2/home","id":"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":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"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":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"usergroups":{"doc_url":"../apidoc/v2/usergroups","id":"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, ‘all’ to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"name","type":"string"},{"name":"role","type":"string"},{"name":"role_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"usergroup","full_name":"usergroup","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"usergroup[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"admin","full_name":"usergroup[admin]","description":"\n\u003cp\u003eis an admin user group, can be modified by admins only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"user_ids","full_name":"usergroup[user_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"usergroup_ids","full_name":"usergroup[usergroup_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"role_ids","full_name":"usergroup[role_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"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":"\n\u003cp\u003eUser groups linked to external groups (LDAP) are automatically synced with these groups on update. Remember this synchronization will remove any LDAP users manually added to the Foreman user group. Only LDAP users in the external groups will remain. Internal users can be added or removed freely.\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"usergroup","full_name":"usergroup","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"usergroup[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"admin","full_name":"usergroup[admin]","description":"\n\u003cp\u003eis an admin user group, can be modified by admins only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"user_ids","full_name":"usergroup[user_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"usergroup_ids","full_name":"usergroup[usergroup_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"role_ids","full_name":"usergroup[role_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"smart_proxy_hosts":{"doc_url":"../apidoc/v2/smart_proxy_hosts","id":"smart_proxy_hosts","api_url":"/api","name":"Smart proxy hosts","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/smart_proxy_hosts/update","name":"update","apis":[{"api_url":"/api/smart_proxies/:smart_proxy_id/hosts/:host_id","http_method":"PUT","short_description":"Assign a host to the smart proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"smart_proxy_id","full_name":"smart_proxy_id","description":"","required":false,"allow_nil":false,"allow_blank":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,"validations":[]},{"name":"host_id","full_name":"host_id","description":"","required":false,"allow_nil":false,"allow_blank":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,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/smart_proxy_hosts/index","name":"index","apis":[{"api_url":"/api/smart_proxies/:smart_proxy_id/hosts","http_method":"GET","short_description":"Get hosts forming the smart proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/smart_proxy_hosts/destroy","name":"destroy","apis":[{"api_url":"/api/smart_proxies/:smart_proxy_id/hosts/:host_id","http_method":"DELETE","short_description":"Unassign a given host from the smart proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"http_proxies":{"doc_url":"../apidoc/v2/http_proxies","id":"http_proxies","api_url":"/api","name":"Http proxies","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/http_proxies/index","name":"index","apis":[{"api_url":"/api/http_proxies","http_method":"GET","short_description":"List of HTTP Proxies","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, ‘all’ to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"url","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/http_proxies/show","name":"show","apis":[{"api_url":"/api/http_proxies/:id","http_method":"GET","short_description":"Show an HTTP Proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eIdentifier of the HTTP Proxy\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":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,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/http_proxies/create","name":"create","apis":[{"api_url":"/api/http_proxies","http_method":"POST","short_description":"Create an HTTP Proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"http_proxy","full_name":"http_proxy","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"http_proxy[name]","description":"\n\u003cp\u003eThe HTTP Proxy name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"http_proxy[url]","description":"\n\u003cp\u003eURL of the HTTP Proxy\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"username","full_name":"http_proxy[username]","description":"\n\u003cp\u003eUsername used to authenticate with the HTTP Proxy\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"http_proxy[password]","description":"\n\u003cp\u003ePassword used to authenticate with the HTTP Proxy\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"http_proxy[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"http_proxy[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/http_proxies/update","name":"update","apis":[{"api_url":"/api/http_proxies/:id","http_method":"PUT","short_description":"Update an HTTP Proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]},{"name":"http_proxy","full_name":"http_proxy","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"http_proxy[name]","description":"\n\u003cp\u003eThe HTTP Proxy name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"http_proxy[url]","description":"\n\u003cp\u003eURL of the HTTP Proxy\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"username","full_name":"http_proxy[username]","description":"\n\u003cp\u003eUsername used to authenticate with the HTTP Proxy\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"http_proxy[password]","description":"\n\u003cp\u003ePassword used to authenticate with the HTTP Proxy\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"http_proxy[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"http_proxy[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/http_proxies/destroy","name":"destroy","apis":[{"api_url":"/api/http_proxies/:id","http_method":"DELETE","short_description":"Delete an HTTP Proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"images":{"doc_url":"../apidoc/v2/images","id":"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},{"api_url":"/api/operatingsystems/:operatingsystem_id/images","http_method":"GET","short_description":"List all images for operating system","deprecated":null},{"api_url":"/api/architectures/:architecture_id/images","http_method":"GET","short_description":"List all images for architecture","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"\n\u003cp\u003eID of compute resource\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"architecture_id","description":"\n\u003cp\u003eID of architecture\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, ‘all’ to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"architecture","type":"integer"},{"name":"compute_resource","type":"string"},{"name":"name","type":"string"},{"name":"operatingsystem","type":"integer"},{"name":"user_data","values":["true","false"]},{"name":"username","type":"string"}]},"see":[],"headers":[],"show":true},{"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},{"api_url":"/api/operatingsystems/:operatingsystem_id/images/:id","http_method":"GET","short_description":"Show an image","deprecated":null},{"api_url":"/api/architectures/:architecture_id/images/:id","http_method":"GET","short_description":"Show an image","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"\n\u003cp\u003eID of compute resource\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"architecture_id","description":"\n\u003cp\u003eID of architecture\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]},{"name":"image","full_name":"image","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"image[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"username","full_name":"image[username]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"uuid","full_name":"image[uuid]","description":"\n\u003cp\u003eTemplate ID in the compute resource\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"image[password]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"image[compute_resource_id]","description":"\n\u003cp\u003eID of compute resource\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"image[architecture_id]","description":"\n\u003cp\u003eID of architecture\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"image[operatingsystem_id]","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user_data","full_name":"image[user_data]","description":"\n\u003cp\u003eWhether or not the image supports user data\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]},{"name":"image","full_name":"image","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"image[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"username","full_name":"image[username]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"uuid","full_name":"image[uuid]","description":"\n\u003cp\u003eTemplate ID in the compute resource\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"image[password]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"image[compute_resource_id]","description":"\n\u003cp\u003eID of compute resource\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"image[architecture_id]","description":"\n\u003cp\u003eID of architecture\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"image[operatingsystem_id]","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user_data","full_name":"image[user_data]","description":"\n\u003cp\u003eWhether or not the image supports user data\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"interfaces":{"doc_url":"../apidoc/v2/interfaces","id":"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},{"api_url":"/api/domains/:domain_id/interfaces","http_method":"GET","short_description":"List all interfaces for domain","deprecated":null},{"api_url":"/api/subnets/:subnet_id/interfaces","http_method":"GET","short_description":"List all interfaces for subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID or name of host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID or name of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID or name of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, ‘all’ to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["GET /api/hosts/host78/interfaces\n200\n{\n  \"total\": 3,\n  \"subtotal\": 3,\n  \"page\": 1,\n  \"per_page\": 20,\n  \"search\": null,\n  \"sort\": {\n    \"by\": null,\n    \"order\": null\n  },\n  \"results\": [\n    {\n      \"subnet_id\": null,\n      \"subnet_name\": null,\n      \"subnet6_id\": null,\n      \"subnet6_name\": null,\n      \"domain_id\": null,\n      \"domain_name\": null,\n      \"created_at\": \"2021-05-18 11:45:38 UTC\",\n      \"updated_at\": \"2021-05-18 11:45:38 UTC\",\n      \"managed\": true,\n      \"identifier\": null,\n      \"id\": 37,\n      \"name\": \"host78\",\n      \"ip\": null,\n      \"ip6\": null,\n      \"mac\": null,\n      \"mtu\": null,\n      \"fqdn\": \"host78\",\n      \"primary\": true,\n      \"provision\": true,\n      \"type\": \"interface\",\n      \"virtual\": false\n    },\n    {\n      \"subnet_id\": null,\n      \"subnet_name\": null,\n      \"subnet6_id\": null,\n      \"subnet6_name\": null,\n      \"domain_id\": null,\n      \"domain_name\": null,\n      \"created_at\": \"2021-05-18 11:45:38 UTC\",\n      \"updated_at\": \"2021-05-18 11:45:38 UTC\",\n      \"managed\": true,\n      \"identifier\": \"eth51\",\n      \"id\": 38,\n      \"name\": null,\n      \"ip\": \"0.0.0.33\",\n      \"ip6\": null,\n      \"mac\": \"00:33:45:ab:00:26\",\n      \"mtu\": null,\n      \"fqdn\": null,\n      \"primary\": false,\n      \"provision\": false,\n      \"type\": \"interface\",\n      \"virtual\": false\n    },\n    {\n      \"subnet_id\": null,\n      \"subnet_name\": null,\n      \"subnet6_id\": null,\n      \"subnet6_name\": null,\n      \"domain_id\": null,\n      \"domain_name\": null,\n      \"created_at\": \"2021-05-18 11:45:38 UTC\",\n      \"updated_at\": \"2021-05-18 11:45:38 UTC\",\n      \"managed\": true,\n      \"identifier\": \"eth52\",\n      \"id\": 39,\n      \"name\": null,\n      \"ip\": \"0.0.0.34\",\n      \"ip6\": null,\n      \"mac\": \"00:33:45:ab:00:27\",\n      \"mtu\": null,\n      \"fqdn\": null,\n      \"primary\": false,\n      \"provision\": false,\n      \"type\": \"bond\",\n      \"mode\": \"balance-rr\",\n      \"attached_devices\": \"\",\n      \"bond_options\": \"\",\n      \"virtual\": true\n    }\n  ]\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID or name of host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID or name of interface\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["GET /api/hosts/host80/interfaces/45\n200\n{\n  \"subnet_id\": null,\n  \"subnet_name\": null,\n  \"subnet6_id\": null,\n  \"subnet6_name\": null,\n  \"domain_id\": null,\n  \"domain_name\": null,\n  \"created_at\": \"2021-05-18 11:45:38 UTC\",\n  \"updated_at\": \"2021-05-18 11:45:38 UTC\",\n  \"managed\": true,\n  \"identifier\": \"eth55\",\n  \"id\": 45,\n  \"name\": null,\n  \"ip\": \"0.0.0.37\",\n  \"ip6\": null,\n  \"mac\": \"00:33:45:ab:00:2a\",\n  \"mtu\": null,\n  \"fqdn\": null,\n  \"primary\": false,\n  \"provision\": false,\n  \"type\": \"interface\",\n  \"virtual\": false\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID or name of host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"interface","full_name":"interface","description":"\n\u003cp\u003einterface information\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"mac","full_name":"interface[mac]","description":"\n\u003cp\u003eMAC address of interface. Required for managed interfaces on bare metal.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip","full_name":"interface[ip]","description":"\n\u003cp\u003eIPv4 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip6","full_name":"interface[ip6]","description":"\n\u003cp\u003eIPv6 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"interface[type]","description":"\n\u003cp\u003eInterface type, e.g. bmc. Default is interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003einterface\u003c/code\u003e, \u003ccode\u003ebmc\u003c/code\u003e, \u003ccode\u003ebond\u003c/code\u003e, \u003ccode\u003ebridge\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"interface[name]","description":"\n\u003cp\u003eInterface’s DNS name\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"interface[subnet_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv4 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet6_id","full_name":"interface[subnet6_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv6 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"interface[domain_id]","description":"\n\u003cp\u003eForeman domain ID of interface. Required for primary interfaces on managed hosts.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"identifier","full_name":"interface[identifier]","description":"\n\u003cp\u003eDevice identifier, e.g. eth0 or eth1.1\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"managed","full_name":"interface[managed]","description":"\n\u003cp\u003eShould this interface be managed via DHCP and DNS smart proxy and should it be configured during provisioning?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"primary","full_name":"interface[primary]","description":"\n\u003cp\u003eShould this interface be used for constructing the FQDN of the host? Each managed hosts needs to have one primary interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"provision","full_name":"interface[provision]","description":"\n\u003cp\u003eShould this interface be used for TFTP of PXELinux (or SSH for image-based hosts)? Each managed hosts needs to have one provision interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"username","full_name":"interface[username]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"interface[password]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider","full_name":"interface[provider]","description":"\n\u003cp\u003eInterface provider, e.g. IPMI. Only for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eIPMI\u003c/code\u003e, \u003ccode\u003eRedfish\u003c/code\u003e, \u003ccode\u003eSSH\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"virtual","full_name":"interface[virtual]","description":"\n\u003cp\u003eAlias or VLAN device\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"tag","full_name":"interface[tag]","description":"\n\u003cp\u003eVLAN tag, this attribute has precedence over the subnet VLAN ID. Only for virtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mtu","full_name":"interface[mtu]","description":"\n\u003cp\u003eMTU, this attribute has precedence over the subnet MTU.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"attached_to","full_name":"interface[attached_to]","description":"\n\u003cp\u003eIdentifier of the interface to which this interface belongs, e.g. eth1. Only for virtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mode","full_name":"interface[mode]","description":"\n\u003cp\u003eBond mode of the interface, e.g. balance-rr. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ebalance-rr\u003c/code\u003e, \u003ccode\u003eactive-backup\u003c/code\u003e, \u003ccode\u003ebalance-xor\u003c/code\u003e, \u003ccode\u003ebroadcast\u003c/code\u003e, \u003ccode\u003e802.3ad\u003c/code\u003e, \u003ccode\u003ebalance-tlb\u003c/code\u003e, \u003ccode\u003ebalance-alb\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attached_devices","full_name":"interface[attached_devices]","description":"\n\u003cp\u003eIdentifiers of attached interfaces, e.g. \u003ccode\u003e[\u0026#39;eth1\u0026#39;, \u0026#39;eth2\u0026#39;]\u003c/code\u003e. For bond interfaces those are the slaves. Only for bond and bridges interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"bond_options","full_name":"interface[bond_options]","description":"\n\u003cp\u003eSpace separated options, e.g. miimon=100. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_attributes","full_name":"interface[compute_attributes]","description":"\n\u003cp\u003eAdditional compute resource specific attributes for the interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":["POST /api/hosts/4/interfaces\n{\n  \"interface\": {\n    \"name\": \"睝掱稬倮蝝燱齖殢硨鵓\",\n    \"ip\": \"10.0.1.1\",\n    \"mac\": \"AA:AA:AA:AA:AA:AA\",\n    \"username\": \"foo\",\n    \"password\": \"bar\",\n    \"provider\": \"IPMI\",\n    \"type\": \"bmc\",\n    \"ip6\": \"2001:db8::1\"\n  }\n}\n422\n{\n  \"error\": {\n    \"id\": null,\n    \"errors\": {\n      \"name\": [\n        \"hostname can contain only lowercase letters, numbers, dashes and dots according to RFC921, RFC952 and RFC1123\"\n      ]\n    },\n    \"full_messages\": [\n      \"Name hostname can contain only lowercase letters, numbers, dashes and dots according to RFC921, RFC952 and RFC1123\"\n    ]\n  }\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID or name of host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of interface\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":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,"validations":[]},{"name":"interface","full_name":"interface","description":"\n\u003cp\u003einterface information\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"mac","full_name":"interface[mac]","description":"\n\u003cp\u003eMAC address of interface. Required for managed interfaces on bare metal.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip","full_name":"interface[ip]","description":"\n\u003cp\u003eIPv4 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip6","full_name":"interface[ip6]","description":"\n\u003cp\u003eIPv6 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"interface[type]","description":"\n\u003cp\u003eInterface type, e.g. bmc. Default is interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003einterface\u003c/code\u003e, \u003ccode\u003ebmc\u003c/code\u003e, \u003ccode\u003ebond\u003c/code\u003e, \u003ccode\u003ebridge\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"interface[name]","description":"\n\u003cp\u003eInterface’s DNS name\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"interface[subnet_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv4 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet6_id","full_name":"interface[subnet6_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv6 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"interface[domain_id]","description":"\n\u003cp\u003eForeman domain ID of interface. Required for primary interfaces on managed hosts.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"identifier","full_name":"interface[identifier]","description":"\n\u003cp\u003eDevice identifier, e.g. eth0 or eth1.1\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"managed","full_name":"interface[managed]","description":"\n\u003cp\u003eShould this interface be managed via DHCP and DNS smart proxy and should it be configured during provisioning?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"primary","full_name":"interface[primary]","description":"\n\u003cp\u003eShould this interface be used for constructing the FQDN of the host? Each managed hosts needs to have one primary interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"provision","full_name":"interface[provision]","description":"\n\u003cp\u003eShould this interface be used for TFTP of PXELinux (or SSH for image-based hosts)? Each managed hosts needs to have one provision interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"username","full_name":"interface[username]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"interface[password]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider","full_name":"interface[provider]","description":"\n\u003cp\u003eInterface provider, e.g. IPMI. Only for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eIPMI\u003c/code\u003e, \u003ccode\u003eRedfish\u003c/code\u003e, \u003ccode\u003eSSH\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"virtual","full_name":"interface[virtual]","description":"\n\u003cp\u003eAlias or VLAN device\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"tag","full_name":"interface[tag]","description":"\n\u003cp\u003eVLAN tag, this attribute has precedence over the subnet VLAN ID. Only for virtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mtu","full_name":"interface[mtu]","description":"\n\u003cp\u003eMTU, this attribute has precedence over the subnet MTU.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"attached_to","full_name":"interface[attached_to]","description":"\n\u003cp\u003eIdentifier of the interface to which this interface belongs, e.g. eth1. Only for virtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mode","full_name":"interface[mode]","description":"\n\u003cp\u003eBond mode of the interface, e.g. balance-rr. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ebalance-rr\u003c/code\u003e, \u003ccode\u003eactive-backup\u003c/code\u003e, \u003ccode\u003ebalance-xor\u003c/code\u003e, \u003ccode\u003ebroadcast\u003c/code\u003e, \u003ccode\u003e802.3ad\u003c/code\u003e, \u003ccode\u003ebalance-tlb\u003c/code\u003e, \u003ccode\u003ebalance-alb\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attached_devices","full_name":"interface[attached_devices]","description":"\n\u003cp\u003eIdentifiers of attached interfaces, e.g. \u003ccode\u003e[\u0026#39;eth1\u0026#39;, \u0026#39;eth2\u0026#39;]\u003c/code\u003e. For bond interfaces those are the slaves. Only for bond and bridges interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"bond_options","full_name":"interface[bond_options]","description":"\n\u003cp\u003eSpace separated options, e.g. miimon=100. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_attributes","full_name":"interface[compute_attributes]","description":"\n\u003cp\u003eAdditional compute resource specific attributes for the interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":["PUT /api/hosts/host70/interfaces/12\n{\n  \"interface\": {\n    \"name\": \"hsobarwiep\"\n  }\n}\n200\n{\n  \"subnet_id\": null,\n  \"subnet_name\": null,\n  \"subnet6_id\": null,\n  \"subnet6_name\": null,\n  \"domain_id\": null,\n  \"domain_name\": null,\n  \"created_at\": \"2021-05-18 11:45:36 UTC\",\n  \"updated_at\": \"2021-05-18 11:45:36 UTC\",\n  \"managed\": true,\n  \"identifier\": \"eth35\",\n  \"id\": 12,\n  \"name\": \"hsobarwiep\",\n  \"ip\": \"0.0.0.17\",\n  \"ip6\": null,\n  \"mac\": \"00:33:45:ab:00:16\",\n  \"mtu\": null,\n  \"fqdn\": \"hsobarwiep\",\n  \"primary\": false,\n  \"provision\": false,\n  \"type\": \"interface\",\n  \"virtual\": false\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID or name of host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of interface\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["DELETE /api/hosts/host66/interfaces/2\n{\n  \"interface\": {}\n}\n200\n{\n  \"id\": 2,\n  \"mac\": \"00:33:45:ab:00:10\",\n  \"ip\": \"0.0.0.11\",\n  \"name\": null,\n  \"host_id\": 1,\n  \"subnet_id\": null,\n  \"domain_id\": null,\n  \"attrs\": {},\n  \"created_at\": \"2021-05-18T11:45:35.580Z\",\n  \"updated_at\": \"2021-05-18T11:45:35.580Z\",\n  \"provider\": null,\n  \"username\": null,\n  \"password\": null,\n  \"virtual\": false,\n  \"link\": true,\n  \"identifier\": \"eth28\",\n  \"tag\": \"\",\n  \"attached_to\": \"\",\n  \"managed\": true,\n  \"mode\": \"balance-rr\",\n  \"attached_devices\": \"\",\n  \"bond_options\": \"\",\n  \"primary\": false,\n  \"provision\": false,\n  \"compute_attributes\": {},\n  \"execution\": false,\n  \"ip6\": null,\n  \"subnet6_id\": null\n}"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"locations":{"doc_url":"../apidoc/v2/locations","id":"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, ‘all’ to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"description","type":"text"},{"name":"id","type":"integer"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"title","type":"string"}]},"see":[],"headers":[],"show":true},{"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":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"show_hidden_parameters","full_name":"show_hidden_parameters","description":"\n\u003cp\u003eDisplay hidden parameter values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"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_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"location","full_name":"location","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"location[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"location[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_ids","full_name":"location[user_ids]","description":"\n\u003cp\u003eUser IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"smart_proxy_ids","full_name":"location[smart_proxy_ids]","description":"\n\u003cp\u003eSmart proxy IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_ids","full_name":"location[compute_resource_ids]","description":"\n\u003cp\u003eCompute resource IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"medium_ids","full_name":"location[medium_ids]","description":"\n\u003cp\u003eMedium IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"ptable_ids","full_name":"location[ptable_ids]","description":"\n\u003cp\u003ePartition template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_ids","full_name":"location[provisioning_template_ids]","description":"\n\u003cp\u003eProvisioning template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"domain_ids","full_name":"location[domain_ids]","description":"\n\u003cp\u003eDomain IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"realm_ids","full_name":"location[realm_ids]","description":"\n\u003cp\u003eRealm IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_ids","full_name":"location[hostgroup_ids]","description":"\n\u003cp\u003eHost group IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"environment_ids","full_name":"location[environment_ids]","description":"\n\u003cp\u003eEnvironment IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"subnet_ids","full_name":"location[subnet_ids]","description":"\n\u003cp\u003eSubnet IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"parent_id","full_name":"location[parent_id]","description":"\n\u003cp\u003eParent ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ignore_types","full_name":"location[ignore_types]","description":"\n\u003cp\u003eList of resources types that will be automatically associated\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"location[organization_ids]","description":"\n\u003cp\u003eAssociated organization IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"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_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"location","full_name":"location","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"location[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"location[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_ids","full_name":"location[user_ids]","description":"\n\u003cp\u003eUser IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"smart_proxy_ids","full_name":"location[smart_proxy_ids]","description":"\n\u003cp\u003eSmart proxy IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_ids","full_name":"location[compute_resource_ids]","description":"\n\u003cp\u003eCompute resource IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"medium_ids","full_name":"location[medium_ids]","description":"\n\u003cp\u003eMedium IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"ptable_ids","full_name":"location[ptable_ids]","description":"\n\u003cp\u003ePartition template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_ids","full_name":"location[provisioning_template_ids]","description":"\n\u003cp\u003eProvisioning template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"domain_ids","full_name":"location[domain_ids]","description":"\n\u003cp\u003eDomain IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"realm_ids","full_name":"location[realm_ids]","description":"\n\u003cp\u003eRealm IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_ids","full_name":"location[hostgroup_ids]","description":"\n\u003cp\u003eHost group IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"environment_ids","full_name":"location[environment_ids]","description":"\n\u003cp\u003eEnvironment IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"subnet_ids","full_name":"location[subnet_ids]","description":"\n\u003cp\u003eSubnet IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"parent_id","full_name":"location[parent_id]","description":"\n\u003cp\u003eParent ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ignore_types","full_name":"location[ignore_types]","description":"\n\u003cp\u003eList of resources types that will be automatically associated\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"location[organization_ids]","description":"\n\u003cp\u003eAssociated organization IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"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":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"mail_notifications":{"doc_url":"../apidoc/v2/mail_notifications","id":"mail_notifications","api_url":"/api","name":"Mail notifications","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/mail_notifications/index","name":"index","apis":[{"api_url":"/api/mail_notifications","http_method":"GET","short_description":"List of email notifications","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, ‘all’ to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"description","type":"text"},{"name":"name","type":"string"},{"name":"user","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/mail_notifications/show","name":"show","apis":[{"api_url":"/api/mail_notifications/:id","http_method":"GET","short_description":"Show an email notification","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eNumerical ID or email notification name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":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,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/mail_notifications/create","name":"create","apis":[{"api_url":"/api/users/:user_id/mail_notifications","http_method":"POST","short_description":"Add an email notification for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mail_notification_id","full_name":"mail_notification_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"interval","full_name":"interval","description":"\n\u003cp\u003eMail notification interval option, e.g. Daily, Weekly or Monthly. Required for summary notification\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subscription","full_name":"subscription","description":"\n\u003cp\u003eMail notification subscription option, e.g. Subscribe, Subscribe to my hosts or Subscribe to all hosts. Required for host built and config error state\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mail_query","full_name":"mail_query","description":"\n\u003cp\u003eRelevant only for audit summary notification\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/mail_notifications/update","name":"update","apis":[{"api_url":"/api/users/:user_id/mail_notifications/:mail_notification_id","http_method":"PUT","short_description":"Update an email notification for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mail_notification_id","full_name":"mail_notification_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"interval","full_name":"interval","description":"\n\u003cp\u003eMail notification interval option, e.g. Daily, Weekly or Monthly. Required for summary notification\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subscription","full_name":"subscription","description":"\n\u003cp\u003eMail notification subscription option, e.g. Subscribe, Subscribe to my hosts or Subscribe to all hosts. Required for host built and config error state\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mail_query","full_name":"mail_query","description":"\n\u003cp\u003eRelevant only for audit summary notification\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/mail_notifications/destroy","name":"destroy","apis":[{"api_url":"/api/users/:user_id/mail_notifications/:mail_notification_id","http_method":"DELETE","short_description":"Remove an email notification for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mail_notification_id","full_name":"mail_notification_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/mail_notifications/user_mail_notifications","name":"user_mail_notifications","apis":[{"api_url":"/api/users/:user_id/mail_notifications","http_method":"GET","short_description":"List all email notifications for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"media":{"doc_url":"../apidoc/v2/media","id":"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},{"api_url":"/api/operatingsystems/:operatingsystem_id/media","http_method":"GET","short_description":"List all media for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/media","http_method":"GET","short_description":"List all media per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/media","http_method":"GET","short_description":"List all media per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, ‘all’ to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"family","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"path","type":"string"}]},"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"medium","full_name":"medium","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"medium[name]","description":"\n\u003cp\u003eName of media\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"path","full_name":"medium[path]","description":"\n\u003cp\u003eThe path to the medium, can be a URL or a valid NFS server (exclusive of the architecture).\u003c/p\u003e\n\n\u003cp\u003efor example http://mirror.centos.org/centos/$version/os/$arch where $arch will be substituted for the host’s actual OS architecture and $version, $major and $minor will be substituted for the version of the operating system.\u003c/p\u003e\n\n\u003cp\u003eSolaris and Debian media may also use $release.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"os_family","full_name":"medium[os_family]","description":"\n\u003cp\u003eOperating system family, available values: AIX, Altlinux, Archlinux, Coreos, Debian, Fcos, Freebsd, Gentoo, Junos, NXOS, Rancheros, Redhat, Rhcos, Solaris, Suse, VRP, Windows, Xenserver\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_ids","full_name":"medium[operatingsystem_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"medium[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"medium[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"medium","full_name":"medium","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"medium[name]","description":"\n\u003cp\u003eName of media\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"path","full_name":"medium[path]","description":"\n\u003cp\u003eThe path to the medium, can be a URL or a valid NFS server (exclusive of the architecture).\u003c/p\u003e\n\n\u003cp\u003efor example http://mirror.centos.org/centos/$version/os/$arch where $arch will be substituted for the host’s actual OS architecture and $version, $major and $minor will be substituted for the version of the operating system.\u003c/p\u003e\n\n\u003cp\u003eSolaris and Debian media may also use $release.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"os_family","full_name":"medium[os_family]","description":"\n\u003cp\u003eOperating system family, available values: AIX, Altlinux, Archlinux, Coreos, Debian, Fcos, Freebsd, Gentoo, Junos, NXOS, Rancheros, Redhat, Rhcos, Solaris, Suse, VRP, Windows, Xenserver\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_ids","full_name":"medium[operatingsystem_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"medium[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"medium[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"models":{"doc_url":"../apidoc/v2/models","id":"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, ‘all’ to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"hardware_model","type":"string"},{"name":"info","type":"text"},{"name":"name","type":"string"},{"name":"vendor_class","type":"string"}]},"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"model","full_name":"model","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"model[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"info","full_name":"model[info]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"vendor_class","full_name":"model[vendor_class]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hardware_model","full_name":"model[hardware_model]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"model","full_name":"model","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"model[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"info","full_name":"model[info]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"vendor_class","full_name":"model[vendor_class]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hardware_model","full_name":"model[hardware_model]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"operatingsystems":{"doc_url":"../apidoc/v2/operatingsystems","id":"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},{"api_url":"/api/architectures/:architecture_id/operatingsystems","http_method":"GET","short_description":"List all operating systems for nested architecture","deprecated":null},{"api_url":"/api/media/:medium_id/operatingsystems","http_method":"GET","short_description":"List all operating systems for nested medium","deprecated":null},{"api_url":"/api/ptables/:ptable_id/operatingsystems","http_method":"GET","short_description":"List all operating systems for nested partition table","deprecated":null},{"api_url":"/api/provisioning_templates/:provisioning_template_id/operatingsystems","http_method":"GET","short_description":"List all operating systems for nested provisioning template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"architecture_id","description":"\n\u003cp\u003eID of architecture\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"medium_id","full_name":"medium_id","description":"\n\u003cp\u003eID of medium\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ptable_id","full_name":"ptable_id","description":"\n\u003cp\u003eID of partition table\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_id","full_name":"provisioning_template_id","description":"\n\u003cp\u003eID of template\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"os_parameters_attributes","full_name":"os_parameters_attributes","description":"\n\u003cp\u003eArray of parameters\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"os_parameters_attributes[name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"os_parameters_attributes[value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, ‘all’ to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"architecture","type":"string"},{"name":"description","type":"string"},{"name":"family","type":"string"},{"name":"major","type":"string"},{"name":"medium","type":"string"},{"name":"minor","type":"string"},{"name":"name","type":"string"},{"name":"params","type":"string"},{"name":"template","type":"string"},{"name":"title","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/operatingsystems/show","name":"show","apis":[{"api_url":"/api/operatingsystems/:id","http_method":"GET","short_description":"Show an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden_parameters","full_name":"show_hidden_parameters","description":"\n\u003cp\u003eDisplay hidden parameter values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/operatingsystems/create","name":"create","apis":[{"api_url":"/api/operatingsystems","http_method":"POST","short_description":"Create an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem","full_name":"operatingsystem","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"operatingsystem[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A(\\S+)\\Z/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"major","full_name":"operatingsystem[major]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"minor","full_name":"operatingsystem[minor]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"operatingsystem[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"family","full_name":"operatingsystem[family]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"release_name","full_name":"operatingsystem[release_name]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"os_parameters_attributes","full_name":"operatingsystem[os_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"operatingsystem[os_parameters_attributes][name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"operatingsystem[os_parameters_attributes][value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"password_hash","full_name":"operatingsystem[password_hash]","description":"\n\u003cp\u003eRoot password hash function to use\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eSHA256\u003c/code\u003e, \u003ccode\u003eSHA512\u003c/code\u003e, \u003ccode\u003eBase64\u003c/code\u003e, \u003ccode\u003eBase64-Windows\u003c/code\u003e, \u003ccode\u003eMD5\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture_ids","full_name":"operatingsystem[architecture_ids]","description":"\n\u003cp\u003eIDs of associated architectures\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_ids","full_name":"operatingsystem[provisioning_template_ids]","description":"\n\u003cp\u003eIDs of associated provisioning templates\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"medium_ids","full_name":"operatingsystem[medium_ids]","description":"\n\u003cp\u003eIDs of associated media\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"ptable_ids","full_name":"operatingsystem[ptable_ids]","description":"\n\u003cp\u003eIDs of associated partition tables\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/operatingsystems/update","name":"update","apis":[{"api_url":"/api/operatingsystems/:id","http_method":"PUT","short_description":"Update an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem","full_name":"operatingsystem","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"operatingsystem[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A(\\S+)\\Z/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"major","full_name":"operatingsystem[major]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"minor","full_name":"operatingsystem[minor]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"operatingsystem[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"family","full_name":"operatingsystem[family]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"release_name","full_name":"operatingsystem[release_name]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"os_parameters_attributes","full_name":"operatingsystem[os_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"operatingsystem[os_parameters_attributes][name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"operatingsystem[os_parameters_attributes][value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"password_hash","full_name":"operatingsystem[password_hash]","description":"\n\u003cp\u003eRoot password hash function to use\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eSHA256\u003c/code\u003e, \u003ccode\u003eSHA512\u003c/code\u003e, \u003ccode\u003eBase64\u003c/code\u003e, \u003ccode\u003eBase64-Windows\u003c/code\u003e, \u003ccode\u003eMD5\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture_ids","full_name":"operatingsystem[architecture_ids]","description":"\n\u003cp\u003eIDs of associated architectures\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_ids","full_name":"operatingsystem[provisioning_template_ids]","description":"\n\u003cp\u003eIDs of associated provisioning templates\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"medium_ids","full_name":"operatingsystem[medium_ids]","description":"\n\u003cp\u003eIDs of associated media\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"ptable_ids","full_name":"operatingsystem[ptable_ids]","description":"\n\u003cp\u003eIDs of associated partition tables\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/operatingsystems/destroy","name":"destroy","apis":[{"api_url":"/api/operatingsystems/:id","http_method":"DELETE","short_description":"Delete an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"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 operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"medium","full_name":"medium","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture","full_name":"architecture","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"organizations":{"doc_url":"../apidoc/v2/organizations","id":"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, ‘all’ to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"description","type":"text"},{"name":"id","type":"integer"},{"name":"name","type":"string"},{"name":"organization_id","type":"integer"},{"name":"title","type":"string"}]},"see":[],"headers":[],"show":true},{"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":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"show_hidden_parameters","full_name":"show_hidden_parameters","description":"\n\u003cp\u003eDisplay hidden parameter values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]}],"returns":[],"examples":["GET /api/organizations/447626463\n200\n{\n  \"select_all_types\": [],\n  \"description\": null,\n  \"created_at\": \"2021-05-18 11:43:41 UTC\",\n  \"updated_at\": \"2021-05-18 11:43:41 UTC\",\n  \"ancestry\": null,\n  \"parent_id\": null,\n  \"parent_name\": null,\n  \"id\": 447626463,\n  \"name\": \"org2\",\n  \"title\": \"org2\",\n  \"users\": [],\n  \"smart_proxies\": [],\n  \"subnets\": [],\n  \"compute_resources\": [],\n  \"media\": [],\n  \"ptables\": [],\n  \"provisioning_templates\": [],\n  \"domains\": [],\n  \"realms\": [],\n  \"environments\": [],\n  \"hostgroups\": [],\n  \"locations\": [],\n  \"hosts_count\": 0,\n  \"parameters\": [\n    {\n      \"priority\": 10,\n      \"created_at\": \"2021-05-18 11:43:41 UTC\",\n      \"updated_at\": \"2021-05-18 11:43:41 UTC\",\n      \"id\": 767575242,\n      \"name\": \"foo\",\n      \"parameter_type\": \"string\",\n      \"value\": \"*****\"\n    }\n  ]\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization","full_name":"organization","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"organization[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"organization[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_ids","full_name":"organization[user_ids]","description":"\n\u003cp\u003eUser IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"smart_proxy_ids","full_name":"organization[smart_proxy_ids]","description":"\n\u003cp\u003eSmart proxy IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_ids","full_name":"organization[compute_resource_ids]","description":"\n\u003cp\u003eCompute resource IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"medium_ids","full_name":"organization[medium_ids]","description":"\n\u003cp\u003eMedium IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"ptable_ids","full_name":"organization[ptable_ids]","description":"\n\u003cp\u003ePartition template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_ids","full_name":"organization[provisioning_template_ids]","description":"\n\u003cp\u003eProvisioning template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"domain_ids","full_name":"organization[domain_ids]","description":"\n\u003cp\u003eDomain IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"realm_ids","full_name":"organization[realm_ids]","description":"\n\u003cp\u003eRealm IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_ids","full_name":"organization[hostgroup_ids]","description":"\n\u003cp\u003eHost group IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"environment_ids","full_name":"organization[environment_ids]","description":"\n\u003cp\u003eEnvironment IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"subnet_ids","full_name":"organization[subnet_ids]","description":"\n\u003cp\u003eSubnet IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"parent_id","full_name":"organization[parent_id]","description":"\n\u003cp\u003eParent ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ignore_types","full_name":"organization[ignore_types]","description":"\n\u003cp\u003eList of resources types that will be automatically associated\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"organization[location_ids]","description":"\n\u003cp\u003eAssociated location IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization","full_name":"organization","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"organization[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"organization[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_ids","full_name":"organization[user_ids]","description":"\n\u003cp\u003eUser IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"smart_proxy_ids","full_name":"organization[smart_proxy_ids]","description":"\n\u003cp\u003eSmart proxy IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_ids","full_name":"organization[compute_resource_ids]","description":"\n\u003cp\u003eCompute resource IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"medium_ids","full_name":"organization[medium_ids]","description":"\n\u003cp\u003eMedium IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"ptable_ids","full_name":"organization[ptable_ids]","description":"\n\u003cp\u003ePartition template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_ids","full_name":"organization[provisioning_template_ids]","description":"\n\u003cp\u003eProvisioning template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"domain_ids","full_name":"organization[domain_ids]","description":"\n\u003cp\u003eDomain IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"realm_ids","full_name":"organization[realm_ids]","description":"\n\u003cp\u003eRealm IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_ids","full_name":"organization[hostgroup_ids]","description":"\n\u003cp\u003eHost group IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"environment_ids","full_name":"organization[environment_ids]","description":"\n\u003cp\u003eEnvironment IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"subnet_ids","full_name":"organization[subnet_ids]","description":"\n\u003cp\u003eSubnet IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"parent_id","full_name":"organization[parent_id]","description":"\n\u003cp\u003eParent ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ignore_types","full_name":"organization[ignore_types]","description":"\n\u003cp\u003eList of resources types that will be automatically associated\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"organization[location_ids]","description":"\n\u003cp\u003eAssociated location IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"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":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"os_default_templates":{"doc_url":"../apidoc/v2/os_default_templates","id":"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},{"api_url":"/api/provisioning_templates/:provisioning_template_id/os_default_templates","http_method":"GET","short_description":"List operating systems where this template is set as a default","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_id","full_name":"provisioning_template_id","description":"\n\u003cp\u003eID of provisioning template\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, ‘all’ to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["GET /api/operatingsystems/1073012828-RHEL%206-1/os_default_templates\n200\n{\n  \"total\": 7,\n  \"subtotal\": 7,\n  \"page\": 1,\n  \"per_page\": 20,\n  \"search\": null,\n  \"sort\": {\n    \"by\": null,\n    \"order\": null\n  },\n  \"results\": [\n    {\n      \"id\": 980190962,\n      \"provisioning_template_id\": 943779058,\n      \"provisioning_template_name\": \"MyString\",\n      \"template_kind_id\": 698706415,\n      \"template_kind_name\": \"iPXE\",\n      \"operatingsystem_id\": 1073012828,\n      \"operatingsystem_name\": \"RHEL 6.1\"\n    },\n    {\n      \"id\": 298486374,\n      \"provisioning_template_id\": 269958254,\n      \"provisioning_template_name\": \"MyString2\",\n      \"template_kind_id\": 983253650,\n      \"template_kind_name\": \"provision\",\n      \"operatingsystem_id\": 1073012828,\n      \"operatingsystem_name\": \"RHEL 6.1\"\n    },\n    {\n      \"id\": 113629430,\n      \"provisioning_template_id\": 981457253,\n      \"provisioning_template_name\": \"MyScript\",\n      \"template_kind_id\": 478250810,\n      \"template_kind_name\": \"script\",\n      \"operatingsystem_id\": 1073012828,\n      \"operatingsystem_name\": \"RHEL 6.1\"\n    },\n    {\n      \"id\": 281110143,\n      \"provisioning_template_id\": 1007981701,\n      \"provisioning_template_name\": \"centos5_3_pxelinux\",\n      \"template_kind_id\": 710512633,\n      \"template_kind_name\": null,\n      \"operatingsystem_id\": 1073012828,\n      \"operatingsystem_name\": \"RHEL 6.1\"\n    },\n    {\n      \"id\": 1018350795,\n      \"provisioning_template_id\": 131565194,\n      \"provisioning_template_name\": \"PXEGrub Dummy Menu\",\n      \"template_kind_id\": 131565194,\n      \"template_kind_name\": \"PXEGrub\",\n      \"operatingsystem_id\": 1073012828,\n      \"operatingsystem_name\": \"RHEL 6.1\"\n    },\n    {\n      \"id\": 51848956,\n      \"provisioning_template_id\": 698706415,\n      \"provisioning_template_name\": \"iPXE Dummy Menu\",\n      \"template_kind_id\": 698706415,\n      \"template_kind_name\": \"iPXE\",\n      \"operatingsystem_id\": 1073012828,\n      \"operatingsystem_name\": \"RHEL 6.1\"\n    },\n    {\n      \"id\": 457008489,\n      \"provisioning_template_id\": 508279162,\n      \"provisioning_template_name\": \"Linux host initial configuration\",\n      \"template_kind_id\": 508279162,\n      \"template_kind_name\": \"host_init_config\",\n      \"operatingsystem_id\": 1073012828,\n      \"operatingsystem_name\": \"RHEL 6.1\"\n    }\n  ]\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["GET /api/operatingsystems/1073012828-RHEL%206-1/os_default_templates/980190962\n200\n{\n  \"id\": 980190962,\n  \"provisioning_template_id\": 943779058,\n  \"provisioning_template_name\": \"MyString\",\n  \"template_kind_id\": 698706415,\n  \"template_kind_name\": \"iPXE\",\n  \"operatingsystem_id\": 1073012828,\n  \"operatingsystem_name\": \"RHEL 6.1\"\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"os_default_template","full_name":"os_default_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"template_kind_id","full_name":"os_default_template[template_kind_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_id","full_name":"os_default_template[provisioning_template_id]","description":"\n\u003cp\u003eID of provisioning template\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":["POST /api/operatingsystems/1073012828-RHEL%206-1/os_default_templates\n{\n  \"os_default_template\": {\n    \"provisioning_template_id\": 943779058,\n    \"template_kind_id\": 698706415\n  }\n}\n201\n{\n  \"id\": 1018350801,\n  \"provisioning_template_id\": 943779058,\n  \"provisioning_template_name\": \"MyString\",\n  \"template_kind_id\": 698706415,\n  \"template_kind_name\": \"iPXE\",\n  \"operatingsystem_id\": 1073012828,\n  \"operatingsystem_name\": \"RHEL 6.1\"\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"os_default_template","full_name":"os_default_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"template_kind_id","full_name":"os_default_template[template_kind_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_id","full_name":"os_default_template[provisioning_template_id]","description":"\n\u003cp\u003eID of provisioning template\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":["PUT /api/operatingsystems/1073012828-RHEL%206-1/os_default_templates/980190962\n{\n  \"os_default_template\": {\n    \"provisioning_template_id\": 821548108,\n    \"template_kind_id\": 452984334\n  }\n}\n200\n{\n  \"id\": 980190962,\n  \"provisioning_template_id\": 821548108,\n  \"provisioning_template_name\": \"PXELinux default local boot\",\n  \"template_kind_id\": 452984334,\n  \"template_kind_name\": \"PXELinux\",\n  \"operatingsystem_id\": 1073012828,\n  \"operatingsystem_name\": \"RHEL 6.1\"\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["DELETE /api/operatingsystems/1073012828-RHEL%206-1/os_default_templates/980190962\n{\n  \"os_default_template\": {}\n}\n200\n{\n  \"id\": 980190962,\n  \"provisioning_template_id\": 943779058,\n  \"template_kind_id\": 698706415,\n  \"operatingsystem_id\": 1073012828,\n  \"created_at\": \"2021-05-18T11:55:49.710Z\",\n  \"updated_at\": \"2021-05-18T11:55:49.710Z\"\n}"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"parameters":{"doc_url":"../apidoc/v2/parameters","id":"parameters","api_url":"/api","name":"Parameters","short_description":null,"full_description":"\n\u003cp\u003eThese API calls are related to \u003cb\u003enested parameters for a host, domain, subnet, host group, operating system\u003c/b\u003e. If you are looking for \u003ca href='common_parameters.html'\u003eglobal parameters\u003c/a\u003e, go to \u003ca href='common_parameters.html'\u003ethis link\u003c/a\u003e.\u003c/p\u003e\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},{"api_url":"/api/subnets/:subnet_id/parameters","http_method":"GET","short_description":"List all parameters for a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden","full_name":"show_hidden","description":"\n\u003cp\u003eDisplay hidden values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, ‘all’ to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["GET /api/hosts/host225/parameters\n200\n{\n  \"total\": 2,\n  \"subtotal\": 1,\n  \"page\": 1,\n  \"per_page\": 20,\n  \"search\": \"name = parameter2\",\n  \"sort\": {\n    \"by\": null,\n    \"order\": null\n  },\n  \"results\": [\n    {\n      \"priority\": 70,\n      \"created_at\": \"2021-05-18 11:53:00 UTC\",\n      \"updated_at\": \"2021-05-18 11:53:00 UTC\",\n      \"id\": 767575240,\n      \"name\": \"parameter2\",\n      \"parameter_type\": \"string\",\n      \"value\": \"X\"\n    }\n  ]\n}"],"metadata":{"search":[{"name":"domain_name","type":"string"},{"name":"host_group_name","type":"string"},{"name":"host_name","type":"string"},{"name":"key_type","type":"string"},{"name":"location_name","type":"string"},{"name":"name","type":"string"},{"name":"organization_name","type":"string"},{"name":"os_name","type":"string"},{"name":"parameter_type","type":"string"},{"name":"subnet_name","type":"text"},{"name":"type","type":"string"},{"name":"value","type":"text"}]},"see":[],"headers":[],"show":true},{"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},{"api_url":"/api/subnets/:subnet_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of parameter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden","full_name":"show_hidden","description":"\n\u003cp\u003eDisplay hidden values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"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},{"api_url":"/api/subnets/:subnet_id/parameters","http_method":"POST","short_description":"Create a nested parameter for a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter","full_name":"parameter","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"parameter[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"parameter[value]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"parameter[parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":["POST /api/hosts/host225/parameters\n{\n  \"parameter\": {\n    \"name\": \"parameter2\",\n    \"value\": \"X\"\n  }\n}\n201\n{\n  \"priority\": 70,\n  \"created_at\": \"2021-05-18 11:53:00 UTC\",\n  \"updated_at\": \"2021-05-18 11:53:00 UTC\",\n  \"id\": 767575240,\n  \"name\": \"parameter2\",\n  \"parameter_type\": \"string\",\n  \"value\": \"X\"\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"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},{"api_url":"/api/subnets/:subnet_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of parameter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter","full_name":"parameter","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"parameter[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"parameter[value]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"parameter[parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"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},{"api_url":"/api/subnets/:subnet_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of parameter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"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},{"api_url":"/api/subnets/:subnet_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameters for a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"permissions":{"doc_url":"../apidoc/v2/permissions","id":"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, ‘all’ to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["GET /api/permissions\n200\n{\n  \"total\": 151,\n  \"subtotal\": 151,\n  \"page\": 1,\n  \"per_page\": 20,\n  \"search\": null,\n  \"sort\": {\n    \"by\": null,\n    \"order\": null\n  },\n  \"results\": [\n    {\n      \"name\": \"view_architectures\",\n      \"id\": 350275019,\n      \"resource_type\": \"Architecture\"\n    },\n    {\n      \"name\": \"create_architectures\",\n      \"id\": 912770095,\n      \"resource_type\": \"Architecture\"\n    },\n    {\n      \"name\": \"edit_architectures\",\n      \"id\": 874798611,\n      \"resource_type\": \"Architecture\"\n    },\n    {\n      \"name\": \"destroy_architectures\",\n      \"id\": 586604735,\n      \"resource_type\": \"Architecture\"\n    },\n    {\n      \"name\": \"view_authenticators\",\n      \"id\": 687843582,\n      \"resource_type\": \"AuthSource\"\n    },\n    {\n      \"name\": \"create_authenticators\",\n      \"id\": 956119309,\n      \"resource_type\": \"AuthSource\"\n    },\n    {\n      \"name\": \"edit_authenticators\",\n      \"id\": 395314704,\n      \"resource_type\": \"AuthSource\"\n    },\n    {\n      \"name\": \"destroy_authenticators\",\n      \"id\": 1067518973,\n      \"resource_type\": \"AuthSource\"\n    },\n    {\n      \"name\": \"view_bookmarks\",\n      \"id\": 995886532,\n      \"resource_type\": \"Bookmark\"\n    },\n    {\n      \"name\": \"create_bookmarks\",\n      \"id\": 435712857,\n      \"resource_type\": \"Bookmark\"\n    },\n    {\n      \"name\": \"edit_bookmarks\",\n      \"id\": 978016136,\n      \"resource_type\": \"Bookmark\"\n    },\n    {\n      \"name\": \"destroy_bookmarks\",\n      \"id\": 1027408783,\n      \"resource_type\": \"Bookmark\"\n    },\n    {\n      \"name\": \"view_compute_resources\",\n      \"id\": 524255159,\n      \"resource_type\": \"ComputeResource\"\n    },\n    {\n      \"name\": \"create_compute_resources\",\n      \"id\": 673360498,\n      \"resource_type\": \"ComputeResource\"\n    },\n    {\n      \"name\": \"edit_compute_resources\",\n      \"id\": 385985960,\n      \"resource_type\": \"ComputeResource\"\n    },\n    {\n      \"name\": \"destroy_compute_resources\",\n      \"id\": 382135357,\n      \"resource_type\": \"ComputeResource\"\n    },\n    {\n      \"name\": \"view_compute_profiles\",\n      \"id\": 944771383,\n      \"resource_type\": \"ComputeProfile\"\n    },\n    {\n      \"name\": \"create_compute_profiles\",\n      \"id\": 1035871455,\n      \"resource_type\": \"ComputeProfile\"\n    },\n    {\n      \"name\": \"edit_compute_profiles\",\n      \"id\": 884230802,\n      \"resource_type\": \"ComputeProfile\"\n    },\n    {\n      \"name\": \"destroy_compute_profiles\",\n      \"id\": 932164668,\n      \"resource_type\": \"ComputeProfile\"\n    }\n  ]\n}"],"metadata":{"search":[{"name":"name","type":"string"},{"name":"resource_type","type":"string"}]},"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]}],"returns":[],"examples":["GET /api/permissions/350275019\n200\n{\n  \"name\": \"view_architectures\",\n  \"id\": 350275019,\n  \"resource_type\": \"Architecture\"\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"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":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["GET /api/permissions/resource_types\n200\n{\n  \"total\": 35,\n  \"subtotal\": 35,\n  \"page\": 1,\n  \"per_page\": 20,\n  \"search\": null,\n  \"sort\": {\n    \"by\": null,\n    \"order\": null\n  },\n  \"results\": [\n    {\n      \"name\": \"Architecture\"\n    },\n    {\n      \"name\": \"Audit\"\n    },\n    {\n      \"name\": \"AuthSource\"\n    },\n    {\n      \"name\": \"Bookmark\"\n    },\n    {\n      \"name\": \"CommonParameter\"\n    },\n    {\n      \"name\": \"ComputeProfile\"\n    },\n    {\n      \"name\": \"ComputeResource\"\n    },\n    {\n      \"name\": \"ConfigReport\"\n    },\n    {\n      \"name\": \"Domain\"\n    },\n    {\n      \"name\": \"Environment\"\n    },\n    {\n      \"name\": \"FactValue\"\n    },\n    {\n      \"name\": \"Host\"\n    },\n    {\n      \"name\": \"HostClass\"\n    },\n    {\n      \"name\": \"Hostgroup\"\n    },\n    {\n      \"name\": \"Image\"\n    },\n    {\n      \"name\": \"Location\"\n    },\n    {\n      \"name\": \"Medium\"\n    },\n    {\n      \"name\": \"Model\"\n    },\n    {\n      \"name\": \"Operatingsystem\"\n    },\n    {\n      \"name\": \"Organization\"\n    },\n    {\n      \"name\": \"Parameter\"\n    },\n    {\n      \"name\": \"ProvisioningTemplate\"\n    },\n    {\n      \"name\": \"Ptable\"\n    },\n    {\n      \"name\": \"Puppetclass\"\n    },\n    {\n      \"name\": \"PuppetclassLookupKey\"\n    },\n    {\n      \"name\": \"Realm\"\n    },\n    {\n      \"name\": \"Report\"\n    },\n    {\n      \"name\": \"ReportTemplate\"\n    },\n    {\n      \"name\": \"Role\"\n    },\n    {\n      \"name\": \"Setting\"\n    },\n    {\n      \"name\": \"SmartProxy\"\n    },\n    {\n      \"name\": \"Subnet\"\n    },\n    {\n      \"name\": \"Test::Resource\"\n    },\n    {\n      \"name\": \"User\"\n    },\n    {\n      \"name\": \"Usergroup\"\n    }\n  ]\n}"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"ping":{"doc_url":"../apidoc/v2/ping","id":"ping","api_url":"/api","name":"Ping","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/ping/ping","name":"ping","apis":[{"api_url":"/api/ping","http_method":"GET","short_description":"Shows status of Foreman system and it's subcomponents","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eThis service is available for unauthenticated users\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ping/statuses","name":"statuses","apis":[{"api_url":"/api/statuses","http_method":"GET","short_description":"Shows status and version information of Foreman system and it's subcomponents","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eThis service is only available for authenticated users\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"plugins":{"doc_url":"../apidoc/v2/plugins","id":"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":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"provisioning_templates":{"doc_url":"../apidoc/v2/provisioning_templates","id":"provisioning_templates","api_url":"/api","name":"Provisioning templates","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/provisioning_templates/index","name":"index","apis":[{"api_url":"/api/provisioning_templates","http_method":"GET","short_description":"List provisioning templates","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/provisioning_templates","http_method":"GET","short_description":"List provisioning templates per operating system","deprecated":null},{"api_url":"/api/locations/:location_id/provisioning_templates","http_method":"GET","short_description":"List provisioning templates per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/provisioning_templates","http_method":"GET","short_description":"List provisioning templates per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, ‘all’ to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["GET /api/operatingsystems/centos%205.3/provisioning_templates\n200\n{\n  \"total\": 14,\n  \"subtotal\": 14,\n  \"page\": 1,\n  \"per_page\": 20,\n  \"search\": null,\n  \"sort\": {\n    \"by\": null,\n    \"order\": null\n  },\n  \"results\": [\n    {\n      \"snippet\": false,\n      \"description\": null,\n      \"created_at\": \"2021-05-18 11:50:53 UTC\",\n      \"updated_at\": \"2021-05-18 11:50:53 UTC\",\n      \"id\": 1007981701,\n      \"name\": \"centos5_3_pxelinux\",\n      \"template_kind_id\": 452984334,\n      \"template_kind_name\": \"PXELinux\"\n    },\n    {\n      \"snippet\": false,\n      \"description\": null,\n      \"created_at\": \"2021-05-18 11:50:53 UTC\",\n      \"updated_at\": \"2021-05-18 11:50:53 UTC\",\n      \"id\": 698706415,\n      \"name\": \"iPXE Dummy Menu\",\n      \"template_kind_id\": 698706415,\n      \"template_kind_name\": \"iPXE\"\n    },\n    {\n      \"snippet\": false,\n      \"description\": null,\n      \"created_at\": \"2021-05-18 11:50:53 UTC\",\n      \"updated_at\": \"2021-05-18 11:50:53 UTC\",\n      \"id\": 508279162,\n      \"name\": \"Linux host initial configuration\",\n      \"template_kind_id\": 508279162,\n      \"template_kind_name\": \"host_init_config\"\n    },\n    {\n      \"snippet\": false,\n      \"description\": null,\n      \"created_at\": \"2021-05-18 11:50:53 UTC\",\n      \"updated_at\": \"2021-05-18 11:50:53 UTC\",\n      \"id\": 718456980,\n      \"name\": \"Locked Template\",\n      \"template_kind_id\": 983253650,\n      \"template_kind_name\": \"provision\"\n    },\n    {\n      \"snippet\": false,\n      \"description\": null,\n      \"created_at\": \"2021-05-18 11:50:53 UTC\",\n      \"updated_at\": \"2021-05-18 11:50:53 UTC\",\n      \"id\": 104314179,\n      \"name\": \"MyFinish\",\n      \"template_kind_id\": 550103832,\n      \"template_kind_name\": \"finish\"\n    },\n    {\n      \"snippet\": false,\n      \"description\": null,\n      \"created_at\": \"2021-05-18 11:50:53 UTC\",\n      \"updated_at\": \"2021-05-18 11:50:53 UTC\",\n      \"id\": 981457253,\n      \"name\": \"MyScript\",\n      \"template_kind_id\": 478250810,\n      \"template_kind_name\": \"script\"\n    },\n    {\n      \"snippet\": false,\n      \"description\": null,\n      \"created_at\": \"2021-05-18 11:50:53 UTC\",\n      \"updated_at\": \"2021-05-18 11:50:53 UTC\",\n      \"id\": 943779058,\n      \"name\": \"MyString\",\n      \"template_kind_id\": 698706415,\n      \"template_kind_name\": \"iPXE\"\n    },\n    {\n      \"snippet\": false,\n      \"description\": null,\n      \"created_at\": \"2021-05-18 11:50:53 UTC\",\n      \"updated_at\": \"2021-05-18 11:50:53 UTC\",\n      \"id\": 269958254,\n      \"name\": \"MyString2\",\n      \"template_kind_id\": 983253650,\n      \"template_kind_name\": \"provision\"\n    },\n    {\n      \"snippet\": false,\n      \"description\": null,\n      \"created_at\": \"2021-05-18 11:50:53 UTC\",\n      \"updated_at\": \"2021-05-18 11:50:53 UTC\",\n      \"id\": 684651467,\n      \"name\": \"PXE Default Menu\",\n      \"template_kind_id\": 452984334,\n      \"template_kind_name\": \"PXELinux\"\n    },\n    {\n      \"snippet\": false,\n      \"description\": null,\n      \"created_at\": \"2021-05-18 11:50:53 UTC\",\n      \"updated_at\": \"2021-05-18 11:50:53 UTC\",\n      \"id\": 554905648,\n      \"name\": \"PXEGrub2 global default\",\n      \"template_kind_id\": 701398793,\n      \"template_kind_name\": \"PXEGrub2\"\n    },\n    {\n      \"snippet\": false,\n      \"description\": null,\n      \"created_at\": \"2021-05-18 11:50:53 UTC\",\n      \"updated_at\": \"2021-05-18 11:50:53 UTC\",\n      \"id\": 131565194,\n      \"name\": \"PXEGrub Dummy Menu\",\n      \"template_kind_id\": 131565194,\n      \"template_kind_name\": \"PXEGrub\"\n    },\n    {\n      \"snippet\": false,\n      \"description\": null,\n      \"created_at\": \"2021-05-18 11:50:53 UTC\",\n      \"updated_at\": \"2021-05-18 11:50:53 UTC\",\n      \"id\": 824224502,\n      \"name\": \"PXEGrub global default\",\n      \"template_kind_id\": 131565194,\n      \"template_kind_name\": \"PXEGrub\"\n    },\n    {\n      \"snippet\": false,\n      \"description\": null,\n      \"created_at\": \"2021-05-18 11:50:53 UTC\",\n      \"updated_at\": \"2021-05-18 11:50:53 UTC\",\n      \"id\": 821548108,\n      \"name\": \"PXELinux default local boot\",\n      \"template_kind_id\": 452984334,\n      \"template_kind_name\": \"PXELinux\"\n    },\n    {\n      \"snippet\": false,\n      \"description\": null,\n      \"created_at\": \"2021-05-18 11:50:53 UTC\",\n      \"updated_at\": \"2021-05-18 11:50:53 UTC\",\n      \"id\": 352050261,\n      \"name\": \"PXELinux global default\",\n      \"template_kind_id\": 452984334,\n      \"template_kind_name\": \"PXELinux\"\n    }\n  ]\n}"],"metadata":{"search":[{"name":"default_template","values":["true","false"]},{"name":"hostgroup","type":"string"},{"name":"kind","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"locked","values":["true","false"]},{"name":"name","type":"string"},{"name":"operatingsystem","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"snippet","values":["true","false"]},{"name":"template","type":"text"},{"name":"vendor","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/show","name":"show","apis":[{"api_url":"/api/provisioning_templates/:id","http_method":"GET","short_description":"Show provisioning template details","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]}],"returns":[],"examples":["GET /api/provisioning_templates/1007981701-centos5_3_pxelinux\n200\n{\n  \"template\": \"default linux~label linux~kernel \u003c%= @kernel %\u003e~append initrd=\u003c%= @initrd %\u003e ks=\u003c%= foreman_url(\\\"kickstart\\\")%\u003e ksdevice=bootif network kssendmac\",\n  \"locked\": false,\n  \"snippet\": false,\n  \"description\": null,\n  \"created_at\": \"2021-05-18 11:50:53 UTC\",\n  \"updated_at\": \"2021-05-18 11:50:53 UTC\",\n  \"id\": 1007981701,\n  \"name\": \"centos5_3_pxelinux\",\n  \"template_kind_id\": 452984334,\n  \"template_kind_name\": \"PXELinux\",\n  \"template_combinations\": [],\n  \"operatingsystems\": [\n    {\n      \"id\": 309172073,\n      \"name\": \"centos\",\n      \"title\": \"centos 5.3\"\n    },\n    {\n      \"id\": 1073012828,\n      \"name\": \"Redhat\",\n      \"title\": \"RHEL 6.1\"\n    },\n    {\n      \"id\": 331303656,\n      \"name\": \"Ubuntu\",\n      \"title\": \"Ubuntu 10.10\"\n    }\n  ],\n  \"os_default_templates\": [\n    {\n      \"id\": 281110143,\n      \"provisioning_template_id\": 1007981701,\n      \"provisioning_template_name\": \"centos5_3_pxelinux\",\n      \"template_kind_id\": 710512633,\n      \"template_kind_name\": null,\n      \"operatingsystem_id\": 1073012828,\n      \"operatingsystem_name\": \"RHEL 6.1\"\n    },\n    {\n      \"id\": 638205575,\n      \"provisioning_template_id\": 1007981701,\n      \"provisioning_template_name\": \"centos5_3_pxelinux\",\n      \"template_kind_id\": 710512633,\n      \"template_kind_name\": null,\n      \"operatingsystem_id\": 331303656,\n      \"operatingsystem_name\": \"Ubuntu 10.10\"\n    }\n  ],\n  \"locations\": [],\n  \"organizations\": []\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/create","name":"create","apis":[{"api_url":"/api/provisioning_templates","http_method":"POST","short_description":"Create a provisioning template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template","full_name":"provisioning_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"provisioning_template[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"provisioning_template[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"provisioning_template[template]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"snippet","full_name":"provisioning_template[snippet]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"audit_comment","full_name":"provisioning_template[audit_comment]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template_kind_id","full_name":"provisioning_template[template_kind_id]","description":"\n\u003cp\u003enot relevant for snippet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_combinations_attributes","full_name":"provisioning_template[template_combinations_attributes]","description":"\n\u003cp\u003eArray of template combinations (hostgroup_id, environment_id)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_ids","full_name":"provisioning_template[operatingsystem_ids]","description":"\n\u003cp\u003eArray of operating system IDs to associate with the template\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"locked","full_name":"provisioning_template[locked]","description":"\n\u003cp\u003eWhether or not the template is locked for editing\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"provisioning_template[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"provisioning_template[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":["POST /api/provisioning_templates\n{\n  \"provisioning_template\": {\n    \"template\": \"This is a test template\",\n    \"template_kind_name\": \"PXEGrub\",\n    \"name\": \"new_template\"\n  }\n}\n201\n{\n  \"template\": \"This is a test template\",\n  \"locked\": false,\n  \"snippet\": false,\n  \"description\": null,\n  \"created_at\": \"2021-05-18 11:51:35 UTC\",\n  \"updated_at\": \"2021-05-18 11:51:35 UTC\",\n  \"id\": 1007981726,\n  \"name\": \"new_template\",\n  \"template_kind_id\": 131565194,\n  \"template_kind_name\": \"PXEGrub\",\n  \"template_combinations\": [],\n  \"operatingsystems\": [],\n  \"os_default_templates\": [],\n  \"locations\": [],\n  \"organizations\": []\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/import","name":"import","apis":[{"api_url":"/api/provisioning_templates/import","http_method":"POST","short_description":"Import a provisioning template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template","full_name":"provisioning_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"provisioning_template[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"provisioning_template[template]","description":"\n\u003cp\u003etemplate contents including metadata\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"provisioning_template[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"provisioning_template[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"options","full_name":"options","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"force","full_name":"options[force]","description":"\n\u003cp\u003euse if you want update locked templates\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"associate","full_name":"options[associate]","description":"\n\u003cp\u003edetermines when the template should associate objects based on metadata, new means only when new template is being created, always means both for new and existing template which is only being updated, never ignores metadata\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003enew\u003c/code\u003e, \u003ccode\u003ealways\u003c/code\u003e, \u003ccode\u003enever\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"lock","full_name":"options[lock]","description":"\n\u003cp\u003elock imported templates (false by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"default","full_name":"options[default]","description":"\n\u003cp\u003emakes the template default meaning it will be automatically associated with newly created organizations and locations (false by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":["POST /api/provisioning_templates/import\n{\n  \"provisioning_template\": {\n    \"name\": \"provisioning_template45\",\n    \"template\": \"\u003c%#\\nsnippet: true\\n-%\u003e\\nbbbb\"\n  }\n}\n201\n{\n  \"template\": \"\u003c%#\\nsnippet: true\\n-%\u003e\\nbbbb\",\n  \"name\": \"provisioning_template45\",\n  \"id\": 1007981730,\n  \"snippet\": true,\n  \"description\": null,\n  \"template_kind_id\": null,\n  \"created_at\": \"2021-05-18T11:51:36.242Z\",\n  \"updated_at\": \"2021-05-18T11:51:36.292Z\",\n  \"locked\": false,\n  \"default\": false,\n  \"vendor\": null,\n  \"os_family\": null,\n  \"job_category\": \"Miscellaneous\",\n  \"provider_type\": null,\n  \"description_format\": null,\n  \"execution_timeout_interval\": null\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/update","name":"update","apis":[{"api_url":"/api/provisioning_templates/:id","http_method":"PUT","short_description":"Update a provisioning template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]},{"name":"provisioning_template","full_name":"provisioning_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"provisioning_template[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"provisioning_template[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"provisioning_template[template]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"snippet","full_name":"provisioning_template[snippet]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"audit_comment","full_name":"provisioning_template[audit_comment]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template_kind_id","full_name":"provisioning_template[template_kind_id]","description":"\n\u003cp\u003enot relevant for snippet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_combinations_attributes","full_name":"provisioning_template[template_combinations_attributes]","description":"\n\u003cp\u003eArray of template combinations (hostgroup_id, environment_id)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_ids","full_name":"provisioning_template[operatingsystem_ids]","description":"\n\u003cp\u003eArray of operating system IDs to associate with the template\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"locked","full_name":"provisioning_template[locked]","description":"\n\u003cp\u003eWhether or not the template is locked for editing\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"provisioning_template[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"provisioning_template[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":["PUT /api/provisioning_templates/1007981701-centos5_3_pxelinux\n{\n  \"provisioning_template\": {\n    \"template\": \"blah\"\n  }\n}\n200\n{\n  \"template\": \"blah\",\n  \"locked\": false,\n  \"snippet\": false,\n  \"description\": null,\n  \"created_at\": \"2021-05-18 11:50:53 UTC\",\n  \"updated_at\": \"2021-05-18 11:51:34 UTC\",\n  \"id\": 1007981701,\n  \"name\": \"centos5_3_pxelinux\",\n  \"template_kind_id\": 452984334,\n  \"template_kind_name\": \"PXELinux\",\n  \"template_combinations\": [],\n  \"operatingsystems\": [\n    {\n      \"id\": 309172073,\n      \"name\": \"centos\",\n      \"title\": \"centos 5.3\"\n    },\n    {\n      \"id\": 1073012828,\n      \"name\": \"Redhat\",\n      \"title\": \"RHEL 6.1\"\n    },\n    {\n      \"id\": 331303656,\n      \"name\": \"Ubuntu\",\n      \"title\": \"Ubuntu 10.10\"\n    }\n  ],\n  \"os_default_templates\": [\n    {\n      \"id\": 281110143,\n      \"provisioning_template_id\": 1007981701,\n      \"provisioning_template_name\": \"centos5_3_pxelinux\",\n      \"template_kind_id\": 710512633,\n      \"template_kind_name\": null,\n      \"operatingsystem_id\": 1073012828,\n      \"operatingsystem_name\": \"RHEL 6.1\"\n    },\n    {\n      \"id\": 638205575,\n      \"provisioning_template_id\": 1007981701,\n      \"provisioning_template_name\": \"centos5_3_pxelinux\",\n      \"template_kind_id\": 710512633,\n      \"template_kind_name\": null,\n      \"operatingsystem_id\": 331303656,\n      \"operatingsystem_name\": \"Ubuntu 10.10\"\n    }\n  ],\n  \"locations\": [],\n  \"organizations\": []\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/revision","name":"revision","apis":[{"api_url":"/api/provisioning_templates/revision","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"version","full_name":"version","description":"\n\u003cp\u003etemplate version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/destroy","name":"destroy","apis":[{"api_url":"/api/provisioning_templates/:id","http_method":"DELETE","short_description":"Delete a provisioning template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]}],"returns":[],"examples":["DELETE /api/provisioning_templates/1007981701-centos5_3_pxelinux\n{\n  \"provisioning_template\": {}\n}\n200\n{\n  \"id\": 1007981701,\n  \"name\": \"centos5_3_pxelinux\",\n  \"template\": \"default linux~label linux~kernel \u003c%= @kernel %\u003e~append initrd=\u003c%= @initrd %\u003e ks=\u003c%= foreman_url(\\\"kickstart\\\")%\u003e ksdevice=bootif network kssendmac\",\n  \"snippet\": false,\n  \"template_kind_id\": 452984334,\n  \"created_at\": \"2021-05-18T11:50:53.779Z\",\n  \"updated_at\": \"2021-05-18T11:50:53.779Z\",\n  \"locked\": false,\n  \"default\": false,\n  \"vendor\": null,\n  \"os_family\": null,\n  \"job_category\": \"Miscellaneous\",\n  \"provider_type\": null,\n  \"description_format\": null,\n  \"execution_timeout_interval\": null,\n  \"description\": null\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/build_pxe_default","name":"build_pxe_default","apis":[{"api_url":"/api/provisioning_templates/build_pxe_default","http_method":"POST","short_description":"Update the default PXE menu on all configured TFTP servers","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["POST /api/provisioning_templates/build_pxe_default\n{\n  \"provisioning_template\": {}\n}\n200\n{\n  \"message\": \"PXE files for templates PXEGrub2 global default, PXELinux global default, and PXEGrub global default have been deployed to all Smart Proxies\"\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/clone","name":"clone","apis":[{"api_url":"/api/provisioning_templates/:id/clone","http_method":"POST","short_description":"Clone a provision template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]},{"name":"provisioning_template","full_name":"provisioning_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"provisioning_template[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":["POST /api/provisioning_templates/1007981701-centos5_3_pxelinux/clone\n{\n  \"provisioning_template\": {\n    \"name\": \"\"\n  }\n}\n422\n{\n  \"error\": {\n    \"id\": null,\n    \"errors\": {\n      \"name\": [\n        \"can't be blank\"\n      ],\n      \"operatingsystems\": [\n        \"is invalid\"\n      ]\n    },\n    \"full_messages\": [\n      \"Name can't be blank\",\n      \"Operatingsystems is invalid\"\n    ]\n  }\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/export","name":"export","apis":[{"api_url":"/api/provisioning_templates/:id/export","http_method":"GET","short_description":"Export a provisioning template to ERB","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]}],"returns":[],"examples":["GET /api/provisioning_templates/1007981701-centos5_3_pxelinux/export\n200\n\u003c%#\nname: centos5_3_pxelinux\nsnippet: false\nmodel: ProvisioningTemplate\nkind: PXELinux\noses:\n- centos\n- Redhat\n- Ubuntu\n-%\u003e\ndefault linux~label linux~kernel \u003c%= @kernel %\u003e~append initrd=\u003c%= @initrd %\u003e ks=\u003c%= foreman_url(\"kickstart\")%\u003e ksdevice=bootif network kssendmac"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"ptables":{"doc_url":"../apidoc/v2/ptables","id":"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},{"api_url":"/api/operatingsystems/:operatingsystem_id/ptables","http_method":"GET","short_description":"List all partition tables for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/ptables","http_method":"GET","short_description":"List all partition tables per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/ptables","http_method":"GET","short_description":"List all partition tables per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, ‘all’ to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"default","values":["true","false"]},{"name":"family","type":"string"},{"name":"layout","type":"text"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"locked","values":["true","false"]},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"snippet","values":["true","false"]},{"name":"template","type":"text"},{"name":"vendor","type":"string"}]},"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ptable","full_name":"ptable","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"ptable[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"ptable[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"layout","full_name":"ptable[layout]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"snippet","full_name":"ptable[snippet]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"audit_comment","full_name":"ptable[audit_comment]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"locked","full_name":"ptable[locked]","description":"\n\u003cp\u003eWhether or not the template is locked for editing\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"os_family","full_name":"ptable[os_family]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_ids","full_name":"ptable[operatingsystem_ids]","description":"\n\u003cp\u003eArray of operating system IDs to associate with the partition table\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"host_ids","full_name":"ptable[host_ids]","description":"\n\u003cp\u003eArray of host IDs to associate with the partition table\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_ids","full_name":"ptable[hostgroup_ids]","description":"\n\u003cp\u003eArray of host group IDs to associate with the partition table\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"ptable[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"ptable[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ptables/import","name":"import","apis":[{"api_url":"/api/ptables/import","http_method":"POST","short_description":"Import a provisioning template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ptable","full_name":"ptable","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"ptable[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"ptable[template]","description":"\n\u003cp\u003etemplate contents including metadata\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"ptable[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"ptable[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"options","full_name":"options","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"force","full_name":"options[force]","description":"\n\u003cp\u003euse if you want update locked templates\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"associate","full_name":"options[associate]","description":"\n\u003cp\u003edetermines when the template should associate objects based on metadata, new means only when new template is being created, always means both for new and existing template which is only being updated, never ignores metadata\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003enew\u003c/code\u003e, \u003ccode\u003ealways\u003c/code\u003e, \u003ccode\u003enever\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"lock","full_name":"options[lock]","description":"\n\u003cp\u003elock imported templates (false by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"default","full_name":"options[default]","description":"\n\u003cp\u003emakes the template default meaning it will be automatically associated with newly created organizations and locations (false by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ptables/revision","name":"revision","apis":[{"api_url":"/api/ptables/revision","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"version","full_name":"version","description":"\n\u003cp\u003etemplate version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ptable","full_name":"ptable","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"ptable[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"ptable[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"layout","full_name":"ptable[layout]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"snippet","full_name":"ptable[snippet]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"audit_comment","full_name":"ptable[audit_comment]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"locked","full_name":"ptable[locked]","description":"\n\u003cp\u003eWhether or not the template is locked for editing\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"os_family","full_name":"ptable[os_family]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_ids","full_name":"ptable[operatingsystem_ids]","description":"\n\u003cp\u003eArray of operating system IDs to associate with the partition table\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"host_ids","full_name":"ptable[host_ids]","description":"\n\u003cp\u003eArray of host IDs to associate with the partition table\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_ids","full_name":"ptable[hostgroup_ids]","description":"\n\u003cp\u003eArray of host group IDs to associate with the partition table\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"ptable[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"ptable[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ptables/clone","name":"clone","apis":[{"api_url":"/api/ptables/:id/clone","http_method":"POST","short_description":"Clone a template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]},{"name":"ptable","full_name":"ptable","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"ptable[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ptables/export","name":"export","apis":[{"api_url":"/api/ptables/:id/export","http_method":"GET","short_description":"Export a partition template to ERB","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"realms":{"doc_url":"../apidoc/v2/realms","id":"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\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, ‘all’ to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"type","type":"string"}]},"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eNumerical ID or realm name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":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,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"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\u003cp\u003eThe \u003cb\u003ename\u003c/b\u003e field is used for the name of the realm.\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"realm","full_name":"realm","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"realm[name]","description":"\n\u003cp\u003eThe realm name, e.g. EXAMPLE.COM\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"realm_proxy_id","full_name":"realm[realm_proxy_id]","description":"\n\u003cp\u003eProxy ID to use within this realm\u003c/p\u003e\n","required":true,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"realm_type","full_name":"realm[realm_type]","description":"\n\u003cp\u003eRealm type, e.g. FreeIPA or Active Directory\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"realm[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"realm[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]},{"name":"realm","full_name":"realm","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"realm[name]","description":"\n\u003cp\u003eThe realm name, e.g. EXAMPLE.COM\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"realm_proxy_id","full_name":"realm[realm_proxy_id]","description":"\n\u003cp\u003eProxy ID to use within this realm\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"realm_type","full_name":"realm[realm_type]","description":"\n\u003cp\u003eRealm type, e.g. FreeIPA or Active Directory\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"realm[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"realm[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"report_templates":{"doc_url":"../apidoc/v2/report_templates","id":"report_templates","api_url":"/api","name":"Report templates","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/report_templates/index","name":"index","apis":[{"api_url":"/api/report_templates","http_method":"GET","short_description":"List all report templates","deprecated":null},{"api_url":"/api/locations/:location_id/report_templates","http_method":"GET","short_description":"List all report templates per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/report_templates","http_method":"GET","short_description":"List all report templates per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, ‘all’ to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["GET /api/report_templates\n200\n{\n  \"total\": 1,\n  \"subtotal\": 1,\n  \"page\": 1,\n  \"per_page\": 20,\n  \"search\": \"report_template27\",\n  \"sort\": {\n    \"by\": null,\n    \"order\": null\n  },\n  \"results\": [\n    {\n      \"description\": null,\n      \"created_at\": \"2021-05-18 11:53:42 UTC\",\n      \"updated_at\": \"2021-05-18 11:53:42 UTC\",\n      \"name\": \"report_template27\",\n      \"id\": 1007981715\n    }\n  ]\n}"],"metadata":{"search":[{"name":"default","values":["true","false"]},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"locked","values":["true","false"]},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"snippet","values":["true","false"]},{"name":"template","type":"text"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/show","name":"show","apis":[{"api_url":"/api/report_templates/:id","http_method":"GET","short_description":"Show a report template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]}],"returns":[],"examples":["GET /api/report_templates/1007981709-report_template22\n200\n{\n  \"template\": \"template content 21\",\n  \"default\": false,\n  \"snippet\": false,\n  \"locked\": false,\n  \"description\": null,\n  \"created_at\": \"2021-05-18 11:53:41 UTC\",\n  \"updated_at\": \"2021-05-18 11:53:41 UTC\",\n  \"name\": \"report_template22\",\n  \"id\": 1007981709,\n  \"locations\": [],\n  \"organizations\": []\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/create","name":"create","apis":[{"api_url":"/api/report_templates","http_method":"POST","short_description":"Create a report template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"report_template","full_name":"report_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"report_template[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"report_template[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"report_template[template]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"snippet","full_name":"report_template[snippet]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"audit_comment","full_name":"report_template[audit_comment]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"locked","full_name":"report_template[locked]","description":"\n\u003cp\u003eWhether or not the template is locked for editing\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"default","full_name":"report_template[default]","description":"\n\u003cp\u003eWhether or not the template is added automatically to new organizations and locations\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"report_template[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"report_template[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":["POST /api/report_templates\n{\n  \"report_template\": {\n    \"name\": \"report_template_test\",\n    \"template\": \"WMbXpygdIDqUOIKBNKTNEaDVXJTOesMKxqkIzDIEATcWivkwvFBUKotetVVQvomusIXGqKFCtTjWsxGOWAaYNduCJVYXtCUBeIBswcEwiISeFbtaeSGaRaCdSvaWgqpvymQhYDqUdvXNPpLDobRjklLwXAbqllvWcumoXXEzKavHOoKNWmVEqEnAdlVsrujQFWbMFButeTPoHNAbpbGhSpExYHxQXPvjqLPldxqocPxuzXvKneFdWeyKlNGOpkcGdTcCIXqDLKrCFQtVqxKaxznTBKpfdjIWNaiiaOXQJtmPqHeseOsbolBNfjwPMDeKOnjXJuNHztwUvMivdpVncJYNmMFaiFwaHsggQlDclQblfcpvdxECVowwTpMJnerfkqipTppOSbIrvTWanEMuOyayWivjgnDibkOqObqkJhTclnCNrKiiPBlwiTjmMtYVCLFGTrsmLGyNDzkSfOQLKrsqnIumvcxUPzKgyVvYedDQlyrgmEOYfcamXPqqqTWkSQTpJqXfdxvrFJRVTIREOlqvsMtzmLcVpmkCnJRnERRjQHcYHTyopDxETOKPyXJVUpPXSNvdOeltwTBwOaVWYMnwlbTxiBXqWxkRTbgpTpztVWIJaWeFIfKTjaRRXxRywvxqDkfPQUbmjttklrMIhpBDKoRnTTAUSyiPGRPyQzUpYuuGNRWNLvpAjiFOjAudIsEUxaGtDLBNIcIsSYtjgoOEpfIwOzlWwAnETkVzCBRndYKrvqmixYbwUBsrsBVNQCfngEcMSwrSInVHEfoPvrDleojSCXvmIzsUxpqhRprWvjhuEdUQIIBUsNdsTomwBahnpqlFoQWeTznJXRquyRYOWbextEqPLtJFvxsbAmuLkbDbIWsBDUAiEXNpELbKUJOzhDapMVijdLJPMyHvlVEHxHYNwzGXYMWFqLDonpevRQQRlnHQPAMWTVoPfeSWbiOOjUigydkPFhStpAcLoCRsBhURhUCdGmkeTprgevgItBuvsTycrQjfjYcePhcXnPlzRyengGxQiRctVpqrXGvVrAnHXkiEVevsDxptzafsDrzaPUAxQFSXcYrlfhraAVtDMIDKTRgSrpktKoFmkhMjSmkUTgcyUdwRJVFPlIAkHOvNIOsOxyUyQNdfpXIGjpBFtRhfrCieWKUHDIUPejxxCdeEgfHlnsrXjNWkNjHkNgkNVjHCLEEwGkYfCQcCzKfXIGfcrvFqMGCVoPDyxyCorBAMVBJYLGFLidpEWBeHJosFELiqMfeGMuYQRbmpIjSqaeOajsXEHzrjXmPDyMzyiekMaFPLuFfVeAXeQtatlbAyWMaqfOtnbXRltRwmVsWQJPSaixJVSxyFzpcNCYVueFEVUemewScosxTPXxNCuJXWtzvNwxOheMOpdFuzWnPLdsBmcsTdRPFYCKsoQSouUJojvBBjEFLOCkYfPoooKnjkQBausLSyNHHKsSLbdgnkgcQmDfYTmbqkdTckdNuDYluAdIWjwvVIsPsSMosKAYarmoYsODHMTKkeModTCCqlIuVkyDEqWLBnGCcKmXjNnwzWANlBGCuiJriJQiGElwfPraFHzWWEwwwAJyNlRUnariOLYFuNPMtQWAsadexvjLiRKnnfiHAeJyzbssMvmOBuCHRfVvOzKxaFFOfbRBHovhkMFdQOvBVAkvUnmSJohduTNWSXNaGsQWfljOcpqhPfGhyWUstGalwRnixpDidNvqGtJGWfUfivFRyRuwoqKKDgVjaUxBPkueCilhbpOdLBqnBkwqSPQOypgbiBrIBiArrHlqfheyUuhqBhpgdEHkKsbwkkTtxQHfHTDmcWVaNThGVBkHJqyPmAmJjDKNSnTHoeSyhtMzDwkObbSWYDVlpSDEhFchivSuDFvQEfEJJhNSORrWINBGMdDBBTKVVvRkUpGKPHruhwaYqMRgwjTQsNfVDfqvnfibFwUzaApmYsEUUylqoqFySrbiyYSCzrLcKBrCvQrsTcybeHcEfGgOBXsQtXkzybBLLvSpDWVpqGaAfSeBYJUjdbkUomdirDAtxLTxwcYpmsgDQKMiRedGFAniApWjhKRUxebDkhEAbCCcTHsHzMipbNDNLvgEMDOsDmbVJYkKcjjvqiFHuppGopNnnsBknkUQFEFUbQRBHDkmaLkfzMBRrAYnthYurCDoxGriMhCXzCconShUFzNOzsVjGtMzfRXOuvNeFVQikmXTNGgrTxgkIMYQkFGMLBQpRHkCkJnazbKrIQmUWkemdWetLqPMvYfKsCyUwXwMqoGvpklSVPtQjnCCQIgdQWzdOGRIYxCxsGWePxHrhIijIWtSLMLDxRdfPQEJeGqucjJiFHDhipVpgoWvSQstBKwtdDYDtKolyGRKKcIOOejbwzedyqNfoTezDPuixzvphtsJWXGpVRJFfhQEdjRFxzSIVUnYnWBXAXoNLpUhpyQvoMzNRdKzcTfExNMbcxIsqffKhYtVVuVwfPpIiLTklDhJamTOutvGEVGRjGATTXciHhGWpkFtauqRsbpByTtAzpUWhgUIVNNnoKRFLPncUEAnpzIVhGvwDYJEaYVxlyvfEGimhxkhPsBoqqDTQCJMiQBgTpeqjIltvItAlsVKTpNuSwzEqMsJktaiNBfRJwKILkjlzuqbMvwvHrmXEDPByuktHHLRHUhjhVhpgjUUaXoGWmgmBrfbQNBmunYmWJGTDGhetFzoAQfrnCjsHvxTBKxqDpvutnFNwbdTnGHeqtCmeKfdRcasbBHLvgalWaSAuKKVlPiORyilyTfovmwsSfsroQCOVMcbytugrlvwDltjkBRLiSbaBvHFLtaEdvhCKiADBeWfrUeMbDmGdXNbxoRCLPMHqfWNJBnppLVvDgAuDvffXBjcxtgObtRmrHcaKmHOKhefRsjWHebcTOBVAuxOUEamAJGuzlqFtEyUOoBUEboYrstcoVyhVpRgxbAbMqdLcVLkYGlrQITVuIjQXASXVcJgzdDcDqIsFwOpgFKcXkSjyARnDXTykiRWfKLztKJOuqHCzqmImziXnMEXyUrWdOLJAMfRJfEpIaViJacGxVQfcooalXlbRwmVJVqKHAKYlfPVxvJHAuIcICbhFpSGdtmXQLQEkMgVGHrYKdlvJeaxbrNAChDGJJwtlqUfUDvmuUJjGPRsDvOvbmLqWAYJwIJAKFwjIXuaipEIWybJrTLTGPnKWiJWQwRDogwrduhwfiGSrvshoCkEFVBuNFiHXbCckmHWRuxBYBRTpcMoHjdfVGdNjvqalpFDJGGlPtpVAhUiaoJHKyDiWRXJczWEEuspvqLLCPmzfhwSjlCLYoPmOSuWmTYoPLNknGGRdvSiHQdOuVUdkpGspjQGcernCWPUzRXhRfxaTKEFQYDVLkrwctbWXmHtecIWplIylgpHtWbXzctXmeLGyWgODRpCiSkBXUFGoTdsaSDqyNNsTGQcOIiiAMCgSeugJzqPuNKqWoJmeRvkKqjnIKHwNWXEqSReVOiWLLWqRzonARTzufKPVaCwtiJJzznuQIevciCletyOpNMTfdBBFedwuRrMKkVRQImzmyUoynoRvBcnDkjzwkOsJMxyUQTzrYhleRDhurxGtrAqWjwCOmJXzDAFBEtRVLqwcXJlxrlMcUnbwyRKOXvTBhLuhPJktKwNABeMJJEfozJFhLxnMOrBlYCMDEkjEuHupXrmsCEvekeKPpzoWCFAsewnBDbQzfTeaIStuRzrTIgHyMDgeqyinIebBviIonSfDNoCOWTsxYVUygrQJLLGLBANkvYgckOXMFGnQNGoIeShgfbGUbLeyQHXXqOmAaKSilSVJCcGtgTWisuGSKtoQmmtAdEXUkCuhNsryXcjQvmEXnLMKbtiOugStVzgJuxSRaBdsIYLFtGaJFDiSHkGsuOARemosLvMGimfmHtuuAcROXNVfYWDDmEhXpBQYcBuIpDaqIYGGdNbayxfSEwoXvIUhflfrroqhdcgCsGSXHTcYVwMpgXqqWghNsdBaODjOrAKHkvdpLFGWeaixAAqJVqKyUtDcuKMHMavRvqDvVxhsTmUAuBfIQWDnXPGqIgOaaOSGbcUzVeDimjOEVGIlRMnNjapkTwaqNJwMQPfbTfvruVYLmgYWzeYlDhSJEbEerrMpSgGnCWezxMhziyYYzKvxjRcVpzbpXvVTVGwzTcIMMWFyiaEocpvozVEMreCOvGjhfIhBKhGIxiazcUDUkWfdOtKfCNSOLRgAKkdukOjjtSdlHKWljlYaCAypySpNcUFMsfWErGSgvcEMEHtGFJyxTzAOMTwfqAqxuzmFsbhgpyBtCuOaeHISjFlImJgQjPWKjVpPGhxIEDmweXqLWhWlpUMdkMFvCwScKXbYxdKscBOzBhAhcVazOwbOBPbGDtJqoEFBRBvQIGlgnBYFvhJktEIpdMjnBFxOqiFDuUYGMGpapTuWdnlTIvQWXRXmszuttdVzXWExrcIKDyYDiRBRXihmtdgAyseYdayWKnSlnuHgFYaRzRkwxxRYBEmJDxxVnSAXvvDhwdaNyXCpvDtdGRKOLXWSLcjbikiMrDvKQzTKpnqqbMaYDdNJHTWmaxybORRWnfdnGApHKhAAgHeuqYCPUfcExRBDqtayQfvihnMWSrQotEKkSQppjkbLgLUNrlEUVpywPGJKSKuxszmxINqhKzsCdHkCPjpYHbGqrOitTcKbUxxHDDlRqIzCPCEQNepWJgCdOgBiWMRtWGUNHAiIavoaEEWilrDShCQAGgGDIXgAhBmydQBOgaaBcJgSNLQmGkUGTdAkaDGDxaniyVveYqKdQYRLJaxrwCiUrljTIMfKnHmKpCEirlgucLXkegpxCHuYTxaiUyIsJItNAjSmEjelILbXPqIXhfOMVaYCuouYVAVEgAppnQrVxWvWBFvJrslnMfggjcRYsGugumKMQYfzYKJBtnCQTHDPKmxNiduIKhijirbfEtyFXifvOLPlfoUeR\"\n  }\n}\n201\n{\n  \"template\": \"WMbXpygdIDqUOIKBNKTNEaDVXJTOesMKxqkIzDIEATcWivkwvFBUKotetVVQvomusIXGqKFCtTjWsxGOWAaYNduCJVYXtCUBeIBswcEwiISeFbtaeSGaRaCdSvaWgqpvymQhYDqUdvXNPpLDobRjklLwXAbqllvWcumoXXEzKavHOoKNWmVEqEnAdlVsrujQFWbMFButeTPoHNAbpbGhSpExYHxQXPvjqLPldxqocPxuzXvKneFdWeyKlNGOpkcGdTcCIXqDLKrCFQtVqxKaxznTBKpfdjIWNaiiaOXQJtmPqHeseOsbolBNfjwPMDeKOnjXJuNHztwUvMivdpVncJYNmMFaiFwaHsggQlDclQblfcpvdxECVowwTpMJnerfkqipTppOSbIrvTWanEMuOyayWivjgnDibkOqObqkJhTclnCNrKiiPBlwiTjmMtYVCLFGTrsmLGyNDzkSfOQLKrsqnIumvcxUPzKgyVvYedDQlyrgmEOYfcamXPqqqTWkSQTpJqXfdxvrFJRVTIREOlqvsMtzmLcVpmkCnJRnERRjQHcYHTyopDxETOKPyXJVUpPXSNvdOeltwTBwOaVWYMnwlbTxiBXqWxkRTbgpTpztVWIJaWeFIfKTjaRRXxRywvxqDkfPQUbmjttklrMIhpBDKoRnTTAUSyiPGRPyQzUpYuuGNRWNLvpAjiFOjAudIsEUxaGtDLBNIcIsSYtjgoOEpfIwOzlWwAnETkVzCBRndYKrvqmixYbwUBsrsBVNQCfngEcMSwrSInVHEfoPvrDleojSCXvmIzsUxpqhRprWvjhuEdUQIIBUsNdsTomwBahnpqlFoQWeTznJXRquyRYOWbextEqPLtJFvxsbAmuLkbDbIWsBDUAiEXNpELbKUJOzhDapMVijdLJPMyHvlVEHxHYNwzGXYMWFqLDonpevRQQRlnHQPAMWTVoPfeSWbiOOjUigydkPFhStpAcLoCRsBhURhUCdGmkeTprgevgItBuvsTycrQjfjYcePhcXnPlzRyengGxQiRctVpqrXGvVrAnHXkiEVevsDxptzafsDrzaPUAxQFSXcYrlfhraAVtDMIDKTRgSrpktKoFmkhMjSmkUTgcyUdwRJVFPlIAkHOvNIOsOxyUyQNdfpXIGjpBFtRhfrCieWKUHDIUPejxxCdeEgfHlnsrXjNWkNjHkNgkNVjHCLEEwGkYfCQcCzKfXIGfcrvFqMGCVoPDyxyCorBAMVBJYLGFLidpEWBeHJosFELiqMfeGMuYQRbmpIjSqaeOajsXEHzrjXmPDyMzyiekMaFPLuFfVeAXeQtatlbAyWMaqfOtnbXRltRwmVsWQJPSaixJVSxyFzpcNCYVueFEVUemewScosxTPXxNCuJXWtzvNwxOheMOpdFuzWnPLdsBmcsTdRPFYCKsoQSouUJojvBBjEFLOCkYfPoooKnjkQBausLSyNHHKsSLbdgnkgcQmDfYTmbqkdTckdNuDYluAdIWjwvVIsPsSMosKAYarmoYsODHMTKkeModTCCqlIuVkyDEqWLBnGCcKmXjNnwzWANlBGCuiJriJQiGElwfPraFHzWWEwwwAJyNlRUnariOLYFuNPMtQWAsadexvjLiRKnnfiHAeJyzbssMvmOBuCHRfVvOzKxaFFOfbRBHovhkMFdQOvBVAkvUnmSJohduTNWSXNaGsQWfljOcpqhPfGhyWUstGalwRnixpDidNvqGtJGWfUfivFRyRuwoqKKDgVjaUxBPkueCilhbpOdLBqnBkwqSPQOypgbiBrIBiArrHlqfheyUuhqBhpgdEHkKsbwkkTtxQHfHTDmcWVaNThGVBkHJqyPmAmJjDKNSnTHoeSyhtMzDwkObbSWYDVlpSDEhFchivSuDFvQEfEJJhNSORrWINBGMdDBBTKVVvRkUpGKPHruhwaYqMRgwjTQsNfVDfqvnfibFwUzaApmYsEUUylqoqFySrbiyYSCzrLcKBrCvQrsTcybeHcEfGgOBXsQtXkzybBLLvSpDWVpqGaAfSeBYJUjdbkUomdirDAtxLTxwcYpmsgDQKMiRedGFAniApWjhKRUxebDkhEAbCCcTHsHzMipbNDNLvgEMDOsDmbVJYkKcjjvqiFHuppGopNnnsBknkUQFEFUbQRBHDkmaLkfzMBRrAYnthYurCDoxGriMhCXzCconShUFzNOzsVjGtMzfRXOuvNeFVQikmXTNGgrTxgkIMYQkFGMLBQpRHkCkJnazbKrIQmUWkemdWetLqPMvYfKsCyUwXwMqoGvpklSVPtQjnCCQIgdQWzdOGRIYxCxsGWePxHrhIijIWtSLMLDxRdfPQEJeGqucjJiFHDhipVpgoWvSQstBKwtdDYDtKolyGRKKcIOOejbwzedyqNfoTezDPuixzvphtsJWXGpVRJFfhQEdjRFxzSIVUnYnWBXAXoNLpUhpyQvoMzNRdKzcTfExNMbcxIsqffKhYtVVuVwfPpIiLTklDhJamTOutvGEVGRjGATTXciHhGWpkFtauqRsbpByTtAzpUWhgUIVNNnoKRFLPncUEAnpzIVhGvwDYJEaYVxlyvfEGimhxkhPsBoqqDTQCJMiQBgTpeqjIltvItAlsVKTpNuSwzEqMsJktaiNBfRJwKILkjlzuqbMvwvHrmXEDPByuktHHLRHUhjhVhpgjUUaXoGWmgmBrfbQNBmunYmWJGTDGhetFzoAQfrnCjsHvxTBKxqDpvutnFNwbdTnGHeqtCmeKfdRcasbBHLvgalWaSAuKKVlPiORyilyTfovmwsSfsroQCOVMcbytugrlvwDltjkBRLiSbaBvHFLtaEdvhCKiADBeWfrUeMbDmGdXNbxoRCLPMHqfWNJBnppLVvDgAuDvffXBjcxtgObtRmrHcaKmHOKhefRsjWHebcTOBVAuxOUEamAJGuzlqFtEyUOoBUEboYrstcoVyhVpRgxbAbMqdLcVLkYGlrQITVuIjQXASXVcJgzdDcDqIsFwOpgFKcXkSjyARnDXTykiRWfKLztKJOuqHCzqmImziXnMEXyUrWdOLJAMfRJfEpIaViJacGxVQfcooalXlbRwmVJVqKHAKYlfPVxvJHAuIcICbhFpSGdtmXQLQEkMgVGHrYKdlvJeaxbrNAChDGJJwtlqUfUDvmuUJjGPRsDvOvbmLqWAYJwIJAKFwjIXuaipEIWybJrTLTGPnKWiJWQwRDogwrduhwfiGSrvshoCkEFVBuNFiHXbCckmHWRuxBYBRTpcMoHjdfVGdNjvqalpFDJGGlPtpVAhUiaoJHKyDiWRXJczWEEuspvqLLCPmzfhwSjlCLYoPmOSuWmTYoPLNknGGRdvSiHQdOuVUdkpGspjQGcernCWPUzRXhRfxaTKEFQYDVLkrwctbWXmHtecIWplIylgpHtWbXzctXmeLGyWgODRpCiSkBXUFGoTdsaSDqyNNsTGQcOIiiAMCgSeugJzqPuNKqWoJmeRvkKqjnIKHwNWXEqSReVOiWLLWqRzonARTzufKPVaCwtiJJzznuQIevciCletyOpNMTfdBBFedwuRrMKkVRQImzmyUoynoRvBcnDkjzwkOsJMxyUQTzrYhleRDhurxGtrAqWjwCOmJXzDAFBEtRVLqwcXJlxrlMcUnbwyRKOXvTBhLuhPJktKwNABeMJJEfozJFhLxnMOrBlYCMDEkjEuHupXrmsCEvekeKPpzoWCFAsewnBDbQzfTeaIStuRzrTIgHyMDgeqyinIebBviIonSfDNoCOWTsxYVUygrQJLLGLBANkvYgckOXMFGnQNGoIeShgfbGUbLeyQHXXqOmAaKSilSVJCcGtgTWisuGSKtoQmmtAdEXUkCuhNsryXcjQvmEXnLMKbtiOugStVzgJuxSRaBdsIYLFtGaJFDiSHkGsuOARemosLvMGimfmHtuuAcROXNVfYWDDmEhXpBQYcBuIpDaqIYGGdNbayxfSEwoXvIUhflfrroqhdcgCsGSXHTcYVwMpgXqqWghNsdBaODjOrAKHkvdpLFGWeaixAAqJVqKyUtDcuKMHMavRvqDvVxhsTmUAuBfIQWDnXPGqIgOaaOSGbcUzVeDimjOEVGIlRMnNjapkTwaqNJwMQPfbTfvruVYLmgYWzeYlDhSJEbEerrMpSgGnCWezxMhziyYYzKvxjRcVpzbpXvVTVGwzTcIMMWFyiaEocpvozVEMreCOvGjhfIhBKhGIxiazcUDUkWfdOtKfCNSOLRgAKkdukOjjtSdlHKWljlYaCAypySpNcUFMsfWErGSgvcEMEHtGFJyxTzAOMTwfqAqxuzmFsbhgpyBtCuOaeHISjFlImJgQjPWKjVpPGhxIEDmweXqLWhWlpUMdkMFvCwScKXbYxdKscBOzBhAhcVazOwbOBPbGDtJqoEFBRBvQIGlgnBYFvhJktEIpdMjnBFxOqiFDuUYGMGpapTuWdnlTIvQWXRXmszuttdVzXWExrcIKDyYDiRBRXihmtdgAyseYdayWKnSlnuHgFYaRzRkwxxRYBEmJDxxVnSAXvvDhwdaNyXCpvDtdGRKOLXWSLcjbikiMrDvKQzTKpnqqbMaYDdNJHTWmaxybORRWnfdnGApHKhAAgHeuqYCPUfcExRBDqtayQfvihnMWSrQotEKkSQppjkbLgLUNrlEUVpywPGJKSKuxszmxINqhKzsCdHkCPjpYHbGqrOitTcKbUxxHDDlRqIzCPCEQNepWJgCdOgBiWMRtWGUNHAiIavoaEEWilrDShCQAGgGDIXgAhBmydQBOgaaBcJgSNLQmGkUGTdAkaDGDxaniyVveYqKdQYRLJaxrwCiUrljTIMfKnHmKpCEirlgucLXkegpxCHuYTxaiUyIsJItNAjSmEjelILbXPqIXhfOMVaYCuouYVAVEgAppnQrVxWvWBFvJrslnMfggjcRYsGugumKMQYfzYKJBtnCQTHDPKmxNiduIKhijirbfEtyFXifvOLPlfoUeR\",\n  \"default\": false,\n  \"snippet\": false,\n  \"locked\": false,\n  \"description\": null,\n  \"created_at\": \"2021-05-18 11:53:41 UTC\",\n  \"updated_at\": \"2021-05-18 11:53:41 UTC\",\n  \"name\": \"report_template_test\",\n  \"id\": 1007981714,\n  \"locations\": [],\n  \"organizations\": []\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/import","name":"import","apis":[{"api_url":"/api/report_templates/import","http_method":"POST","short_description":"Import a report template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"report_template","full_name":"report_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"report_template[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"report_template[template]","description":"\n\u003cp\u003etemplate contents including metadata\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"report_template[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"report_template[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"options","full_name":"options","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"force","full_name":"options[force]","description":"\n\u003cp\u003euse if you want update locked templates\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"associate","full_name":"options[associate]","description":"\n\u003cp\u003edetermines when the template should associate objects based on metadata, new means only when new template is being created, always means both for new and existing template which is only being updated, never ignores metadata\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003enew\u003c/code\u003e, \u003ccode\u003ealways\u003c/code\u003e, \u003ccode\u003enever\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"lock","full_name":"options[lock]","description":"\n\u003cp\u003elock imported templates (false by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"default","full_name":"options[default]","description":"\n\u003cp\u003emakes the template default meaning it will be automatically associated with newly created organizations and locations (false by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":["POST /api/report_templates/import\n{\n  \"report_template\": {\n    \"name\": \"report_template37\",\n    \"template\": \"b\"\n  }\n}\n201\n{\n  \"template\": \"b\",\n  \"name\": \"report_template37\",\n  \"id\": 1007981725,\n  \"snippet\": false,\n  \"description\": null,\n  \"template_kind_id\": null,\n  \"created_at\": \"2021-05-18T11:53:43.327Z\",\n  \"updated_at\": \"2021-05-18T11:53:43.362Z\",\n  \"locked\": false,\n  \"default\": false,\n  \"vendor\": null,\n  \"os_family\": null,\n  \"job_category\": \"Miscellaneous\",\n  \"provider_type\": null,\n  \"description_format\": null,\n  \"execution_timeout_interval\": null\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/revision","name":"revision","apis":[{"api_url":"/api/report_templates/revision","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"version","full_name":"version","description":"\n\u003cp\u003etemplate version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/update","name":"update","apis":[{"api_url":"/api/report_templates/:id","http_method":"PUT","short_description":"Update a report template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"report_template","full_name":"report_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"report_template[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"report_template[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"report_template[template]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"snippet","full_name":"report_template[snippet]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"audit_comment","full_name":"report_template[audit_comment]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"locked","full_name":"report_template[locked]","description":"\n\u003cp\u003eWhether or not the template is locked for editing\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"default","full_name":"report_template[default]","description":"\n\u003cp\u003eWhether or not the template is added automatically to new organizations and locations\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"report_template[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"report_template[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":["PUT /api/report_templates/1007981710\n{\n  \"report_template\": {\n    \"template\": \"\"\n  }\n}\n422\n{\n  \"error\": {\n    \"id\": 1007981710,\n    \"errors\": {\n      \"template\": [\n        \"can't be blank\"\n      ]\n    },\n    \"full_messages\": [\n      \"Template can't be blank\"\n    ]\n  }\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/destroy","name":"destroy","apis":[{"api_url":"/api/report_templates/:id","http_method":"DELETE","short_description":"Delete a report template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["DELETE /api/report_templates/1007981717-report_template29\n{\n  \"report_template\": {}\n}\n200\n{\n  \"id\": 1007981717,\n  \"name\": \"report_template29\",\n  \"template\": \"template content 28\",\n  \"snippet\": false,\n  \"template_kind_id\": null,\n  \"created_at\": \"2021-05-18T11:53:42.723Z\",\n  \"updated_at\": \"2021-05-18T11:53:42.723Z\",\n  \"locked\": false,\n  \"default\": false,\n  \"vendor\": null,\n  \"os_family\": null,\n  \"job_category\": \"Miscellaneous\",\n  \"provider_type\": null,\n  \"description_format\": null,\n  \"execution_timeout_interval\": null,\n  \"description\": null\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/clone","name":"clone","apis":[{"api_url":"/api/report_templates/:id/clone","http_method":"POST","short_description":"Clone a template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]},{"name":"report_template","full_name":"report_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"report_template[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":["POST /api/report_templates/1007981712-report_template25/clone\n{\n  \"report_template\": {\n    \"name\": \"\"\n  }\n}\n422\n{\n  \"error\": {\n    \"id\": null,\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":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/export","name":"export","apis":[{"api_url":"/api/report_templates/:id/export","http_method":"GET","short_description":"Export a report template to ERB","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]}],"returns":[],"examples":["GET /api/report_templates/1007981734-report_template44/export\n200\n\u003c%#\nname: report_template44\nsnippet: false\nmodel: ReportTemplate\n-%\u003e\ntemplate content 42"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/generate","name":"generate","apis":[{"api_url":"/api/report_templates/:id/generate","http_method":"POST","short_description":"Generate report from a template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]},{"name":"input_values","full_name":"input_values","description":"\n\u003cp\u003eHash of input values where key is the name of input, value is the value for this input\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"gzip","full_name":"gzip","description":"\n\u003cp\u003eCompress the report uzing gzip\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"report_format","full_name":"report_format","description":"\n\u003cp\u003eReport format, defaults to ‘csv’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ecsv\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ehtml\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/schedule_report","name":"schedule_report","apis":[{"api_url":"/api/report_templates/:id/schedule_report","http_method":"POST","short_description":"Schedule generating of a report","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eThe reports are generated asynchronously. If mail_to is not given, action returns an url to get resulting report from (see \u003cb\u003ereport_data\u003c/b\u003e).\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]},{"name":"input_values","full_name":"input_values","description":"\n\u003cp\u003eHash of input values where key is the name of input, value is the value for this input\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"gzip","full_name":"gzip","description":"\n\u003cp\u003eCompress the report using gzip\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"mail_to","full_name":"mail_to","description":"\n\u003cp\u003eIf set, scheduled report will be delivered via e-mail. Use ‘,’ to separate multiple email addresses.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"generate_at","full_name":"generate_at","description":"\n\u003cp\u003eUTC time to generate report at\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"report_format","full_name":"report_format","description":"\n\u003cp\u003eReport format, defaults to ‘csv’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ecsv\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ehtml\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[{"code":200,"description":"a successful response","is_array":false,"returns_object":[{"name":"job_id","full_name":"job_id","description":"\n\u003cp\u003eAn ID of job, which generates report. To be used with report_data API endpoint for report data retrieval.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true},{"name":"data_url","full_name":"data_url","description":"\n\u003cp\u003eAn url to get resulting report from. This is not available when report is delivered via e-mail.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true}],"additional_properties":false}],"examples":["POST /api/report_templates/:id/schedule_report/\n200\n{\n  \"job_id\": UNIQUE-REPORT-GENERATING-JOB-UUID\n  \"data_url\": \"/api/v2/report_templates/1/report_data/UNIQUE-REPORT-GENERATING-JOB-UUID\"\n}\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/report_data","name":"report_data","apis":[{"api_url":"/api/report_templates/:id/report_data/:job_id","http_method":"GET","short_description":"Downloads a generated report","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eReturns the report data as a raw response. In case the report hasn’t been generated yet, it will return an empty response with http status 204 - NoContent.\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]},{"name":"job_id","full_name":"job_id","description":"\n\u003cp\u003eID assigned to generating job by the schedule command\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"roles":{"doc_url":"../apidoc/v2/roles","id":"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, ‘all’ to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"builtin","values":["true","false"]},{"name":"description","type":"text"},{"name":"name","type":"string"},{"name":"permission","type":"string"}]},"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]},{"name":"description","full_name":"description","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"role","full_name":"role","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"role[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"role[description]","description":"\n\u003cp\u003eRole description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"role[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"role[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":["POST /api/roles\n{\n  \"role\": {\n    \"name\": \"Test Role\",\n    \"location_ids\": [\n      255093256\n    ],\n    \"organization_ids\": [\n      447626438\n    ]\n  }\n}\n201\n{\n  \"builtin\": 0,\n  \"cloned_from_id\": null,\n  \"name\": \"Test Role\",\n  \"id\": 31,\n  \"description\": null,\n  \"origin\": null,\n  \"filters\": [],\n  \"locations\": [\n    {\n      \"id\": 255093256,\n      \"name\": \"Location 1\",\n      \"title\": \"Location 1\",\n      \"description\": null\n    }\n  ],\n  \"organizations\": [\n    {\n      \"id\": 447626438,\n      \"name\": \"Organization 1\",\n      \"title\": \"Organization 1\",\n      \"description\": null\n    }\n  ]\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"role","full_name":"role","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"role[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"role[description]","description":"\n\u003cp\u003eRole description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"role[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"role[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":["PUT /api/roles/28\n{\n  \"role\": {\n    \"location_ids\": [\n      255093256\n    ],\n    \"organization_ids\": [\n      447626438\n    ]\n  }\n}\n200\n{\n  \"builtin\": 0,\n  \"cloned_from_id\": null,\n  \"name\": \"New Role\",\n  \"id\": 28,\n  \"description\": null,\n  \"origin\": null,\n  \"filters\": [\n    {\n      \"id\": 1062414193\n    }\n  ],\n  \"locations\": [\n    {\n      \"id\": 255093256,\n      \"name\": \"Location 1\",\n      \"title\": \"Location 1\",\n      \"description\": null\n    }\n  ],\n  \"organizations\": [\n    {\n      \"id\": 447626438,\n      \"name\": \"Organization 1\",\n      \"title\": \"Organization 1\",\n      \"description\": null\n    }\n  ]\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["DELETE /api/roles/29\n{\n  \"role\": {}\n}\n200\n{\n  \"id\": 29,\n  \"name\": \"new_org_admin\",\n  \"builtin\": 0,\n  \"description\": null,\n  \"origin\": null,\n  \"cloned_from_id\": 13\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/roles/clone","name":"clone","apis":[{"api_url":"/api/roles/:id/clone","http_method":"POST","short_description":"Clone a role","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"role","full_name":"role","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"role[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"role[description]","description":"\n\u003cp\u003eRole description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"role[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"role[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":["POST /api/roles/13-Organization%20admin/clone\n{\n  \"new_name\": \"Org Admin\",\n  \"role\": {\n    \"name\": \"Org Admin\"\n  }\n}\n201\n{\n  \"id\": 35,\n  \"name\": \"Org Admin\",\n  \"builtin\": 0,\n  \"description\": \"Role granting all permissions except for managing organizations. It can be used to delegate administration of specific organization to a user. In order to create such role, clone this role and assign desired organizations\",\n  \"origin\": null,\n  \"cloned_from_id\": 13\n}"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"instance_hosts":{"doc_url":"../apidoc/v2/instance_hosts","id":"instance_hosts","api_url":"/api","name":"Instance hosts","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/instance_hosts/update","name":"update","apis":[{"api_url":"/api/instance_hosts/:host_id","http_method":"PUT","short_description":"Assign a host to the Foreman instance","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"","required":false,"allow_nil":false,"allow_blank":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,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/instance_hosts/index","name":"index","apis":[{"api_url":"/api/instance_hosts","http_method":"GET","short_description":"List hosts forming the Foreman instance","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/instance_hosts/destroy","name":"destroy","apis":[{"api_url":"/api/instance_hosts/:host_id","http_method":"DESTROY","short_description":"Unassign a given host from the Foreman instance","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"ssh_keys":{"doc_url":"../apidoc/v2/ssh_keys","id":"ssh_keys","api_url":"/api","name":"Ssh keys","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/ssh_keys/index","name":"index","apis":[{"api_url":"/api/users/:user_id/ssh_keys","http_method":"GET","short_description":"List all SSH keys for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, ‘all’ to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"name","type":"string"},{"name":"user_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ssh_keys/show","name":"show","apis":[{"api_url":"/api/users/:user_id/ssh_keys/:id","http_method":"GET","short_description":"Show an SSH key from a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ssh_keys/create","name":"create","apis":[{"api_url":"/api/users/:user_id/ssh_keys","http_method":"POST","short_description":"Add an SSH key for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ssh_key","full_name":"ssh_key","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"ssh_key[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"key","full_name":"ssh_key[key]","description":"\n\u003cp\u003ePublic SSH key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ssh_keys/destroy","name":"destroy","apis":[{"api_url":"/api/users/:user_id/ssh_keys/:id","http_method":"DELETE","short_description":"Delete an SSH key for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"subnets":{"doc_url":"../apidoc/v2/subnets","id":"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},{"api_url":"/api/domains/:domain_id/subnets","http_method":"GET","short_description":"List of subnets for a domain","deprecated":null},{"api_url":"/api/locations/:location_id/subnets","http_method":"GET","short_description":"List of subnets per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/subnets","http_method":"GET","short_description":"List of subnets per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, ‘all’ to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"boot_mode","type":"string"},{"name":"dns_primary","type":"string"},{"name":"dns_secondary","type":"string"},{"name":"domain","type":"string"},{"name":"gateway","type":"string"},{"name":"ipam","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"mask","type":"string"},{"name":"mtu","type":"integer"},{"name":"name","type":"text"},{"name":"network","type":"string"},{"name":"nic_delay","type":"integer"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"params","type":"string"},{"name":"type","type":"string"},{"name":"vlanid","type":"integer"}]},"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]},{"name":"show_hidden_parameters","full_name":"show_hidden_parameters","description":"\n\u003cp\u003eDisplay hidden parameter values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet","full_name":"subnet","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"subnet[name]","description":"\n\u003cp\u003eSubnet name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"subnet[description]","description":"\n\u003cp\u003eSubnet description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"network_type","full_name":"subnet[network_type]","description":"\n\u003cp\u003eType or protocol, IPv4 or IPv6, defaults to IPv4\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eIPv4\u003c/code\u003e, \u003ccode\u003eIPv6\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"network","full_name":"subnet[network]","description":"\n\u003cp\u003eSubnet network\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"cidr","full_name":"subnet[cidr]","description":"\n\u003cp\u003eNetwork prefix in CIDR notation\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mask","full_name":"subnet[mask]","description":"\n\u003cp\u003eNetmask for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"gateway","full_name":"subnet[gateway]","description":"\n\u003cp\u003eSubnet gateway\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dns_primary","full_name":"subnet[dns_primary]","description":"\n\u003cp\u003ePrimary DNS for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dns_secondary","full_name":"subnet[dns_secondary]","description":"\n\u003cp\u003eSecondary DNS for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ipam","full_name":"subnet[ipam]","description":"\n\u003cp\u003eIP Address auto suggestion mode for this subnet.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eDHCP\u003c/code\u003e, \u003ccode\u003eInternal DB\u003c/code\u003e, \u003ccode\u003eRandom DB\u003c/code\u003e, \u003ccode\u003eEUI-64\u003c/code\u003e, \u003ccode\u003eExternal IPAM\u003c/code\u003e, \u003ccode\u003eNone\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"externalipam_group","full_name":"subnet[externalipam_group]","description":"\n\u003cp\u003eExternal IPAM group - only relevant when IPAM is set to external\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"from","full_name":"subnet[from]","description":"\n\u003cp\u003eStarting IP Address for IP auto suggestion\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"to","full_name":"subnet[to]","description":"\n\u003cp\u003eEnding IP Address for IP auto suggestion\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"vlanid","full_name":"subnet[vlanid]","description":"\n\u003cp\u003eVLAN ID for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mtu","full_name":"subnet[mtu]","description":"\n\u003cp\u003eMTU for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_ids","full_name":"subnet[domain_ids]","description":"\n\u003cp\u003eDomains in which this subnet is part\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"dhcp_id","full_name":"subnet[dhcp_id]","description":"\n\u003cp\u003eDHCP Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"tftp_id","full_name":"subnet[tftp_id]","description":"\n\u003cp\u003eTFTP Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"httpboot_id","full_name":"subnet[httpboot_id]","description":"\n\u003cp\u003eHTTPBoot Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"externalipam_id","full_name":"subnet[externalipam_id]","description":"\n\u003cp\u003eExternal IPAM Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"dns_id","full_name":"subnet[dns_id]","description":"\n\u003cp\u003eDNS Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"subnet[template_id]","description":"\n\u003cp\u003eTemplate HTTP(S) Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"bmc_id","full_name":"subnet[bmc_id]","description":"\n\u003cp\u003eBMC Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"boot_mode","full_name":"subnet[boot_mode]","description":"\n\u003cp\u003eDefault boot mode for interfaces assigned to this subnet.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eStatic\u003c/code\u003e, \u003ccode\u003eDHCP\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_parameters_attributes","full_name":"subnet[subnet_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters (name, value)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"subnet[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"subnet[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eSubnet numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet","full_name":"subnet","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"subnet[name]","description":"\n\u003cp\u003eSubnet name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"subnet[description]","description":"\n\u003cp\u003eSubnet description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"network_type","full_name":"subnet[network_type]","description":"\n\u003cp\u003eType or protocol, IPv4 or IPv6, defaults to IPv4\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eIPv4\u003c/code\u003e, \u003ccode\u003eIPv6\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"network","full_name":"subnet[network]","description":"\n\u003cp\u003eSubnet network\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"cidr","full_name":"subnet[cidr]","description":"\n\u003cp\u003eNetwork prefix in CIDR notation\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mask","full_name":"subnet[mask]","description":"\n\u003cp\u003eNetmask for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"gateway","full_name":"subnet[gateway]","description":"\n\u003cp\u003eSubnet gateway\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dns_primary","full_name":"subnet[dns_primary]","description":"\n\u003cp\u003ePrimary DNS for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dns_secondary","full_name":"subnet[dns_secondary]","description":"\n\u003cp\u003eSecondary DNS for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ipam","full_name":"subnet[ipam]","description":"\n\u003cp\u003eIP Address auto suggestion mode for this subnet.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eDHCP\u003c/code\u003e, \u003ccode\u003eInternal DB\u003c/code\u003e, \u003ccode\u003eRandom DB\u003c/code\u003e, \u003ccode\u003eEUI-64\u003c/code\u003e, \u003ccode\u003eExternal IPAM\u003c/code\u003e, \u003ccode\u003eNone\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"externalipam_group","full_name":"subnet[externalipam_group]","description":"\n\u003cp\u003eExternal IPAM group - only relevant when IPAM is set to external\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"from","full_name":"subnet[from]","description":"\n\u003cp\u003eStarting IP Address for IP auto suggestion\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"to","full_name":"subnet[to]","description":"\n\u003cp\u003eEnding IP Address for IP auto suggestion\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"vlanid","full_name":"subnet[vlanid]","description":"\n\u003cp\u003eVLAN ID for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mtu","full_name":"subnet[mtu]","description":"\n\u003cp\u003eMTU for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_ids","full_name":"subnet[domain_ids]","description":"\n\u003cp\u003eDomains in which this subnet is part\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"dhcp_id","full_name":"subnet[dhcp_id]","description":"\n\u003cp\u003eDHCP Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"tftp_id","full_name":"subnet[tftp_id]","description":"\n\u003cp\u003eTFTP Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"httpboot_id","full_name":"subnet[httpboot_id]","description":"\n\u003cp\u003eHTTPBoot Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"externalipam_id","full_name":"subnet[externalipam_id]","description":"\n\u003cp\u003eExternal IPAM Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"dns_id","full_name":"subnet[dns_id]","description":"\n\u003cp\u003eDNS Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"subnet[template_id]","description":"\n\u003cp\u003eTemplate HTTP(S) Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"bmc_id","full_name":"subnet[bmc_id]","description":"\n\u003cp\u003eBMC Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"boot_mode","full_name":"subnet[boot_mode]","description":"\n\u003cp\u003eDefault boot mode for interfaces assigned to this subnet.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eStatic\u003c/code\u003e, \u003ccode\u003eDHCP\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_parameters_attributes","full_name":"subnet[subnet_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters (name, value)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"subnet[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"subnet[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eSubnet numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/subnets/freeip","name":"freeip","apis":[{"api_url":"/api/subnets/:id/freeip","http_method":"GET","short_description":"Provides an unused IP address in this subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]},{"name":"mac","full_name":"mac","description":"\n\u003cp\u003eMAC address to reuse the IP for this host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"excluded_ips","full_name":"excluded_ips","description":"\n\u003cp\u003eIP addresses that should be excluded from suggestion\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"table_preferences":{"doc_url":"../apidoc/v2/table_preferences","id":"table_preferences","api_url":"/api","name":"Table preferences","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/table_preferences/index","name":"index","apis":[{"api_url":"/api/users/:user_id/table_preferences","http_method":"GET","short_description":"List of table preferences for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["GET /api/users/980190962/table_preferences\n200\n{\n  \"total\": 0,\n  \"subtotal\": 0,\n  \"page\": 1,\n  \"per_page\": 20,\n  \"search\": null,\n  \"sort\": {\n    \"by\": null,\n    \"order\": null\n  },\n  \"results\": []\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/table_preferences/show","name":"show","apis":[{"api_url":"/api/users/:user_id/table_preferences/:name","http_method":"GET","short_description":"Table preference details of a given table","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["GET /api/users/135138680/table_preferences/test_subscriptions_resource\n200\n{\n  \"id\": 5,\n  \"name\": \"test_subscriptions_resource\",\n  \"columns\": [\n    \"1\",\n    \"2\",\n    \"3\"\n  ],\n  \"created_at\": \"2021-05-18 11:43:36 UTC\",\n  \"updated_at\": \"2021-05-18 11:43:36 UTC\"\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/table_preferences/create","name":"create","apis":[{"api_url":"/api/users/:user_id/table_preferences","http_method":"POST","short_description":"Creates a table preference for a given table","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"table_preferences","full_name":"table_preferences","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"table_preferences[name]","description":"\n\u003cp\u003eName of the table\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"columns","full_name":"table_preferences[columns]","description":"\n\u003cp\u003eList of user selected columns\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":["POST /api/users/135138680/table_preferences\n{\n  \"name\": \"test_subscriptions_resource\",\n  \"columns\": [\n    \"1\",\n    \"2\",\n    \"3\"\n  ],\n  \"table_preference\": {\n    \"name\": \"test_subscriptions_resource\",\n    \"columns\": [\n      \"1\",\n      \"2\",\n      \"3\"\n    ]\n  }\n}\n201\n{\n  \"id\": 4,\n  \"name\": \"test_subscriptions_resource\",\n  \"columns\": [\n    \"1\",\n    \"2\",\n    \"3\"\n  ],\n  \"created_at\": \"2021-05-18 11:43:36 UTC\",\n  \"updated_at\": \"2021-05-18 11:43:36 UTC\"\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/table_preferences/update","name":"update","apis":[{"api_url":"/api/users/:user_id/table_preferences/:name","http_method":"PUT","short_description":"Updates a table preference for a given table","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"table_preferences","full_name":"table_preferences","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"table_preferences[name]","description":"\n\u003cp\u003eName of the table\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"columns","full_name":"table_preferences[columns]","description":"\n\u003cp\u003eList of user selected columns\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":["PUT /api/users/135138680/table_preferences/test_subscriptions_resource\n{\n  \"columns\": [\n    \"1\",\n    \"2\",\n    \"3\"\n  ],\n  \"table_preference\": {\n    \"columns\": [\n      \"1\",\n      \"2\",\n      \"3\"\n    ]\n  }\n}\n200\n{\n  \"id\": 1,\n  \"name\": \"test_subscriptions_resource\",\n  \"columns\": [\n    \"1\",\n    \"2\",\n    \"3\"\n  ],\n  \"created_at\": \"2021-05-18 11:43:36 UTC\",\n  \"updated_at\": \"2021-05-18 11:43:36 UTC\"\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/table_preferences/destroy","name":"destroy","apis":[{"api_url":"/api/users/:user_id/table_preferences/:name","http_method":"DELETE","short_description":"Delete a table preference for a given table","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003ename of the table\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["DELETE /api/users/135138680/table_preferences/test_subscriptions_resource\n{\n  \"table_preference\": {}\n}\n200\n{\n  \"id\": 2,\n  \"name\": \"test_subscriptions_resource\",\n  \"columns\": [\n    \"1\",\n    \"2\",\n    \"3\"\n  ],\n  \"created_at\": \"2021-05-18 11:43:36 UTC\",\n  \"updated_at\": \"2021-05-18 11:43:36 UTC\"\n}"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"tasks":{"doc_url":"../apidoc/v2/tasks","id":"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":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"template_inputs":{"doc_url":"../apidoc/v2/template_inputs","id":"template_inputs","api_url":"/api","name":"Template inputs","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/template_inputs/index","name":"index","apis":[{"api_url":"/api/templates/:template_id/template_inputs","http_method":"GET","short_description":"List template inputs","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"template_id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, ‘all’ to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["GET /api/templates/1007981711/template_inputs\n200\n{\n  \"total\": 1,\n  \"subtotal\": 1,\n  \"page\": 1,\n  \"per_page\": 20,\n  \"search\": null,\n  \"sort\": {\n    \"by\": null,\n    \"order\": null\n  },\n  \"results\": [\n    {\n      \"template_id\": 1007981711,\n      \"fact_name\": null,\n      \"variable_name\": null,\n      \"puppet_parameter_name\": null,\n      \"puppet_class_name\": null,\n      \"description\": null,\n      \"required\": false,\n      \"default\": null,\n      \"hidden_value\": false,\n      \"id\": 2,\n      \"name\": \"Template input 2\",\n      \"input_type\": \"user\",\n      \"options\": null\n    }\n  ]\n}"],"metadata":{"search":[{"name":"input_type","type":"string"},{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/template_inputs/show","name":"show","apis":[{"api_url":"/api/templates/:template_id/template_inputs/:id","http_method":"GET","short_description":"Show template input details","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"template_id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]}],"returns":[],"examples":["GET /api/templates/1007981715-report_template54/template_inputs/7\n200\n{\n  \"template_id\": 1007981715,\n  \"fact_name\": null,\n  \"variable_name\": null,\n  \"puppet_parameter_name\": null,\n  \"puppet_class_name\": null,\n  \"description\": null,\n  \"required\": false,\n  \"default\": null,\n  \"hidden_value\": false,\n  \"id\": 7,\n  \"name\": \"Template input 6\",\n  \"input_type\": \"user\",\n  \"options\": null\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/template_inputs/create","name":"create","apis":[{"api_url":"/api/templates/:template_id/template_inputs","http_method":"POST","short_description":"Create a template input","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"template_id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]},{"name":"template_input","full_name":"template_input","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"template_input[name]","description":"\n\u003cp\u003eInput name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"template_input[description]","description":"\n\u003cp\u003eInput description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"required","full_name":"template_input[required]","description":"\n\u003cp\u003eInput is required\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"advanced","full_name":"template_input[advanced]","description":"\n\u003cp\u003eInput is advanced\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"input_type","full_name":"template_input[input_type]","description":"\n\u003cp\u003eInput type\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003euser\u003c/code\u003e, \u003ccode\u003efact\u003c/code\u003e, \u003ccode\u003evariable\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fact_name","full_name":"template_input[fact_name]","description":"\n\u003cp\u003eFact name, used when input type is Fact value\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"variable_name","full_name":"template_input[variable_name]","description":"\n\u003cp\u003eVariable name, used when input type is Variable\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"options","full_name":"template_input[options]","description":"\n\u003cp\u003eSelectable values for user inputs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"default","full_name":"template_input[default]","description":"\n\u003cp\u003eDefault value for user input\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"template_input[hidden_value]","description":"\n\u003cp\u003eThe value contains sensitive information and shouldn not be normally visible, useful e.g. for passwords\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"value_type","full_name":"template_input[value_type]","description":"\n\u003cp\u003eValue type, defaults to plain\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eplain\u003c/code\u003e, \u003ccode\u003esearch\u003c/code\u003e, \u003ccode\u003edate\u003c/code\u003e, \u003ccode\u003eresource\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"resource_type","full_name":"template_input[resource_type]","description":"\n\u003cp\u003eFor values of type search, this is the resource the value searches in\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eAnsibleRole\u003c/code\u003e, \u003ccode\u003eAnsibleVariable\u003c/code\u003e, \u003ccode\u003eArchitecture\u003c/code\u003e, \u003ccode\u003eAudit\u003c/code\u003e, \u003ccode\u003eAuthSource\u003c/code\u003e, \u003ccode\u003eBookmark\u003c/code\u003e, \u003ccode\u003eComputeProfile\u003c/code\u003e, \u003ccode\u003eComputeResource\u003c/code\u003e, \u003ccode\u003eConfigReport\u003c/code\u003e, \u003ccode\u003eDiscoveryRule\u003c/code\u003e, \u003ccode\u003eDomain\u003c/code\u003e, \u003ccode\u003eExternalUsergroup\u003c/code\u003e, \u003ccode\u003eFactValue\u003c/code\u003e, \u003ccode\u003eFilter\u003c/code\u003e, \u003ccode\u003eForemanOpenscap::ArfReport\u003c/code\u003e, \u003ccode\u003eForemanOpenscap::OvalContent\u003c/code\u003e, \u003ccode\u003eForemanOpenscap::OvalPolicy\u003c/code\u003e, \u003ccode\u003eForemanOpenscap::Policy\u003c/code\u003e, \u003ccode\u003eForemanOpenscap::ScapContent\u003c/code\u003e, \u003ccode\u003eForemanOpenscap::TailoringFile\u003c/code\u003e, \u003ccode\u003eForemanPuppet::ConfigGroup\u003c/code\u003e, \u003ccode\u003eForemanPuppet::Environment\u003c/code\u003e, \u003ccode\u003eForemanPuppet::Puppetclass\u003c/code\u003e, \u003ccode\u003eForemanPuppet::PuppetclassLookupKey\u003c/code\u003e, \u003ccode\u003eForemanTasks::RecurringLogic\u003c/code\u003e, \u003ccode\u003eForemanTasks::Task\u003c/code\u003e, \u003ccode\u003eForemanVirtWhoConfigure::Config\u003c/code\u003e, \u003ccode\u003eHost\u003c/code\u003e, \u003ccode\u003eHostClass\u003c/code\u003e, \u003ccode\u003eHostgroup\u003c/code\u003e, \u003ccode\u003eHttpProxy\u003c/code\u003e, \u003ccode\u003eImage\u003c/code\u003e, \u003ccode\u003eJobInvocation\u003c/code\u003e, \u003ccode\u003eJobTemplate\u003c/code\u003e, \u003ccode\u003eKatello::ActivationKey\u003c/code\u003e, \u003ccode\u003eKatello::ContentCredential\u003c/code\u003e, \u003ccode\u003eKatello::ContentView\u003c/code\u003e, \u003ccode\u003eKatello::HostCollection\u003c/code\u003e, \u003ccode\u003eKatello::KTEnvironment\u003c/code\u003e, \u003ccode\u003eKatello::Product\u003c/code\u003e, \u003ccode\u003eKatello::Subscription\u003c/code\u003e, \u003ccode\u003eKatello::SyncPlan\u003c/code\u003e, \u003ccode\u003eKeyPair\u003c/code\u003e, \u003ccode\u003eLocation\u003c/code\u003e, \u003ccode\u003eMailNotification\u003c/code\u003e, \u003ccode\u003eMedium\u003c/code\u003e, \u003ccode\u003eModel\u003c/code\u003e, \u003ccode\u003eOperatingsystem\u003c/code\u003e, \u003ccode\u003eOrganization\u003c/code\u003e, \u003ccode\u003eParameter\u003c/code\u003e, \u003ccode\u003ePersonalAccessToken\u003c/code\u003e, \u003ccode\u003eProvisioningTemplate\u003c/code\u003e, \u003ccode\u003ePtable\u003c/code\u003e, \u003ccode\u003eRealm\u003c/code\u003e, \u003ccode\u003eRemoteExecutionFeature\u003c/code\u003e, \u003ccode\u003eReport\u003c/code\u003e, \u003ccode\u003eReportTemplate\u003c/code\u003e, \u003ccode\u003eRole\u003c/code\u003e, \u003ccode\u003eSetting\u003c/code\u003e, \u003ccode\u003eSmartProxy\u003c/code\u003e, \u003ccode\u003eSshKey\u003c/code\u003e, \u003ccode\u003eSubnet\u003c/code\u003e, \u003ccode\u003eTemplate\u003c/code\u003e, \u003ccode\u003eTemplateInvocation\u003c/code\u003e, \u003ccode\u003eUser\u003c/code\u003e, \u003ccode\u003eUsergroup\u003c/code\u003e, \u003ccode\u003eWebhook\u003c/code\u003e, \u003ccode\u003eWebhookTemplate\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":["POST /api/templates/1007981713-report_template52/template_inputs\n{\n  \"template_input\": {\n    \"name\": \"is_potato\",\n    \"input_type\": \"user\",\n    \"options\": [\n      \"true\",\n      \"false\"\n    ]\n  }\n}\n201\n{\n  \"template_id\": 1007981713,\n  \"fact_name\": null,\n  \"variable_name\": null,\n  \"puppet_parameter_name\": null,\n  \"puppet_class_name\": null,\n  \"description\": null,\n  \"required\": false,\n  \"default\": null,\n  \"hidden_value\": false,\n  \"id\": 5,\n  \"name\": \"is_potato\",\n  \"input_type\": \"user\",\n  \"options\": [\n    \"true\",\n    \"false\"\n  ]\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/template_inputs/destroy","name":"destroy","apis":[{"api_url":"/api/templates/:template_id/template_inputs/:id","http_method":"DELETE","short_description":"Delete a template input","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"template_id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]}],"returns":[],"examples":["DELETE /api/templates/1007981714-report_template53/template_inputs/6\n{\n  \"template_input\": {}\n}\n200\n{\n  \"id\": 6,\n  \"name\": \"Template input 5\",\n  \"required\": false,\n  \"input_type\": \"user\",\n  \"fact_name\": null,\n  \"variable_name\": null,\n  \"puppet_class_name\": null,\n  \"puppet_parameter_name\": null,\n  \"description\": null,\n  \"template_id\": 1007981714,\n  \"created_at\": \"2021-05-18T11:58:09.261Z\",\n  \"updated_at\": \"2021-05-18T11:58:09.261Z\",\n  \"options\": null,\n  \"advanced\": false,\n  \"value_type\": \"plain\",\n  \"resource_type\": null,\n  \"default\": null,\n  \"hidden_value\": false\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/template_inputs/update","name":"update","apis":[{"api_url":"/api/templates/:template_id/template_inputs/:id","http_method":"PUT","short_description":"Update a template input","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"template_id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]},{"name":"template_input","full_name":"template_input","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"template_input[name]","description":"\n\u003cp\u003eInput name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"template_input[description]","description":"\n\u003cp\u003eInput description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"required","full_name":"template_input[required]","description":"\n\u003cp\u003eInput is required\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"advanced","full_name":"template_input[advanced]","description":"\n\u003cp\u003eInput is advanced\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"input_type","full_name":"template_input[input_type]","description":"\n\u003cp\u003eInput type\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003euser\u003c/code\u003e, \u003ccode\u003efact\u003c/code\u003e, \u003ccode\u003evariable\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fact_name","full_name":"template_input[fact_name]","description":"\n\u003cp\u003eFact name, used when input type is Fact value\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"variable_name","full_name":"template_input[variable_name]","description":"\n\u003cp\u003eVariable name, used when input type is Variable\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"options","full_name":"template_input[options]","description":"\n\u003cp\u003eSelectable values for user inputs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"default","full_name":"template_input[default]","description":"\n\u003cp\u003eDefault value for user input\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"template_input[hidden_value]","description":"\n\u003cp\u003eThe value contains sensitive information and shouldn not be normally visible, useful e.g. for passwords\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"value_type","full_name":"template_input[value_type]","description":"\n\u003cp\u003eValue type, defaults to plain\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eplain\u003c/code\u003e, \u003ccode\u003esearch\u003c/code\u003e, \u003ccode\u003edate\u003c/code\u003e, \u003ccode\u003eresource\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"resource_type","full_name":"template_input[resource_type]","description":"\n\u003cp\u003eFor values of type search, this is the resource the value searches in\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eAnsibleRole\u003c/code\u003e, \u003ccode\u003eAnsibleVariable\u003c/code\u003e, \u003ccode\u003eArchitecture\u003c/code\u003e, \u003ccode\u003eAudit\u003c/code\u003e, \u003ccode\u003eAuthSource\u003c/code\u003e, \u003ccode\u003eBookmark\u003c/code\u003e, \u003ccode\u003eComputeProfile\u003c/code\u003e, \u003ccode\u003eComputeResource\u003c/code\u003e, \u003ccode\u003eConfigReport\u003c/code\u003e, \u003ccode\u003eDiscoveryRule\u003c/code\u003e, \u003ccode\u003eDomain\u003c/code\u003e, \u003ccode\u003eExternalUsergroup\u003c/code\u003e, \u003ccode\u003eFactValue\u003c/code\u003e, \u003ccode\u003eFilter\u003c/code\u003e, \u003ccode\u003eForemanOpenscap::ArfReport\u003c/code\u003e, \u003ccode\u003eForemanOpenscap::OvalContent\u003c/code\u003e, \u003ccode\u003eForemanOpenscap::OvalPolicy\u003c/code\u003e, \u003ccode\u003eForemanOpenscap::Policy\u003c/code\u003e, \u003ccode\u003eForemanOpenscap::ScapContent\u003c/code\u003e, \u003ccode\u003eForemanOpenscap::TailoringFile\u003c/code\u003e, \u003ccode\u003eForemanPuppet::ConfigGroup\u003c/code\u003e, \u003ccode\u003eForemanPuppet::Environment\u003c/code\u003e, \u003ccode\u003eForemanPuppet::Puppetclass\u003c/code\u003e, \u003ccode\u003eForemanPuppet::PuppetclassLookupKey\u003c/code\u003e, \u003ccode\u003eForemanTasks::RecurringLogic\u003c/code\u003e, \u003ccode\u003eForemanTasks::Task\u003c/code\u003e, \u003ccode\u003eForemanVirtWhoConfigure::Config\u003c/code\u003e, \u003ccode\u003eHost\u003c/code\u003e, \u003ccode\u003eHostClass\u003c/code\u003e, \u003ccode\u003eHostgroup\u003c/code\u003e, \u003ccode\u003eHttpProxy\u003c/code\u003e, \u003ccode\u003eImage\u003c/code\u003e, \u003ccode\u003eJobInvocation\u003c/code\u003e, \u003ccode\u003eJobTemplate\u003c/code\u003e, \u003ccode\u003eKatello::ActivationKey\u003c/code\u003e, \u003ccode\u003eKatello::ContentCredential\u003c/code\u003e, \u003ccode\u003eKatello::ContentView\u003c/code\u003e, \u003ccode\u003eKatello::HostCollection\u003c/code\u003e, \u003ccode\u003eKatello::KTEnvironment\u003c/code\u003e, \u003ccode\u003eKatello::Product\u003c/code\u003e, \u003ccode\u003eKatello::Subscription\u003c/code\u003e, \u003ccode\u003eKatello::SyncPlan\u003c/code\u003e, \u003ccode\u003eKeyPair\u003c/code\u003e, \u003ccode\u003eLocation\u003c/code\u003e, \u003ccode\u003eMailNotification\u003c/code\u003e, \u003ccode\u003eMedium\u003c/code\u003e, \u003ccode\u003eModel\u003c/code\u003e, \u003ccode\u003eOperatingsystem\u003c/code\u003e, \u003ccode\u003eOrganization\u003c/code\u003e, \u003ccode\u003eParameter\u003c/code\u003e, \u003ccode\u003ePersonalAccessToken\u003c/code\u003e, \u003ccode\u003eProvisioningTemplate\u003c/code\u003e, \u003ccode\u003ePtable\u003c/code\u003e, \u003ccode\u003eRealm\u003c/code\u003e, \u003ccode\u003eRemoteExecutionFeature\u003c/code\u003e, \u003ccode\u003eReport\u003c/code\u003e, \u003ccode\u003eReportTemplate\u003c/code\u003e, \u003ccode\u003eRole\u003c/code\u003e, \u003ccode\u003eSetting\u003c/code\u003e, \u003ccode\u003eSmartProxy\u003c/code\u003e, \u003ccode\u003eSshKey\u003c/code\u003e, \u003ccode\u003eSubnet\u003c/code\u003e, \u003ccode\u003eTemplate\u003c/code\u003e, \u003ccode\u003eTemplateInvocation\u003c/code\u003e, \u003ccode\u003eUser\u003c/code\u003e, \u003ccode\u003eUsergroup\u003c/code\u003e, \u003ccode\u003eWebhook\u003c/code\u003e, \u003ccode\u003eWebhookTemplate\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":["PUT /api/templates/1007981710-report_template49/template_inputs/1\n{\n  \"template_input\": {\n    \"name\": \"blah\"\n  }\n}\n200\n{\n  \"id\": 1,\n  \"name\": \"blah\",\n  \"required\": false,\n  \"input_type\": \"user\",\n  \"fact_name\": null,\n  \"variable_name\": null,\n  \"puppet_class_name\": null,\n  \"puppet_parameter_name\": null,\n  \"description\": null,\n  \"template_id\": 1007981710,\n  \"created_at\": \"2021-05-18T11:58:08.817Z\",\n  \"updated_at\": \"2021-05-18T11:58:08.878Z\",\n  \"options\": null,\n  \"advanced\": false,\n  \"value_type\": \"plain\",\n  \"resource_type\": null,\n  \"default\": null,\n  \"hidden_value\": false\n}"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"template_kinds":{"doc_url":"../apidoc/v2/template_kinds","id":"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, ‘all’ to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"users":{"doc_url":"../apidoc/v2/users","id":"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},{"api_url":"/api/auth_source_ldaps/:auth_source_ldap_id/users","http_method":"GET","short_description":"List all users for LDAP authentication source","deprecated":null},{"api_url":"/api/auth_source_externals/:auth_source_external_id/users","http_method":"GET","short_description":"List all users for external authentication source","deprecated":null},{"api_url":"/api/usergroups/:usergroup_id/users","http_method":"GET","short_description":"List all users for user group","deprecated":null},{"api_url":"/api/roles/:role_id/users","http_method":"GET","short_description":"List all users for role","deprecated":null},{"api_url":"/api/locations/:location_id/users","http_method":"GET","short_description":"List all users for location","deprecated":null},{"api_url":"/api/organizations/:organization_id/users","http_method":"GET","short_description":"List all users for organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"auth_source_ldap_id","full_name":"auth_source_ldap_id","description":"\n\u003cp\u003eID of LDAP authentication source\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"usergroup_id","full_name":"usergroup_id","description":"\n\u003cp\u003eID of user group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"role_id","full_name":"role_id","description":"\n\u003cp\u003eID of role\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, ‘all’ to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["GET /api/users\n200\n{\n  \"total\": 10,\n  \"subtotal\": 10,\n  \"page\": 1,\n  \"per_page\": 20,\n  \"search\": null,\n  \"sort\": {\n    \"by\": null,\n    \"order\": null\n  },\n  \"results\": [\n    {\n      \"firstname\": \"Admin\",\n      \"lastname\": \"User\",\n      \"mail\": \"admin@someware.com\",\n      \"admin\": true,\n      \"auth_source_id\": 200482051,\n      \"disabled\": false,\n      \"auth_source_name\": \"Internal\",\n      \"timezone\": null,\n      \"locale\": null,\n      \"last_login_on\": \"2009-10-12 21:50:04 UTC\",\n      \"created_at\": \"2021-05-18 11:50:53 UTC\",\n      \"updated_at\": \"2021-05-18 11:50:53 UTC\",\n      \"id\": 135138680,\n      \"login\": \"secret_admin\",\n      \"description\": null,\n      \"ssh_keys\": [],\n      \"default_location\": null,\n      \"locations\": [],\n      \"default_organization\": null,\n      \"organizations\": [],\n      \"effective_admin\": true\n    },\n    {\n      \"firstname\": \"apiadmin\",\n      \"lastname\": \"User\",\n      \"mail\": \"apiadmin@someware.com\",\n      \"admin\": true,\n      \"auth_source_id\": 200482051,\n      \"disabled\": false,\n      \"auth_source_name\": \"Internal\",\n      \"timezone\": null,\n      \"locale\": null,\n      \"last_login_on\": \"2009-10-12 21:50:04 UTC\",\n      \"created_at\": \"2021-05-18 11:50:53 UTC\",\n      \"updated_at\": \"2021-05-18 11:50:53 UTC\",\n      \"id\": 886836129,\n      \"login\": \"apiadmin\",\n      \"description\": null,\n      \"ssh_keys\": [],\n      \"default_location\": null,\n      \"locations\": [],\n      \"default_organization\": null,\n      \"organizations\": [],\n      \"effective_admin\": true\n    },\n    {\n      \"firstname\": \"External\",\n      \"lastname\": \"User\",\n      \"mail\": \"external_user@someware.com\",\n      \"admin\": false,\n      \"auth_source_id\": 408068537,\n      \"disabled\": false,\n      \"auth_source_name\": \"External\",\n      \"timezone\": null,\n      \"locale\": null,\n      \"last_login_on\": \"2009-10-12 21:50:04 UTC\",\n      \"created_at\": \"2021-05-18 11:50:53 UTC\",\n      \"updated_at\": \"2021-05-18 11:50:53 UTC\",\n      \"id\": 408068537,\n      \"login\": \"external\",\n      \"description\": null,\n      \"ssh_keys\": [],\n      \"default_location\": null,\n      \"locations\": [],\n      \"default_organization\": null,\n      \"organizations\": [],\n      \"effective_admin\": false\n    },\n    {\n      \"firstname\": \"One\",\n      \"lastname\": \"User\",\n      \"mail\": \"userone@someware.com\",\n      \"admin\": false,\n      \"auth_source_id\": 980190962,\n      \"disabled\": false,\n      \"auth_source_name\": \"ldap-server\",\n      \"timezone\": null,\n      \"locale\": null,\n      \"last_login_on\": \"2009-10-12 21:50:04 UTC\",\n      \"created_at\": \"2021-05-18 11:50:53 UTC\",\n      \"updated_at\": \"2021-05-18 11:50:53 UTC\",\n      \"id\": 980190962,\n      \"login\": \"one\",\n      \"description\": null,\n      \"ssh_keys\": [],\n      \"default_location\": null,\n      \"locations\": [\n        {\n          \"id\": 255093256,\n          \"name\": \"Location 1\"\n        }\n      ],\n      \"default_organization\": null,\n      \"organizations\": [\n        {\n          \"id\": 447626438,\n          \"name\": \"Organization 1\"\n        }\n      ],\n      \"effective_admin\": false\n    },\n    {\n      \"firstname\": \"Restricted\",\n      \"lastname\": \"User\",\n      \"mail\": \"userrestricted@someware.com\",\n      \"admin\": false,\n      \"auth_source_id\": 980190962,\n      \"disabled\": false,\n      \"auth_source_name\": \"ldap-server\",\n      \"timezone\": null,\n      \"locale\": null,\n      \"last_login_on\": \"2009-10-12 21:50:04 UTC\",\n      \"created_at\": \"2021-05-18 11:50:53 UTC\",\n      \"updated_at\": \"2021-05-18 11:50:53 UTC\",\n      \"id\": 130842698,\n      \"login\": \"restricted\",\n      \"description\": null,\n      \"ssh_keys\": [],\n      \"default_location\": null,\n      \"locations\": [],\n      \"default_organization\": null,\n      \"organizations\": [],\n      \"effective_admin\": false\n    },\n    {\n      \"firstname\": \"Scoped\",\n      \"lastname\": \"User\",\n      \"mail\": \"userscoped@someware.com\",\n      \"admin\": false,\n      \"auth_source_id\": 980190962,\n      \"disabled\": false,\n      \"auth_source_name\": \"ldap-server\",\n      \"timezone\": null,\n      \"locale\": null,\n      \"last_login_on\": \"2009-10-12 21:50:05 UTC\",\n      \"created_at\": \"2021-05-18 11:50:53 UTC\",\n      \"updated_at\": \"2021-05-18 11:50:53 UTC\",\n      \"id\": 117925625,\n      \"login\": \"scoped\",\n      \"description\": null,\n      \"ssh_keys\": [],\n      \"default_location\": null,\n      \"locations\": [\n        {\n          \"id\": 255093256,\n          \"name\": \"Location 1\"\n        }\n      ],\n      \"default_organization\": null,\n      \"organizations\": [\n        {\n          \"id\": 447626438,\n          \"name\": \"Organization 1\"\n        }\n      ],\n      \"effective_admin\": false\n    },\n    {\n      \"firstname\": \"system_admin\",\n      \"lastname\": \"User\",\n      \"mail\": \"system_admin@anywhere.com\",\n      \"admin\": false,\n      \"auth_source_id\": 200482051,\n      \"disabled\": false,\n      \"auth_source_name\": \"Internal\",\n      \"timezone\": null,\n      \"locale\": null,\n      \"last_login_on\": \"2009-10-12 21:50:04 UTC\",\n      \"created_at\": \"2021-05-18 11:50:53 UTC\",\n      \"updated_at\": \"2021-05-18 11:50:53 UTC\",\n      \"id\": 482449135,\n      \"login\": \"system_admin\",\n      \"description\": null,\n      \"ssh_keys\": [],\n      \"default_location\": null,\n      \"locations\": [],\n      \"default_organization\": null,\n      \"organizations\": [],\n      \"effective_admin\": false\n    },\n    {\n      \"firstname\": \"test\",\n      \"lastname\": \"User\",\n      \"mail\": \"testuser@someware.com\",\n      \"admin\": false,\n      \"auth_source_id\": 200482051,\n      \"disabled\": false,\n      \"auth_source_name\": \"Internal\",\n      \"timezone\": null,\n      \"locale\": null,\n      \"last_login_on\": \"2009-10-12 21:50:04 UTC\",\n      \"created_at\": \"2021-05-18 11:50:53 UTC\",\n      \"updated_at\": \"2021-05-18 11:50:53 UTC\",\n      \"id\": 200482051,\n      \"login\": \"test\",\n      \"description\": null,\n      \"ssh_keys\": [],\n      \"default_location\": null,\n      \"locations\": [],\n      \"default_organization\": null,\n      \"organizations\": [],\n      \"effective_admin\": false\n    },\n    {\n      \"firstname\": \"Two\",\n      \"lastname\": \"User\",\n      \"mail\": \"usertwo@someware.com\",\n      \"admin\": false,\n      \"auth_source_id\": 980190962,\n      \"disabled\": false,\n      \"auth_source_name\": \"ldap-server\",\n      \"timezone\": null,\n      \"locale\": null,\n      \"last_login_on\": \"2009-10-12 21:50:04 UTC\",\n      \"created_at\": \"2021-05-18 11:50:53 UTC\",\n      \"updated_at\": \"2021-05-18 11:50:53 UTC\",\n      \"id\": 298486374,\n      \"login\": \"two\",\n      \"description\": null,\n      \"ssh_keys\": [],\n      \"default_location\": null,\n      \"locations\": [],\n      \"default_organization\": null,\n      \"organizations\": [],\n      \"effective_admin\": false\n    },\n    {\n      \"firstname\": \"view_hosts\",\n      \"lastname\": \"User\",\n      \"mail\": \"view_hosts@someware.com\",\n      \"admin\": false,\n      \"auth_source_id\": 200482051,\n      \"disabled\": false,\n      \"auth_source_name\": \"Internal\",\n      \"timezone\": null,\n      \"locale\": null,\n      \"last_login_on\": \"2009-10-12 21:50:04 UTC\",\n      \"created_at\": \"2021-05-18 11:50:53 UTC\",\n      \"updated_at\": \"2021-05-18 11:50:53 UTC\",\n      \"id\": 988725676,\n      \"login\": \"view_hosts\",\n      \"description\": null,\n      \"ssh_keys\": [],\n      \"default_location\": null,\n      \"locations\": [],\n      \"default_organization\": null,\n      \"organizations\": [],\n      \"effective_admin\": false\n    }\n  ]\n}"],"metadata":{"search":[{"name":"admin","values":["true","false"]},{"name":"auth_source","type":"string"},{"name":"auth_source_type","type":"string"},{"name":"description","type":"text"},{"name":"disabled","values":["true","false"]},{"name":"firstname","type":"string"},{"name":"last_login_on","type":"datetime"},{"name":"lastname","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"login","type":"string"},{"name":"mail","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"role","type":"string"},{"name":"role_id","type":"integer"},{"name":"usergroup","type":"string"}]},"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["GET /api/users/980190962\n200\n{\n  \"firstname\": \"One\",\n  \"lastname\": \"User\",\n  \"mail\": \"userone@someware.com\",\n  \"admin\": false,\n  \"auth_source_id\": 980190962,\n  \"disabled\": false,\n  \"auth_source_name\": \"ldap-server\",\n  \"timezone\": null,\n  \"locale\": null,\n  \"last_login_on\": \"2009-10-12 21:50:04 UTC\",\n  \"created_at\": \"2021-05-18 11:50:53 UTC\",\n  \"updated_at\": \"2021-05-18 11:51:21 UTC\",\n  \"id\": 980190962,\n  \"login\": \"one\",\n  \"description\": null,\n  \"ssh_keys\": [],\n  \"default_location\": {\n    \"id\": 255093256,\n    \"name\": \"Location 1\",\n    \"title\": \"Location 1\",\n    \"description\": null\n  },\n  \"locations\": [\n    {\n      \"id\": 255093256,\n      \"name\": \"Location 1\",\n      \"title\": \"Location 1\",\n      \"description\": null\n    }\n  ],\n  \"default_organization\": null,\n  \"organizations\": [\n    {\n      \"id\": 447626438,\n      \"name\": \"Organization 1\",\n      \"title\": \"Organization 1\",\n      \"description\": null\n    }\n  ],\n  \"effective_admin\": false,\n  \"cached_usergroups\": [],\n  \"auth_source_ldap\": {\n    \"id\": 980190962,\n    \"type\": \"AuthSourceLdap\",\n    \"name\": \"ldap-server\"\n  },\n  \"mail_notifications\": [],\n  \"roles\": [\n    {\n      \"name\": \"Viewer\",\n      \"id\": 5,\n      \"description\": null,\n      \"origin\": \"foreman\"\n    }\n  ],\n  \"usergroups\": []\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/users/show_current","name":"show_current","apis":[{"api_url":"/api/current_user","http_method":"GET","short_description":"Show the currently logged-in user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["GET /api/current_user\n200\n{\n  \"firstname\": \"One\",\n  \"lastname\": \"User\",\n  \"mail\": \"userone@someware.com\",\n  \"admin\": false,\n  \"auth_source_id\": 980190962,\n  \"disabled\": false,\n  \"auth_source_name\": \"ldap-server\",\n  \"timezone\": null,\n  \"locale\": null,\n  \"last_login_on\": \"2009-10-12 21:50:04 UTC\",\n  \"created_at\": \"2021-05-18 11:50:53 UTC\",\n  \"updated_at\": \"2021-05-18 11:50:53 UTC\",\n  \"id\": 980190962,\n  \"login\": \"one\",\n  \"description\": null,\n  \"ssh_keys\": [],\n  \"default_location\": null,\n  \"locations\": [\n    {\n      \"id\": 255093256,\n      \"name\": \"Location 1\",\n      \"title\": \"Location 1\",\n      \"description\": null\n    }\n  ],\n  \"default_organization\": null,\n  \"organizations\": [\n    {\n      \"id\": 447626438,\n      \"name\": \"Organization 1\",\n      \"title\": \"Organization 1\",\n      \"description\": null\n    }\n  ],\n  \"effective_admin\": false,\n  \"cached_usergroups\": [],\n  \"auth_source_ldap\": {\n    \"id\": 980190962,\n    \"type\": \"AuthSourceLdap\",\n    \"name\": \"ldap-server\"\n  },\n  \"mail_notifications\": [],\n  \"roles\": [\n    {\n      \"name\": \"Viewer\",\n      \"id\": 5,\n      \"description\": null,\n      \"origin\": \"foreman\"\n    }\n  ],\n  \"usergroups\": []\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"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\u003cp\u003eAdds role ‘Default role’ to the user by default\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user","full_name":"user","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"login","full_name":"user[login]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"firstname","full_name":"user[firstname]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"lastname","full_name":"user[lastname]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mail","full_name":"user[mail]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"user[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"disabled","full_name":"user[disabled]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"admin","full_name":"user[admin]","description":"\n\u003cp\u003eis an admin account\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"user[password]","description":"\n\u003cp\u003eRequired unless user is in an external authentication source\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"default_location_id","full_name":"user[default_location_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"default_organization_id","full_name":"user[default_organization_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"auth_source_id","full_name":"user[auth_source_id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"timezone","full_name":"user[timezone]","description":"\n\u003cp\u003eUser’s timezone\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eInternational Date Line West\u003c/code\u003e, \u003ccode\u003eAmerican Samoa\u003c/code\u003e, \u003ccode\u003eMidway Island\u003c/code\u003e, \u003ccode\u003eHawaii\u003c/code\u003e, \u003ccode\u003eAlaska\u003c/code\u003e, \u003ccode\u003ePacific Time (US \u0026amp; Canada)\u003c/code\u003e, \u003ccode\u003eTijuana\u003c/code\u003e, \u003ccode\u003eArizona\u003c/code\u003e, \u003ccode\u003eChihuahua\u003c/code\u003e, \u003ccode\u003eMazatlan\u003c/code\u003e, \u003ccode\u003eMountain Time (US \u0026amp; Canada)\u003c/code\u003e, \u003ccode\u003eCentral America\u003c/code\u003e, \u003ccode\u003eCentral Time (US \u0026amp; Canada)\u003c/code\u003e, \u003ccode\u003eGuadalajara\u003c/code\u003e, \u003ccode\u003eMexico City\u003c/code\u003e, \u003ccode\u003eMonterrey\u003c/code\u003e, \u003ccode\u003eSaskatchewan\u003c/code\u003e, \u003ccode\u003eBogota\u003c/code\u003e, \u003ccode\u003eEastern Time (US \u0026amp; Canada)\u003c/code\u003e, \u003ccode\u003eIndiana (East)\u003c/code\u003e, \u003ccode\u003eLima\u003c/code\u003e, \u003ccode\u003eQuito\u003c/code\u003e, \u003ccode\u003eAtlantic Time (Canada)\u003c/code\u003e, \u003ccode\u003eCaracas\u003c/code\u003e, \u003ccode\u003eGeorgetown\u003c/code\u003e, \u003ccode\u003eLa Paz\u003c/code\u003e, \u003ccode\u003ePuerto Rico\u003c/code\u003e, \u003ccode\u003eSantiago\u003c/code\u003e, \u003ccode\u003eNewfoundland\u003c/code\u003e, \u003ccode\u003eBrasilia\u003c/code\u003e, \u003ccode\u003eBuenos Aires\u003c/code\u003e, \u003ccode\u003eGreenland\u003c/code\u003e, \u003ccode\u003eMontevideo\u003c/code\u003e, \u003ccode\u003eMid-Atlantic\u003c/code\u003e, \u003ccode\u003eAzores\u003c/code\u003e, \u003ccode\u003eCape Verde Is.\u003c/code\u003e, \u003ccode\u003eCasablanca\u003c/code\u003e, \u003ccode\u003eDublin\u003c/code\u003e, \u003ccode\u003eEdinburgh\u003c/code\u003e, \u003ccode\u003eLisbon\u003c/code\u003e, \u003ccode\u003eLondon\u003c/code\u003e, \u003ccode\u003eMonrovia\u003c/code\u003e, \u003ccode\u003eUTC\u003c/code\u003e, \u003ccode\u003eAmsterdam\u003c/code\u003e, \u003ccode\u003eBelgrade\u003c/code\u003e, \u003ccode\u003eBerlin\u003c/code\u003e, \u003ccode\u003eBern\u003c/code\u003e, \u003ccode\u003eBratislava\u003c/code\u003e, \u003ccode\u003eBrussels\u003c/code\u003e, \u003ccode\u003eBudapest\u003c/code\u003e, \u003ccode\u003eCopenhagen\u003c/code\u003e, \u003ccode\u003eLjubljana\u003c/code\u003e, \u003ccode\u003eMadrid\u003c/code\u003e, \u003ccode\u003eParis\u003c/code\u003e, \u003ccode\u003ePrague\u003c/code\u003e, \u003ccode\u003eRome\u003c/code\u003e, \u003ccode\u003eSarajevo\u003c/code\u003e, \u003ccode\u003eSkopje\u003c/code\u003e, \u003ccode\u003eStockholm\u003c/code\u003e, \u003ccode\u003eVienna\u003c/code\u003e, \u003ccode\u003eWarsaw\u003c/code\u003e, \u003ccode\u003eWest Central Africa\u003c/code\u003e, \u003ccode\u003eZagreb\u003c/code\u003e, \u003ccode\u003eZurich\u003c/code\u003e, \u003ccode\u003eAthens\u003c/code\u003e, \u003ccode\u003eBucharest\u003c/code\u003e, \u003ccode\u003eCairo\u003c/code\u003e, \u003ccode\u003eHarare\u003c/code\u003e, \u003ccode\u003eHelsinki\u003c/code\u003e, \u003ccode\u003eJerusalem\u003c/code\u003e, \u003ccode\u003eKaliningrad\u003c/code\u003e, \u003ccode\u003eKyiv\u003c/code\u003e, \u003ccode\u003ePretoria\u003c/code\u003e, \u003ccode\u003eRiga\u003c/code\u003e, \u003ccode\u003eSofia\u003c/code\u003e, \u003ccode\u003eTallinn\u003c/code\u003e, \u003ccode\u003eVilnius\u003c/code\u003e, \u003ccode\u003eBaghdad\u003c/code\u003e, \u003ccode\u003eIstanbul\u003c/code\u003e, \u003ccode\u003eKuwait\u003c/code\u003e, \u003ccode\u003eMinsk\u003c/code\u003e, \u003ccode\u003eMoscow\u003c/code\u003e, \u003ccode\u003eNairobi\u003c/code\u003e, \u003ccode\u003eRiyadh\u003c/code\u003e, \u003ccode\u003eSt. Petersburg\u003c/code\u003e, \u003ccode\u003eTehran\u003c/code\u003e, \u003ccode\u003eAbu Dhabi\u003c/code\u003e, \u003ccode\u003eBaku\u003c/code\u003e, \u003ccode\u003eMuscat\u003c/code\u003e, \u003ccode\u003eSamara\u003c/code\u003e, \u003ccode\u003eTbilisi\u003c/code\u003e, \u003ccode\u003eVolgograd\u003c/code\u003e, \u003ccode\u003eYerevan\u003c/code\u003e, \u003ccode\u003eKabul\u003c/code\u003e, \u003ccode\u003eEkaterinburg\u003c/code\u003e, \u003ccode\u003eIslamabad\u003c/code\u003e, \u003ccode\u003eKarachi\u003c/code\u003e, \u003ccode\u003eTashkent\u003c/code\u003e, \u003ccode\u003eChennai\u003c/code\u003e, \u003ccode\u003eKolkata\u003c/code\u003e, \u003ccode\u003eMumbai\u003c/code\u003e, \u003ccode\u003eNew Delhi\u003c/code\u003e, \u003ccode\u003eSri Jayawardenepura\u003c/code\u003e, \u003ccode\u003eKathmandu\u003c/code\u003e, \u003ccode\u003eAlmaty\u003c/code\u003e, \u003ccode\u003eAstana\u003c/code\u003e, \u003ccode\u003eDhaka\u003c/code\u003e, \u003ccode\u003eUrumqi\u003c/code\u003e, \u003ccode\u003eRangoon\u003c/code\u003e, \u003ccode\u003eBangkok\u003c/code\u003e, \u003ccode\u003eHanoi\u003c/code\u003e, \u003ccode\u003eJakarta\u003c/code\u003e, \u003ccode\u003eKrasnoyarsk\u003c/code\u003e, \u003ccode\u003eNovosibirsk\u003c/code\u003e, \u003ccode\u003eBeijing\u003c/code\u003e, \u003ccode\u003eChongqing\u003c/code\u003e, \u003ccode\u003eHong Kong\u003c/code\u003e, \u003ccode\u003eIrkutsk\u003c/code\u003e, \u003ccode\u003eKuala Lumpur\u003c/code\u003e, \u003ccode\u003ePerth\u003c/code\u003e, \u003ccode\u003eSingapore\u003c/code\u003e, \u003ccode\u003eTaipei\u003c/code\u003e, \u003ccode\u003eUlaanbaatar\u003c/code\u003e, \u003ccode\u003eOsaka\u003c/code\u003e, \u003ccode\u003eSapporo\u003c/code\u003e, \u003ccode\u003eSeoul\u003c/code\u003e, \u003ccode\u003eTokyo\u003c/code\u003e, \u003ccode\u003eYakutsk\u003c/code\u003e, \u003ccode\u003eAdelaide\u003c/code\u003e, \u003ccode\u003eDarwin\u003c/code\u003e, \u003ccode\u003eBrisbane\u003c/code\u003e, \u003ccode\u003eCanberra\u003c/code\u003e, \u003ccode\u003eGuam\u003c/code\u003e, \u003ccode\u003eHobart\u003c/code\u003e, \u003ccode\u003eMelbourne\u003c/code\u003e, \u003ccode\u003ePort Moresby\u003c/code\u003e, \u003ccode\u003eSydney\u003c/code\u003e, \u003ccode\u003eVladivostok\u003c/code\u003e, \u003ccode\u003eMagadan\u003c/code\u003e, \u003ccode\u003eNew Caledonia\u003c/code\u003e, \u003ccode\u003eSolomon Is.\u003c/code\u003e, \u003ccode\u003eSrednekolymsk\u003c/code\u003e, \u003ccode\u003eAuckland\u003c/code\u003e, \u003ccode\u003eFiji\u003c/code\u003e, \u003ccode\u003eKamchatka\u003c/code\u003e, \u003ccode\u003eMarshall Is.\u003c/code\u003e, \u003ccode\u003eWellington\u003c/code\u003e, \u003ccode\u003eChatham Is.\u003c/code\u003e, \u003ccode\u003eNuku\u0026#39;alofa\u003c/code\u003e, \u003ccode\u003eSamoa\u003c/code\u003e, \u003ccode\u003eTokelau Is.\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"locale","full_name":"user[locale]","description":"\n\u003cp\u003eUser’s preferred locale\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eca\u003c/code\u003e, \u003ccode\u003ecs_CZ\u003c/code\u003e, \u003ccode\u003ede\u003c/code\u003e, \u003ccode\u003een\u003c/code\u003e, \u003ccode\u003een_GB\u003c/code\u003e, \u003ccode\u003ees\u003c/code\u003e, \u003ccode\u003efr\u003c/code\u003e, \u003ccode\u003egl\u003c/code\u003e, \u003ccode\u003eit\u003c/code\u003e, \u003ccode\u003eja\u003c/code\u003e, \u003ccode\u003eko\u003c/code\u003e, \u003ccode\u003enl_NL\u003c/code\u003e, \u003ccode\u003epl\u003c/code\u003e, \u003ccode\u003ept_BR\u003c/code\u003e, \u003ccode\u003eru\u003c/code\u003e, \u003ccode\u003esv_SE\u003c/code\u003e, \u003ccode\u003ezh_CN\u003c/code\u003e, \u003ccode\u003ezh_TW\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"role_ids","full_name":"user[role_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"user[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"user[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":["POST /api/users\n{\n  \"user\": {\n    \"login\": \"foo\",\n    \"auth_source_id\": 200482051,\n    \"password\": \"123456\",\n    \"role_ids\": [\n      1,\n      3\n    ]\n  }\n}\n201\n{\n  \"firstname\": null,\n  \"lastname\": null,\n  \"mail\": null,\n  \"admin\": false,\n  \"auth_source_id\": 200482051,\n  \"disabled\": false,\n  \"auth_source_name\": \"Internal\",\n  \"timezone\": null,\n  \"locale\": null,\n  \"last_login_on\": null,\n  \"created_at\": \"2021-05-18 11:51:19 UTC\",\n  \"updated_at\": \"2021-05-18 11:51:19 UTC\",\n  \"id\": 988725689,\n  \"login\": \"foo\",\n  \"description\": null,\n  \"ssh_keys\": [],\n  \"default_location\": null,\n  \"locations\": [],\n  \"default_organization\": null,\n  \"organizations\": [],\n  \"effective_admin\": false,\n  \"cached_usergroups\": [],\n  \"auth_source_internal\": {\n    \"id\": 200482051,\n    \"type\": \"AuthSourceInternal\",\n    \"name\": \"Internal\"\n  },\n  \"mail_notifications\": [],\n  \"roles\": [\n    {\n      \"name\": \"Manager\",\n      \"id\": 1,\n      \"description\": null,\n      \"origin\": \"foreman\"\n    },\n    {\n      \"name\": \"View hosts\",\n      \"id\": 3,\n      \"description\": null,\n      \"origin\": \"foreman\"\n    }\n  ],\n  \"usergroups\": []\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"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\u003cp\u003eAdds role ‘Default role’ to the user if it is not already present. Only another admin can change the admin account attribute.\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user","full_name":"user","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"login","full_name":"user[login]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"firstname","full_name":"user[firstname]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"lastname","full_name":"user[lastname]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mail","full_name":"user[mail]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"user[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"disabled","full_name":"user[disabled]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"admin","full_name":"user[admin]","description":"\n\u003cp\u003eis an admin account\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"user[password]","description":"\n\u003cp\u003eRequired unless user is in an external authentication source\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"default_location_id","full_name":"user[default_location_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"default_organization_id","full_name":"user[default_organization_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"auth_source_id","full_name":"user[auth_source_id]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"timezone","full_name":"user[timezone]","description":"\n\u003cp\u003eUser’s timezone\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eInternational Date Line West\u003c/code\u003e, \u003ccode\u003eAmerican Samoa\u003c/code\u003e, \u003ccode\u003eMidway Island\u003c/code\u003e, \u003ccode\u003eHawaii\u003c/code\u003e, \u003ccode\u003eAlaska\u003c/code\u003e, \u003ccode\u003ePacific Time (US \u0026amp; Canada)\u003c/code\u003e, \u003ccode\u003eTijuana\u003c/code\u003e, \u003ccode\u003eArizona\u003c/code\u003e, \u003ccode\u003eChihuahua\u003c/code\u003e, \u003ccode\u003eMazatlan\u003c/code\u003e, \u003ccode\u003eMountain Time (US \u0026amp; Canada)\u003c/code\u003e, \u003ccode\u003eCentral America\u003c/code\u003e, \u003ccode\u003eCentral Time (US \u0026amp; Canada)\u003c/code\u003e, \u003ccode\u003eGuadalajara\u003c/code\u003e, \u003ccode\u003eMexico City\u003c/code\u003e, \u003ccode\u003eMonterrey\u003c/code\u003e, \u003ccode\u003eSaskatchewan\u003c/code\u003e, \u003ccode\u003eBogota\u003c/code\u003e, \u003ccode\u003eEastern Time (US \u0026amp; Canada)\u003c/code\u003e, \u003ccode\u003eIndiana (East)\u003c/code\u003e, \u003ccode\u003eLima\u003c/code\u003e, \u003ccode\u003eQuito\u003c/code\u003e, \u003ccode\u003eAtlantic Time (Canada)\u003c/code\u003e, \u003ccode\u003eCaracas\u003c/code\u003e, \u003ccode\u003eGeorgetown\u003c/code\u003e, \u003ccode\u003eLa Paz\u003c/code\u003e, \u003ccode\u003ePuerto Rico\u003c/code\u003e, \u003ccode\u003eSantiago\u003c/code\u003e, \u003ccode\u003eNewfoundland\u003c/code\u003e, \u003ccode\u003eBrasilia\u003c/code\u003e, \u003ccode\u003eBuenos Aires\u003c/code\u003e, \u003ccode\u003eGreenland\u003c/code\u003e, \u003ccode\u003eMontevideo\u003c/code\u003e, \u003ccode\u003eMid-Atlantic\u003c/code\u003e, \u003ccode\u003eAzores\u003c/code\u003e, \u003ccode\u003eCape Verde Is.\u003c/code\u003e, \u003ccode\u003eCasablanca\u003c/code\u003e, \u003ccode\u003eDublin\u003c/code\u003e, \u003ccode\u003eEdinburgh\u003c/code\u003e, \u003ccode\u003eLisbon\u003c/code\u003e, \u003ccode\u003eLondon\u003c/code\u003e, \u003ccode\u003eMonrovia\u003c/code\u003e, \u003ccode\u003eUTC\u003c/code\u003e, \u003ccode\u003eAmsterdam\u003c/code\u003e, \u003ccode\u003eBelgrade\u003c/code\u003e, \u003ccode\u003eBerlin\u003c/code\u003e, \u003ccode\u003eBern\u003c/code\u003e, \u003ccode\u003eBratislava\u003c/code\u003e, \u003ccode\u003eBrussels\u003c/code\u003e, \u003ccode\u003eBudapest\u003c/code\u003e, \u003ccode\u003eCopenhagen\u003c/code\u003e, \u003ccode\u003eLjubljana\u003c/code\u003e, \u003ccode\u003eMadrid\u003c/code\u003e, \u003ccode\u003eParis\u003c/code\u003e, \u003ccode\u003ePrague\u003c/code\u003e, \u003ccode\u003eRome\u003c/code\u003e, \u003ccode\u003eSarajevo\u003c/code\u003e, \u003ccode\u003eSkopje\u003c/code\u003e, \u003ccode\u003eStockholm\u003c/code\u003e, \u003ccode\u003eVienna\u003c/code\u003e, \u003ccode\u003eWarsaw\u003c/code\u003e, \u003ccode\u003eWest Central Africa\u003c/code\u003e, \u003ccode\u003eZagreb\u003c/code\u003e, \u003ccode\u003eZurich\u003c/code\u003e, \u003ccode\u003eAthens\u003c/code\u003e, \u003ccode\u003eBucharest\u003c/code\u003e, \u003ccode\u003eCairo\u003c/code\u003e, \u003ccode\u003eHarare\u003c/code\u003e, \u003ccode\u003eHelsinki\u003c/code\u003e, \u003ccode\u003eJerusalem\u003c/code\u003e, \u003ccode\u003eKaliningrad\u003c/code\u003e, \u003ccode\u003eKyiv\u003c/code\u003e, \u003ccode\u003ePretoria\u003c/code\u003e, \u003ccode\u003eRiga\u003c/code\u003e, \u003ccode\u003eSofia\u003c/code\u003e, \u003ccode\u003eTallinn\u003c/code\u003e, \u003ccode\u003eVilnius\u003c/code\u003e, \u003ccode\u003eBaghdad\u003c/code\u003e, \u003ccode\u003eIstanbul\u003c/code\u003e, \u003ccode\u003eKuwait\u003c/code\u003e, \u003ccode\u003eMinsk\u003c/code\u003e, \u003ccode\u003eMoscow\u003c/code\u003e, \u003ccode\u003eNairobi\u003c/code\u003e, \u003ccode\u003eRiyadh\u003c/code\u003e, \u003ccode\u003eSt. Petersburg\u003c/code\u003e, \u003ccode\u003eTehran\u003c/code\u003e, \u003ccode\u003eAbu Dhabi\u003c/code\u003e, \u003ccode\u003eBaku\u003c/code\u003e, \u003ccode\u003eMuscat\u003c/code\u003e, \u003ccode\u003eSamara\u003c/code\u003e, \u003ccode\u003eTbilisi\u003c/code\u003e, \u003ccode\u003eVolgograd\u003c/code\u003e, \u003ccode\u003eYerevan\u003c/code\u003e, \u003ccode\u003eKabul\u003c/code\u003e, \u003ccode\u003eEkaterinburg\u003c/code\u003e, \u003ccode\u003eIslamabad\u003c/code\u003e, \u003ccode\u003eKarachi\u003c/code\u003e, \u003ccode\u003eTashkent\u003c/code\u003e, \u003ccode\u003eChennai\u003c/code\u003e, \u003ccode\u003eKolkata\u003c/code\u003e, \u003ccode\u003eMumbai\u003c/code\u003e, \u003ccode\u003eNew Delhi\u003c/code\u003e, \u003ccode\u003eSri Jayawardenepura\u003c/code\u003e, \u003ccode\u003eKathmandu\u003c/code\u003e, \u003ccode\u003eAlmaty\u003c/code\u003e, \u003ccode\u003eAstana\u003c/code\u003e, \u003ccode\u003eDhaka\u003c/code\u003e, \u003ccode\u003eUrumqi\u003c/code\u003e, \u003ccode\u003eRangoon\u003c/code\u003e, \u003ccode\u003eBangkok\u003c/code\u003e, \u003ccode\u003eHanoi\u003c/code\u003e, \u003ccode\u003eJakarta\u003c/code\u003e, \u003ccode\u003eKrasnoyarsk\u003c/code\u003e, \u003ccode\u003eNovosibirsk\u003c/code\u003e, \u003ccode\u003eBeijing\u003c/code\u003e, \u003ccode\u003eChongqing\u003c/code\u003e, \u003ccode\u003eHong Kong\u003c/code\u003e, \u003ccode\u003eIrkutsk\u003c/code\u003e, \u003ccode\u003eKuala Lumpur\u003c/code\u003e, \u003ccode\u003ePerth\u003c/code\u003e, \u003ccode\u003eSingapore\u003c/code\u003e, \u003ccode\u003eTaipei\u003c/code\u003e, \u003ccode\u003eUlaanbaatar\u003c/code\u003e, \u003ccode\u003eOsaka\u003c/code\u003e, \u003ccode\u003eSapporo\u003c/code\u003e, \u003ccode\u003eSeoul\u003c/code\u003e, \u003ccode\u003eTokyo\u003c/code\u003e, \u003ccode\u003eYakutsk\u003c/code\u003e, \u003ccode\u003eAdelaide\u003c/code\u003e, \u003ccode\u003eDarwin\u003c/code\u003e, \u003ccode\u003eBrisbane\u003c/code\u003e, \u003ccode\u003eCanberra\u003c/code\u003e, \u003ccode\u003eGuam\u003c/code\u003e, \u003ccode\u003eHobart\u003c/code\u003e, \u003ccode\u003eMelbourne\u003c/code\u003e, \u003ccode\u003ePort Moresby\u003c/code\u003e, \u003ccode\u003eSydney\u003c/code\u003e, \u003ccode\u003eVladivostok\u003c/code\u003e, \u003ccode\u003eMagadan\u003c/code\u003e, \u003ccode\u003eNew Caledonia\u003c/code\u003e, \u003ccode\u003eSolomon Is.\u003c/code\u003e, \u003ccode\u003eSrednekolymsk\u003c/code\u003e, \u003ccode\u003eAuckland\u003c/code\u003e, \u003ccode\u003eFiji\u003c/code\u003e, \u003ccode\u003eKamchatka\u003c/code\u003e, \u003ccode\u003eMarshall Is.\u003c/code\u003e, \u003ccode\u003eWellington\u003c/code\u003e, \u003ccode\u003eChatham Is.\u003c/code\u003e, \u003ccode\u003eNuku\u0026#39;alofa\u003c/code\u003e, \u003ccode\u003eSamoa\u003c/code\u003e, \u003ccode\u003eTokelau Is.\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"locale","full_name":"user[locale]","description":"\n\u003cp\u003eUser’s preferred locale\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eca\u003c/code\u003e, \u003ccode\u003ecs_CZ\u003c/code\u003e, \u003ccode\u003ede\u003c/code\u003e, \u003ccode\u003een\u003c/code\u003e, \u003ccode\u003een_GB\u003c/code\u003e, \u003ccode\u003ees\u003c/code\u003e, \u003ccode\u003efr\u003c/code\u003e, \u003ccode\u003egl\u003c/code\u003e, \u003ccode\u003eit\u003c/code\u003e, \u003ccode\u003eja\u003c/code\u003e, \u003ccode\u003eko\u003c/code\u003e, \u003ccode\u003enl_NL\u003c/code\u003e, \u003ccode\u003epl\u003c/code\u003e, \u003ccode\u003ept_BR\u003c/code\u003e, \u003ccode\u003eru\u003c/code\u003e, \u003ccode\u003esv_SE\u003c/code\u003e, \u003ccode\u003ezh_CN\u003c/code\u003e, \u003ccode\u003ezh_TW\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"role_ids","full_name":"user[role_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"user[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"user[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"current_password","full_name":"user[current_password]","description":"\n\u003cp\u003eRequired when user want to change own password\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":["PUT /api/users/980190962\n{\n  \"user\": {\n    \"firstname\": \"hDLLVXbciy\"\n  }\n}\n200\n{\n  \"firstname\": \"hDLLVXbciy\",\n  \"lastname\": \"User\",\n  \"mail\": \"userone@someware.com\",\n  \"admin\": false,\n  \"auth_source_id\": 980190962,\n  \"disabled\": false,\n  \"auth_source_name\": \"ldap-server\",\n  \"timezone\": null,\n  \"locale\": null,\n  \"last_login_on\": \"2009-10-12 21:50:04 UTC\",\n  \"created_at\": \"2021-05-18 11:50:53 UTC\",\n  \"updated_at\": \"2021-05-18 11:51:18 UTC\",\n  \"id\": 980190962,\n  \"login\": \"one\",\n  \"description\": null,\n  \"ssh_keys\": [],\n  \"default_location\": null,\n  \"locations\": [\n    {\n      \"id\": 255093256,\n      \"name\": \"Location 1\",\n      \"title\": \"Location 1\",\n      \"description\": null\n    }\n  ],\n  \"default_organization\": null,\n  \"organizations\": [\n    {\n      \"id\": 447626438,\n      \"name\": \"Organization 1\",\n      \"title\": \"Organization 1\",\n      \"description\": null\n    }\n  ],\n  \"effective_admin\": false,\n  \"cached_usergroups\": [],\n  \"auth_source_ldap\": {\n    \"id\": 980190962,\n    \"type\": \"AuthSourceLdap\",\n    \"name\": \"ldap-server\"\n  },\n  \"mail_notifications\": [],\n  \"roles\": [\n    {\n      \"name\": \"Viewer\",\n      \"id\": 5,\n      \"description\": null,\n      \"origin\": \"foreman\"\n    }\n  ],\n  \"usergroups\": []\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["DELETE /api/users/980190962\n{\n  \"user\": {}\n}\n403\n{\n  \"error\": {\n    \"message\": \"Access denied\",\n    \"details\": \"You are trying to delete your own account\",\n    \"missing_permissions\": null\n  }\n}"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"host_statuses":{"doc_url":"../apidoc/v2/host_statuses","id":"host_statuses","api_url":"/api","name":"Host statuses","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/host_statuses/index","name":"index","apis":[{"api_url":"/api/host_statuses","http_method":"GET","short_description":"List of host statuses","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, ‘all’ to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"personal_access_tokens":{"doc_url":"../apidoc/v2/personal_access_tokens","id":"personal_access_tokens","api_url":"/api","name":"Personal access tokens","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/personal_access_tokens/index","name":"index","apis":[{"api_url":"/api/users/:user_id/personal_access_tokens","http_method":"GET","short_description":"List all Personal Access Tokens for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, ‘all’ to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"name","type":"string"},{"name":"user_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/personal_access_tokens/show","name":"show","apis":[{"api_url":"/api/users/:user_id/personal_access_tokens/:id","http_method":"GET","short_description":"Show a Personal Access Token for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/personal_access_tokens/create","name":"create","apis":[{"api_url":"/api/users/:user_id/personal_access_tokens","http_method":"POST","short_description":"Create a Personal Access Token for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"personal_access_token","full_name":"personal_access_token","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"personal_access_token[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"expires_at","full_name":"personal_access_token[expires_at]","description":"\n\u003cp\u003eExpiry Date\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a DateTime","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/personal_access_tokens/destroy","name":"destroy","apis":[{"api_url":"/api/users/:user_id/personal_access_tokens/:id","http_method":"DELETE","short_description":"Revoke a Personal Access Token for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"registration_commands":{"doc_url":"../apidoc/v2/registration_commands","id":"registration_commands","api_url":"/api","name":"Registration commands","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/registration_commands/create","name":"create","apis":[{"api_url":"/api/registration_commands","http_method":"POST","short_description":"Generate global registration command","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"registration_command","full_name":"registration_command","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"organization_id","full_name":"registration_command[organization_id]","description":"\n\u003cp\u003eID of the Organization to register the host in\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"registration_command[location_id]","description":"\n\u003cp\u003eID of the Location to register the host in\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"registration_command[hostgroup_id]","description":"\n\u003cp\u003eID of the Host group to register the host in\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"registration_command[operatingsystem_id]","description":"\n\u003cp\u003eID of the Operating System to register the host in. Operating system must have a \u003ccode\u003ehost_init_config\u003c/code\u003e template assigned\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"smart_proxy_id","full_name":"registration_command[smart_proxy_id]","description":"\n\u003cp\u003eID of the Smart Proxy. This Proxy must have enabled both the ‘Templates’ and ‘Registration’ features\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"setup_insights","full_name":"registration_command[setup_insights]","description":"\n\u003cp\u003eSet ‘host_registration_insights’ parameter for the host. If it is set to true, insights client will be installed and registered on Red Hat family operating systems\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"setup_remote_execution","full_name":"registration_command[setup_remote_execution]","description":"\n\u003cp\u003eSet ‘host_registration_remote_execution’ parameter for the host. If it is set to true, SSH keys will be installed on the host\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"jwt_expiration","full_name":"registration_command[jwt_expiration]","description":"\n\u003cp\u003eExpiration of the authorization token (in hours)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"insecure","full_name":"registration_command[insecure]","description":"\n\u003cp\u003eEnable insecure argument for the initial curl\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"packages","full_name":"registration_command[packages]","description":"\n\u003cp\u003ePackages to install on the host when registered. Can be set by \u003ccode\u003ehost_packages\u003c/code\u003e parameter. Example: \u003ccode\u003epkg1 pkg2\u003c/code\u003e\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"update_packages","full_name":"registration_command[update_packages]","description":"\n\u003cp\u003eUpdate all packages on the host\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"repo","full_name":"registration_command[repo]","description":"\n\u003cp\u003eRepository URL / details, for example for Debian OS family: ‘deb http://deb.example.com/ buster 1.0’, for Red Hat OS family: ‘http://yum.theforeman.org/client/latest/el8/x86_64/’\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"repo_gpg_key_url","full_name":"registration_command[repo_gpg_key_url]","description":"\n\u003cp\u003eURL of the GPG key for the repository\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":["POST /api/registration_commands\n{\n  \"registration_command\": {}\n}\n200\n{\n  \"registration_command\": \"curl -sS  'http://test.host/register' -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxMzUxMzg2ODAsImlhdCI6MTYyMTMzOTE3OCwianRpIjoiYzEzYjJhMmM1MTk1MjIyNjA0OGMxMjE4NjU2NTU1Y2EwYTU2ZWY0ZmRjNjFlMDc0ODM2OTVjZmEzZjQ5ZTM3MiIsImV4cCI6MTYyMTM1MzU3OCwic2NvcGUiOiJyZWdpc3RyYXRpb24jZ2xvYmFsIHJlZ2lzdHJhdGlvbiNob3N0In0.1m0WR--FXB2Cy2gsX2xrrZ0uRTNKbf99AuxNsl7skhQ' | bash\"\n}"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"compute_resources":{"doc_url":"../apidoc/v2/compute_resources","id":"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\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, ‘all’ to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"id","type":"integer"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"type","type":"string"}]},"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource","full_name":"compute_resource","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"compute_resource[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider","full_name":"compute_resource[provider]","description":"\n\u003cp\u003eProviders include Libvirt, Ovirt, EC2, Vmware, Openstack, GCE\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"compute_resource[url]","description":"\n\u003cp\u003eURL for Libvirt, oVirt and OpenStack\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"compute_resource[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user","full_name":"compute_resource[user]","description":"\n\u003cp\u003eUsername for oVirt, EC2, VMware, OpenStack. Access Key for EC2.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"compute_resource[password]","description":"\n\u003cp\u003ePassword for oVirt, EC2, VMware, OpenStack. Secret key for EC2\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"datacenter","full_name":"compute_resource[datacenter]","description":"\n\u003cp\u003efor oVirt, VMware Datacenter\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ovirt_quota","full_name":"compute_resource[ovirt_quota]","description":"\n\u003cp\u003efor oVirt only, ID or Name of quota to use\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"public_key","full_name":"compute_resource[public_key]","description":"\n\u003cp\u003efor oVirt only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"region","full_name":"compute_resource[region]","description":"\n\u003cp\u003efor AzureRm eg. ‘eastus’ and for EC2 only. Use ‘us-gov-west-1’ for EC2 GovCloud region\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"tenant","full_name":"compute_resource[tenant]","description":"\n\u003cp\u003efor OpenStack and AzureRm only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain","full_name":"compute_resource[domain]","description":"\n\u003cp\u003efor OpenStack (v3) only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"project_domain_name","full_name":"compute_resource[project_domain_name]","description":"\n\u003cp\u003efor OpenStack (v3) only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"project_domain_id","full_name":"compute_resource[project_domain_id]","description":"\n\u003cp\u003efor OpenStack (v3) only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"server","full_name":"compute_resource[server]","description":"\n\u003cp\u003efor VMware\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"set_console_password","full_name":"compute_resource[set_console_password]","description":"\n\u003cp\u003efor Libvirt and VMware only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"display_type","full_name":"compute_resource[display_type]","description":"\n\u003cp\u003efor Libvirt and oVirt only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eVNC\u003c/code\u003e, \u003ccode\u003eSPICE\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"keyboard_layout","full_name":"compute_resource[keyboard_layout]","description":"\n\u003cp\u003efor oVirt only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ear\u003c/code\u003e, \u003ccode\u003ede-ch\u003c/code\u003e, \u003ccode\u003ees\u003c/code\u003e, \u003ccode\u003efo\u003c/code\u003e, \u003ccode\u003efr-ca\u003c/code\u003e, \u003ccode\u003ehu\u003c/code\u003e, \u003ccode\u003eja\u003c/code\u003e, \u003ccode\u003emk\u003c/code\u003e, \u003ccode\u003eno\u003c/code\u003e, \u003ccode\u003ept-br\u003c/code\u003e, \u003ccode\u003esv\u003c/code\u003e, \u003ccode\u003eda\u003c/code\u003e, \u003ccode\u003een-gb\u003c/code\u003e, \u003ccode\u003eet\u003c/code\u003e, \u003ccode\u003efr\u003c/code\u003e, \u003ccode\u003efr-ch\u003c/code\u003e, \u003ccode\u003eis\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003enl\u003c/code\u003e, \u003ccode\u003epl\u003c/code\u003e, \u003ccode\u003eru\u003c/code\u003e, \u003ccode\u003eth\u003c/code\u003e, \u003ccode\u003ede\u003c/code\u003e, \u003ccode\u003een-us\u003c/code\u003e, \u003ccode\u003efi\u003c/code\u003e, \u003ccode\u003efr-be\u003c/code\u003e, \u003ccode\u003ehr\u003c/code\u003e, \u003ccode\u003eit\u003c/code\u003e, \u003ccode\u003elv\u003c/code\u003e, \u003ccode\u003enl-be\u003c/code\u003e, \u003ccode\u003ept\u003c/code\u003e, \u003ccode\u003esl\u003c/code\u003e, \u003ccode\u003etr\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"caching_enabled","full_name":"compute_resource[caching_enabled]","description":"\n\u003cp\u003eenable caching, for VMware only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"project","full_name":"compute_resource[project]","description":"\n\u003cp\u003eProject id for GCE only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"email","full_name":"compute_resource[email]","description":"\n\u003cp\u003eEmail for GCE only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"key_path","full_name":"compute_resource[key_path]","description":"\n\u003cp\u003eCertificate path for GCE only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"zone","full_name":"compute_resource[zone]","description":"\n\u003cp\u003efor GCE only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"compute_resource[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"compute_resource[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_resource","full_name":"compute_resource","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"compute_resource[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider","full_name":"compute_resource[provider]","description":"\n\u003cp\u003eProviders include Libvirt, Ovirt, EC2, Vmware, Openstack, GCE\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"compute_resource[url]","description":"\n\u003cp\u003eURL for Libvirt, oVirt and OpenStack\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"compute_resource[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user","full_name":"compute_resource[user]","description":"\n\u003cp\u003eUsername for oVirt, EC2, VMware, OpenStack. Access Key for EC2.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"compute_resource[password]","description":"\n\u003cp\u003ePassword for oVirt, EC2, VMware, OpenStack. Secret key for EC2\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"datacenter","full_name":"compute_resource[datacenter]","description":"\n\u003cp\u003efor oVirt, VMware Datacenter\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ovirt_quota","full_name":"compute_resource[ovirt_quota]","description":"\n\u003cp\u003efor oVirt only, ID or Name of quota to use\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"public_key","full_name":"compute_resource[public_key]","description":"\n\u003cp\u003efor oVirt only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"region","full_name":"compute_resource[region]","description":"\n\u003cp\u003efor AzureRm eg. ‘eastus’ and for EC2 only. Use ‘us-gov-west-1’ for EC2 GovCloud region\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"tenant","full_name":"compute_resource[tenant]","description":"\n\u003cp\u003efor OpenStack and AzureRm only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain","full_name":"compute_resource[domain]","description":"\n\u003cp\u003efor OpenStack (v3) only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"project_domain_name","full_name":"compute_resource[project_domain_name]","description":"\n\u003cp\u003efor OpenStack (v3) only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"project_domain_id","full_name":"compute_resource[project_domain_id]","description":"\n\u003cp\u003efor OpenStack (v3) only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"server","full_name":"compute_resource[server]","description":"\n\u003cp\u003efor VMware\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"set_console_password","full_name":"compute_resource[set_console_password]","description":"\n\u003cp\u003efor Libvirt and VMware only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"display_type","full_name":"compute_resource[display_type]","description":"\n\u003cp\u003efor Libvirt and oVirt only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eVNC\u003c/code\u003e, \u003ccode\u003eSPICE\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"keyboard_layout","full_name":"compute_resource[keyboard_layout]","description":"\n\u003cp\u003efor oVirt only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ear\u003c/code\u003e, \u003ccode\u003ede-ch\u003c/code\u003e, \u003ccode\u003ees\u003c/code\u003e, \u003ccode\u003efo\u003c/code\u003e, \u003ccode\u003efr-ca\u003c/code\u003e, \u003ccode\u003ehu\u003c/code\u003e, \u003ccode\u003eja\u003c/code\u003e, \u003ccode\u003emk\u003c/code\u003e, \u003ccode\u003eno\u003c/code\u003e, \u003ccode\u003ept-br\u003c/code\u003e, \u003ccode\u003esv\u003c/code\u003e, \u003ccode\u003eda\u003c/code\u003e, \u003ccode\u003een-gb\u003c/code\u003e, \u003ccode\u003eet\u003c/code\u003e, \u003ccode\u003efr\u003c/code\u003e, \u003ccode\u003efr-ch\u003c/code\u003e, \u003ccode\u003eis\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003enl\u003c/code\u003e, \u003ccode\u003epl\u003c/code\u003e, \u003ccode\u003eru\u003c/code\u003e, \u003ccode\u003eth\u003c/code\u003e, \u003ccode\u003ede\u003c/code\u003e, \u003ccode\u003een-us\u003c/code\u003e, \u003ccode\u003efi\u003c/code\u003e, \u003ccode\u003efr-be\u003c/code\u003e, \u003ccode\u003ehr\u003c/code\u003e, \u003ccode\u003eit\u003c/code\u003e, \u003ccode\u003elv\u003c/code\u003e, \u003ccode\u003enl-be\u003c/code\u003e, \u003ccode\u003ept\u003c/code\u003e, \u003ccode\u003esl\u003c/code\u003e, \u003ccode\u003etr\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"caching_enabled","full_name":"compute_resource[caching_enabled]","description":"\n\u003cp\u003eenable caching, for VMware only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"project","full_name":"compute_resource[project]","description":"\n\u003cp\u003eProject id for GCE only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"email","full_name":"compute_resource[email]","description":"\n\u003cp\u003eEmail for GCE only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"key_path","full_name":"compute_resource[key_path]","description":"\n\u003cp\u003eCertificate path for GCE only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"zone","full_name":"compute_resource[zone]","description":"\n\u003cp\u003efor GCE only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"compute_resource[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"compute_resource[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/available_flavors","name":"available_flavors","apis":[{"api_url":"/api/compute_resources/:id/available_flavors","http_method":"GET","short_description":"List available flavors for a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/available_zones","name":"available_zones","apis":[{"api_url":"/api/compute_resources/:id/available_zones","http_method":"GET","short_description":"List available zone for a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]},{"name":"cluster_id","full_name":"cluster_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/available_vnic_profiles","name":"available_vnic_profiles","apis":[{"api_url":"/api/compute_resources/:id/available_vnic_profiles","http_method":"GET","short_description":"List available vnic profiles for a compute resource, for oVirt only","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]},{"name":"cluster_id","full_name":"cluster_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/storage_domain","name":"storage_domain","apis":[{"api_url":"/api/compute_resources/:id/storage_domains/:storage_domain_id","http_method":"GET","short_description":"List attributes for a given storage domain","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]},{"name":"storage_domain_id","full_name":"storage_domain_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"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/:storage_domain","http_method":"GET","short_description":"List attributes for a given storage domain","deprecated":null},{"api_url":"/api/compute_resources/:id/available_clusters/:cluster_id/available_storage_domains","http_method":"GET","short_description":"List storage domains for a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]},{"name":"cluster_id","full_name":"cluster_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"storage_domain","full_name":"storage_domain","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/storage_pod","name":"storage_pod","apis":[{"api_url":"/api/compute_resources/:id/storage_pods/:storage_pod_id","http_method":"GET","short_description":"List attributes for a given storage pod","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]},{"name":"storage_pod_id","full_name":"storage_pod_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/available_storage_pods","name":"available_storage_pods","apis":[{"api_url":"/api/compute_resources/:id/available_storage_pods","http_method":"GET","short_description":"List storage pods for a compute resource","deprecated":null},{"api_url":"/api/compute_resources/:id/available_storage_pods/:storage_pod","http_method":"GET","short_description":"List attributes for a given storage pod","deprecated":null},{"api_url":"/api/compute_resources/:id/available_clusters/:cluster_id/available_storage_pods","http_method":"GET","short_description":"List storage pods for a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]},{"name":"cluster_id","full_name":"cluster_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"storage_pod","full_name":"storage_pod","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/available_security_groups","name":"available_security_groups","apis":[{"api_url":"/api/compute_resources/:id/available_security_groups","http_method":"GET","short_description":"List available security groups for a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/associate","name":"associate","apis":[{"api_url":"/api/compute_resources/:id/associate/:vm_id","http_method":"PUT","short_description":"Associate VMs to Hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]},{"name":"vm_id","full_name":"vm_id","description":"","required":false,"allow_nil":false,"allow_blank":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,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/refresh_cache","name":"refresh_cache","apis":[{"api_url":"/api/compute_resources/:id/refresh_cache","http_method":"PUT","short_description":"Refresh Compute Resource Cache","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]}],"returns":[],"examples":["PUT /api/compute_resources/305613588-Vmware/refresh_cache\n{\n  \"compute_resource\": {}\n}\n200\n{\n  \"message\": \"Successfully refreshed the cache.\"\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/available_virtual_machines","name":"available_virtual_machines","apis":[{"api_url":"/api/compute_resources/:id/available_virtual_machines","http_method":"GET","short_description":"List available virtual machines for a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/show_vm","name":"show_vm","apis":[{"api_url":"/api/compute_resources/:id/available_virtual_machines/:vm_id","http_method":"GET","short_description":"Show a virtual machine","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]},{"name":"vm_id","full_name":"vm_id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/power_vm","name":"power_vm","apis":[{"api_url":"/api/compute_resources/:id/available_virtual_machines/:vm_id/power","http_method":"PUT","short_description":"Power a Virtual Machine","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]},{"name":"vm_id","full_name":"vm_id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/destroy_vm","name":"destroy_vm","apis":[{"api_url":"/api/compute_resources/:id/available_virtual_machines/:vm_id","http_method":"DELETE","short_description":"Delete a Virtual Machine","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]},{"name":"vm_id","full_name":"vm_id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"smart_proxies":{"doc_url":"../apidoc/v2/smart_proxies","id":"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/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\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, ‘all’ to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"include_status","full_name":"include_status","description":"\n\u003cp\u003eFlag to indicate whether to include status or not\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"feature","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"url","type":"string"}]},"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]},{"name":"include_status","full_name":"include_status","description":"\n\u003cp\u003eFlag to indicate whether to include status or not\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"include_version","full_name":"include_version","description":"\n\u003cp\u003eFlag to indicate whether to include version or not\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"smart_proxy","full_name":"smart_proxy","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"smart_proxy[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"smart_proxy[url]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"smart_proxy[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"smart_proxy[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"smart_proxy","full_name":"smart_proxy","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"smart_proxy[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"smart_proxy[url]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"smart_proxy[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"smart_proxy[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"template_combinations":{"doc_url":"../apidoc/v2/template_combinations","id":"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/provisioning_templates/:provisioning_template_id/template_combinations","http_method":"GET","short_description":"List template combination","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/template_combinations","http_method":"GET","short_description":"List template combination","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_id","full_name":"provisioning_template_id","description":"\n\u003cp\u003eID of config template\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/template_combinations/create","name":"create","apis":[{"api_url":"/api/provisioning_templates/:provisioning_template_id/template_combinations","http_method":"POST","short_description":"Add a template combination","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/template_combinations","http_method":"POST","short_description":"Add a template combination","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_id","full_name":"provisioning_template_id","description":"\n\u003cp\u003eID of config template\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template_combination","full_name":"template_combination","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"hostgroup_id","full_name":"template_combination[hostgroup_id]","description":"\n\u003cp\u003ehost group id\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"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},{"api_url":"/api/provisioning_templates/:provisioning_template_id/template_combinations/:id","http_method":"GET","short_description":"Show template combination","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/template_combinations/:id","http_method":"GET","short_description":"Show template combination","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_id","full_name":"provisioning_template_id","description":"\n\u003cp\u003eID of config template\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]}],"returns":[],"examples":["GET /api/template_combinations/281110143\n200\n{\n  \"created_at\": \"2021-05-18 11:55:49 UTC\",\n  \"updated_at\": \"2021-05-18 11:55:49 UTC\",\n  \"id\": 281110143,\n  \"provisioning_template_id\": 269958254,\n  \"provisioning_template_name\": \"MyString2\",\n  \"hostgroup_id\": 636252244,\n  \"hostgroup_name\": \"Common\",\n  \"environment_id\": 334344675,\n  \"environment_name\": \"production\"\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/template_combinations/update","name":"update","apis":[{"api_url":"/api/provisioning_templates/:provisioning_template_id/template_combinations/:id","http_method":"PUT","short_description":"Update template combination","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/template_combinations/:id","http_method":"PUT","short_description":"Update template combination","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]},{"name":"provisioning_template_id","full_name":"provisioning_template_id","description":"\n\u003cp\u003eID of config template\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template_combination","full_name":"template_combination","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"hostgroup_id","full_name":"template_combination[hostgroup_id]","description":"\n\u003cp\u003ehost group id\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]}],"returns":[],"examples":["DELETE /api/template_combinations/281110143\n{\n  \"template_combination\": {}\n}\n200\n{\n  \"id\": 281110143,\n  \"provisioning_template_id\": 269958254,\n  \"hostgroup_id\": 636252244,\n  \"environment_id\": 334344675,\n  \"created_at\": \"2021-05-18T11:55:49.717Z\",\n  \"updated_at\": \"2021-05-18T11:55:49.717Z\"\n}"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"hosts":{"doc_url":"../apidoc/v2/hosts","id":"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},{"api_url":"/api/hostgroups/:hostgroup_id/hosts","http_method":"GET","short_description":"List all hosts for a host group","deprecated":null},{"api_url":"/api/locations/:location_id/hosts","http_method":"GET","short_description":"List hosts per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/hosts","http_method":"GET","short_description":"List hosts per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"thin","full_name":"thin","description":"\n\u003cp\u003eOnly list ID and name of hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"include","full_name":"include","description":"\n\u003cp\u003eArray of extra information types to include\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eparameters\u003c/code\u003e, \u003ccode\u003eall_parameters\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, ‘all’ to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["GET /api/hosts\n200\n{\n  \"total\": 10,\n  \"subtotal\": 1,\n  \"page\": 1,\n  \"per_page\": 20,\n  \"search\": \"host100.example59.com\",\n  \"sort\": {\n    \"by\": null,\n    \"order\": null\n  },\n  \"results\": [\n    {\n      \"ip\": \"0.0.0.18\",\n      \"ip6\": null,\n      \"environment_id\": null,\n      \"environment_name\": null,\n      \"last_report\": null,\n      \"mac\": \"00:53:67:ab:00:12\",\n      \"realm_id\": null,\n      \"realm_name\": null,\n      \"sp_mac\": \"00:43:56:cd:00:05\",\n      \"sp_ip\": \"2.3.4.5\",\n      \"sp_name\": null,\n      \"domain_id\": 759776768,\n      \"domain_name\": \"example59.com\",\n      \"architecture_id\": 922134526,\n      \"architecture_name\": \"x86_64-36\",\n      \"operatingsystem_id\": 1073012833,\n      \"operatingsystem_name\": \"operatingsystem33 33\",\n      \"subnet_id\": null,\n      \"subnet_name\": null,\n      \"subnet6_id\": null,\n      \"subnet6_name\": null,\n      \"sp_subnet_id\": 980190962,\n      \"ptable_id\": 1007981710,\n      \"ptable_name\": \"ptable37\",\n      \"medium_id\": 1011586623,\n      \"medium_name\": \"medium35\",\n      \"pxe_loader\": \"Grub2 UEFI\",\n      \"build\": false,\n      \"comment\": null,\n      \"disk\": null,\n      \"installed_at\": null,\n      \"model_id\": null,\n      \"hostgroup_id\": null,\n      \"owner_id\": 886836129,\n      \"owner_name\": \"apiadmin User\",\n      \"owner_type\": \"User\",\n      \"enabled\": true,\n      \"managed\": true,\n      \"use_image\": null,\n      \"image_file\": \"\",\n      \"uuid\": null,\n      \"compute_resource_id\": null,\n      \"compute_resource_name\": null,\n      \"compute_profile_id\": null,\n      \"compute_profile_name\": null,\n      \"capabilities\": [\n        \"build\"\n      ],\n      \"provision_method\": \"build\",\n      \"certname\": \"host100.example59.com\",\n      \"image_id\": null,\n      \"image_name\": null,\n      \"created_at\": \"2021-05-18 11:50:57 UTC\",\n      \"updated_at\": \"2021-05-18 11:50:57 UTC\",\n      \"last_compile\": null,\n      \"global_status\": 0,\n      \"global_status_label\": \"OK\",\n      \"uptime_seconds\": null,\n      \"organization_id\": 447626438,\n      \"organization_name\": \"Organization 1\",\n      \"location_id\": 255093256,\n      \"location_name\": \"Location 1\",\n      \"puppet_status\": 0,\n      \"model_name\": null,\n      \"build_status\": 0,\n      \"build_status_label\": \"Installed\",\n      \"name\": \"host100.example59.com\",\n      \"id\": 9,\n      \"puppet_proxy_id\": null,\n      \"puppet_proxy_name\": null,\n      \"puppet_ca_proxy_id\": null,\n      \"puppet_ca_proxy_name\": null,\n      \"puppet_proxy\": null,\n      \"puppet_ca_proxy\": null,\n      \"hostgroup_name\": null,\n      \"hostgroup_title\": null\n    }\n  ]\n}"],"metadata":{"search":[{"name":"architecture","type":"string"},{"name":"boot_time","type":"datetime"},{"name":"build","values":["true","false"]},{"name":"build_status","values":["built","pending","token_expired","build_failed"]},{"name":"comment","type":"text"},{"name":"compute_resource","type":"string"},{"name":"compute_resource_id","type":"integer"},{"name":"created_at","type":"datetime"},{"name":"domain","type":"string"},{"name":"domain_id","type":"integer"},{"name":"facts","type":"string"},{"name":"global_status","values":["ok","warning","error"]},{"name":"has_ip","type":"string"},{"name":"has_mac","type":"string"},{"name":"hostgroup","type":"string"},{"name":"hostgroup_fullname","type":"string"},{"name":"hostgroup_id","type":"integer"},{"name":"hostgroup_name","type":"string"},{"name":"hostgroup_title","type":"string"},{"name":"id","type":"integer"},{"name":"image","type":"string"},{"name":"infrastructure_facet.foreman","type":"boolean"},{"name":"infrastructure_facet.smart_proxy_id","type":"integer"},{"name":"installed_at","type":"datetime"},{"name":"ip","type":"string"},{"name":"last_report","type":"datetime"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"mac","type":"string"},{"name":"managed","values":["true","false"]},{"name":"model","type":"string"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"origin","type":"string"},{"name":"os","type":"string"},{"name":"os_description","type":"string"},{"name":"os_id","type":"integer"},{"name":"os_major","type":"string"},{"name":"os_minor","type":"string"},{"name":"os_title","type":"string"},{"name":"owner","type":"string"},{"name":"owner_id","type":"integer"},{"name":"owner_type","type":"string"},{"name":"params","type":"string"},{"name":"params_name","type":"string"},{"name":"parent_hostgroup","type":"string"},{"name":"puppet_ca","type":"string"},{"name":"puppet_proxy_id","type":"integer"},{"name":"puppetmaster","type":"string"},{"name":"realm","type":"string"},{"name":"realm_id","type":"integer"},{"name":"reported.boot_time","type":"datetime"},{"name":"reported.cores","type":"integer"},{"name":"reported.disks_total","type":"integer"},{"name":"reported.ram","type":"integer"},{"name":"reported.sockets","type":"integer"},{"name":"reported.virtual","values":["true","false"]},{"name":"smart_proxy","type":"string"},{"name":"status.applied","type":"integer"},{"name":"status.enabled","values":["true","false"]},{"name":"status.failed","type":"integer"},{"name":"status.failed_restarts","type":"integer"},{"name":"status.interesting","values":["true","false"]},{"name":"status.pending","type":"integer"},{"name":"status.restarted","type":"integer"},{"name":"status.skipped","type":"integer"},{"name":"subnet","type":"string"},{"name":"subnet.name","type":"text"},{"name":"subnet6","type":"string"},{"name":"subnet6.name","type":"text"},{"name":"user.firstname","type":"string"},{"name":"user.lastname","type":"string"},{"name":"user.login","type":"string"},{"name":"user.mail","type":"string"},{"name":"usergroup","type":"string"},{"name":"usergroup.name","type":"string"},{"name":"uuid","type":"string"}]},"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]},{"name":"show_hidden_parameters","full_name":"show_hidden_parameters","description":"\n\u003cp\u003eDisplay hidden parameter values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["GET /api/hosts/70\n200\n{\n  \"ip\": null,\n  \"ip6\": null,\n  \"environment_id\": null,\n  \"environment_name\": null,\n  \"last_report\": null,\n  \"mac\": null,\n  \"realm_id\": null,\n  \"realm_name\": null,\n  \"sp_mac\": null,\n  \"sp_ip\": null,\n  \"sp_name\": null,\n  \"domain_id\": null,\n  \"domain_name\": null,\n  \"architecture_id\": null,\n  \"architecture_name\": null,\n  \"operatingsystem_id\": null,\n  \"operatingsystem_name\": null,\n  \"subnet_id\": null,\n  \"subnet_name\": null,\n  \"subnet6_id\": null,\n  \"subnet6_name\": null,\n  \"sp_subnet_id\": null,\n  \"ptable_id\": null,\n  \"ptable_name\": null,\n  \"medium_id\": null,\n  \"medium_name\": null,\n  \"pxe_loader\": null,\n  \"build\": false,\n  \"comment\": null,\n  \"disk\": null,\n  \"installed_at\": null,\n  \"model_id\": null,\n  \"hostgroup_id\": null,\n  \"owner_id\": 135138680,\n  \"owner_name\": \"Admin User\",\n  \"owner_type\": \"User\",\n  \"enabled\": true,\n  \"managed\": false,\n  \"use_image\": null,\n  \"image_file\": \"\",\n  \"uuid\": null,\n  \"compute_resource_id\": null,\n  \"compute_resource_name\": null,\n  \"compute_profile_id\": null,\n  \"compute_profile_name\": null,\n  \"capabilities\": [\n    \"build\"\n  ],\n  \"provision_method\": \"build\",\n  \"certname\": \"host343\",\n  \"image_id\": null,\n  \"image_name\": null,\n  \"created_at\": \"2021-05-18 11:53:58 UTC\",\n  \"updated_at\": \"2021-05-18 11:53:58 UTC\",\n  \"last_compile\": null,\n  \"global_status\": 0,\n  \"global_status_label\": \"OK\",\n  \"uptime_seconds\": null,\n  \"organization_id\": 447626438,\n  \"organization_name\": \"Organization 1\",\n  \"location_id\": 255093256,\n  \"location_name\": \"Location 1\",\n  \"puppet_status\": 0,\n  \"model_name\": null,\n  \"name\": \"host343\",\n  \"id\": 70,\n  \"puppet_proxy_id\": null,\n  \"puppet_proxy_name\": null,\n  \"puppet_ca_proxy_id\": null,\n  \"puppet_ca_proxy_name\": null,\n  \"puppet_proxy\": null,\n  \"puppet_ca_proxy\": null,\n  \"hostgroup_name\": null,\n  \"hostgroup_title\": null,\n  \"parameters\": [\n    {\n      \"priority\": 70,\n      \"created_at\": \"2021-05-18 11:53:58 UTC\",\n      \"updated_at\": \"2021-05-18 11:53:58 UTC\",\n      \"id\": 767575239,\n      \"name\": \"foo\",\n      \"parameter_type\": \"integer\",\n      \"value\": 42\n    }\n  ],\n  \"all_parameters\": [\n    {\n      \"priority\": 70,\n      \"created_at\": \"2021-05-18 11:53:58 UTC\",\n      \"updated_at\": \"2021-05-18 11:53:58 UTC\",\n      \"id\": 767575239,\n      \"name\": \"foo\",\n      \"parameter_type\": \"integer\",\n      \"value\": 42\n    },\n    {\n      \"priority\": null,\n      \"created_at\": \"2021-05-18 11:53:21 UTC\",\n      \"updated_at\": \"2021-05-18 11:53:21 UTC\",\n      \"id\": 513706444,\n      \"name\": \"loc_param\",\n      \"parameter_type\": \"string\",\n      \"value\": \"abc\"\n    },\n    {\n      \"priority\": null,\n      \"created_at\": \"2021-05-18 11:53:21 UTC\",\n      \"updated_at\": \"2021-05-18 11:53:21 UTC\",\n      \"id\": 32400255,\n      \"name\": \"org_param\",\n      \"parameter_type\": \"string\",\n      \"value\": \"xyz\"\n    },\n    {\n      \"priority\": null,\n      \"created_at\": \"2021-05-18 11:53:21 UTC\",\n      \"updated_at\": \"2021-05-18 11:53:21 UTC\",\n      \"id\": 636252244,\n      \"name\": \"test\",\n      \"parameter_type\": \"string\",\n      \"value\": \"myvalue\"\n    }\n  ],\n  \"interfaces\": [\n    {\n      \"subnet_id\": null,\n      \"subnet_name\": null,\n      \"subnet6_id\": null,\n      \"subnet6_name\": null,\n      \"domain_id\": null,\n      \"domain_name\": null,\n      \"created_at\": \"2021-05-18 11:53:58 UTC\",\n      \"updated_at\": \"2021-05-18 11:53:58 UTC\",\n      \"managed\": true,\n      \"identifier\": null,\n      \"id\": 84,\n      \"name\": \"host343\",\n      \"ip\": null,\n      \"ip6\": null,\n      \"mac\": null,\n      \"mtu\": null,\n      \"fqdn\": \"host343\",\n      \"primary\": true,\n      \"provision\": true,\n      \"type\": \"interface\",\n      \"virtual\": false\n    }\n  ],\n  \"puppetclasses\": [],\n  \"config_groups\": [],\n  \"all_puppetclasses\": [],\n  \"permissions\": {\n    \"view_hosts\": true,\n    \"create_hosts\": true,\n    \"edit_hosts\": true,\n    \"destroy_hosts\": true,\n    \"build_hosts\": true,\n    \"power_hosts\": true,\n    \"console_hosts\": true,\n    \"ipmi_boot_hosts\": true\n  }\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host","full_name":"host","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"host[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"host[location_id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"host[organization_id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ip","full_name":"host[ip]","description":"\n\u003cp\u003enot required if using a subnet with DHCP proxy\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mac","full_name":"host[mac]","description":"\n\u003cp\u003erequired for managed host that is bare metal, not required if it’s a virtual machine\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"host[architecture_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"host[domain_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"realm_id","full_name":"host[realm_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppet_proxy_id","full_name":"host[puppet_proxy_id]","description":"\n\u003cp\u003ePuppet proxy ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppet_ca_proxy_id","full_name":"host[puppet_ca_proxy_id]","description":"\n\u003cp\u003ePuppet CA proxy ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"host[operatingsystem_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"medium_id","full_name":"host[medium_id]","description":"\n\u003cp\u003erequired if not imaged based provisioning and host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"pxe_loader","full_name":"host[pxe_loader]","description":"\n\u003cp\u003eDHCP filename option (Grub2/PXELinux by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eNone\u003c/code\u003e, \u003ccode\u003ePXELinux BIOS\u003c/code\u003e, \u003ccode\u003ePXELinux UEFI\u003c/code\u003e, \u003ccode\u003eGrub UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 BIOS\u003c/code\u003e, \u003ccode\u003eGrub2 ELF\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI SecureBoot\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTP\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS SecureBoot\u003c/code\u003e, \u003ccode\u003eiPXE Embedded\u003c/code\u003e, \u003ccode\u003eiPXE UEFI HTTP\u003c/code\u003e, \u003ccode\u003eiPXE Chain BIOS\u003c/code\u003e, \u003ccode\u003eiPXE Chain UEFI\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ptable_id","full_name":"host[ptable_id]","description":"\n\u003cp\u003erequired if host is managed and custom partition has not been defined\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"host[subnet_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"host[compute_resource_id]","description":"\n\u003cp\u003enil means host is bare metal\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"root_pass","full_name":"host[root_pass]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group or default password in settings\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"model_id","full_name":"host[model_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"host[hostgroup_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"owner_id","full_name":"host[owner_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"owner_type","full_name":"host[owner_type]","description":"\n\u003cp\u003eHost’s owner type\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eUser\u003c/code\u003e, \u003ccode\u003eUsergroup\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"image_id","full_name":"host[image_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_parameters_attributes","full_name":"host[host_parameters_attributes]","description":"\n\u003cp\u003eHost’s parameters (array or indexed hash)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"host[host_parameters_attributes][name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"host[host_parameters_attributes][value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"host[host_parameters_attributes][parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"host[host_parameters_attributes][hidden_value]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]},{"name":"build","full_name":"host[build]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"enabled","full_name":"host[enabled]","description":"\n\u003cp\u003eInclude this host within Foreman reporting\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"provision_method","full_name":"host[provision_method]","description":"\n\u003cp\u003eThe method used to provision the host.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ebuild\u003c/code\u003e, \u003ccode\u003eimage\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"managed","full_name":"host[managed]","description":"\n\u003cp\u003eTrue/False flag whether a host is managed or unmanaged. Note: this value also determines whether several parameters are required or not\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"progress_report_id","full_name":"host[progress_report_id]","description":"\n\u003cp\u003eUUID to track orchestration tasks status, GET /api/orchestration/:UUID/tasks\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"comment","full_name":"host[comment]","description":"\n\u003cp\u003eAdditional information about this host\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"capabilities","full_name":"host[capabilities]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_profile_id","full_name":"host[compute_profile_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"interfaces_attributes","full_name":"host[interfaces_attributes]","description":"\n\u003cp\u003eHost’s network interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"id","full_name":"host[interfaces_attributes][id]","description":"\n\u003cp\u003eID of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"mac","full_name":"host[interfaces_attributes][mac]","description":"\n\u003cp\u003eMAC address of interface. Required for managed interfaces on bare metal.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip","full_name":"host[interfaces_attributes][ip]","description":"\n\u003cp\u003eIPv4 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip6","full_name":"host[interfaces_attributes][ip6]","description":"\n\u003cp\u003eIPv6 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"host[interfaces_attributes][type]","description":"\n\u003cp\u003eInterface type, e.g. bmc. Default is interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003einterface\u003c/code\u003e, \u003ccode\u003ebmc\u003c/code\u003e, \u003ccode\u003ebond\u003c/code\u003e, \u003ccode\u003ebridge\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"host[interfaces_attributes][name]","description":"\n\u003cp\u003eInterface’s DNS name\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"host[interfaces_attributes][subnet_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv4 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet6_id","full_name":"host[interfaces_attributes][subnet6_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv6 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"host[interfaces_attributes][domain_id]","description":"\n\u003cp\u003eForeman domain ID of interface. Required for primary interfaces on managed hosts.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"identifier","full_name":"host[interfaces_attributes][identifier]","description":"\n\u003cp\u003eDevice identifier, e.g. eth0 or eth1.1\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"managed","full_name":"host[interfaces_attributes][managed]","description":"\n\u003cp\u003eShould this interface be managed via DHCP and DNS smart proxy and should it be configured during provisioning?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"primary","full_name":"host[interfaces_attributes][primary]","description":"\n\u003cp\u003eShould this interface be used for constructing the FQDN of the host? Each managed hosts needs to have one primary interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"provision","full_name":"host[interfaces_attributes][provision]","description":"\n\u003cp\u003eShould this interface be used for TFTP of PXELinux (or SSH for image-based hosts)? Each managed hosts needs to have one provision interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"username","full_name":"host[interfaces_attributes][username]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"host[interfaces_attributes][password]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider","full_name":"host[interfaces_attributes][provider]","description":"\n\u003cp\u003eInterface provider, e.g. IPMI. Only for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eIPMI\u003c/code\u003e, \u003ccode\u003eRedfish\u003c/code\u003e, \u003ccode\u003eSSH\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"virtual","full_name":"host[interfaces_attributes][virtual]","description":"\n\u003cp\u003eAlias or VLAN device\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"tag","full_name":"host[interfaces_attributes][tag]","description":"\n\u003cp\u003eVLAN tag, this attribute has precedence over the subnet VLAN ID. Only for virtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mtu","full_name":"host[interfaces_attributes][mtu]","description":"\n\u003cp\u003eMTU, this attribute has precedence over the subnet MTU.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"attached_to","full_name":"host[interfaces_attributes][attached_to]","description":"\n\u003cp\u003eIdentifier of the interface to which this interface belongs, e.g. eth1. Only for virtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mode","full_name":"host[interfaces_attributes][mode]","description":"\n\u003cp\u003eBond mode of the interface, e.g. balance-rr. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ebalance-rr\u003c/code\u003e, \u003ccode\u003eactive-backup\u003c/code\u003e, \u003ccode\u003ebalance-xor\u003c/code\u003e, \u003ccode\u003ebroadcast\u003c/code\u003e, \u003ccode\u003e802.3ad\u003c/code\u003e, \u003ccode\u003ebalance-tlb\u003c/code\u003e, \u003ccode\u003ebalance-alb\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attached_devices","full_name":"host[interfaces_attributes][attached_devices]","description":"\n\u003cp\u003eIdentifiers of attached interfaces, e.g. \u003ccode\u003e[\u0026#39;eth1\u0026#39;, \u0026#39;eth2\u0026#39;]\u003c/code\u003e. For bond interfaces those are the slaves. Only for bond and bridges interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"bond_options","full_name":"host[interfaces_attributes][bond_options]","description":"\n\u003cp\u003eSpace separated options, e.g. miimon=100. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_attributes","full_name":"host[interfaces_attributes][compute_attributes]","description":"\n\u003cp\u003eAdditional compute resource specific attributes for the interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}]},{"name":"compute_attributes","full_name":"host[compute_attributes]","description":"\n\u003cp\u003eAdditional compute resource specific attributes.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"overwrite","full_name":"host[overwrite]","description":"\n\u003cp\u003eOverwrite existing host (true by default)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":["POST /api/hosts\n{\n  \"host\": {\n    \"id\": null,\n    \"name\": \"host341\",\n    \"last_compile\": null,\n    \"last_report\": null,\n    \"updated_at\": null,\n    \"created_at\": null,\n    \"root_pass\": \"xybxa6JUkz63w\",\n    \"architecture_id\": null,\n    \"operatingsystem_id\": null,\n    \"environment_id\": null,\n    \"ptable_id\": null,\n    \"medium_id\": null,\n    \"build\": false,\n    \"comment\": null,\n    \"disk\": null,\n    \"installed_at\": null,\n    \"model_id\": null,\n    \"hostgroup_id\": null,\n    \"owner_id\": null,\n    \"owner_type\": null,\n    \"enabled\": true,\n    \"puppet_ca_proxy_id\": null,\n    \"managed\": false,\n    \"use_image\": null,\n    \"image_file\": null,\n    \"uuid\": null,\n    \"compute_resource_id\": null,\n    \"puppet_proxy_id\": null,\n    \"certname\": null,\n    \"image_id\": null,\n    \"organization_id\": 447626438,\n    \"location_id\": 255093256,\n    \"type\": \"Host::Managed\",\n    \"otp\": null,\n    \"realm_id\": null,\n    \"compute_profile_id\": null,\n    \"provision_method\": null,\n    \"grub_pass\": \"\",\n    \"discovery_rule_id\": null,\n    \"global_status\": 0,\n    \"lookup_value_matcher\": null,\n    \"openscap_proxy_id\": null,\n    \"pxe_loader\": null,\n    \"initiated_at\": null,\n    \"build_errors\": null,\n    \"parameters\": [\n      {\n        \"name\": \"foo\",\n        \"value\": 42,\n        \"parameter_type\": \"integer\"\n      }\n    ]\n  }\n}\n201\n{\n  \"ip\": null,\n  \"ip6\": null,\n  \"environment_id\": null,\n  \"environment_name\": null,\n  \"last_report\": null,\n  \"mac\": null,\n  \"realm_id\": null,\n  \"realm_name\": null,\n  \"sp_mac\": null,\n  \"sp_ip\": null,\n  \"sp_name\": null,\n  \"domain_id\": null,\n  \"domain_name\": null,\n  \"architecture_id\": null,\n  \"architecture_name\": null,\n  \"operatingsystem_id\": null,\n  \"operatingsystem_name\": null,\n  \"subnet_id\": null,\n  \"subnet_name\": null,\n  \"subnet6_id\": null,\n  \"subnet6_name\": null,\n  \"sp_subnet_id\": null,\n  \"ptable_id\": null,\n  \"ptable_name\": null,\n  \"medium_id\": null,\n  \"medium_name\": null,\n  \"pxe_loader\": null,\n  \"build\": false,\n  \"comment\": null,\n  \"disk\": null,\n  \"installed_at\": null,\n  \"model_id\": null,\n  \"hostgroup_id\": null,\n  \"owner_id\": 135138680,\n  \"owner_name\": \"Admin User\",\n  \"owner_type\": \"User\",\n  \"enabled\": true,\n  \"managed\": false,\n  \"use_image\": null,\n  \"image_file\": \"\",\n  \"uuid\": null,\n  \"compute_resource_id\": null,\n  \"compute_resource_name\": null,\n  \"compute_profile_id\": null,\n  \"compute_profile_name\": null,\n  \"capabilities\": [\n    \"build\"\n  ],\n  \"provision_method\": \"build\",\n  \"certname\": \"host341\",\n  \"image_id\": null,\n  \"image_name\": null,\n  \"created_at\": \"2021-05-18 11:53:57 UTC\",\n  \"updated_at\": \"2021-05-18 11:53:57 UTC\",\n  \"last_compile\": null,\n  \"global_status\": 0,\n  \"global_status_label\": \"OK\",\n  \"uptime_seconds\": null,\n  \"organization_id\": 447626438,\n  \"organization_name\": \"Organization 1\",\n  \"location_id\": 255093256,\n  \"location_name\": \"Location 1\",\n  \"puppet_status\": 0,\n  \"model_name\": null,\n  \"name\": \"host341\",\n  \"id\": 68,\n  \"puppet_proxy_id\": null,\n  \"puppet_proxy_name\": null,\n  \"puppet_ca_proxy_id\": null,\n  \"puppet_ca_proxy_name\": null,\n  \"puppet_proxy\": null,\n  \"puppet_ca_proxy\": null,\n  \"hostgroup_name\": null,\n  \"hostgroup_title\": null,\n  \"parameters\": [],\n  \"all_parameters\": [\n    {\n      \"priority\": null,\n      \"created_at\": \"2021-05-18 11:53:21 UTC\",\n      \"updated_at\": \"2021-05-18 11:53:21 UTC\",\n      \"id\": 513706444,\n      \"name\": \"loc_param\",\n      \"parameter_type\": \"string\",\n      \"value\": \"abc\"\n    },\n    {\n      \"priority\": null,\n      \"created_at\": \"2021-05-18 11:53:21 UTC\",\n      \"updated_at\": \"2021-05-18 11:53:21 UTC\",\n      \"id\": 32400255,\n      \"name\": \"org_param\",\n      \"parameter_type\": \"string\",\n      \"value\": \"xyz\"\n    },\n    {\n      \"priority\": null,\n      \"created_at\": \"2021-05-18 11:53:21 UTC\",\n      \"updated_at\": \"2021-05-18 11:53:21 UTC\",\n      \"id\": 636252244,\n      \"name\": \"test\",\n      \"parameter_type\": \"string\",\n      \"value\": \"myvalue\"\n    }\n  ],\n  \"interfaces\": [\n    {\n      \"subnet_id\": null,\n      \"subnet_name\": null,\n      \"subnet6_id\": null,\n      \"subnet6_name\": null,\n      \"domain_id\": null,\n      \"domain_name\": null,\n      \"created_at\": \"2021-05-18 11:53:57 UTC\",\n      \"updated_at\": \"2021-05-18 11:53:57 UTC\",\n      \"managed\": true,\n      \"identifier\": null,\n      \"id\": 82,\n      \"name\": \"host341\",\n      \"ip\": null,\n      \"ip6\": null,\n      \"mac\": null,\n      \"mtu\": null,\n      \"fqdn\": \"host341\",\n      \"primary\": true,\n      \"provision\": true,\n      \"type\": \"interface\",\n      \"virtual\": false\n    }\n  ],\n  \"puppetclasses\": [],\n  \"config_groups\": [],\n  \"all_puppetclasses\": [],\n  \"permissions\": {\n    \"view_hosts\": true,\n    \"create_hosts\": true,\n    \"edit_hosts\": true,\n    \"destroy_hosts\": true,\n    \"build_hosts\": true,\n    \"power_hosts\": true,\n    \"console_hosts\": true,\n    \"ipmi_boot_hosts\": true\n  }\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]},{"name":"host","full_name":"host","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"host[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"host[location_id]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"host[organization_id]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ip","full_name":"host[ip]","description":"\n\u003cp\u003enot required if using a subnet with DHCP proxy\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mac","full_name":"host[mac]","description":"\n\u003cp\u003erequired for managed host that is bare metal, not required if it’s a virtual machine\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"host[architecture_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"host[domain_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"realm_id","full_name":"host[realm_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppet_proxy_id","full_name":"host[puppet_proxy_id]","description":"\n\u003cp\u003ePuppet proxy ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppet_ca_proxy_id","full_name":"host[puppet_ca_proxy_id]","description":"\n\u003cp\u003ePuppet CA proxy ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"host[operatingsystem_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"medium_id","full_name":"host[medium_id]","description":"\n\u003cp\u003erequired if not imaged based provisioning and host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"pxe_loader","full_name":"host[pxe_loader]","description":"\n\u003cp\u003eDHCP filename option (Grub2/PXELinux by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eNone\u003c/code\u003e, \u003ccode\u003ePXELinux BIOS\u003c/code\u003e, \u003ccode\u003ePXELinux UEFI\u003c/code\u003e, \u003ccode\u003eGrub UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 BIOS\u003c/code\u003e, \u003ccode\u003eGrub2 ELF\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI SecureBoot\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTP\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS SecureBoot\u003c/code\u003e, \u003ccode\u003eiPXE Embedded\u003c/code\u003e, \u003ccode\u003eiPXE UEFI HTTP\u003c/code\u003e, \u003ccode\u003eiPXE Chain BIOS\u003c/code\u003e, \u003ccode\u003eiPXE Chain UEFI\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ptable_id","full_name":"host[ptable_id]","description":"\n\u003cp\u003erequired if host is managed and custom partition has not been defined\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"host[subnet_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"host[compute_resource_id]","description":"\n\u003cp\u003enil means host is bare metal\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"root_pass","full_name":"host[root_pass]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group or default password in settings\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"model_id","full_name":"host[model_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"host[hostgroup_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"owner_id","full_name":"host[owner_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"owner_type","full_name":"host[owner_type]","description":"\n\u003cp\u003eHost’s owner type\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eUser\u003c/code\u003e, \u003ccode\u003eUsergroup\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"image_id","full_name":"host[image_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_parameters_attributes","full_name":"host[host_parameters_attributes]","description":"\n\u003cp\u003eHost’s parameters (array or indexed hash)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"host[host_parameters_attributes][name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"host[host_parameters_attributes][value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"host[host_parameters_attributes][parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"host[host_parameters_attributes][hidden_value]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]},{"name":"build","full_name":"host[build]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"enabled","full_name":"host[enabled]","description":"\n\u003cp\u003eInclude this host within Foreman reporting\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"provision_method","full_name":"host[provision_method]","description":"\n\u003cp\u003eThe method used to provision the host.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ebuild\u003c/code\u003e, \u003ccode\u003eimage\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"managed","full_name":"host[managed]","description":"\n\u003cp\u003eTrue/False flag whether a host is managed or unmanaged. Note: this value also determines whether several parameters are required or not\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"progress_report_id","full_name":"host[progress_report_id]","description":"\n\u003cp\u003eUUID to track orchestration tasks status, GET /api/orchestration/:UUID/tasks\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"comment","full_name":"host[comment]","description":"\n\u003cp\u003eAdditional information about this host\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"capabilities","full_name":"host[capabilities]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_profile_id","full_name":"host[compute_profile_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"interfaces_attributes","full_name":"host[interfaces_attributes]","description":"\n\u003cp\u003eHost’s network interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"id","full_name":"host[interfaces_attributes][id]","description":"\n\u003cp\u003eID of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"mac","full_name":"host[interfaces_attributes][mac]","description":"\n\u003cp\u003eMAC address of interface. Required for managed interfaces on bare metal.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip","full_name":"host[interfaces_attributes][ip]","description":"\n\u003cp\u003eIPv4 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip6","full_name":"host[interfaces_attributes][ip6]","description":"\n\u003cp\u003eIPv6 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"host[interfaces_attributes][type]","description":"\n\u003cp\u003eInterface type, e.g. bmc. Default is interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003einterface\u003c/code\u003e, \u003ccode\u003ebmc\u003c/code\u003e, \u003ccode\u003ebond\u003c/code\u003e, \u003ccode\u003ebridge\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"host[interfaces_attributes][name]","description":"\n\u003cp\u003eInterface’s DNS name\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"host[interfaces_attributes][subnet_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv4 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet6_id","full_name":"host[interfaces_attributes][subnet6_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv6 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"host[interfaces_attributes][domain_id]","description":"\n\u003cp\u003eForeman domain ID of interface. Required for primary interfaces on managed hosts.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"identifier","full_name":"host[interfaces_attributes][identifier]","description":"\n\u003cp\u003eDevice identifier, e.g. eth0 or eth1.1\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"managed","full_name":"host[interfaces_attributes][managed]","description":"\n\u003cp\u003eShould this interface be managed via DHCP and DNS smart proxy and should it be configured during provisioning?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"primary","full_name":"host[interfaces_attributes][primary]","description":"\n\u003cp\u003eShould this interface be used for constructing the FQDN of the host? Each managed hosts needs to have one primary interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"provision","full_name":"host[interfaces_attributes][provision]","description":"\n\u003cp\u003eShould this interface be used for TFTP of PXELinux (or SSH for image-based hosts)? Each managed hosts needs to have one provision interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"username","full_name":"host[interfaces_attributes][username]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"host[interfaces_attributes][password]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider","full_name":"host[interfaces_attributes][provider]","description":"\n\u003cp\u003eInterface provider, e.g. IPMI. Only for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eIPMI\u003c/code\u003e, \u003ccode\u003eRedfish\u003c/code\u003e, \u003ccode\u003eSSH\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"virtual","full_name":"host[interfaces_attributes][virtual]","description":"\n\u003cp\u003eAlias or VLAN device\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"tag","full_name":"host[interfaces_attributes][tag]","description":"\n\u003cp\u003eVLAN tag, this attribute has precedence over the subnet VLAN ID. Only for virtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mtu","full_name":"host[interfaces_attributes][mtu]","description":"\n\u003cp\u003eMTU, this attribute has precedence over the subnet MTU.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"attached_to","full_name":"host[interfaces_attributes][attached_to]","description":"\n\u003cp\u003eIdentifier of the interface to which this interface belongs, e.g. eth1. Only for virtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mode","full_name":"host[interfaces_attributes][mode]","description":"\n\u003cp\u003eBond mode of the interface, e.g. balance-rr. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ebalance-rr\u003c/code\u003e, \u003ccode\u003eactive-backup\u003c/code\u003e, \u003ccode\u003ebalance-xor\u003c/code\u003e, \u003ccode\u003ebroadcast\u003c/code\u003e, \u003ccode\u003e802.3ad\u003c/code\u003e, \u003ccode\u003ebalance-tlb\u003c/code\u003e, \u003ccode\u003ebalance-alb\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attached_devices","full_name":"host[interfaces_attributes][attached_devices]","description":"\n\u003cp\u003eIdentifiers of attached interfaces, e.g. \u003ccode\u003e[\u0026#39;eth1\u0026#39;, \u0026#39;eth2\u0026#39;]\u003c/code\u003e. For bond interfaces those are the slaves. Only for bond and bridges interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"bond_options","full_name":"host[interfaces_attributes][bond_options]","description":"\n\u003cp\u003eSpace separated options, e.g. miimon=100. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_attributes","full_name":"host[interfaces_attributes][compute_attributes]","description":"\n\u003cp\u003eAdditional compute resource specific attributes for the interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}]},{"name":"compute_attributes","full_name":"host[compute_attributes]","description":"\n\u003cp\u003eAdditional compute resource specific attributes.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]}],"returns":[],"examples":["DELETE /api/discovered_hosts/10/auto_provision\n{\n  \"host\": {}\n}\n200\n{\n  \"id\": 10,\n  \"name\": \"macaabbccddeeff\",\n  \"last_compile\": null,\n  \"last_report\": null,\n  \"updated_at\": \"2021-05-18T11:30:43.041Z\",\n  \"created_at\": \"2021-05-18T11:30:42.549Z\",\n  \"root_pass\": \"$5$amS8bQSXPaxsCOrq$djm/ByybBRtkuotQtc9m9p0HmAzSsQisLNiyi3HHwA4\",\n  \"architecture_id\": 922134528,\n  \"operatingsystem_id\": 1073012835,\n  \"environment_id\": null,\n  \"ptable_id\": 1007981708,\n  \"medium_id\": 1011586625,\n  \"build\": true,\n  \"comment\": \"Auto-discovered and provisioned via rule 'rule13'\",\n  \"disk\": null,\n  \"installed_at\": null,\n  \"model_id\": null,\n  \"hostgroup_id\": 928644292,\n  \"owner_id\": 36826545,\n  \"owner_type\": \"User\",\n  \"enabled\": true,\n  \"puppet_ca_proxy_id\": null,\n  \"managed\": true,\n  \"use_image\": null,\n  \"image_file\": \"\",\n  \"uuid\": null,\n  \"compute_resource_id\": null,\n  \"puppet_proxy_id\": null,\n  \"certname\": \"macaabbccddeeff\",\n  \"image_id\": null,\n  \"organization_id\": 447626438,\n  \"location_id\": 255093256,\n  \"otp\": null,\n  \"realm_id\": null,\n  \"compute_profile_id\": null,\n  \"provision_method\": \"build\",\n  \"grub_pass\": \"$5$amS8bQSXPaxsCOrq$djm/ByybBRtkuotQtc9m9p0HmAzSsQisLNiyi3HHwA4\",\n  \"discovery_rule_id\": 5,\n  \"global_status\": 0,\n  \"lookup_value_matcher\": \"fqdn=macaabbccddeeff\",\n  \"openscap_proxy_id\": null,\n  \"pxe_loader\": null,\n  \"initiated_at\": null,\n  \"build_errors\": null\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/enc","name":"enc","apis":[{"api_url":"/api/hosts/:id/enc","http_method":"GET","short_description":"Get ENC values of host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/get_status","name":"get_status","apis":[{"api_url":"/api/hosts/:id/status/:type","http_method":"GET","short_description":"Get status of host","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eReturns string representing a host status of a given type\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]},{"name":"type","full_name":"type","description":"\n\u003cp\u003estatus type, can be one of * global * configuration * build\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eHostStatus::Global\u003c/code\u003e, \u003ccode\u003econfiguration\u003c/code\u003e, \u003ccode\u003ebuild\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/forget_status","name":"forget_status","apis":[{"api_url":"/api/hosts/:id/status/:type","http_method":"DELETE","short_description":"Clear sub-status of host","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eClears a host sub-status of a given type\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]},{"name":"type","full_name":"type","description":"\n\u003cp\u003estatus type\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003econfiguration\u003c/code\u003e, \u003ccode\u003ebuild\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/vm_compute_attributes","name":"vm_compute_attributes","apis":[{"api_url":"/api/hosts/:id/vm_compute_attributes","http_method":"GET","short_description":"Get vm attributes of host","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eReturn the host’s compute attributes that can be used to create a clone of this VM\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]},{"name":"power_action","full_name":"power_action","description":"\n\u003cp\u003epower action, valid actions are (on/start), (off/stop), (soft/reboot), (cycle/reset), (state/status)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["PUT /api/hosts/host96.example57.com/power\n{\n  \"power_action\": \"wrongmethod\",\n  \"host\": {}\n}\n422\n{\n  \"error\": \"Unknown power action: available methods are start, stop, poweroff, reboot, reset, soft, cycle, state, on, off, status, ready?\"\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/power_status","name":"power_status","apis":[{"api_url":"/api/hosts/:id/power","http_method":"GET","short_description":"Fetch the status of whether the host is powered on or not. Supported hosts are VMs and physical hosts with BMCs.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]},{"name":"device","full_name":"device","description":"\n\u003cp\u003eboot device, valid devices are disk, cdrom, pxe, bios\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["PUT /api/hosts/host92.example55.com/boot\n{\n  \"device\": \"bios\",\n  \"host\": {}\n}\n200\n{\n  \"boot\": \"{\\\"action\\\":\\\"bios\\\",\\\"result\\\":true}\"\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003ehostname of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"facts","full_name":"facts","description":"\n\u003cp\u003ehash containing the facts for the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"certname","full_name":"certname","description":"\n\u003cp\u003eoptional: certname of the host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"type","description":"\n\u003cp\u003eoptional: the STI type of host to create\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["POST /api/hosts/facts\n{\n  \"name\": \"brslc022.brs.infineon.com\",\n  \"certname\": \"brslc022.brs.infineon.com\",\n  \"facts\": {\n    \"is_virtual\": \"true\",\n    \"processorcount\": \"2\",\n    \"serialnumber\": \"VMware-56 4d 15 06 72 86 a9 d3-8a 09 fc 27 5a cf 00 45\",\n    \"kernel\": \"Linux\",\n    \"virtual\": \"vmware\",\n    \"_timestamp\": \"2010-02-16 12:52:38.163833 +01:00\",\n    \"network_eth0\": \"172.29.205.0\",\n    \"operatingsystemrelease\": \"4\",\n    \"uniqueid\": \"1dac16cd\",\n    \"hardwaremodel\": \"i686\",\n    \"rubysitedir\": \"/usr/lib/site_ruby/1.8\",\n    \"platform\": \"Linux_2.6_i386_all\",\n    \"uptime_seconds\": \"3756\",\n    \"lsbrelease\": \":core-3.0-ia32:core-3.0-noarch:graphics-3.0-ia32:graphics-3.0-noarch\",\n    \"memorysize\": \"1.45 GB\",\n    \"gi\": \"4\",\n    \"netmask_eth0\": \"255.255.255.128\",\n    \"ipaddress\": \"172.29.205.22\",\n    \"physicalprocessorcount\": \"0\",\n    \"swapfree\": \"1.95 GB\",\n    \"vmware\": \"virtual\",\n    \"netmask\": \"255.255.255.128\",\n    \"clientversion\": \"0.24.8\",\n    \"fqdn\": \"brslc022.brs.infineon.com\",\n    \"timezone\": \"GMT\",\n    \"ps\": \"ps -ef\",\n    \"kernelrelease\": \"2.6.9-89.0.16.ELsmp\",\n    \"hardwareisa\": \"i686\",\n    \"domain\": \"brs.infineon.com\",\n    \"type\": \"Other\",\n    \"kernelversion\": \"2.6.9\",\n    \"id\": \"root\",\n    \"lsbdistdescription\": \"Red Hat Enterprise Linux AS release 4 (Nahant Update 8)\",\n    \"uptime_hours\": \"1\",\n    \"lsbdistrelease\": \"4\",\n    \"macaddress_eth0\": \"00:0C:29:CF:00:45\",\n    \"manufacturer\": \"VMware, Inc.\",\n    \"memoryfree\": \"1.39 GB\",\n    \"selinux\": \"false\",\n    \"gateway_if\": \"eth0\",\n    \"lsbdistcodename\": \"NahantUpdate8\",\n    \"sshrsakey\": \"AAAAB3NzaC1yc2EAAAABIwAAAIEAyj0XAKzx4WlNE8Vzj0ABBEHxqHr2H4AZZnabnQkYTOfz5kObXL+BvYqPONg2EqeUYCTNaFtQQPpJ4H+TM+GCJDNvFEKJTRd+cFoOuramf9LunWN/+ETreQ5V8KhKvdYTNw5blPBKiQz/XxSxcm7beo5QiBVr/lOM0u8YhGTLawk=\",\n    \"uptime_days\": \"0\",\n    \"interfaces\": \"eth0\",\n    \"hostname\": \"brslc022\",\n    \"graphcard\": \"VMware\",\n    \"uptime\": \"1:02 hours\",\n    \"processor0\": \"Intel(R) Xeon(R) CPU           X5460  @ 3.16GHz\",\n    \"puppetversion\": \"0.24.8\",\n    \"productname\": \"VMware Virtual Platform\",\n    \"architecture\": \"i386\",\n    \"gateway\": \"172.29.205.1\",\n    \"rubyversion\": \"1.8.1\",\n    \"environment\": \"brs_test\",\n    \"path\": \"/usr/bin:/sbin:/bin:/usr/sbin:/opt/csw/bin\",\n    \"swapsize\": \"1.95 GB\",\n    \"ipaddress_eth0\": \"172.29.205.22\",\n    \"facterversion\": \"1.5.7\",\n    \"kernelmajversion\": \"2.6\",\n    \"operatingsystem\": \"RedHat\",\n    \"macaddress\": \"00:0C:29:CF:00:45\",\n    \"processor1\": \"Intel(R) Xeon(R) CPU           X5460  @ 3.16GHz\",\n    \"lsbmajdistrelease\": \"4\",\n    \"sshdsakey\": \"AAAAB3NzaC1kc3MAAACBAIUasO2eEvlRHfcO8wMPfbo98YfgVsJj0qhUDSSoSa6xmYI8QWBDMoxf1h8INiDfrNQ5e4VreLQjt4/2Ex7OXoeB7C9Cg18/TlfZU+RTNMdsL85W5hQrrKoBm+ksMnxidkDC66ROq+pmxBTGDwwxg3ugF8eZnVSzCZ1FE605AsStAAAAFQCrr3s1cLQFRc6oZJAx3EZDxDraCQAAAIBqIqIvY7KtRsI+8y8E5MSZXpRRZxf0zqbraDxASwzImUr6ysEmpJsHbHyi6UePnF55tG/iZNM4bSNg/3qExK8So040byV71qN4HNT48nIh3cCS0z8oKLqvlCRJ+dOY1QMkE8ZLfOyF4A6ZOTuE8TTsGpvUIR0HyXkpoiIR9XcgzgAAAIA4nkedBQi+VA01NvWx27GGz5P3TTQ36yDODZdLmXoepQM1rPfKWvPFFd5MxgJumSU5BKhYUiQTOImcRlQcY5DA3dGbog1dOAKlWyeJn4WRHbYr+VNgR/HwBzHLMW4TXLt38ThmPv9TiLS1RvTdHuDm2oRTadNZOrmQz619kZejmw==\",\n    \"lsbdistid\": \"RedHatEnterpriseAS\"\n  },\n  \"host\": {\n    \"certname\": \"brslc022.brs.infineon.com\",\n    \"name\": \"brslc022.brs.infineon.com\"\n  }\n}\n201\n{\n  \"id\": 95,\n  \"name\": \"brslc022.brs.infineon.com\",\n  \"last_compile\": \"2010-02-16T11:52:38.163Z\",\n  \"last_report\": null,\n  \"updated_at\": \"2021-05-18T11:52:47.009Z\",\n  \"created_at\": \"2021-05-18T11:52:46.429Z\",\n  \"root_pass\": null,\n  \"architecture_id\": 922134540,\n  \"operatingsystem_id\": 1073012846,\n  \"environment_id\": 687036940,\n  \"ptable_id\": null,\n  \"medium_id\": null,\n  \"build\": false,\n  \"comment\": null,\n  \"disk\": null,\n  \"installed_at\": null,\n  \"model_id\": 980190963,\n  \"hostgroup_id\": null,\n  \"owner_id\": null,\n  \"owner_type\": null,\n  \"enabled\": true,\n  \"puppet_ca_proxy_id\": null,\n  \"managed\": false,\n  \"use_image\": null,\n  \"image_file\": \"\",\n  \"uuid\": null,\n  \"compute_resource_id\": null,\n  \"puppet_proxy_id\": null,\n  \"certname\": \"brslc022.brs.infineon.com\",\n  \"image_id\": null,\n  \"organization_id\": 447626438,\n  \"location_id\": 255093256,\n  \"otp\": null,\n  \"realm_id\": null,\n  \"compute_profile_id\": null,\n  \"provision_method\": \"build\",\n  \"grub_pass\": \"\",\n  \"discovery_rule_id\": null,\n  \"global_status\": 0,\n  \"lookup_value_matcher\": \"fqdn=brslc022.brs.infineon.com\",\n  \"openscap_proxy_id\": null,\n  \"pxe_loader\": null,\n  \"initiated_at\": null,\n  \"build_errors\": null,\n  \"reported_data_attributes\": {\n    \"id\": 2,\n    \"host_id\": 95,\n    \"boot_time\": \"2021-05-18T10:50:10.000Z\",\n    \"created_at\": \"2021-05-18T11:52:46.956Z\",\n    \"updated_at\": \"2021-05-18T11:52:46.956Z\",\n    \"virtual\": true,\n    \"sockets\": 0,\n    \"cores\": 2,\n    \"ram\": null,\n    \"disks_total\": null\n  }\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/rebuild_config","name":"rebuild_config","apis":[{"api_url":"/api/hosts/:id/rebuild_config","http_method":"PUT","short_description":"Rebuild orchestration config","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]},{"name":"only","full_name":"only","description":"\n\u003cp\u003eLimit rebuild steps, valid steps are DHCP, DNS, TFTP\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/template","name":"template","apis":[{"api_url":"/api/hosts/:id/template/:kind","http_method":"GET","short_description":"Preview rendered provisioning template content","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]},{"name":"kind","full_name":"kind","description":"\n\u003cp\u003eTemplate kinds, available values: PXELinux, PXEGrub, PXEGrub2, iPXE, provision, finish, script, user_data, ZTP, POAP, cloud-init, host_init_config, registration, kexec, Bootdisk\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"hostgroups":{"doc_url":"../apidoc/v2/hostgroups","id":"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},{"api_url":"/api/locations/:location_id/hostgroups","http_method":"GET","short_description":"List all host groups per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/hostgroups","http_method":"GET","short_description":"List all host groups per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, ‘all’ to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"include","full_name":"include","description":"\n\u003cp\u003eArray of extra information types to include\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of [\"parameters\"]","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"architecture","type":"string"},{"name":"host","type":"string"},{"name":"id","type":"integer"},{"name":"label","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"medium","type":"string"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"os","type":"string"},{"name":"os_description","type":"string"},{"name":"os_id","type":"integer"},{"name":"os_major","type":"string"},{"name":"os_minor","type":"string"},{"name":"os_title","type":"string"},{"name":"params","type":"string"},{"name":"template","type":"string"},{"name":"title","type":"string"}]},"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]},{"name":"show_hidden_parameters","full_name":"show_hidden_parameters","description":"\n\u003cp\u003eDisplay hidden parameter values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"hostgroup","full_name":"hostgroup","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"hostgroup[name]","description":"\n\u003cp\u003eName of the host group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"hostgroup[description]","description":"\n\u003cp\u003eHost group description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parent_id","full_name":"hostgroup[parent_id]","description":"\n\u003cp\u003eParent ID of the host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_profile_id","full_name":"hostgroup[compute_profile_id]","description":"\n\u003cp\u003eCompute profile ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"hostgroup[compute_resource_id]","description":"\n\u003cp\u003eCompute resource ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"hostgroup[operatingsystem_id]","description":"\n\u003cp\u003eOperating system ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"hostgroup[architecture_id]","description":"\n\u003cp\u003eArchitecture ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"pxe_loader","full_name":"hostgroup[pxe_loader]","description":"\n\u003cp\u003eDHCP filename option (Grub2/PXELinux by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eNone\u003c/code\u003e, \u003ccode\u003ePXELinux BIOS\u003c/code\u003e, \u003ccode\u003ePXELinux UEFI\u003c/code\u003e, \u003ccode\u003eGrub UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 BIOS\u003c/code\u003e, \u003ccode\u003eGrub2 ELF\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI SecureBoot\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTP\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS SecureBoot\u003c/code\u003e, \u003ccode\u003eiPXE Embedded\u003c/code\u003e, \u003ccode\u003eiPXE UEFI HTTP\u003c/code\u003e, \u003ccode\u003eiPXE Chain BIOS\u003c/code\u003e, \u003ccode\u003eiPXE Chain UEFI\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"medium_id","full_name":"hostgroup[medium_id]","description":"\n\u003cp\u003eMedia ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ptable_id","full_name":"hostgroup[ptable_id]","description":"\n\u003cp\u003ePartition table ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"hostgroup[subnet_id]","description":"\n\u003cp\u003eSubnet ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet6_id","full_name":"hostgroup[subnet6_id]","description":"\n\u003cp\u003eSubnet IPv6 ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"hostgroup[domain_id]","description":"\n\u003cp\u003eDomain ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"realm_id","full_name":"hostgroup[realm_id]","description":"\n\u003cp\u003eRealm ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"group_parameters_attributes","full_name":"hostgroup[group_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"hostgroup[group_parameters_attributes][name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"hostgroup[group_parameters_attributes][value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"hostgroup[group_parameters_attributes][parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"hostgroup[group_parameters_attributes][hidden_value]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]},{"name":"puppet_proxy_id","full_name":"hostgroup[puppet_proxy_id]","description":"\n\u003cp\u003ePuppet proxy ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppet_ca_proxy_id","full_name":"hostgroup[puppet_ca_proxy_id]","description":"\n\u003cp\u003ePuppet CA proxy ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"root_pass","full_name":"hostgroup[root_pass]","description":"\n\u003cp\u003eRoot password on provisioned hosts\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"hostgroup[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"hostgroup[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]},{"name":"hostgroup","full_name":"hostgroup","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"hostgroup[name]","description":"\n\u003cp\u003eName of the host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"hostgroup[description]","description":"\n\u003cp\u003eHost group description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parent_id","full_name":"hostgroup[parent_id]","description":"\n\u003cp\u003eParent ID of the host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_profile_id","full_name":"hostgroup[compute_profile_id]","description":"\n\u003cp\u003eCompute profile ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"hostgroup[compute_resource_id]","description":"\n\u003cp\u003eCompute resource ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"hostgroup[operatingsystem_id]","description":"\n\u003cp\u003eOperating system ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"hostgroup[architecture_id]","description":"\n\u003cp\u003eArchitecture ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"pxe_loader","full_name":"hostgroup[pxe_loader]","description":"\n\u003cp\u003eDHCP filename option (Grub2/PXELinux by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eNone\u003c/code\u003e, \u003ccode\u003ePXELinux BIOS\u003c/code\u003e, \u003ccode\u003ePXELinux UEFI\u003c/code\u003e, \u003ccode\u003eGrub UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 BIOS\u003c/code\u003e, \u003ccode\u003eGrub2 ELF\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI SecureBoot\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTP\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS SecureBoot\u003c/code\u003e, \u003ccode\u003eiPXE Embedded\u003c/code\u003e, \u003ccode\u003eiPXE UEFI HTTP\u003c/code\u003e, \u003ccode\u003eiPXE Chain BIOS\u003c/code\u003e, \u003ccode\u003eiPXE Chain UEFI\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"medium_id","full_name":"hostgroup[medium_id]","description":"\n\u003cp\u003eMedia ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ptable_id","full_name":"hostgroup[ptable_id]","description":"\n\u003cp\u003ePartition table ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"hostgroup[subnet_id]","description":"\n\u003cp\u003eSubnet ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet6_id","full_name":"hostgroup[subnet6_id]","description":"\n\u003cp\u003eSubnet IPv6 ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"hostgroup[domain_id]","description":"\n\u003cp\u003eDomain ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"realm_id","full_name":"hostgroup[realm_id]","description":"\n\u003cp\u003eRealm ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"group_parameters_attributes","full_name":"hostgroup[group_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"hostgroup[group_parameters_attributes][name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"hostgroup[group_parameters_attributes][value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"hostgroup[group_parameters_attributes][parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"hostgroup[group_parameters_attributes][hidden_value]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]},{"name":"puppet_proxy_id","full_name":"hostgroup[puppet_proxy_id]","description":"\n\u003cp\u003ePuppet proxy ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppet_ca_proxy_id","full_name":"hostgroup[puppet_ca_proxy_id]","description":"\n\u003cp\u003ePuppet CA proxy ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"root_pass","full_name":"hostgroup[root_pass]","description":"\n\u003cp\u003eRoot password on provisioned hosts\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"hostgroup[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"hostgroup[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hostgroups/rebuild_config","name":"rebuild_config","apis":[{"api_url":"/api/hostgroups/:id/rebuild_config","http_method":"PUT","short_description":"Rebuild orchestration config","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]},{"name":"only","full_name":"only","description":"\n\u003cp\u003eLimit rebuild steps, valid steps are DHCP, DNS, TFTP\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"children_hosts","full_name":"children_hosts","description":"\n\u003cp\u003eOperate on child hostgroup hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"registration":{"doc_url":"../apidoc/v2/registration","id":"registration","api_url":"/api","name":"Registration","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/registration/global","name":"global","apis":[{"api_url":"/api/register","http_method":"GET","short_description":"Render Global registration template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the Organization to register the host in.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of the Location to register the host in.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of the Host group to register the host in.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of the Operating System to register the host in.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"setup_insights","full_name":"setup_insights","description":"\n\u003cp\u003eSet ‘host_registration_insights’ parameter for the host. If it is set to true, insights client will be installed and registered on Red Hat family operating systems.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"setup_remote_execution","full_name":"setup_remote_execution","description":"\n\u003cp\u003eSet ‘host_registration_remote_execution’ parameter for the host. If it is set to true, SSH keys will be installed on the host.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"packages","full_name":"packages","description":"\n\u003cp\u003ePackages to install on the host when registered. Can be set by \u003ccode\u003ehost_packages\u003c/code\u003e parameter. Example: \u003ccode\u003epkg1 pkg2\u003c/code\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"update_packages","full_name":"update_packages","description":"\n\u003cp\u003eUpdate all packages on the host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"repo","full_name":"repo","description":"\n\u003cp\u003eRepository URL / details, for example for Debian OS family: ‘deb http://deb.example.com/ buster 1.0’, for Red Hat OS family: ‘http://yum.theforeman.org/client/latest/el8/x86_64/’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"repo_gpg_key_url","full_name":"repo_gpg_key_url","description":"\n\u003cp\u003eURL of the GPG key for the repository\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/registration/host","name":"host","apis":[{"api_url":"/api/register","http_method":"POST","short_description":"Find or create a host and render the 'Host initial configuration' template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host","full_name":"host","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"host[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"host[location_id]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"host[organization_id]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ip","full_name":"host[ip]","description":"\n\u003cp\u003eIPv4 address, not required if using a subnet with DHCP proxy\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip6","full_name":"host[ip6]","description":"\n\u003cp\u003eIPv6 address, not required if using a subnet with DHCP proxy\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mac","full_name":"host[mac]","description":"\n\u003cp\u003erequired for managed host that is bare metal, not required if it’s a virtual machine\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"host[domain_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"host[operatingsystem_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"host[subnet_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"model_id","full_name":"host[model_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"host[hostgroup_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_parameters_attributes","full_name":"host[host_parameters_attributes]","description":"\n\u003cp\u003eHost’s parameters (array or indexed hash)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"host[host_parameters_attributes][name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"host[host_parameters_attributes][value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"host[host_parameters_attributes][parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"host[host_parameters_attributes][hidden_value]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]},{"name":"build","full_name":"host[build]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"enabled","full_name":"host[enabled]","description":"\n\u003cp\u003eInclude this host within Foreman reporting\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"managed","full_name":"host[managed]","description":"\n\u003cp\u003eTrue/False flag whether a host is managed or unmanaged. Note: this value also determines whether several parameters are required or not\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"comment","full_name":"host[comment]","description":"\n\u003cp\u003eAdditional information about this host\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"interfaces_attributes","full_name":"host[interfaces_attributes]","description":"\n\u003cp\u003eHost’s network interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"mac","full_name":"host[interfaces_attributes][mac]","description":"\n\u003cp\u003eMAC address of interface. Required for managed interfaces on bare metal.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip","full_name":"host[interfaces_attributes][ip]","description":"\n\u003cp\u003eIPv4 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip6","full_name":"host[interfaces_attributes][ip6]","description":"\n\u003cp\u003eIPv6 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"host[interfaces_attributes][type]","description":"\n\u003cp\u003eInterface type, e.g. bmc. Default is interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003einterface\u003c/code\u003e, \u003ccode\u003ebmc\u003c/code\u003e, \u003ccode\u003ebond\u003c/code\u003e, \u003ccode\u003ebridge\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"host[interfaces_attributes][name]","description":"\n\u003cp\u003eInterface’s DNS name\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"host[interfaces_attributes][subnet_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv4 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet6_id","full_name":"host[interfaces_attributes][subnet6_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv6 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"host[interfaces_attributes][domain_id]","description":"\n\u003cp\u003eForeman domain ID of interface. Required for primary interfaces on managed hosts.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"identifier","full_name":"host[interfaces_attributes][identifier]","description":"\n\u003cp\u003eDevice identifier, e.g. eth0 or eth1.1\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"managed","full_name":"host[interfaces_attributes][managed]","description":"\n\u003cp\u003eShould this interface be managed via DHCP and DNS smart proxy and should it be configured during provisioning?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"primary","full_name":"host[interfaces_attributes][primary]","description":"\n\u003cp\u003eShould this interface be used for constructing the FQDN of the host? Each managed hosts needs to have one primary interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"provision","full_name":"host[interfaces_attributes][provision]","description":"\n\u003cp\u003eShould this interface be used for TFTP of PXELinux (or SSH for image-based hosts)? Each managed hosts needs to have one provision interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"username","full_name":"host[interfaces_attributes][username]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"host[interfaces_attributes][password]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider","full_name":"host[interfaces_attributes][provider]","description":"\n\u003cp\u003eInterface provider, e.g. IPMI. Only for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eIPMI\u003c/code\u003e, \u003ccode\u003eRedfish\u003c/code\u003e, \u003ccode\u003eSSH\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"virtual","full_name":"host[interfaces_attributes][virtual]","description":"\n\u003cp\u003eAlias or VLAN device\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"tag","full_name":"host[interfaces_attributes][tag]","description":"\n\u003cp\u003eVLAN tag, this attribute has precedence over the subnet VLAN ID. Only for virtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mtu","full_name":"host[interfaces_attributes][mtu]","description":"\n\u003cp\u003eMTU, this attribute has precedence over the subnet MTU.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"attached_to","full_name":"host[interfaces_attributes][attached_to]","description":"\n\u003cp\u003eIdentifier of the interface to which this interface belongs, e.g. eth1. Only for virtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mode","full_name":"host[interfaces_attributes][mode]","description":"\n\u003cp\u003eBond mode of the interface, e.g. balance-rr. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ebalance-rr\u003c/code\u003e, \u003ccode\u003eactive-backup\u003c/code\u003e, \u003ccode\u003ebalance-xor\u003c/code\u003e, \u003ccode\u003ebroadcast\u003c/code\u003e, \u003ccode\u003e802.3ad\u003c/code\u003e, \u003ccode\u003ebalance-tlb\u003c/code\u003e, \u003ccode\u003ebalance-alb\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attached_devices","full_name":"host[interfaces_attributes][attached_devices]","description":"\n\u003cp\u003eIdentifiers of attached interfaces, e.g. \u003ccode\u003e[\u0026#39;eth1\u0026#39;, \u0026#39;eth2\u0026#39;]\u003c/code\u003e. For bond interfaces those are the slaves. Only for bond and bridges interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"bond_options","full_name":"host[interfaces_attributes][bond_options]","description":"\n\u003cp\u003eSpace separated options, e.g. miimon=100. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_attributes","full_name":"host[interfaces_attributes][compute_attributes]","description":"\n\u003cp\u003eAdditional compute resource specific attributes for the interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}]}]},{"name":"setup_insights","full_name":"setup_insights","description":"\n\u003cp\u003eSet ‘host_registration_insights’ parameter for the host. If it is set to true, insights client will be installed and registered on Red Hat family operating systems.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"setup_remote_execution","full_name":"setup_remote_execution","description":"\n\u003cp\u003eSet ‘host_registration_remote_execution’ parameter for the host. If it is set to true, SSH keys will be installed on the host.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["POST /register\n{\n  \"packages\": \"\",\n  \"host\": {\n    \"name\": \"centos-test.example.com\",\n    \"operatingsystem_id\": 1073012828\n  },\n  \"registration\": {\n    \"packages\": \"\",\n    \"host\": {\n      \"name\": \"centos-test.example.com\",\n      \"operatingsystem_id\": 1073012828\n    }\n  }\n}\n200\necho \"Linux host initial configuration\""],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"settings":{"doc_url":"../apidoc/v2/settings","id":"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, ‘all’ to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[{"code":200,"description":"List of all settings","is_array":false,"returns_object":[{"name":"results","full_name":"results","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}],"additional_properties":false}],"examples":[],"metadata":{"search":[{"name":"description","type":"text"},{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[{"code":200,"description":"Information about the setting","is_array":false,"returns_object":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eAlias for setting name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true},{"name":"name","full_name":"name","description":"\n\u003cp\u003eSetting unique name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true},{"name":"full_name","full_name":"full_name","description":"\n\u003cp\u003eSetting full user readable name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true},{"name":"category","full_name":"category","description":"\n\u003cp\u003eThe category of setting\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true},{"name":"category_name","full_name":"category_name","description":"\n\u003cp\u003eThe human readable name of settings category\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true},{"name":"settings_type","full_name":"settings_type","description":"\n\u003cp\u003eValue type, that the setting accepts\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescribes the purpose of the setting\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true},{"name":"default","full_name":"default","description":"\n\u003cp\u003eDefault value for the setting\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true},{"name":"value","full_name":"value","description":"\n\u003cp\u003eSetting current value. If this setting is encypted, the value will not be returned\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true},{"name":"readonly","full_name":"readonly","description":"\n\u003cp\u003eIs this setting readonly?\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true},{"name":"encrypted","full_name":"encrypted","description":"\n\u003cp\u003eIs this setting encrypted?\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true},{"name":"config_file","full_name":"config_file","description":"\n\u003cp\u003eIf this setting needs to be changed in file, it will have the file path.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true},{"name":"select_values","full_name":"select_values","description":"\n\u003cp\u003eIf this setting has list of possible values, this includes the list of the values.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"updated_at","full_name":"updated_at","description":"\n\u003cp\u003eLast updated. NOTE: this will be reset to application install time, when setting is reset to default value.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Time","expected_type":"string","metadata":null,"show":true}],"additional_properties":false}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"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":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"setting","full_name":"setting","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"value","full_name":"setting[value]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[{"code":200,"description":"Information about the updated setting","is_array":false,"returns_object":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eAlias for setting name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true},{"name":"name","full_name":"name","description":"\n\u003cp\u003eSetting unique name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true},{"name":"full_name","full_name":"full_name","description":"\n\u003cp\u003eSetting full user readable name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true},{"name":"category","full_name":"category","description":"\n\u003cp\u003eThe category of setting\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true},{"name":"category_name","full_name":"category_name","description":"\n\u003cp\u003eThe human readable name of settings category\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true},{"name":"settings_type","full_name":"settings_type","description":"\n\u003cp\u003eValue type, that the setting accepts\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescribes the purpose of the setting\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true},{"name":"default","full_name":"default","description":"\n\u003cp\u003eDefault value for the setting\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true},{"name":"value","full_name":"value","description":"\n\u003cp\u003eSetting current value. If this setting is encypted, the value will not be returned\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true},{"name":"readonly","full_name":"readonly","description":"\n\u003cp\u003eIs this setting readonly?\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true},{"name":"encrypted","full_name":"encrypted","description":"\n\u003cp\u003eIs this setting encrypted?\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true},{"name":"config_file","full_name":"config_file","description":"\n\u003cp\u003eIf this setting needs to be changed in file, it will have the file path.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true},{"name":"select_values","full_name":"select_values","description":"\n\u003cp\u003eIf this setting has list of possible values, this includes the list of the values.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"updated_at","full_name":"updated_at","description":"\n\u003cp\u003eLast updated. NOTE: this will be reset to application install time, when setting is reset to default value.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Time","expected_type":"string","metadata":null,"show":true}],"additional_properties":false}],"examples":["PUT /api/settings/1073209422\n{\n  \"setting\": {\n    \"value\": \"\"\n  }\n}\n422\n{\n  \"error\": {\n    \"id\": 1073209422,\n    \"errors\": {\n      \"value\": [\n        \"can't be blank\"\n      ]\n    },\n    \"full_messages\": [\n      \"Value can't be blank\"\n    ]\n  }\n}"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"webhook_templates":{"doc_url":"../apidoc/v2/webhook_templates","id":"webhook_templates","api_url":"/api","name":"Webhook templates","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/webhook_templates/index","name":"index","apis":[{"api_url":"/api/webhook_templates","http_method":"GET","short_description":"List webhook templates","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, ‘all’ to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["GET /api/webhook_templates\n200\n{\n  \"total\": 1,\n  \"subtotal\": 1,\n  \"page\": 1,\n  \"per_page\": 20,\n  \"search\": \"webhook_template8\",\n  \"sort\": {\n    \"by\": null,\n    \"order\": null\n  },\n  \"results\": [\n    {\n      \"description\": null,\n      \"created_at\": \"2021-05-18 11:27:19 UTC\",\n      \"updated_at\": \"2021-05-18 11:27:19 UTC\",\n      \"name\": \"webhook_template8\",\n      \"id\": 1007981711\n    }\n  ]\n}"],"metadata":{"search":[{"name":"default","values":["true","false"]},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"locked","values":["true","false"]},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"snippet","values":["true","false"]},{"name":"template","type":"text"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/webhook_templates/show","name":"show","apis":[{"api_url":"/api/webhook_templates/:id","http_method":"GET","short_description":"Show webhook template details","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]}],"returns":[],"examples":["GET /api/webhook_templates/1007981731-webhook_template24\n200\n{\n  \"template\": \"template content 23\",\n  \"default\": false,\n  \"snippet\": false,\n  \"locked\": false,\n  \"description\": null,\n  \"created_at\": \"2021-05-18 11:27:21 UTC\",\n  \"updated_at\": \"2021-05-18 11:27:21 UTC\",\n  \"name\": \"webhook_template24\",\n  \"id\": 1007981731,\n  \"locations\": [],\n  \"organizations\": []\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/webhook_templates/create","name":"create","apis":[{"api_url":"/api/webhook_templates","http_method":"POST","short_description":"Create a webhook template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"webhook_template","full_name":"webhook_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"webhook_template[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"webhook_template[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"webhook_template[template]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"snippet","full_name":"webhook_template[snippet]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"audit_comment","full_name":"webhook_template[audit_comment]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"locked","full_name":"webhook_template[locked]","description":"\n\u003cp\u003eWhether or not the template is locked for editing\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"default","full_name":"webhook_template[default]","description":"\n\u003cp\u003eWhether or not the template is added automatically to new organizations and locations\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"webhook_template[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"webhook_template[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":["POST /api/webhook_templates\n{\n  \"webhook_template\": {\n    \"name\": \"p\",\n    \"template\": \"a,b,c\"\n  }\n}\n201\n{\n  \"template\": \"a,b,c\",\n  \"default\": false,\n  \"snippet\": false,\n  \"locked\": false,\n  \"description\": null,\n  \"created_at\": \"2021-05-18 11:27:18 UTC\",\n  \"updated_at\": \"2021-05-18 11:27:18 UTC\",\n  \"name\": \"p\",\n  \"id\": 1007981704,\n  \"locations\": [],\n  \"organizations\": []\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/webhook_templates/import","name":"import","apis":[{"api_url":"/api/webhook_templates/import","http_method":"POST","short_description":"Import a webhook template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"webhook_template","full_name":"webhook_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"webhook_template[name]","description":"\n\u003cp\u003eTemplate name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"webhook_template[template]","description":"\n\u003cp\u003eTemplate contents including metadata\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"webhook_template[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"webhook_template[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"options","full_name":"options","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"force","full_name":"options[force]","description":"\n\u003cp\u003euse if you want update locked templates\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"associate","full_name":"options[associate]","description":"\n\u003cp\u003edetermines when the template should associate objects based on metadata, new means only when new template is being created, always means both for new and existing template which is only being updated, never ignores metadata\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003enew\u003c/code\u003e, \u003ccode\u003ealways\u003c/code\u003e, \u003ccode\u003enever\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"lock","full_name":"options[lock]","description":"\n\u003cp\u003elock imported templates (false by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"default","full_name":"options[default]","description":"\n\u003cp\u003emakes the template default meaning it will be automatically associated with newly created organizations and locations (false by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":["POST /api/webhook_templates/import\n{\n  \"webhook_template\": {\n    \"name\": \"webhook_template23\",\n    \"template\": \"b\"\n  }\n}\n201\n{\n  \"template\": \"b\",\n  \"name\": \"webhook_template23\",\n  \"id\": 1007981730,\n  \"snippet\": false,\n  \"description\": null,\n  \"template_kind_id\": null,\n  \"created_at\": \"2021-05-18T11:27:21.196Z\",\n  \"updated_at\": \"2021-05-18T11:27:21.236Z\",\n  \"locked\": false,\n  \"default\": false,\n  \"vendor\": null,\n  \"os_family\": null,\n  \"job_category\": \"Miscellaneous\",\n  \"provider_type\": null,\n  \"description_format\": null,\n  \"execution_timeout_interval\": null\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/webhook_templates/update","name":"update","apis":[{"api_url":"/api/webhook_templates/:id","http_method":"PUT","short_description":"Update a webhook template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]},{"name":"webhook_template","full_name":"webhook_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"webhook_template[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"webhook_template[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"webhook_template[template]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"snippet","full_name":"webhook_template[snippet]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"audit_comment","full_name":"webhook_template[audit_comment]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"locked","full_name":"webhook_template[locked]","description":"\n\u003cp\u003eWhether or not the template is locked for editing\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"default","full_name":"webhook_template[default]","description":"\n\u003cp\u003eWhether or not the template is added automatically to new organizations and locations\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"webhook_template[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"webhook_template[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":["PUT /api/webhook_templates/1007981713\n{\n  \"webhook_template\": {\n    \"name\": \"\"\n  }\n}\n422\n{\n  \"error\": {\n    \"id\": 1007981713,\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":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/webhook_templates/destroy","name":"destroy","apis":[{"api_url":"/api/webhook_templates/:id","http_method":"DELETE","short_description":"Delete a webhook template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]}],"returns":[],"examples":["DELETE /api/webhook_templates/1007981733-webhook_template26\n{\n  \"webhook_template\": {}\n}\n200\n{\n  \"id\": 1007981733,\n  \"name\": \"webhook_template26\",\n  \"template\": \"template content 25\",\n  \"snippet\": false,\n  \"template_kind_id\": null,\n  \"created_at\": \"2021-05-18T11:27:21.469Z\",\n  \"updated_at\": \"2021-05-18T11:27:21.469Z\",\n  \"locked\": false,\n  \"default\": false,\n  \"vendor\": null,\n  \"os_family\": null,\n  \"job_category\": \"Miscellaneous\",\n  \"provider_type\": null,\n  \"description_format\": null,\n  \"execution_timeout_interval\": null,\n  \"description\": null\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/webhook_templates/clone","name":"clone","apis":[{"api_url":"/api/webhook_templates/:id/clone","http_method":"POST","short_description":"Clone a template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]},{"name":"webhook_template","full_name":"webhook_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"webhook_template[name]","description":"\n\u003cp\u003eTemplate name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":["POST /api/webhook_templates/1007981707-webhook_template5/clone\n{\n  \"webhook_template\": {\n    \"name\": \"MyClone\"\n  }\n}\n201\n{\n  \"id\": 1007981708,\n  \"name\": \"MyClone\",\n  \"template\": \"template content 5\",\n  \"snippet\": false,\n  \"template_kind_id\": null,\n  \"created_at\": \"2021-05-18T11:27:19.213Z\",\n  \"updated_at\": \"2021-05-18T11:27:19.213Z\",\n  \"locked\": false,\n  \"default\": false,\n  \"vendor\": null,\n  \"os_family\": null,\n  \"job_category\": \"Miscellaneous\",\n  \"provider_type\": null,\n  \"description_format\": null,\n  \"execution_timeout_interval\": null,\n  \"description\": null\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/webhook_templates/export","name":"export","apis":[{"api_url":"/api/webhook_templates/:id/export","http_method":"GET","short_description":"Export a webhook template to ERB","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]}],"returns":[],"examples":["GET /api/webhook_templates/1007981710-webhook_template7/export\n200\n\u003c%#\nname: webhook_template7\nsnippet: false\nmodel: WebhookTemplate\n-%\u003e\ntemplate content 7"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"webhooks":{"doc_url":"../apidoc/v2/webhooks","id":"webhooks","api_url":"/api","name":"Webhooks","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/webhooks/index","name":"index","apis":[{"api_url":"/api/webhooks","http_method":"GET","short_description":"List Webhooks","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort and order by a searchable field, e.g. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, ‘all’ to return all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A([1-9]\\d*|all)\\Z$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["GET /api/webhooks\n200\n{\n  \"total\": 1,\n  \"subtotal\": 1,\n  \"page\": 1,\n  \"per_page\": 20,\n  \"search\": \"Webhook 5\",\n  \"sort\": {\n    \"by\": null,\n    \"order\": null\n  },\n  \"results\": [\n    {\n      \"target_url\": \"https://hook.example.com/api/callback\",\n      \"enabled\": true,\n      \"created_at\": \"2021-05-18 11:27:22 UTC\",\n      \"updated_at\": \"2021-05-18 11:27:22 UTC\",\n      \"id\": 21,\n      \"name\": \"Webhook 5\"\n    }\n  ]\n}"],"metadata":{"search":[{"name":"enabled","values":["true","false"]},{"name":"name","type":"string"},{"name":"target_url","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/webhooks/show","name":"show","apis":[{"api_url":"/api/webhooks/:id","http_method":"GET","short_description":"Show Webhook details","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]}],"returns":[],"examples":["GET /api/webhooks/18-Webhook%202\n200\n{\n  \"target_url\": \"https://hook.example.com/api/callback\",\n  \"event\": \"subnet_created.event.foreman\",\n  \"http_method\": \"POST\",\n  \"http_content_type\": \"application/json\",\n  \"enabled\": true,\n  \"verify_ssl\": true,\n  \"http_headers\": null,\n  \"ssl_ca_certs\": null,\n  \"user\": null,\n  \"created_at\": \"2021-05-18 11:27:21 UTC\",\n  \"updated_at\": \"2021-05-18 11:27:21 UTC\",\n  \"id\": 18,\n  \"name\": \"Webhook 2\",\n  \"webhook_template\": {\n    \"name\": \"webhook_template29\",\n    \"id\": 1007981736\n  }\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/webhooks/create","name":"create","apis":[{"api_url":"/api/webhooks","http_method":"POST","short_description":"Create a Webhook","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"webhook","full_name":"webhook","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"webhook[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"target_url","full_name":"webhook[target_url]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"http_method","full_name":"webhook[http_method]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ePOST\u003c/code\u003e, \u003ccode\u003eGET\u003c/code\u003e, \u003ccode\u003ePUT\u003c/code\u003e, \u003ccode\u003eDELETE\u003c/code\u003e, \u003ccode\u003ePATCH\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"http_content_type","full_name":"webhook[http_content_type]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"event","full_name":"webhook[event]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ebuild_entered\u003c/code\u003e, \u003ccode\u003ebuild_exited\u003c/code\u003e, \u003ccode\u003ecreate_rss_notifications_performed\u003c/code\u003e, \u003ccode\u003edomain_created\u003c/code\u003e, \u003ccode\u003edomain_destroyed\u003c/code\u003e, \u003ccode\u003edomain_updated\u003c/code\u003e, \u003ccode\u003ehost_created\u003c/code\u003e, \u003ccode\u003ehost_destroyed\u003c/code\u003e, \u003ccode\u003ehost_updated\u003c/code\u003e, \u003ccode\u003ehostgroup_created\u003c/code\u003e, \u003ccode\u003ehostgroup_destroyed\u003c/code\u003e, \u003ccode\u003ehostgroup_updated\u003c/code\u003e, \u003ccode\u003emodel_created\u003c/code\u003e, \u003ccode\u003emodel_destroyed\u003c/code\u003e, \u003ccode\u003emodel_updated\u003c/code\u003e, \u003ccode\u003estatus_changed\u003c/code\u003e, \u003ccode\u003estored_values_cleanup_performed\u003c/code\u003e, \u003ccode\u003esubnet_created\u003c/code\u003e, \u003ccode\u003esubnet_destroyed\u003c/code\u003e, \u003ccode\u003esubnet_updated\u003c/code\u003e, \u003ccode\u003etemplate_render_performed\u003c/code\u003e, \u003ccode\u003euser_created\u003c/code\u003e, \u003ccode\u003euser_destroyed\u003c/code\u003e, \u003ccode\u003euser_updated\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_template_id","full_name":"webhook[webhook_template_id]","description":"","required":false,"allow_nil":true,"allow_blank":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,"validations":[]},{"name":"enabled","full_name":"webhook[enabled]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"verify_ssl","full_name":"webhook[verify_ssl]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"ssl_ca_certs","full_name":"webhook[ssl_ca_certs]","description":"\n\u003cp\u003eX509 Certification Authorities concatenated in PEM format\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user","full_name":"webhook[user]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"webhook[password]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"http_headers","full_name":"webhook[http_headers]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"proxy_authorization","full_name":"webhook[proxy_authorization]","description":"\n\u003cp\u003eAuthorize with Foreman client certificate and validate smart-proxy CA from Settings\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":["POST /api/webhooks\n{\n  \"webhook\": {\n    \"name\": \"\",\n    \"event\": \"host_created.event.foreman\",\n    \"target_url\": \"https://app.example.com\"\n  }\n}\n422\n{\n  \"error\": {\n    \"id\": null,\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":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/webhooks/update","name":"update","apis":[{"api_url":"/api/webhooks/:id","http_method":"PUT","short_description":"Update a Webhook","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]},{"name":"webhook","full_name":"webhook","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"webhook[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"target_url","full_name":"webhook[target_url]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"http_method","full_name":"webhook[http_method]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ePOST\u003c/code\u003e, \u003ccode\u003eGET\u003c/code\u003e, \u003ccode\u003ePUT\u003c/code\u003e, \u003ccode\u003eDELETE\u003c/code\u003e, \u003ccode\u003ePATCH\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"http_content_type","full_name":"webhook[http_content_type]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"event","full_name":"webhook[event]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ebuild_entered\u003c/code\u003e, \u003ccode\u003ebuild_exited\u003c/code\u003e, \u003ccode\u003ecreate_rss_notifications_performed\u003c/code\u003e, \u003ccode\u003edomain_created\u003c/code\u003e, \u003ccode\u003edomain_destroyed\u003c/code\u003e, \u003ccode\u003edomain_updated\u003c/code\u003e, \u003ccode\u003ehost_created\u003c/code\u003e, \u003ccode\u003ehost_destroyed\u003c/code\u003e, \u003ccode\u003ehost_updated\u003c/code\u003e, \u003ccode\u003ehostgroup_created\u003c/code\u003e, \u003ccode\u003ehostgroup_destroyed\u003c/code\u003e, \u003ccode\u003ehostgroup_updated\u003c/code\u003e, \u003ccode\u003emodel_created\u003c/code\u003e, \u003ccode\u003emodel_destroyed\u003c/code\u003e, \u003ccode\u003emodel_updated\u003c/code\u003e, \u003ccode\u003estatus_changed\u003c/code\u003e, \u003ccode\u003estored_values_cleanup_performed\u003c/code\u003e, \u003ccode\u003esubnet_created\u003c/code\u003e, \u003ccode\u003esubnet_destroyed\u003c/code\u003e, \u003ccode\u003esubnet_updated\u003c/code\u003e, \u003ccode\u003etemplate_render_performed\u003c/code\u003e, \u003ccode\u003euser_created\u003c/code\u003e, \u003ccode\u003euser_destroyed\u003c/code\u003e, \u003ccode\u003euser_updated\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_template_id","full_name":"webhook[webhook_template_id]","description":"","required":false,"allow_nil":true,"allow_blank":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,"validations":[]},{"name":"enabled","full_name":"webhook[enabled]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"verify_ssl","full_name":"webhook[verify_ssl]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"ssl_ca_certs","full_name":"webhook[ssl_ca_certs]","description":"\n\u003cp\u003eX509 Certification Authorities concatenated in PEM format\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user","full_name":"webhook[user]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"webhook[password]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"http_headers","full_name":"webhook[http_headers]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"proxy_authorization","full_name":"webhook[proxy_authorization]","description":"\n\u003cp\u003eAuthorize with Foreman client certificate and validate smart-proxy CA from Settings\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":["PUT /api/webhooks/19-Webhook%203\n{\n  \"webhook\": {\n    \"name\": \"webhook_test\",\n    \"event\": \"host_created.event.foreman\",\n    \"target_url\": \"https://app.example.com\"\n  }\n}\n200\n{\n  \"target_url\": \"https://app.example.com\",\n  \"event\": \"host_created.event.foreman\",\n  \"http_method\": \"POST\",\n  \"http_content_type\": \"application/json\",\n  \"enabled\": true,\n  \"verify_ssl\": true,\n  \"http_headers\": null,\n  \"ssl_ca_certs\": null,\n  \"user\": null,\n  \"created_at\": \"2021-05-18 11:27:21 UTC\",\n  \"updated_at\": \"2021-05-18 11:27:21 UTC\",\n  \"id\": 19,\n  \"name\": \"webhook_test\",\n  \"webhook_template\": {\n    \"name\": \"webhook_template31\",\n    \"id\": 1007981738\n  }\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/webhooks/destroy","name":"destroy","apis":[{"api_url":"/api/webhooks/:id","http_method":"DELETE","short_description":"Delete a Webhook","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":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,"validations":[]}],"returns":[],"examples":["DELETE /api/webhooks/22-Webhook%206\n{\n  \"webhook\": {}\n}\n200\n{\n  \"id\": 22,\n  \"name\": \"Webhook 6\",\n  \"target_url\": \"https://hook.example.com/api/callback\",\n  \"events\": [\n    \"subnet_created.event.foreman\"\n  ],\n  \"created_at\": \"2021-05-18T11:27:22.091Z\",\n  \"updated_at\": \"2021-05-18T11:27:22.091Z\",\n  \"webhook_template_id\": 1007981744,\n  \"http_method\": \"POST\",\n  \"http_content_type\": \"application/json\",\n  \"enabled\": true,\n  \"verify_ssl\": true,\n  \"ssl_ca_certs\": null,\n  \"user\": null,\n  \"password\": null,\n  \"http_headers\": null,\n  \"proxy_authorization\": false\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/webhooks/events","name":"events","apis":[{"api_url":"/api/webhooks/events","http_method":"GET","short_description":"List available events for subscription","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null}},"link_extension":".en.html"}}