foreman_api 0.1.1 → 0.1.2

data/doc/top-level-namespace.html

@@ -6,7 +6,7 @@
 <title>
   Top Level Namespace
   
-    &mdash; Documentation by YARD 0.8.3
+    &mdash; Documentation by YARD 0.8.5.2
   
 </title>
 
@@ -103,9 +103,9 @@
 </div>
 
     <div id="footer">
-  Generated on Mon Jan 21 15:44:34 2013 by
+  Generated on Tue Mar 19 09:50:22 2013 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.8.3 (ruby-1.9.3).
+  0.8.5.2 (ruby-1.8.7).
 </div>
 
   </body>

data/lib/foreman_api.rb

@@ -2,19 +2,6 @@ require 'json'
 require 'yaml'
 
 module ForemanApi
-  def self.client_config
-    @client_config ||= YAML.load_file("#{root}/foreman_api/config.yml")
-  end
-
-  def self.root
-    @root ||= File.expand_path(File.dirname(__FILE__))
-  end
-
-  def self.doc
-    @doc ||= File.open("#{root}/foreman_api/documentation.json", 'r') do |f|
-      JSON.load(f.read)['docs']
-    end
-  end
 end
 
 require 'foreman_api/base'

data/lib/foreman_api/base.rb

@@ -2,14 +2,36 @@ require 'rest_client'
 require 'oauth'
 require 'json'
 require 'foreman_api/rest_client_oauth'
+require 'logger'
 
 module ForemanApi
+
+  def self.client_config
+    @client_config ||= YAML.load_file("#{root}/foreman_api/config.yml")
+  end
+
+  def self.root
+    @root ||= File.expand_path('../', File.dirname(__FILE__))
+  end
+
+  def self.doc_file
+    "#{root}/foreman_api/documentation.json"
+  end
+
+  def self.doc
+    @doc ||= File.open(doc_file, 'r') do |f|
+      JSON.load(f.read)['docs']
+    end
+  end
+
   class Base
     API_VERSION = "2"
 
-    attr_reader :client, :config
+    attr_reader :client, :config, :logger
 
     def initialize(config, options = {})
+      config = config.dup
+      self.logger = config.delete(:logger)
       @client = RestClient::Resource.new(
           config[:base_url],
           { :user     => config[:username],
@@ -21,16 +43,28 @@ module ForemanApi
       @config = config
     end
 
-    def call(method, path, params = { }, headers = { })
+    def perform_call(method_name, params, headers)
+      method_doc = self.class.method_doc(method_name)
+      check_params params, :allowed => method_doc['params'].any?, :method => method_name
+      method_apis = method_doc['apis']
+      api = find_suitable_api_call(method_apis, params)
+      url, params = fill_params_in_url api['api_url'], params
+      return http_call(api['http_method'].downcase, url, params, headers)
+    end
+
+    def http_call(http_method, path, params = { }, headers = { })
       headers ||= { }
 
-      args = [method]
-      if [:post, :put].include?(method)
+      args = [http_method]
+      if %w[post put].include?(http_method.to_s)
         args << params.to_json
       else
         headers[:params] = params if params
       end
 
+      logger.info "#{method.upcase} #{path}"
+      logger.debug "Params: #{params.inspect}"
+      logger.debug "Headers: #{headers.inspect}"
       args << headers if headers
       process_data client[path].send(*args)
     end
@@ -60,6 +94,14 @@ module ForemanApi
       end
     end
 
+    def logger=(logger)
+      if logger.nil?
+        logger = Logger.new(STDOUT)
+        logger.level = Logger::WARN
+      end
+      @logger = logger
+    end
+
     protected
 
     def process_data(response)
@@ -68,6 +110,7 @@ module ForemanApi
              rescue JSON::ParserError
                response.body
              end
+      logger.debug "Returned data: #{data.inspect}"
       return data, response
     end
 
@@ -85,12 +128,39 @@ module ForemanApi
       end
     end
 
+    # @param possible_apis [Array] Array of hasahs in form of
+    #   [{:api_url => '/path1', :http_method => 'GET'}, {...}]
+    # @param params [Hash] enterred params
+    # @return api that suits the enterred params mosts
+    #
+    # Given this paths:
+    #   1. +/comments+
+    #   2. +/users/:user_id/comments+
+    #   3. +/users/:user_id/posts/:post_id/comments+
+    #
+    # If +:user_id+ and +:post_id+ is pecified, the third path is
+    # used. If only +:user_id+ is specified, the second one is used.
+    # The selection defaults to the path with the least number of
+    # incuded params in alphanumeric order.
+    def find_suitable_api_call(possible_apis, params)
+      apis_with_params = possible_apis.map do |api|
+        [api, self.class.params_in_path(api['api_url'])]
+      end.sort_by { |api, url_params| [-1 * url_params.count, api['api_url']] }
+
+      suitable_api = apis_with_params.find do |api, url_params|
+        url_params.all? { |url_param| params.keys.map(&:to_s).include?(url_param) }
+      end
+
+      suitable_api ||= apis_with_params.last
+      return suitable_api.first
+    end
+
     # @return url and rest of the params
     def fill_params_in_url(url, params)
       params          ||= { }
       # insert param values
-      url_param_names = params_in_path(url)
-      url             = params_in_path(url).inject(url) do |url, param_name|
+      url_param_names = self.class.params_in_path(url)
+      url             = url_param_names.inject(url) do |url, param_name|
         param_value = params[param_name] or
           raise ArgumentError, "missing param '#{param_name}' in parameters"
         url.sub(":#{param_name}", param_value.to_s)
@@ -126,7 +196,7 @@ module ForemanApi
       end
     end
 
-    def params_in_path(url)
+    def self.params_in_path(url)
       url.scan(/:([^\/]*)/).map { |m| m.first }
     end
   end

data/lib/foreman_api/documentation.json

@@ -1 +1 @@
-{"docs":{"resources":{"puppetclasses":{"version":"1","methods":[{"examples":["GET /api/puppetclasses\n200\n{\n  \"base\": [\n    {\n      \"puppetclass\": {\n        \"id\": 980190962,\n        \"name\": \"base\",\n        \"lookup_keys\": [\n          {\n            \"id\": 298486374\n          }\n        ]\n      }\n    }\n  ],\n  \"apache\": [\n    {\n      \"puppetclass\": {\n        \"id\": 298486374,\n        \"name\": \"apache\",\n        \"lookup_keys\": []\n      }\n    }\n  ]\n}"],"full_description":"","see":null,"params":[{"required":false,"full_name":"search","validator":"Must be String","allow_nil":false,"description":"<p>filter results</p>\n","expected_type":"string","name":"search"},{"required":false,"full_name":"order","validator":"Must be String","allow_nil":false,"description":"<p>sort results</p>\n","expected_type":"string","name":"order"},{"required":false,"full_name":"page","validator":"Must be String","allow_nil":false,"description":"<p>paginate results</p>\n","expected_type":"string","name":"page"},{"required":false,"full_name":"per_page","validator":"Must be String","allow_nil":false,"description":"<p>number of entries per request</p>\n","expected_type":"string","name":"per_page"}],"apis":[{"http_method":"GET","short_description":"List all puppetclasses.","api_url":"/api/puppetclasses"}],"doc_url":"/apidoc/puppetclasses/index","errors":[],"formats":[],"name":"index","see_url":null},{"examples":["GET /api/puppetclasses/base\n200\n{\n  \"puppetclass\": {\n    \"id\": 980190962,\n    \"name\": \"base\",\n    \"lookup_keys\": [\n      {\n        \"lookup_key\": {\n          \"id\": 298486374,\n          \"override\": false,\n          \"default_value\": \"443\",\n          \"is_param\": false,\n          \"key\": \"ssl_port\",\n          \"required\": false,\n          \"description\": null\n        }\n      }\n    ]\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","allow_nil":false,"description":"","expected_type":"string","name":"id"}],"apis":[{"http_method":"GET","short_description":"Show a puppetclass.","api_url":"/api/puppetclasses/:id"}],"doc_url":"/apidoc/puppetclasses/show","errors":[],"formats":[],"name":"show","see_url":null},{"examples":["POST /api/puppetclasses\n{\n  \"puppetclass\": {\n    \"name\": \"test_puppetclass\"\n  }\n}\n201\n{\n  \"puppetclass\": {\n    \"id\": 980190963,\n    \"name\": \"test_puppetclass\",\n    \"lookup_keys\": []\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"puppetclass","validator":"Must be a Hash","params":[{"required":true,"full_name":"puppetclass[name]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"name"}],"allow_nil":false,"description":"","expected_type":"hash","name":"puppetclass"}],"apis":[{"http_method":"POST","short_description":"Create a puppetclass.","api_url":"/api/puppetclasses"}],"doc_url":"/apidoc/puppetclasses/create","errors":[],"formats":[],"name":"create","see_url":null},{"examples":["PUT /api/puppetclasses/base\n{\n  \"puppetclass\": {}\n}\n200\n{\n  \"puppetclass\": {\n    \"id\": 980190962,\n    \"name\": \"base\",\n    \"lookup_keys\": [\n      {\n        \"id\": 298486374\n      }\n    ]\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"id","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"id"},{"required":true,"full_name":"puppetclass","validator":"Must be a Hash","params":[{"required":false,"full_name":"puppetclass[name]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"name"}],"allow_nil":false,"description":"","expected_type":"hash","name":"puppetclass"}],"apis":[{"http_method":"PUT","short_description":"Update a puppetclass.","api_url":"/api/puppetclasses/:id"}],"doc_url":"/apidoc/puppetclasses/update","errors":[],"formats":[],"name":"update","see_url":null},{"examples":["DELETE /api/puppetclasses/base\n200\n{\n  \"puppetclass\": {\n    \"id\": 980190962,\n    \"name\": \"base\",\n    \"lookup_keys\": [\n      {\n        \"id\": 298486374\n      }\n    ]\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"id","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"id"}],"apis":[{"http_method":"DELETE","short_description":"Delete a puppetclass.","api_url":"/api/puppetclasses/:id"}],"doc_url":"/apidoc/puppetclasses/destroy","errors":[],"formats":[],"name":"destroy","see_url":null}],"full_description":"","short_description":"","doc_url":"/apidoc/puppetclasses","api_url":"/api","formats":[],"name":"Puppetclasses"},"dashboard":{"version":"1","methods":[{"examples":["GET /api/dashboard\n200\n{\n  \"bad_hosts_enabled\": 0,\n  \"disabled_hosts\": 0,\n  \"good_hosts\": 0,\n  \"ok_hosts_enabled\": 0,\n  \"bad_hosts\": 0,\n  \"percentage\": 0,\n  \"reports_missing\": 12,\n  \"good_hosts_enabled\": 0,\n  \"pending_hosts\": 0,\n  \"active_hosts\": 0,\n  \"active_hosts_ok_enabled\": 0,\n  \"out_of_sync_hosts\": 0,\n  \"total_hosts\": 12,\n  \"pending_hosts_enabled\": 0,\n  \"ok_hosts\": 0,\n  \"out_of_sync_hosts_enabled\": 0,\n  \"active_hosts_ok\": 0\n}"],"full_description":"","see":null,"params":[{"required":false,"full_name":"search","validator":"Must be String","allow_nil":false,"description":"<p>filter results</p>\n","expected_type":"string","name":"search"}],"apis":[{"http_method":"GET","short_description":"Get Dashboard results","api_url":"/api/dashboard"}],"doc_url":"/apidoc/dashboard/index","errors":[],"formats":[],"name":"index","see_url":null}],"full_description":"","short_description":"","doc_url":"/apidoc/dashboard","api_url":"/api","formats":[],"name":"Dashboard"},"common_parameters":{"version":"1","methods":[{"examples":["GET /api/common_parameters\n200\n[\n  {\n    \"common_parameter\": {\n      \"id\": 636252244,\n      \"name\": \"test\",\n      \"value\": \"myvalue\"\n    }\n  }\n]"],"full_description":"","see":null,"params":[{"required":false,"full_name":"search","validator":"Must be String","allow_nil":false,"description":"<p>filter results</p>\n","expected_type":"string","name":"search"},{"required":false,"full_name":"order","validator":"Must be String","allow_nil":false,"description":"<p>sort results</p>\n","expected_type":"string","name":"order"},{"required":false,"full_name":"page","validator":"Must be String","allow_nil":false,"description":"<p>paginate results</p>\n","expected_type":"string","name":"page"},{"required":false,"full_name":"per_page","validator":"Must be String","allow_nil":false,"description":"<p>number of entries per request</p>\n","expected_type":"string","name":"per_page"}],"apis":[{"http_method":"GET","short_description":"List all common parameters.","api_url":"/api/common_parameters"}],"doc_url":"/apidoc/common_parameters/index","errors":[],"formats":[],"name":"index","see_url":null},{"examples":["GET /api/common_parameters/636252244\n200\n{\n  \"common_parameter\": {\n    \"id\": 636252244,\n    \"name\": \"test\",\n    \"value\": \"myvalue\"\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","allow_nil":false,"description":"","expected_type":"string","name":"id"}],"apis":[{"http_method":"GET","short_description":"Show a common parameter.","api_url":"/api/common_parameters/:id"}],"doc_url":"/apidoc/common_parameters/show","errors":[],"formats":[],"name":"show","see_url":null},{"examples":["POST /api/common_parameters\n{\n  \"common_parameter\": {\n    \"name\": \"special_key\",\n    \"value\": \"123\"\n  }\n}\n200\n{\n  \"common_parameter\": {\n    \"id\": 767575239,\n    \"name\": \"special_key\",\n    \"value\": \"123\"\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"common_parameter","validator":"Must be a Hash","params":[{"required":true,"full_name":"common_parameter[name]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"name"},{"required":true,"full_name":"common_parameter[value]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"value"}],"allow_nil":false,"description":"","expected_type":"hash","name":"common_parameter"}],"apis":[{"http_method":"POST","short_description":"Create a common_parameter","api_url":"/api/common_parameters"}],"doc_url":"/apidoc/common_parameters/create","errors":[],"formats":[],"name":"create","see_url":null},{"examples":["PUT /api/common_parameters/636252244\n{\n  \"common_parameter\": {}\n}\n200\n{\n  \"common_parameter\": {\n    \"id\": 636252244,\n    \"name\": \"test\",\n    \"value\": \"myvalue\"\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","allow_nil":false,"description":"","expected_type":"string","name":"id"},{"required":true,"full_name":"common_parameter","validator":"Must be a Hash","params":[{"required":false,"full_name":"common_parameter[name]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"name"},{"required":false,"full_name":"common_parameter[value]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"value"}],"allow_nil":false,"description":"","expected_type":"hash","name":"common_parameter"}],"apis":[{"http_method":"PUT","short_description":"Update a common_parameter","api_url":"/api/common_parameters/:id"}],"doc_url":"/apidoc/common_parameters/update","errors":[],"formats":[],"name":"update","see_url":null},{"examples":["DELETE /api/common_parameters/636252244\n200\n{\n  \"common_parameter\": {\n    \"id\": 636252244,\n    \"name\": \"test\",\n    \"value\": \"myvalue\"\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","allow_nil":false,"description":"","expected_type":"string","name":"id"}],"apis":[{"http_method":"DELETE","short_description":"Delete a common_parameter","api_url":"/api/common_parameters/:id"}],"doc_url":"/apidoc/common_parameters/destroy","errors":[],"formats":[],"name":"destroy","see_url":null}],"full_description":"","short_description":"","doc_url":"/apidoc/common_parameters","api_url":"/api","formats":[],"name":"Common parameters"},"compute_resources":{"version":"1","methods":[{"examples":["GET /api/compute_resources\n200\n[\n  {\n    \"compute_resource\": {\n      \"created_at\": \"2012-12-18T15:24:42Z\",\n      \"provider\": \"Libvirt\",\n      \"id\": 367690737,\n      \"user\": \"MyString\",\n      \"url\": \"test:///default\",\n      \"description\": \"mycompute\",\n      \"name\": \"mycompute\",\n      \"updated_at\": \"2012-12-18T15:24:42Z\"\n    }\n  },\n  {\n    \"compute_resource\": {\n      \"created_at\": \"2012-12-18T15:24:42Z\",\n      \"provider\": \"Libvirt\",\n      \"id\": 980190962,\n      \"user\": \"MyString\",\n      \"url\": \"qemu://stam/system\",\n      \"description\": \"MyString\",\n      \"name\": \"MyString\",\n      \"updated_at\": \"2012-12-18T15:24:42Z\"\n    }\n  },\n  {\n    \"compute_resource\": {\n      \"created_at\": \"2012-12-18T15:24:42Z\",\n      \"provider\": \"Libvirt\",\n      \"id\": 932571420,\n      \"user\": \"MyString\",\n      \"url\": \"test:///default\",\n      \"description\": \"yourcompute\",\n      \"name\": \"yourcompute\",\n      \"updated_at\": \"2012-12-18T15:24:42Z\"\n    }\n  }\n]"],"full_description":"","see":null,"params":[{"required":false,"full_name":"search","validator":"Must be String","allow_nil":false,"description":"<p>filter results</p>\n","expected_type":"string","name":"search"},{"required":false,"full_name":"order","validator":"Must be String","allow_nil":false,"description":"<p>sort results</p>\n","expected_type":"string","name":"order"},{"required":false,"full_name":"page","validator":"Must be String","allow_nil":false,"description":"<p>paginate results</p>\n","expected_type":"string","name":"page"},{"required":false,"full_name":"per_page","validator":"Must be String","allow_nil":false,"description":"<p>number of entries per request</p>\n","expected_type":"string","name":"per_page"}],"apis":[{"http_method":"GET","short_description":"List all compute resources.","api_url":"/api/compute_resources"}],"doc_url":"/apidoc/compute_resources/index","errors":[],"formats":[],"name":"index","see_url":null},{"examples":["GET /api/compute_resources/980190962-mystring\n200\n{\n  \"compute_resource\": {\n    \"created_at\": \"2012-12-18T15:24:42Z\",\n    \"provider\": \"Libvirt\",\n    \"id\": 980190962,\n    \"user\": \"MyString\",\n    \"url\": \"qemu://stam/system\",\n    \"description\": \"MyString\",\n    \"name\": \"MyString\",\n    \"updated_at\": \"2012-12-18T15:24:42Z\"\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","allow_nil":false,"description":"","expected_type":"string","name":"id"}],"apis":[{"http_method":"GET","short_description":"Show an compute resource.","api_url":"/api/compute_resources/:id"}],"doc_url":"/apidoc/compute_resources/show","errors":[],"formats":[],"name":"show","see_url":null},{"examples":["POST /api/compute_resources\n{\n  \"compute_resource\": {\n    \"password\": \"secret\",\n    \"provider\": \"EC2\",\n    \"user\": \"user@example.com\",\n    \"name\": \"special_compute\",\n    \"region\": \"eu-west-1\"\n  }\n}\n200\n{\n  \"compute_resource\": {\n    \"created_at\": \"2012-12-18T15:24:44Z\",\n    \"provider\": \"EC2\",\n    \"id\": 980190963,\n    \"user\": \"user@example.com\",\n    \"url\": \"eu-west-1\",\n    \"description\": null,\n    \"name\": \"special_compute\",\n    \"updated_at\": \"2012-12-18T15:24:44Z\"\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"compute_resource","validator":"Must be a Hash","params":[{"required":false,"full_name":"compute_resource[name]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"name"},{"required":false,"full_name":"compute_resource[provider]","validator":"Must be String","allow_nil":false,"description":"<p>Providers include Libvirt, Ovirt, EC2, Vmware, Openstack, Rackspace</p>\n","expected_type":"string","name":"provider"},{"required":true,"full_name":"compute_resource[url]","validator":"Must be String","allow_nil":false,"description":"<p>URL for Libvirt, Ovirt, and Openstack</p>\n","expected_type":"string","name":"url"},{"required":false,"full_name":"compute_resource[description]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"description"},{"required":false,"full_name":"compute_resource[user]","validator":"Must be String","allow_nil":false,"description":"<p>Username for Ovirt, EC2, Vmware, Openstack. Access Key for EC2.</p>\n","expected_type":"string","name":"user"},{"required":false,"full_name":"compute_resource[password]","validator":"Must be String","allow_nil":false,"description":"<p>Password for Ovirt, EC2, Vmware, Openstack. Secret key for EC2</p>\n","expected_type":"string","name":"password"},{"required":false,"full_name":"compute_resource[uuid]","validator":"Must be String","allow_nil":false,"description":"<p>for Ovirt, Vmware Datacenter</p>\n","expected_type":"string","name":"uuid"},{"required":false,"full_name":"compute_resource[region]","validator":"Must be String","allow_nil":false,"description":"<p>for EC2 only</p>\n","expected_type":"string","name":"region"},{"required":false,"full_name":"compute_resource[tenant]","validator":"Must be String","allow_nil":false,"description":"<p>for Openstack only</p>\n","expected_type":"string","name":"tenant"},{"required":false,"full_name":"compute_resource[server]","validator":"Must be String","allow_nil":false,"description":"<p>for Vmware</p>\n","expected_type":"string","name":"server"}],"allow_nil":false,"description":"","expected_type":"hash","name":"compute_resource"}],"apis":[{"http_method":"POST","short_description":"Create a compute resource.","api_url":"/api/compute_resources"}],"doc_url":"/apidoc/compute_resources/create","errors":[],"formats":[],"name":"create","see_url":null},{"examples":["PUT /api/compute_resources/367690737-mycompute\n{\n  \"compute_resource\": {\n    \"description\": \"new_description\"\n  }\n}\n200\n{\n  \"compute_resource\": {\n    \"created_at\": \"2012-12-18T15:24:42Z\",\n    \"id\": 367690737,\n    \"user\": \"MyString\",\n    \"url\": \"test:///default\",\n    \"description\": \"new_description\",\n    \"name\": \"mycompute\",\n    \"attrs\": {},\n    \"updated_at\": \"2012-12-18T15:24:45Z\",\n    \"uuid\": \"mycompute\"\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"id","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"id"},{"required":true,"full_name":"compute_resource","validator":"Must be a Hash","params":[{"required":false,"full_name":"compute_resource[name]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"name"},{"required":false,"full_name":"compute_resource[provider]","validator":"Must be String","allow_nil":false,"description":"<p>Providers include Libvirt, Ovirt, EC2, Vmware, Openstack, Rackspace</p>\n","expected_type":"string","name":"provider"},{"required":false,"full_name":"compute_resource[url]","validator":"Must be String","allow_nil":false,"description":"<p>URL for Libvirt, Ovirt, and Openstack</p>\n","expected_type":"string","name":"url"},{"required":false,"full_name":"compute_resource[description]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"description"},{"required":false,"full_name":"compute_resource[user]","validator":"Must be String","allow_nil":false,"description":"<p>Username for Ovirt, EC2, Vmware, Openstack. Access Key for EC2.</p>\n","expected_type":"string","name":"user"},{"required":false,"full_name":"compute_resource[password]","validator":"Must be String","allow_nil":false,"description":"<p>Password for Ovirt, EC2, Vmware, Openstack. Secret key for EC2</p>\n","expected_type":"string","name":"password"},{"required":false,"full_name":"compute_resource[uuid]","validator":"Must be String","allow_nil":false,"description":"<p>for Ovirt, Vmware Datacenter</p>\n","expected_type":"string","name":"uuid"},{"required":false,"full_name":"compute_resource[region]","validator":"Must be String","allow_nil":false,"description":"<p>for EC2 only</p>\n","expected_type":"string","name":"region"},{"required":false,"full_name":"compute_resource[tenant]","validator":"Must be String","allow_nil":false,"description":"<p>for Openstack only</p>\n","expected_type":"string","name":"tenant"},{"required":false,"full_name":"compute_resource[server]","validator":"Must be String","allow_nil":false,"description":"<p>for Vmware</p>\n","expected_type":"string","name":"server"}],"allow_nil":false,"description":"","expected_type":"hash","name":"compute_resource"}],"apis":[{"http_method":"PUT","short_description":"Update a compute resource.","api_url":"/api/compute_resources/:id"}],"doc_url":"/apidoc/compute_resources/update","errors":[],"formats":[],"name":"update","see_url":null},{"examples":["DELETE /api/compute_resources/932571420\n200\n{\n  \"compute_resource\": {\n    \"created_at\": \"2012-12-18T15:24:42Z\",\n    \"id\": 932571420,\n    \"user\": \"MyString\",\n    \"url\": \"test:///default\",\n    \"description\": \"yourcompute\",\n    \"name\": \"yourcompute\",\n    \"attrs\": null,\n    \"updated_at\": \"2012-12-18T15:24:42Z\",\n    \"uuid\": \"yourcompute\"\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","allow_nil":false,"description":"","expected_type":"string","name":"id"}],"apis":[{"http_method":"DELETE","short_description":"Delete a compute resource.","api_url":"/api/compute_resources/:id"}],"doc_url":"/apidoc/compute_resources/destroy","errors":[],"formats":[],"name":"destroy","see_url":null}],"full_description":"","short_description":"","doc_url":"/apidoc/compute_resources","api_url":"/api","formats":[],"name":"Compute resources"},"audits":{"version":"1","methods":[{"examples":["GET /api/audits\n200\n[\n  {\n    \"audit\": {\n      \"associated_type\": \"Host\",\n      \"created_at\": \"2009-12-14T08:01:17Z\",\n      \"comment\": null,\n      \"associated_id\": 272,\n      \"id\": 1,\n      \"audited_changes\": {\n        \"architecture_id\": [\n          10463,\n          10466\n        ]\n      },\n      \"associated_name\": null,\n      \"user_type\": null,\n      \"auditable_type\": \"Host\",\n      \"user_id\": null,\n      \"version\": 1,\n      \"action\": \"update\",\n      \"remote_address\": null,\n      \"auditable_id\": 0,\n      \"auditable_name\": null\n    }\n  }\n]"],"full_description":"","see":null,"params":[{"required":false,"full_name":"search","validator":"Must be String","allow_nil":false,"description":"<p>filter results</p>\n","expected_type":"string","name":"search"},{"required":false,"full_name":"order","validator":"Must be String","allow_nil":false,"description":"<p>sort results</p>\n","expected_type":"string","name":"order"},{"required":false,"full_name":"page","validator":"Must be String","allow_nil":false,"description":"<p>paginate results</p>\n","expected_type":"string","name":"page"},{"required":false,"full_name":"per_page","validator":"Must be String","allow_nil":false,"description":"<p>number of entries per request</p>\n","expected_type":"string","name":"per_page"}],"apis":[{"http_method":"GET","short_description":"List all audits.","api_url":"/api/audits"}],"doc_url":"/apidoc/audits/index","errors":[],"formats":[],"name":"index","see_url":null},{"examples":["GET /api/audits/1\n200\n{\n  \"audit\": {\n    \"associated_type\": \"Host\",\n    \"created_at\": \"2009-12-14T08:01:17Z\",\n    \"comment\": null,\n    \"associated_id\": 272,\n    \"id\": 1,\n    \"audited_changes\": {\n      \"architecture_id\": [\n        10463,\n        10466\n      ]\n    },\n    \"associated_name\": null,\n    \"user_type\": null,\n    \"auditable_type\": \"Host\",\n    \"user_id\": null,\n    \"version\": 1,\n    \"action\": \"update\",\n    \"remote_address\": null,\n    \"auditable_id\": 0,\n    \"auditable_name\": null\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","allow_nil":false,"description":"","expected_type":"string","name":"id"}],"apis":[{"http_method":"GET","short_description":"Show an audit","api_url":"/api/audits/:id"}],"doc_url":"/apidoc/audits/show","errors":[],"formats":[],"name":"show","see_url":null}],"full_description":"","short_description":"","doc_url":"/apidoc/audits","api_url":"/api","formats":[],"name":"Audits"},"reports":{"version":"1","methods":[{"examples":["GET /api/reports\n200\n[\n  {\n    \"report\": {\n      \"id\": 70219655,\n      \"status\": {\n        \"restarted\": 0,\n        \"pending\": 0,\n        \"skipped\": 0,\n        \"failed\": 0,\n        \"applied\": 0,\n        \"failed_restarts\": 0\n      },\n      \"summary\": \"Success\",\n      \"metrics\": {\n        \"time\": {\n          \"mailalias\": 0.000283,\n          \"cron\": 0.000419,\n          \"package\": 0.003989,\n          \"service\": 0.149739,\n          \"file\": 0.007025,\n          \"exec\": 0.000299,\n          \"schedule\": 0.00083,\n          \"filebucket\": 0.000171,\n          \"config_retrieval\": 16.3637869358063\n        },\n        \"resources\": {\n          \"total\": 33\n        },\n        \"events\": {\n          \"total\": 0\n        },\n        \"changes\": {}\n      },\n      \"logs\": [],\n      \"reported_at\": \"2012-12-11T15:24:42Z\"\n    }\n  }\n]"],"full_description":"","see":null,"params":[{"required":false,"full_name":"search","validator":"Must be String","allow_nil":false,"description":"<p>filter results</p>\n","expected_type":"string","name":"search"},{"required":false,"full_name":"order","validator":"Must be String","allow_nil":false,"description":"<p>sort results</p>\n","expected_type":"string","name":"order"},{"required":false,"full_name":"page","validator":"Must be String","allow_nil":false,"description":"<p>paginate results</p>\n","expected_type":"string","name":"page"},{"required":false,"full_name":"per_page","validator":"Must be String","allow_nil":false,"description":"<p>number of entries per request</p>\n","expected_type":"string","name":"per_page"}],"apis":[{"http_method":"GET","short_description":"List all reports.","api_url":"/api/reports"}],"doc_url":"/apidoc/reports/index","errors":[],"formats":[],"name":"index","see_url":null},{"examples":["GET /api/reports/70219655\n200\n{\n  \"report\": {\n    \"id\": 70219655,\n    \"status\": {\n      \"restarted\": 0,\n      \"pending\": 0,\n      \"skipped\": 0,\n      \"failed\": 0,\n      \"applied\": 0,\n      \"failed_restarts\": 0\n    },\n    \"summary\": \"Success\",\n    \"metrics\": {\n      \"time\": {\n        \"mailalias\": 0.000283,\n        \"cron\": 0.000419,\n        \"package\": 0.003989,\n        \"service\": 0.149739,\n        \"file\": 0.007025,\n        \"exec\": 0.000299,\n        \"schedule\": 0.00083,\n        \"filebucket\": 0.000171,\n        \"config_retrieval\": 16.3637869358063\n      },\n      \"resources\": {\n        \"total\": 33\n      },\n      \"events\": {\n        \"total\": 0\n      },\n      \"changes\": {}\n    },\n    \"logs\": [],\n    \"reported_at\": \"2012-12-11T15:24:42Z\"\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","allow_nil":false,"description":"","expected_type":"string","name":"id"}],"apis":[{"http_method":"GET","short_description":"Show a report.","api_url":"/api/reports/:id"}],"doc_url":"/apidoc/reports/show","errors":[],"formats":[],"name":"show","see_url":null},{"examples":["DELETE /api/reports/70219655\n200\n{\n  \"report\": {\n    \"id\": 70219655,\n    \"status\": {\n      \"restarted\": 0,\n      \"pending\": 0,\n      \"skipped\": 0,\n      \"failed\": 0,\n      \"applied\": 0,\n      \"failed_restarts\": 0\n    },\n    \"summary\": \"Success\",\n    \"host\": \"my5name.mydomain.net\",\n    \"metrics\": {\n      \"time\": {\n        \"mailalias\": 0.000283,\n        \"cron\": 0.000419,\n        \"package\": 0.003989,\n        \"service\": 0.149739,\n        \"file\": 0.007025,\n        \"exec\": 0.000299,\n        \"schedule\": 0.00083,\n        \"filebucket\": 0.000171,\n        \"config_retrieval\": 16.3637869358063\n      },\n      \"resources\": {\n        \"total\": 33\n      },\n      \"events\": {\n        \"total\": 0\n      },\n      \"changes\": {}\n    },\n    \"logs\": [],\n    \"reported_at\": \"2012-12-11T15:24:42Z\"\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"id","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"id"}],"apis":[{"http_method":"DELETE","short_description":"Delete a report.","api_url":"/api/ptables/:id"}],"doc_url":"/apidoc/reports/destroy","errors":[],"formats":[],"name":"destroy","see_url":null}],"full_description":"","short_description":"","doc_url":"/apidoc/reports","api_url":"/api","formats":[],"name":"Reports"},"users":{"version":"1","methods":[{"examples":["GET /api/users\n200\n[\n  {\n    \"user\": {\n      \"mail\": \"admin@someware.com\",\n      \"created_at\": \"2012-12-18T15:24:42Z\",\n      \"id\": 135138680,\n      \"firstname\": \"Admin\",\n      \"compute_resources_andor\": \"or\",\n      \"domains_andor\": \"or\",\n      \"last_login_on\": \"2009-10-12T21:50:04Z\",\n      \"lastname\": \"User\",\n      \"role_id\": null,\n      \"facts_andor\": \"or\",\n      \"hostgroups_andor\": \"or\",\n      \"auth_source_id\": 980190962,\n      \"login\": \"admin\",\n      \"admin\": true,\n      \"updated_at\": \"2012-12-18T15:24:42Z\",\n      \"filter_on_owner\": null\n    }\n  },\n  {\n    \"user\": {\n      \"mail\": \"apiadmin@someware.com\",\n      \"created_at\": \"2012-12-18T15:24:42Z\",\n      \"id\": 886836129,\n      \"firstname\": \"apiadmin\",\n      \"compute_resources_andor\": \"or\",\n      \"domains_andor\": \"or\",\n      \"last_login_on\": \"2009-10-12T21:50:04Z\",\n      \"lastname\": \"User\",\n      \"role_id\": null,\n      \"facts_andor\": \"or\",\n      \"hostgroups_andor\": \"or\",\n      \"auth_source_id\": 200482051,\n      \"login\": \"apiadmin\",\n      \"admin\": true,\n      \"updated_at\": \"2012-12-18T15:24:42Z\",\n      \"filter_on_owner\": null\n    }\n  },\n  {\n    \"user\": {\n      \"mail\": \"userone@someware.com\",\n      \"created_at\": \"2012-12-18T15:24:42Z\",\n      \"id\": 980190962,\n      \"firstname\": \"One\",\n      \"compute_resources_andor\": \"or\",\n      \"domains_andor\": \"or\",\n      \"last_login_on\": \"2009-10-12T21:50:04Z\",\n      \"lastname\": \"User\",\n      \"role_id\": null,\n      \"facts_andor\": \"or\",\n      \"hostgroups_andor\": \"or\",\n      \"auth_source_id\": 980190962,\n      \"login\": \"one\",\n      \"admin\": false,\n      \"updated_at\": \"2012-12-18T15:24:42Z\",\n      \"filter_on_owner\": null\n    }\n  },\n  {\n    \"user\": {\n      \"mail\": \"testuser@someware.com\",\n      \"created_at\": \"2012-12-18T15:24:42Z\",\n      \"id\": 200482051,\n      \"firstname\": \"test\",\n      \"compute_resources_andor\": \"or\",\n      \"domains_andor\": \"or\",\n      \"last_login_on\": \"2009-10-12T21:50:04Z\",\n      \"lastname\": \"User\",\n      \"role_id\": null,\n      \"facts_andor\": \"or\",\n      \"hostgroups_andor\": \"or\",\n      \"auth_source_id\": 200482051,\n      \"login\": \"test\",\n      \"admin\": false,\n      \"updated_at\": \"2012-12-18T15:24:42Z\",\n      \"filter_on_owner\": null\n    }\n  },\n  {\n    \"user\": {\n      \"mail\": \"usertwo@someware.com\",\n      \"created_at\": \"2012-12-18T15:24:42Z\",\n      \"id\": 298486374,\n      \"firstname\": \"Two\",\n      \"compute_resources_andor\": \"or\",\n      \"domains_andor\": \"or\",\n      \"last_login_on\": \"2009-10-12T21:50:04Z\",\n      \"lastname\": \"User\",\n      \"role_id\": null,\n      \"facts_andor\": \"or\",\n      \"hostgroups_andor\": \"or\",\n      \"auth_source_id\": 980190962,\n      \"login\": \"two\",\n      \"admin\": false,\n      \"updated_at\": \"2012-12-18T15:24:42Z\",\n      \"filter_on_owner\": null\n    }\n  }\n]"],"full_description":"","see":null,"params":[{"required":false,"full_name":"search","validator":"Must be String","allow_nil":false,"description":"<p>filter results</p>\n","expected_type":"string","name":"search"},{"required":false,"full_name":"order","validator":"Must be String","allow_nil":false,"description":"<p>sort results</p>\n","expected_type":"string","name":"order"},{"required":false,"full_name":"page","validator":"Must be String","allow_nil":false,"description":"<p>paginate results</p>\n","expected_type":"string","name":"page"},{"required":false,"full_name":"per_page","validator":"Must be String","allow_nil":false,"description":"<p>number of entries per request</p>\n","expected_type":"string","name":"per_page"}],"apis":[{"http_method":"GET","short_description":"List all users.","api_url":"/api/users"}],"doc_url":"/apidoc/users/index","errors":[],"formats":[],"name":"index","see_url":null},{"examples":["GET /api/users/980190962-one\n200\n{\n  \"user\": {\n    \"mail\": \"userone@someware.com\",\n    \"created_at\": \"2012-12-18T15:24:42Z\",\n    \"id\": 980190962,\n    \"firstname\": \"One\",\n    \"compute_resources_andor\": \"or\",\n    \"domains_andor\": \"or\",\n    \"last_login_on\": \"2009-10-12T21:50:04Z\",\n    \"lastname\": \"User\",\n    \"role_id\": null,\n    \"facts_andor\": \"or\",\n    \"hostgroups_andor\": \"or\",\n    \"auth_source_id\": 980190962,\n    \"login\": \"one\",\n    \"admin\": false,\n    \"updated_at\": \"2012-12-18T15:24:42Z\",\n    \"auth_source_ldap\": {\n      \"onthefly_register\": true,\n      \"created_at\": \"2012-12-18T15:24:43Z\",\n      \"base_dn\": \"dn=x,dn=y\",\n      \"attr_mail\": \"mail\",\n      \"id\": 980190962,\n      \"type\": \"AuthSourceLdap\",\n      \"attr_lastname\": \"sn\",\n      \"tls\": true,\n      \"port\": 123,\n      \"attr_firstname\": \"givenName\",\n      \"host\": \"ldap\",\n      \"name\": \"ldap\",\n      \"account\": null,\n      \"updated_at\": \"2012-12-18T15:24:43Z\",\n      \"attr_login\": \"uid\"\n    },\n    \"roles\": [\n      {\n        \"role\": {\n          \"permissions\": [\n            \"view_architectures\",\n            \"view_audit_logs\",\n            \"view_authenticators\",\n            \"access_dashboard\",\n            \"view_domains\",\n            \"view_environments\",\n            \"view_external_variables\",\n            \"view_facts\",\n            \"view_globals\",\n            \"view_hostgroups\",\n            \"view_hosts\",\n            \"view_locations\",\n            \"view_media\",\n            \"view_models\",\n            \"view_operatingsystems\",\n            \"view_ptables\",\n            \"view_puppetclasses\",\n            \"view_reports\",\n            \"access_settings\",\n            \"view_statistics\",\n            \"view_organizations\",\n            \"view_usergroups\",\n            \"view_users\"\n          ],\n          \"id\": 5,\n          \"name\": \"Viewer\",\n          \"builtin\": 0\n        }\n      },\n      {\n        \"role\": {\n          \"permissions\": [\n            \"view_hosts\"\n          ],\n          \"id\": 7,\n          \"name\": \"Anonymous\",\n          \"builtin\": 2\n        }\n      }\n    ],\n    \"filter_on_owner\": null\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"id","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"id"}],"apis":[{"http_method":"GET","short_description":"Show an user.","api_url":"/api/users/:id"}],"doc_url":"/apidoc/users/show","errors":[],"formats":[],"name":"show","see_url":null},{"examples":[],"full_description":"<p>Adds role &#39;Anonymous&#39; to the user by default</p>\n","see":null,"params":[{"required":true,"full_name":"user","validator":"Must be a Hash","params":[{"required":true,"full_name":"user[login]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"login"},{"required":false,"full_name":"user[firstname]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"firstname"},{"required":false,"full_name":"user[lastname]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"lastname"},{"required":true,"full_name":"user[mail]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"mail"},{"required":false,"full_name":"user[admin]","validator":"Must be 'true' or 'false'","allow_nil":false,"description":"<p>Is an admin account?</p>\n","expected_type":"string","name":"admin"},{"required":true,"full_name":"user[password]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"password"},{"required":true,"full_name":"user[auth_source_id]","validator":"Must be Integer","allow_nil":false,"description":"","expected_type":"numeric","name":"auth_source_id"}],"allow_nil":false,"description":"","expected_type":"hash","name":"user"}],"apis":[{"http_method":"POST","short_description":"Create an user.","api_url":"/api/users"}],"doc_url":"/apidoc/users/create","errors":[],"formats":[],"name":"create","see_url":null},{"examples":["PUT /api/users/980190963\n{\n  \"user\": {\n    \"password\": \"dummy\",\n    \"password_confirmation\": \"DUMMY\",\n    \"login\": \"johnsmith\"\n  }\n}\n422\n{\n  \"user\": {\n    \"errors\": {\n      \"password\": [\n        \"doesn't match confirmation\"\n      ]\n    },\n    \"id\": 980190963,\n    \"full_messages\": [\n      \"Password doesn't match confirmation\"\n    ]\n  }\n}"],"full_description":"<p>Adds role &#39;Anonymous&#39; to the user if it is not already present.\nOnly admin can set admin account.</p>\n","see":null,"params":[{"required":true,"full_name":"id","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"id"},{"required":true,"full_name":"user","validator":"Must be a Hash","params":[{"required":false,"full_name":"user[login]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"login"},{"required":false,"full_name":"user[firstname]","validator":"Must be String","allow_nil":true,"description":"","expected_type":"string","name":"firstname"},{"required":false,"full_name":"user[lastname]","validator":"Must be String","allow_nil":true,"description":"","expected_type":"string","name":"lastname"},{"required":false,"full_name":"user[mail]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"mail"},{"required":false,"full_name":"user[admin]","validator":"Must be 'true' or 'false'","allow_nil":false,"description":"<p>Is an admin account?</p>\n","expected_type":"string","name":"admin"},{"required":false,"full_name":"user[password]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"password"}],"allow_nil":false,"description":"","expected_type":"hash","name":"user"}],"apis":[{"http_method":"PUT","short_description":"Update an user.","api_url":"/api/users/:id"}],"doc_url":"/apidoc/users/update","errors":[],"formats":[],"name":"update","see_url":null},{"examples":["DELETE /api/users/980190962\n200\n{\n  \"user\": {\n    \"password_salt\": null,\n    \"mail\": \"userone@someware.com\",\n    \"created_at\": \"2012-12-18T15:24:42Z\",\n    \"password_hash\": null,\n    \"id\": 980190962,\n    \"organizations_andor\": \"or\",\n    \"firstname\": \"One\",\n    \"compute_resources_andor\": \"or\",\n    \"domains_andor\": \"or\",\n    \"last_login_on\": \"2009-10-12T21:50:04Z\",\n    \"lastname\": \"User\",\n    \"role_id\": null,\n    \"facts_andor\": \"or\",\n    \"hostgroups_andor\": \"or\",\n    \"auth_source_id\": 980190962,\n    \"locations_andor\": \"or\",\n    \"login\": \"one\",\n    \"admin\": false,\n    \"updated_at\": \"2012-12-18T15:24:42Z\",\n    \"filter_on_owner\": null\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"id","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"id"}],"apis":[{"http_method":"DELETE","short_description":"Delete an user.","api_url":"/api/users/:id"}],"doc_url":"/apidoc/users/destroy","errors":[],"formats":[],"name":"destroy","see_url":null}],"full_description":"","short_description":"","doc_url":"/apidoc/users","api_url":"/api","formats":[],"name":"Users"},"usergroups":{"version":"1","methods":[{"examples":["GET /api/usergroups\n200\n[\n  {\n    \"usergroup\": {\n      \"created_at\": \"2012-12-18T15:24:43Z\",\n      \"id\": 980190962,\n      \"name\": \"MyString\",\n      \"updated_at\": \"2012-12-18T15:24:43Z\"\n    }\n  },\n  {\n    \"usergroup\": {\n      \"created_at\": \"2012-12-18T15:24:43Z\",\n      \"id\": 298486374,\n      \"name\": \"MyString2\",\n      \"updated_at\": \"2012-12-18T15:24:43Z\"\n    }\n  }\n]"],"full_description":"","see":null,"params":[{"required":false,"full_name":"page","validator":"Must be String","allow_nil":false,"description":"<p>paginate results</p>\n","expected_type":"string","name":"page"},{"required":false,"full_name":"per_page","validator":"Must be String","allow_nil":false,"description":"<p>number of entries per request</p>\n","expected_type":"string","name":"per_page"}],"apis":[{"http_method":"GET","short_description":"List all usergroups.","api_url":"/api/usergroups"}],"doc_url":"/apidoc/usergroups/index","errors":[],"formats":[],"name":"index","see_url":null},{"examples":["GET /api/usergroups/980190962\n200\n{\n  \"usergroup\": {\n    \"created_at\": \"2012-12-18T15:24:43Z\",\n    \"id\": 980190962,\n    \"name\": \"MyString\",\n    \"updated_at\": \"2012-12-18T15:24:43Z\"\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","allow_nil":false,"description":"","expected_type":"string","name":"id"}],"apis":[{"http_method":"GET","short_description":"Show a usergroup.","api_url":"/api/usergroups/:id"}],"doc_url":"/apidoc/usergroups/show","errors":[],"formats":[],"name":"show","see_url":null},{"examples":["POST /api/usergroups\n{\n  \"usergroup\": {\n    \"name\": \"test_usergroup\"\n  }\n}\n201\n{\n  \"usergroup\": {\n    \"id\": 980190963,\n    \"name\": \"test_usergroup\"\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"usergroup","validator":"Must be a Hash","params":[{"required":true,"full_name":"usergroup[name]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"name"}],"allow_nil":false,"description":"","expected_type":"hash","name":"usergroup"}],"apis":[{"http_method":"POST","short_description":"Create a usergroup.","api_url":"/api/usergroups"}],"doc_url":"/apidoc/usergroups/create","errors":[],"formats":[],"name":"create","see_url":null},{"examples":["PUT /api/usergroups/980190962\n{\n  \"usergroup\": {}\n}\n200\n{\n  \"usergroup\": {\n    \"id\": 980190962,\n    \"name\": \"MyString\"\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"id","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"id"},{"required":true,"full_name":"usergroup","validator":"Must be a Hash","params":[{"required":false,"full_name":"usergroup[name]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"name"}],"allow_nil":false,"description":"","expected_type":"hash","name":"usergroup"}],"apis":[{"http_method":"PUT","short_description":"Update a usergroup.","api_url":"/api/usergroups/:id"}],"doc_url":"/apidoc/usergroups/update","errors":[],"formats":[],"name":"update","see_url":null},{"examples":["DELETE /api/usergroups/980190962\n200\n{\n  \"usergroup\": {\n    \"id\": 980190962,\n    \"name\": \"MyString\"\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"id","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"id"}],"apis":[{"http_method":"DELETE","short_description":"Delete a usergroup.","api_url":"/api/usergroups/:id"}],"doc_url":"/apidoc/usergroups/destroy","errors":[],"formats":[],"name":"destroy","see_url":null}],"full_description":"","short_description":"","doc_url":"/apidoc/usergroups","api_url":"/api","formats":[],"name":"Usergroups"},"config_templates":{"version":"1","methods":[{"examples":["GET /api/config_templates\n200\n[\n  {\n    \"config_template\": {\n      \"snippet\": null,\n      \"template\": \"default linux~label linux~kernel <%= @kernel %>~append initrd=<%= @initrd %> ks=<%= foreman_url(\\\"kickstart\\\")%> ksdevice=bootif network kssendmac\",\n      \"id\": 1007981701,\n      \"template_kind\": {\n        \"id\": 452984334,\n        \"name\": \"PXELinux\"\n      },\n      \"name\": \"centos5_3_pxelinux\",\n      \"audit_comment\": null\n    }\n  },\n  {\n    \"config_template\": {\n      \"snippet\": null,\n      \"template\": \"MyFinish\",\n      \"id\": 104314179,\n      \"template_kind\": {\n        \"id\": 550103832,\n        \"name\": \"finish\"\n      },\n      \"name\": \"MyFinish\",\n      \"audit_comment\": null\n    }\n  },\n  {\n    \"config_template\": {\n      \"snippet\": null,\n      \"template\": \"MyText\",\n      \"id\": 981457253,\n      \"template_kind\": {\n        \"id\": 478250810,\n        \"name\": \"script\"\n      },\n      \"name\": \"MyScript\",\n      \"audit_comment\": null\n    }\n  },\n  {\n    \"config_template\": {\n      \"snippet\": null,\n      \"template\": \"MyText\",\n      \"id\": 943779058,\n      \"template_kind\": {\n        \"id\": 158998239,\n        \"name\": \"gPXE\"\n      },\n      \"name\": \"MyString\",\n      \"audit_comment\": null\n    }\n  },\n  {\n    \"config_template\": {\n      \"snippet\": null,\n      \"template\": \"MyText\",\n      \"id\": 269958254,\n      \"template_kind\": {\n        \"id\": 983253650,\n        \"name\": \"provision\"\n      },\n      \"name\": \"MyString2\",\n      \"audit_comment\": null\n    }\n  },\n  {\n    \"config_template\": {\n      \"snippet\": null,\n      \"template\": \"default linux~label linux~kernel <%= @kernel %>~append initrd=<%= @initrd %> ksdevice=bootif network kssendmac\",\n      \"id\": 352050261,\n      \"template_kind\": {\n        \"id\": 452984334,\n        \"name\": \"PXELinux\"\n      },\n      \"name\": \"PXE Default File\",\n      \"audit_comment\": null\n    }\n  },\n  {\n    \"config_template\": {\n      \"snippet\": null,\n      \"template\": \"FOO\",\n      \"id\": 684651467,\n      \"\": null,\n      \"name\": \"PXE Default Menu\",\n      \"audit_comment\": null\n    }\n  },\n  {\n    \"config_template\": {\n      \"snippet\": null,\n      \"template\": \"DEFAULT menu~PROMPT 0~MENU TITLE PXE Menu~TIMEOUT 200~TOTALTIMEOUT 6000~ONTIMEOUT local~~LABEL local~MENU LABEL (local)~MENU DEFAULT~LOCALBOOT 0\",\n      \"id\": 821548108,\n      \"template_kind\": {\n        \"id\": 452984334,\n        \"name\": \"PXELinux\"\n      },\n      \"name\": \"PXE Localboot Default\",\n      \"audit_comment\": null\n    }\n  }\n]"],"full_description":"","see":null,"params":[{"required":false,"full_name":"search","validator":"Must be String","allow_nil":false,"description":"<p>filter results</p>\n","expected_type":"string","name":"search"},{"required":false,"full_name":"order","validator":"Must be String","allow_nil":false,"description":"<p>sort results</p>\n","expected_type":"string","name":"order"},{"required":false,"full_name":"page","validator":"Must be String","allow_nil":false,"description":"<p>paginate results</p>\n","expected_type":"string","name":"page"},{"required":false,"full_name":"per_page","validator":"Must be String","allow_nil":false,"description":"<p>number of entries per request</p>\n","expected_type":"string","name":"per_page"}],"apis":[{"http_method":"GET","short_description":"List templates","api_url":"/api/config_templates"}],"doc_url":"/apidoc/config_templates/index","errors":[],"formats":[],"name":"index","see_url":null},{"examples":["GET /api/config_templates/centos5_3_pxelinux\n200\n{\n  \"config_template\": {\n    \"snippet\": null,\n    \"template\": \"default linux~label linux~kernel <%= @kernel %>~append initrd=<%= @initrd %> ks=<%= foreman_url(\\\"kickstart\\\")%> ksdevice=bootif network kssendmac\",\n    \"id\": 1007981701,\n    \"template_kind\": {\n      \"id\": 452984334,\n      \"name\": \"PXELinux\"\n    },\n    \"name\": \"centos5_3_pxelinux\",\n    \"audit_comment\": null\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","allow_nil":false,"description":"","expected_type":"string","name":"id"}],"apis":[{"http_method":"GET","short_description":"Show template details","api_url":"/api/config_templates/:id"}],"doc_url":"/apidoc/config_templates/show","errors":[],"formats":[],"name":"show","see_url":null},{"examples":["POST /api/config_templates\n{\n  \"config_template\": {\n    \"template\": \"This is a test template\",\n    \"template_kind_id\": 1,\n    \"name\": \"RandomName\"\n  }\n}\n200\n{\n  \"config_template\": {\n    \"snippet\": null,\n    \"template\": \"This is a test template\",\n    \"id\": 1007981702,\n    \"\": null,\n    \"name\": \"RandomName\",\n    \"audit_comment\": null\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"config_template","validator":"Must be a Hash","params":[{"required":true,"full_name":"config_template[name]","validator":"Must be String","allow_nil":false,"description":"<p>template name</p>\n","expected_type":"string","name":"name"},{"required":true,"full_name":"config_template[template]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"template"},{"required":false,"full_name":"config_template[snippet]","validator":"Must be 'true' or 'false'","allow_nil":true,"description":"","expected_type":"string","name":"snippet"},{"required":false,"full_name":"config_template[audit_comment]","validator":"Must be String","allow_nil":true,"description":"","expected_type":"string","name":"audit_comment"},{"required":false,"full_name":"config_template[template_kind_id]","validator":"Must be a number.","allow_nil":true,"description":"<p>not relevant for snippet</p>\n","expected_type":"string","name":"template_kind_id"},{"required":false,"full_name":"config_template[template_combinations_attributes]","validator":"Must be Array","allow_nil":false,"description":"<p>Array of template combinations (hostgroup<em>id, environment</em>id)</p>\n","expected_type":"string","name":"template_combinations_attributes"},{"required":false,"full_name":"config_template[operatingsystem_ids]","validator":"Must be Array","allow_nil":false,"description":"<p>Array of operating systems ID to associate the template with</p>\n","expected_type":"string","name":"operatingsystem_ids"}],"allow_nil":false,"description":"","expected_type":"hash","name":"config_template"}],"apis":[{"http_method":"POST","short_description":"Create a template","api_url":"/api/config_templates"}],"doc_url":"/apidoc/config_templates/create","errors":[],"formats":[],"name":"create","see_url":null},{"examples":["PUT /api/config_templates/centos5_3_pxelinux\n{\n  \"config_template\": {\n    \"template\": \"tmp\",\n    \"audit_comment\": \"aha\"\n  }\n}\n200\n{\n  \"config_template\": {\n    \"snippet\": null,\n    \"template\": \"tmp\",\n    \"id\": 1007981701,\n    \"template_kind\": {\n      \"id\": 452984334,\n      \"name\": \"PXELinux\"\n    },\n    \"name\": \"centos5_3_pxelinux\"\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","allow_nil":false,"description":"","expected_type":"string","name":"id"},{"required":true,"full_name":"config_template","validator":"Must be a Hash","params":[{"required":false,"full_name":"config_template[name]","validator":"Must be String","allow_nil":false,"description":"<p>template name</p>\n","expected_type":"string","name":"name"},{"required":false,"full_name":"config_template[template]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"template"},{"required":false,"full_name":"config_template[snippet]","validator":"Must be 'true' or 'false'","allow_nil":false,"description":"","expected_type":"string","name":"snippet"},{"required":false,"full_name":"config_template[audit_comment]","validator":"Must be String","allow_nil":true,"description":"","expected_type":"string","name":"audit_comment"},{"required":false,"full_name":"config_template[template_kind_id]","validator":"Must be a number.","allow_nil":true,"description":"<p>not relevant for snippet</p>\n","expected_type":"string","name":"template_kind_id"},{"required":false,"full_name":"config_template[template_combinations_attributes]","validator":"Must be Array","allow_nil":false,"description":"<p>Array of template combinations (hostgroup<em>id, environment</em>id)</p>\n","expected_type":"string","name":"template_combinations_attributes"},{"required":false,"full_name":"config_template[operatingsystem_ids]","validator":"Must be Array","allow_nil":false,"description":"<p>Array of operating systems ID to associate the template with</p>\n","expected_type":"string","name":"operatingsystem_ids"}],"allow_nil":false,"description":"","expected_type":"hash","name":"config_template"}],"apis":[{"http_method":"PUT","short_description":"Update a template","api_url":"/api/config_templates/:id"}],"doc_url":"/apidoc/config_templates/update","errors":[],"formats":[],"name":"update","see_url":null},{"examples":[],"full_description":"","see":null,"params":[{"required":false,"full_name":"version","validator":"Must be String","allow_nil":false,"description":"<p>template version</p>\n","expected_type":"string","name":"version"}],"apis":[{"http_method":"GET","short_description":null,"api_url":"/api/config_templates/revision"}],"doc_url":"/apidoc/config_templates/revision","errors":[],"formats":[],"name":"revision","see_url":null},{"examples":["DELETE /api/config_templates/centos5_3_pxelinux\n200\n{\n  \"config_template\": {\n    \"snippet\": null,\n    \"template\": \"default linux~label linux~kernel <%= @kernel %>~append initrd=<%= @initrd %> ks=<%= foreman_url(\\\"kickstart\\\")%> ksdevice=bootif network kssendmac\",\n    \"id\": 1007981701,\n    \"template_kind\": {\n      \"id\": 452984334,\n      \"name\": \"PXELinux\"\n    },\n    \"name\": \"centos5_3_pxelinux\"\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","allow_nil":false,"description":"","expected_type":"string","name":"id"}],"apis":[{"http_method":"DELETE","short_description":"Delete a template","api_url":"/api/config_templates/:id"}],"doc_url":"/apidoc/config_templates/destroy","errors":[],"formats":[],"name":"destroy","see_url":null},{"examples":["GET /api/config_templates/build_pxe_default\n200\nPXE Default file has been deployed to all Smart Proxies"],"full_description":"","see":null,"params":[],"apis":[{"http_method":"GET","short_description":"Change the default PXE menu on all configured TFTP servers","api_url":"/api/config_templates/build_pxe_default"}],"doc_url":"/apidoc/config_templates/build_pxe_default","errors":[],"formats":[],"name":"build_pxe_default","see_url":null}],"full_description":"","short_description":"","doc_url":"/apidoc/config_templates","api_url":"/api","formats":[],"name":"Config templates"},"hosts":{"version":"1","methods":[{"examples":["GET /api/hosts\n200\n[\n  {\n    \"host\": {\n      \"id\": 55602819,\n      \"hostgroup_id\": null,\n      \"operatingsystem_id\": 1073012828,\n      \"name\": \"anotherfullhost\"\n    }\n  },\n  {\n    \"host\": {\n      \"id\": 219245707,\n      \"hostgroup_id\": null,\n      \"operatingsystem_id\": 1073012828,\n      \"name\": \"dhcp.mydomain.net\"\n    }\n  },\n  {\n    \"host\": {\n      \"id\": 980190962,\n      \"hostgroup_id\": null,\n      \"operatingsystem_id\": 1073012828,\n      \"name\": \"my5name.mydomain.net\"\n    }\n  },\n  {\n    \"host\": {\n      \"id\": 1053842695,\n      \"hostgroup_id\": null,\n      \"operatingsystem_id\": 309172073,\n      \"name\": \"myfullname.mydomain.net\"\n    }\n  },\n  {\n    \"host\": {\n      \"id\": 661942085,\n      \"hostgroup_id\": null,\n      \"operatingsystem_id\": 1073012828,\n      \"name\": \"otherfullhost\"\n    }\n  },\n  {\n    \"host\": {\n      \"id\": 500757383,\n      \"hostgroup_id\": null,\n      \"operatingsystem_id\": 1073012828,\n      \"name\": \"sdhcp.mydomain.net\"\n    }\n  },\n  {\n    \"host\": {\n      \"id\": 715054938,\n      \"hostgroup_id\": null,\n      \"operatingsystem_id\": 442321401,\n      \"name\": \"sol10host\"\n    }\n  },\n  {\n    \"host\": {\n      \"id\": 859751735,\n      \"hostgroup_id\": null,\n      \"operatingsystem_id\": 859751735,\n      \"name\": \"suse01.yourdomain.net\"\n    }\n  },\n  {\n    \"host\": {\n      \"id\": 1011586618,\n      \"hostgroup_id\": null,\n      \"operatingsystem_id\": 331303656,\n      \"name\": \"temp-01.yourdomain.net\"\n    }\n  },\n  {\n    \"host\": {\n      \"id\": 1073012828,\n      \"hostgroup_id\": null,\n      \"operatingsystem_id\": 1073012828,\n      \"name\": \"temp01.yourdomain.net\"\n    }\n  },\n  {\n    \"host\": {\n      \"id\": 3666571,\n      \"hostgroup_id\": null,\n      \"operatingsystem_id\": 331303656,\n      \"name\": \"temp-02.useless.net\"\n    }\n  },\n  {\n    \"host\": {\n      \"id\": 298486374,\n      \"hostgroup_id\": null,\n      \"operatingsystem_id\": 309172073,\n      \"name\": \"temp.yourdomain.net\"\n    }\n  }\n]"],"full_description":"","see":null,"params":[{"required":false,"full_name":"search","validator":"Must be String","allow_nil":false,"description":"<p>Filter results</p>\n","expected_type":"string","name":"search"},{"required":false,"full_name":"order","validator":"Must be String","allow_nil":false,"description":"<p>Sort results</p>\n","expected_type":"string","name":"order"},{"required":false,"full_name":"page","validator":"Must be String","allow_nil":false,"description":"<p>paginate results</p>\n","expected_type":"string","name":"page"},{"required":false,"full_name":"per_page","validator":"Must be String","allow_nil":false,"description":"<p>number of entries per request</p>\n","expected_type":"string","name":"per_page"}],"apis":[{"http_method":"GET","short_description":"List all hosts.","api_url":"/api/hosts"}],"doc_url":"/apidoc/hosts/index","errors":[],"formats":[],"name":"index","see_url":null},{"examples":["GET /api/hosts/my5name.mydomain.net\n200\n{\n  \"host\": {\n    \"subnet_id\": 980190962,\n    \"created_at\": \"2012-12-18T15:24:43Z\",\n    \"sp_subnet_id\": null,\n    \"comment\": null,\n    \"use_image\": null,\n    \"id\": 980190962,\n    \"ip\": \"2.3.4.1\",\n    \"last_report\": null,\n    \"sp_ip\": \"\",\n    \"compute_resource_id\": 980190962,\n    \"image_id\": null,\n    \"architecture_id\": 501905019,\n    \"managed\": true,\n    \"ptable_id\": 980190962,\n    \"owner_id\": null,\n    \"disk\": null,\n    \"hostgroup_id\": null,\n    \"build\": false,\n    \"enabled\": true,\n    \"installed_at\": null,\n    \"owner_type\": null,\n    \"puppet_proxy_id\": 182953976,\n    \"operatingsystem_id\": 1073012828,\n    \"mac\": \"aabbCCddeeee\",\n    \"environment\": {\n      \"environment\": {\n        \"id\": 334344675,\n        \"name\": \"production\"\n      }\n    },\n    \"model_id\": null,\n    \"certname\": \"my5name.mydomain.net\",\n    \"image_file\": \"\",\n    \"environment_id\": 334344675,\n    \"sp_name\": \"\",\n    \"name\": \"my5name.mydomain.net\",\n    \"host_parameters\": [\n      {\n        \"host_parameter\": {\n          \"created_at\": \"2012-12-18T15:24:43Z\",\n          \"id\": 254219264,\n          \"reference_id\": 980190962,\n          \"priority\": 4,\n          \"name\": \"host1\",\n          \"updated_at\": \"2012-12-18T15:24:43Z\",\n          \"value\": \"host1\"\n        }\n      }\n    ],\n    \"domain_id\": 22495316,\n    \"sp_mac\": \"\",\n    \"puppet_ca_proxy_id\": null,\n    \"updated_at\": \"2012-12-18T15:24:43Z\",\n    \"uuid\": null,\n    \"medium_id\": null\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","allow_nil":false,"description":"","expected_type":"string","name":"id"}],"apis":[{"http_method":"GET","short_description":"Show a host.","api_url":"/api/hosts/:id"}],"doc_url":"/apidoc/hosts/show","errors":[],"formats":[],"name":"show","see_url":null},{"examples":["POST /api/hosts\n{\n  \"host\": {\n    \"ip\": \"10.0.0.20\",\n    \"architecture_id\": 501905019,\n    \"puppet_proxy_id\": 7,\n    \"operatingsystem_id\": 1073012828,\n    \"mac\": \"52:53:00:1e:85:93\",\n    \"environment_id\": 334344675,\n    \"name\": \"testhost11\",\n    \"domain_id\": 22495316\n  }\n}\n200\n{\n  \"host\": {\n    \"subnet_id\": null,\n    \"created_at\": \"2012-12-18T15:24:48Z\",\n    \"sp_subnet_id\": null,\n    \"comment\": null,\n    \"use_image\": null,\n    \"ip\": \"10.0.0.20\",\n    \"id\": 1073012829,\n    \"last_report\": null,\n    \"sp_ip\": \"\",\n    \"image_id\": null,\n    \"compute_resource_id\": null,\n    \"architecture_id\": 501905019,\n    \"managed\": true,\n    \"ptable_id\": null,\n    \"owner_id\": 886836129,\n    \"disk\": null,\n    \"hostgroup_id\": null,\n    \"build\": false,\n    \"enabled\": true,\n    \"installed_at\": null,\n    \"owner_type\": \"User\",\n    \"puppet_proxy_id\": 7,\n    \"operatingsystem_id\": 1073012828,\n    \"mac\": \"52:53:00:1e:85:93\",\n    \"environment\": {\n      \"environment\": {\n        \"id\": 334344675,\n        \"name\": \"production\"\n      }\n    },\n    \"model_id\": null,\n    \"certname\": \"fcfce82c-33d1-4565-843a-4f58ff8e371a\",\n    \"image_file\": \"\",\n    \"environment_id\": 334344675,\n    \"sp_name\": \"\",\n    \"host_parameters\": [],\n    \"name\": \"testhost11.mydomain.net\",\n    \"domain_id\": 22495316,\n    \"sp_mac\": \"\",\n    \"puppet_ca_proxy_id\": null,\n    \"updated_at\": \"2012-12-18T15:24:48Z\",\n    \"uuid\": null,\n    \"medium_id\": null\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"host","validator":"Must be a Hash","params":[{"required":true,"full_name":"host[name]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"name"},{"required":true,"full_name":"host[environment_id]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"environment_id"},{"required":false,"full_name":"host[ip]","validator":"Must be String","allow_nil":false,"description":"<p>not required if using a subnet with dhcp proxy</p>\n","expected_type":"string","name":"ip"},{"required":false,"full_name":"host[mac]","validator":"Must be String","allow_nil":false,"description":"<p>not required if its a virtual machine</p>\n","expected_type":"string","name":"mac"},{"required":true,"full_name":"host[architecture_id]","validator":"Must be a number.","allow_nil":false,"description":"","expected_type":"string","name":"architecture_id"},{"required":true,"full_name":"host[domain_id]","validator":"Must be a number.","allow_nil":false,"description":"","expected_type":"string","name":"domain_id"},{"required":true,"full_name":"host[puppet_proxy_id]","validator":"Must be a number.","allow_nil":false,"description":"","expected_type":"string","name":"puppet_proxy_id"},{"required":true,"full_name":"host[operatingsystem_id]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"operatingsystem_id"},{"required":false,"full_name":"host[medium_id]","validator":"Must be a number.","allow_nil":false,"description":"","expected_type":"string","name":"medium_id"},{"required":false,"full_name":"host[ptable_id]","validator":"Must be a number.","allow_nil":false,"description":"","expected_type":"string","name":"ptable_id"},{"required":false,"full_name":"host[subnet_id]","validator":"Must be a number.","allow_nil":false,"description":"","expected_type":"string","name":"subnet_id"},{"required":false,"full_name":"host[sp_subnet_id]","validator":"Must be a number.","allow_nil":false,"description":"","expected_type":"string","name":"sp_subnet_id"},{"required":false,"full_name":"host[model_id_id]","validator":"Must be a number.","allow_nil":false,"description":"","expected_type":"string","name":"model_id_id"},{"required":false,"full_name":"host[hostgroup_id]","validator":"Must be a number.","allow_nil":false,"description":"","expected_type":"string","name":"hostgroup_id"},{"required":false,"full_name":"host[owner_id]","validator":"Must be a number.","allow_nil":false,"description":"","expected_type":"string","name":"owner_id"},{"required":false,"full_name":"host[puppet_ca_proxy_id]","validator":"Must be a number.","allow_nil":false,"description":"","expected_type":"string","name":"puppet_ca_proxy_id"},{"required":false,"full_name":"host[image_id]","validator":"Must be a number.","allow_nil":false,"description":"","expected_type":"string","name":"image_id"},{"required":false,"full_name":"host[host_parameters_attributes]","validator":"Must be Array","allow_nil":false,"description":"","expected_type":"string","name":"host_parameters_attributes"}],"allow_nil":false,"description":"","expected_type":"hash","name":"host"}],"apis":[{"http_method":"POST","short_description":"Create a host.","api_url":"/api/hosts"}],"doc_url":"/apidoc/hosts/create","errors":[],"formats":[],"name":"create","see_url":null},{"examples":["PUT /api/hosts/temp.yourdomain.net\n{\n  \"host\": {}\n}\n200\n{\n  \"host\": {\n    \"puppet_status\": 0,\n    \"subnet_id\": 980190962,\n    \"created_at\": \"2012-12-18T15:24:43Z\",\n    \"sp_subnet_id\": null,\n    \"comment\": null,\n    \"location_id\": null,\n    \"use_image\": null,\n    \"id\": 298486374,\n    \"ip\": \"2.3.4.5\",\n    \"last_report\": null,\n    \"serial\": null,\n    \"sp_ip\": \"\",\n    \"architecture_id\": 501905019,\n    \"compute_resource_id\": 980190962,\n    \"image_id\": null,\n    \"managed\": null,\n    \"ptable_id\": 980190962,\n    \"owner_id\": 886836129,\n    \"last_compile\": null,\n    \"last_freshcheck\": null,\n    \"disk\": null,\n    \"hostgroup_id\": null,\n    \"build\": false,\n    \"root_pass\": \"xybxa6JUkz63w\",\n    \"enabled\": true,\n    \"installed_at\": null,\n    \"owner_type\": \"User\",\n    \"puppet_proxy_id\": 182953976,\n    \"operatingsystem_id\": 309172073,\n    \"mac\": \"aa:bb:cc:dd:ee:ff\",\n    \"environment\": {\n      \"environment\": {\n        \"id\": 334344675,\n        \"name\": \"production\"\n      }\n    },\n    \"model_id\": null,\n    \"certname\": \"temp.yourdomain.net\",\n    \"image_file\": \"\",\n    \"environment_id\": 334344675,\n    \"organization_id\": null,\n    \"name\": \"temp.yourdomain.net\",\n    \"sp_name\": \"\",\n    \"domain_id\": 589326610,\n    \"puppet_ca_proxy_id\": null,\n    \"sp_mac\": \"\",\n    \"source_file_id\": null,\n    \"updated_at\": \"2012-12-18T15:24:48Z\",\n    \"uuid\": null,\n    \"medium_id\": 980190962\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","allow_nil":false,"description":"","expected_type":"string","name":"id"},{"required":true,"full_name":"host","validator":"Must be a Hash","params":[{"required":false,"full_name":"host[name]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"name"},{"required":false,"full_name":"host[environment_id]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"environment_id"},{"required":false,"full_name":"host[ip]","validator":"Must be String","allow_nil":false,"description":"<p>not required if using a subnet with dhcp proxy</p>\n","expected_type":"string","name":"ip"},{"required":false,"full_name":"host[mac]","validator":"Must be String","allow_nil":false,"description":"<p>not required if its a virtual machine</p>\n","expected_type":"string","name":"mac"},{"required":false,"full_name":"host[architecture_id]","validator":"Must be a number.","allow_nil":false,"description":"","expected_type":"string","name":"architecture_id"},{"required":false,"full_name":"host[domain_id]","validator":"Must be a number.","allow_nil":false,"description":"","expected_type":"string","name":"domain_id"},{"required":false,"full_name":"host[puppet_proxy_id]","validator":"Must be a number.","allow_nil":false,"description":"","expected_type":"string","name":"puppet_proxy_id"},{"required":false,"full_name":"host[operatingsystem_id]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"operatingsystem_id"},{"required":false,"full_name":"host[medium_id]","validator":"Must be a number.","allow_nil":false,"description":"","expected_type":"string","name":"medium_id"},{"required":false,"full_name":"host[ptable_id]","validator":"Must be a number.","allow_nil":false,"description":"","expected_type":"string","name":"ptable_id"},{"required":false,"full_name":"host[subnet_id]","validator":"Must be a number.","allow_nil":false,"description":"","expected_type":"string","name":"subnet_id"},{"required":false,"full_name":"host[sp_subnet_id]","validator":"Must be a number.","allow_nil":false,"description":"","expected_type":"string","name":"sp_subnet_id"},{"required":false,"full_name":"host[model_id_id]","validator":"Must be a number.","allow_nil":false,"description":"","expected_type":"string","name":"model_id_id"},{"required":false,"full_name":"host[hostgroup_id]","validator":"Must be a number.","allow_nil":false,"description":"","expected_type":"string","name":"hostgroup_id"},{"required":false,"full_name":"host[owner_id]","validator":"Must be a number.","allow_nil":false,"description":"","expected_type":"string","name":"owner_id"},{"required":false,"full_name":"host[puppet_ca_proxy_id]","validator":"Must be a number.","allow_nil":false,"description":"","expected_type":"string","name":"puppet_ca_proxy_id"},{"required":false,"full_name":"host[image_id]","validator":"Must be a number.","allow_nil":false,"description":"","expected_type":"string","name":"image_id"},{"required":false,"full_name":"host[host_parameters_attributes]","validator":"Must be Array","allow_nil":false,"description":"","expected_type":"string","name":"host_parameters_attributes"}],"allow_nil":false,"description":"","expected_type":"hash","name":"host"}],"apis":[{"http_method":"PUT","short_description":"Update a host.","api_url":"/api/hosts/:id"}],"doc_url":"/apidoc/hosts/update","errors":[],"formats":[],"name":"update","see_url":null},{"examples":["DELETE /api/hosts/my5name.mydomain.net\n200\n{\n  \"host\": {\n    \"puppet_status\": 0,\n    \"subnet_id\": 980190962,\n    \"created_at\": \"2012-12-18T15:24:43Z\",\n    \"sp_subnet_id\": null,\n    \"comment\": null,\n    \"location_id\": null,\n    \"use_image\": null,\n    \"id\": 980190962,\n    \"ip\": \"2.3.4.1\",\n    \"last_report\": null,\n    \"serial\": null,\n    \"sp_ip\": \"\",\n    \"architecture_id\": 501905019,\n    \"compute_resource_id\": 980190962,\n    \"image_id\": null,\n    \"managed\": true,\n    \"ptable_id\": 980190962,\n    \"owner_id\": null,\n    \"last_compile\": null,\n    \"last_freshcheck\": null,\n    \"disk\": null,\n    \"hostgroup_id\": null,\n    \"build\": false,\n    \"root_pass\": \"xybxa6JUkz63w\",\n    \"enabled\": true,\n    \"installed_at\": null,\n    \"owner_type\": null,\n    \"puppet_proxy_id\": 182953976,\n    \"operatingsystem_id\": 1073012828,\n    \"mac\": \"aabbCCddeeee\",\n    \"environment\": {\n      \"environment\": {\n        \"id\": 334344675,\n        \"name\": \"production\"\n      }\n    },\n    \"model_id\": null,\n    \"certname\": \"my5name.mydomain.net\",\n    \"image_file\": \"\",\n    \"environment_id\": 334344675,\n    \"organization_id\": null,\n    \"name\": \"my5name.mydomain.net\",\n    \"sp_name\": \"\",\n    \"domain_id\": 22495316,\n    \"puppet_ca_proxy_id\": null,\n    \"sp_mac\": \"\",\n    \"source_file_id\": null,\n    \"updated_at\": \"2012-12-18T15:24:43Z\",\n    \"uuid\": null,\n    \"medium_id\": null\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","allow_nil":false,"description":"","expected_type":"string","name":"id"}],"apis":[{"http_method":"DELETE","short_description":"Delete an host.","api_url":"/api/hosts/:id"}],"doc_url":"/apidoc/hosts/destroy","errors":[],"formats":[],"name":"destroy","see_url":null},{"examples":["GET /api/hosts/my5name.mydomain.net/status\n200\n{\n  \"status\": \"missing\"\n}"],"full_description":"<p>Return value may either be one of the following:</p>\n\n<ul>\n<li>missing</li>\n<li>failed</li>\n<li>pending</li>\n<li>changed</li>\n<li>unchanged</li>\n<li>unreported</li>\n</ul>\n","see":null,"params":[{"required":true,"full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","allow_nil":false,"description":"","expected_type":"string","name":"id"}],"apis":[{"http_method":"GET","short_description":"Get status of host","api_url":"/api/hosts/:id/status"}],"doc_url":"/apidoc/hosts/status","errors":[],"formats":[],"name":"status","see_url":null}],"full_description":"","short_description":"","doc_url":"/apidoc/hosts","api_url":"/api","formats":[],"name":"Hosts"},"domains":{"version":"1","methods":[{"examples":["GET /api/domains\n200\n[\n  {\n    \"domain\": {\n      \"created_at\": \"2012-12-18T15:24:43Z\",\n      \"dns_id\": 113629430,\n      \"id\": 22495316,\n      \"fullname\": null,\n      \"name\": \"mydomain.net\",\n      \"updated_at\": \"2012-12-18T15:24:43Z\"\n    }\n  },\n  {\n    \"domain\": {\n      \"created_at\": \"2012-12-18T15:24:43Z\",\n      \"dns_id\": 113629430,\n      \"id\": 759776763,\n      \"fullname\": \"somewhare that is never used\",\n      \"name\": \"unused.net\",\n      \"updated_at\": \"2012-12-18T15:24:43Z\"\n    }\n  },\n  {\n    \"domain\": {\n      \"created_at\": \"2012-12-18T15:24:43Z\",\n      \"dns_id\": null,\n      \"id\": 229305443,\n      \"fullname\": null,\n      \"name\": \"useless.net\",\n      \"updated_at\": \"2012-12-18T15:24:43Z\"\n    }\n  },\n  {\n    \"domain\": {\n      \"created_at\": \"2012-12-18T15:24:43Z\",\n      \"dns_id\": 113629430,\n      \"id\": 589326610,\n      \"fullname\": \"somewhere in yourdomain\",\n      \"name\": \"yourdomain.net\",\n      \"updated_at\": \"2012-12-18T15:24:43Z\"\n    }\n  }\n]"],"full_description":"","see":null,"params":[{"required":false,"full_name":"search","validator":"Must be String","allow_nil":false,"description":"<p>Filter results</p>\n","expected_type":"string","name":"search"},{"required":false,"full_name":"order","validator":"Must be String","allow_nil":false,"description":"<p>Sort results</p>\n","expected_type":"string","name":"order"},{"required":false,"full_name":"page","validator":"Must be String","allow_nil":false,"description":"<p>paginate results</p>\n","expected_type":"string","name":"page"},{"required":false,"full_name":"per_page","validator":"Must be String","allow_nil":false,"description":"<p>number of entries per request</p>\n","expected_type":"string","name":"per_page"}],"apis":[{"http_method":"GET","short_description":"List of domains","api_url":"/api/domains"}],"doc_url":"/apidoc/domains/index","errors":[],"formats":[],"name":"index","see_url":null},{"examples":["GET /api/domains/mydomain.net\n200\n{\n  \"domain\": {\n    \"created_at\": \"2012-12-18T15:24:43Z\",\n    \"dns_id\": 113629430,\n    \"id\": 22495316,\n    \"fullname\": null,\n    \"name\": \"mydomain.net\",\n    \"updated_at\": \"2012-12-18T15:24:43Z\"\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","allow_nil":false,"description":"<p>May be numerical id or domain name</p>\n","expected_type":"string","name":"id"}],"apis":[{"http_method":"GET","short_description":"Show a domain.","api_url":"/api/domains/:id"}],"doc_url":"/apidoc/domains/show","errors":[],"formats":[],"name":"show","see_url":null},{"examples":["POST /api/domains\n{\n  \"domain\": {\n    \"name\": \"domain.net\"\n  }\n}\n201\n{\n  \"domain\": {\n    \"id\": 759776764,\n    \"name\": \"domain.net\"\n  }\n}"],"full_description":"<p>The <b>fullname</b> field is used for human readability in reports\nand other pages that refer to domains, and also available as\nan external node parameter</p>\n","see":null,"params":[{"required":true,"full_name":"domain","validator":"Must be a Hash","params":[{"required":true,"full_name":"domain[name]","validator":"Must be String","allow_nil":false,"description":"<p>The full DNS Domain name</p>\n","expected_type":"string","name":"name"},{"required":false,"full_name":"domain[fullname]","validator":"Must be String","allow_nil":true,"description":"<p>Full name describing the domain</p>\n","expected_type":"string","name":"fullname"},{"required":false,"full_name":"domain[dns_id]","validator":"Must be a number.","allow_nil":true,"description":"<p>DNS Proxy to use within this domain</p>\n","expected_type":"string","name":"dns_id"},{"required":false,"full_name":"domain[domain_parameters_attributes]","validator":"Must be Array","allow_nil":false,"description":"<p>Array of parameters (name, value)</p>\n","expected_type":"string","name":"domain_parameters_attributes"}],"allow_nil":false,"description":"","expected_type":"hash","name":"domain"}],"apis":[{"http_method":"POST","short_description":"Create a domain.","api_url":"/api/domains"}],"doc_url":"/apidoc/domains/create","errors":[],"formats":[],"name":"create","see_url":null},{"examples":["PUT /api/domains/mydomain.net\n{\n  \"domain\": {\n    \"name\": \"\"\n  }\n}\n422\n{\n  \"domain\": {\n    \"errors\": {\n      \"name\": [\n        \"can't be blank\"\n      ]\n    },\n    \"id\": 22495316,\n    \"full_messages\": [\n      \"Name can't be blank\"\n    ]\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","allow_nil":false,"description":"","expected_type":"string","name":"id"},{"required":true,"full_name":"domain","validator":"Must be a Hash","params":[{"required":false,"full_name":"domain[name]","validator":"Must be String","allow_nil":true,"description":"<p>The full DNS Domain name</p>\n","expected_type":"string","name":"name"},{"required":false,"full_name":"domain[fullname]","validator":"Must be String","allow_nil":true,"description":"<p>Full name describing the domain</p>\n","expected_type":"string","name":"fullname"},{"required":false,"full_name":"domain[dns_id]","validator":"Must be a number.","allow_nil":true,"description":"<p>DNS Proxy to use within this domain</p>\n","expected_type":"string","name":"dns_id"},{"required":false,"full_name":"domain[domain_parameters_attributes]","validator":"Must be Array","allow_nil":false,"description":"<p>Array of parameters (name, value)</p>\n","expected_type":"string","name":"domain_parameters_attributes"}],"allow_nil":false,"description":"","expected_type":"hash","name":"domain"}],"apis":[{"http_method":"PUT","short_description":"Update a domain.","api_url":"/api/domains/:id"}],"doc_url":"/apidoc/domains/update","errors":[],"formats":[],"name":"update","see_url":null},{"examples":["DELETE /api/domains/mydomain.net\n200\n{\n  \"domain\": {\n    \"id\": 22495316,\n    \"name\": \"mydomain.net\"\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","allow_nil":false,"description":"","expected_type":"string","name":"id"}],"apis":[{"http_method":"DELETE","short_description":"Delete a domain.","api_url":"/api/domains/:id"}],"doc_url":"/apidoc/domains/destroy","errors":[],"formats":[],"name":"destroy","see_url":null}],"full_description":"<p>Foreman considers a domain and a DNS zone as the same thing. That is, if you\nare planning to manage a site where all the machines are or the form\n<i>hostname</i>.<b>somewhere.com</b> then the domain is <b>somewhere.com</b>.\nThis allows Foreman to associate a puppet variable with a domain/site\nand automatically append this variable to all external node requests made\nby machines at that site.</p>\n","short_description":"","doc_url":"/apidoc/domains","api_url":"/api","formats":[],"name":"Domains"},"models":{"version":"1","methods":[{"examples":["GET /api/models\n200\n[\n  {\n    \"model\": {\n      \"created_at\": \"2012-12-18T15:24:43Z\",\n      \"id\": 980190962,\n      \"hardware_model\": null,\n      \"info\": \"Virtual Machine\",\n      \"vendor_class\": null,\n      \"name\": \"KVM\",\n      \"updated_at\": \"2012-12-18T15:24:43Z\"\n    }\n  },\n  {\n    \"model\": {\n      \"created_at\": \"2012-12-18T15:24:43Z\",\n      \"id\": 139037058,\n      \"hardware_model\": \"SUN4U\",\n      \"info\": null,\n      \"vendor_class\": \"Sun-Fire-V210\",\n      \"name\": \"SUN V210\",\n      \"updated_at\": \"2012-12-18T15:24:43Z\"\n    }\n  }\n]"],"full_description":"","see":null,"params":[{"required":false,"full_name":"search","validator":"Must be String","allow_nil":false,"description":"<p>filter results</p>\n","expected_type":"string","name":"search"},{"required":false,"full_name":"order","validator":"Must be String","allow_nil":false,"description":"<p>sort results</p>\n","expected_type":"string","name":"order"},{"required":false,"full_name":"page","validator":"Must be String","allow_nil":false,"description":"<p>paginate results</p>\n","expected_type":"string","name":"page"},{"required":false,"full_name":"per_page","validator":"Must be String","allow_nil":false,"description":"<p>number of entries per request</p>\n","expected_type":"string","name":"per_page"}],"apis":[{"http_method":"GET","short_description":"List all models.","api_url":"/api/models"}],"doc_url":"/apidoc/models/index","errors":[],"formats":[],"name":"index","see_url":null},{"examples":["GET /api/models/980190962\n200\n{\n  \"model\": {\n    \"created_at\": \"2012-12-18T15:24:43Z\",\n    \"id\": 980190962,\n    \"hardware_model\": null,\n    \"info\": \"Virtual Machine\",\n    \"vendor_class\": null,\n    \"name\": \"KVM\",\n    \"updated_at\": \"2012-12-18T15:24:43Z\"\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","allow_nil":false,"description":"","expected_type":"string","name":"id"}],"apis":[{"http_method":"GET","short_description":"Show a model.","api_url":"/api/models/:id"}],"doc_url":"/apidoc/models/show","errors":[],"formats":[],"name":"show","see_url":null},{"examples":["POST /api/models\n{\n  \"model\": {\n    \"name\": \"new model\"\n  }\n}\n201\n{\n  \"model\": {\n    \"created_at\": \"2012-12-18T15:24:49Z\",\n    \"id\": 980190963,\n    \"hardware_model\": null,\n    \"info\": null,\n    \"vendor_class\": null,\n    \"name\": \"new model\",\n    \"updated_at\": \"2012-12-18T15:24:49Z\"\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"model","validator":"Must be a Hash","params":[{"required":true,"full_name":"model[name]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"name"},{"required":false,"full_name":"model[info]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"info"},{"required":false,"full_name":"model[vendor_class]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"vendor_class"},{"required":false,"full_name":"model[hardware_model]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"hardware_model"}],"allow_nil":false,"description":"","expected_type":"hash","name":"model"}],"apis":[{"http_method":"POST","short_description":"Create a model.","api_url":"/api/models"}],"doc_url":"/apidoc/models/create","errors":[],"formats":[],"name":"create","see_url":null},{"examples":["PUT /api/models/980190962\n{\n  \"name\": \"KVM\"\n}\n200\n{\n  \"model\": {\n    \"created_at\": \"2012-12-18T15:24:43Z\",\n    \"id\": 980190962,\n    \"hardware_model\": null,\n    \"info\": \"Virtual Machine\",\n    \"vendor_class\": null,\n    \"name\": \"KVM\",\n    \"updated_at\": \"2012-12-18T15:24:43Z\"\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"id","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"id"},{"required":true,"full_name":"model","validator":"Must be a Hash","params":[{"required":false,"full_name":"model[name]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"name"},{"required":false,"full_name":"model[info]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"info"},{"required":false,"full_name":"model[vendor_class]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"vendor_class"},{"required":false,"full_name":"model[hardware_model]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"hardware_model"}],"allow_nil":false,"description":"","expected_type":"hash","name":"model"}],"apis":[{"http_method":"PUT","short_description":"Update a model.","api_url":"/api/models/:id"}],"doc_url":"/apidoc/models/update","errors":[],"formats":[],"name":"update","see_url":null},{"examples":["DELETE /api/models/980190962\n200\n{\n  \"model\": {\n    \"created_at\": \"2012-12-18T15:24:43Z\",\n    \"id\": 980190962,\n    \"hardware_model\": null,\n    \"info\": \"Virtual Machine\",\n    \"vendor_class\": null,\n    \"name\": \"KVM\",\n    \"updated_at\": \"2012-12-18T15:24:43Z\"\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"id","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"id"}],"apis":[{"http_method":"DELETE","short_description":"Delete a model.","api_url":"/api/models/:id"}],"doc_url":"/apidoc/models/destroy","errors":[],"formats":[],"name":"destroy","see_url":null}],"full_description":"","short_description":"","doc_url":"/apidoc/models","api_url":"/api","formats":[],"name":"Models"},"settings":{"version":"1","methods":[{"examples":[],"full_description":"","see":null,"params":[{"required":false,"full_name":"search","validator":"Must be String","allow_nil":false,"description":"<p>Filter results</p>\n","expected_type":"string","name":"search"},{"required":false,"full_name":"order","validator":"Must be String","allow_nil":false,"description":"<p>Sort results</p>\n","expected_type":"string","name":"order"},{"required":false,"full_name":"page","validator":"Must be String","allow_nil":false,"description":"<p>paginate results</p>\n","expected_type":"string","name":"page"},{"required":false,"full_name":"per_page","validator":"Must be String","allow_nil":false,"description":"<p>number of entries per request</p>\n","expected_type":"string","name":"per_page"}],"apis":[{"http_method":"GET","short_description":"List all settings.","api_url":"/api/settings"}],"doc_url":"/apidoc/settings/index","errors":[],"formats":[],"name":"index","see_url":null},{"examples":["GET /api/settings/333972760\n200\n{\n  \"setting\": {\n    \"created_at\": \"2012-12-18T15:24:43Z\",\n    \"settings_type\": null,\n    \"id\": 333972760,\n    \"default\": \"root@some.host.fqdn\",\n    \"category\": \"General\",\n    \"description\": \"The Default administrator email address\",\n    \"name\": \"administrator\",\n    \"updated_at\": \"2012-12-18T15:24:43Z\",\n    \"value\": \"root@some.host.fqdn\"\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"id","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"id"}],"apis":[{"http_method":"GET","short_description":"Show an setting.","api_url":"/api/settings/:id"}],"doc_url":"/apidoc/settings/show","errors":[],"formats":[],"name":"show","see_url":null},{"examples":["PUT /api/settings/333972760\n{\n  \"setting\": {}\n}\n200\n{\n  \"setting\": {\n    \"created_at\": \"2012-12-18T15:24:43Z\",\n    \"settings_type\": null,\n    \"id\": 333972760,\n    \"default\": \"root@some.host.fqdn\",\n    \"category\": \"General\",\n    \"description\": \"The Default administrator email address\",\n    \"name\": \"administrator\",\n    \"updated_at\": \"2012-12-18T15:24:43Z\",\n    \"value\": \"root@some.host.fqdn\"\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"id","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"id"},{"required":true,"full_name":"setting","validator":"Must be a Hash","params":[{"required":false,"full_name":"setting[value]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"value"}],"allow_nil":false,"description":"","expected_type":"hash","name":"setting"}],"apis":[{"http_method":"PUT","short_description":"Update a setting.","api_url":"/api/settings/:id"}],"doc_url":"/apidoc/settings/update","errors":[],"formats":[],"name":"update","see_url":null}],"full_description":"","short_description":"","doc_url":"/apidoc/settings","api_url":"/api","formats":[],"name":"Settings"},"media":{"version":"1","methods":[{"examples":["GET /api/media\n200\n[\n  {\n    \"medium\": {\n      \"id\": 980190962,\n      \"path\": \"http://mirror.averse.net/centos/6.0/os/$arch\",\n      \"name\": \"CentOS 5.4\"\n    }\n  },\n  {\n    \"medium\": {\n      \"id\": 859751735,\n      \"path\": \"http://mirror.isoc.org.il/pub/opensuse/distribution/$major.$minor/repo/oss\",\n      \"name\": \"OpenSuse Mirror\"\n    }\n  },\n  {\n    \"medium\": {\n      \"id\": 442321401,\n      \"path\": \"http://brsla01/vol/solgi_5.10/sol$minor_$release_$arch\",\n      \"name\": \"Solaris 10\"\n    }\n  },\n  {\n    \"medium\": {\n      \"id\": 1011586618,\n      \"path\": \"http://sg.archive.ubuntu.com\",\n      \"name\": \"Ubuntu Mirror\"\n    }\n  },\n  {\n    \"medium\": {\n      \"id\": 338446587,\n      \"path\": \"http://nothing.intersting.com\",\n      \"name\": \"unused\"\n    }\n  }\n]"],"full_description":"","see":null,"params":[{"required":false,"full_name":"search","validator":"Must be String","allow_nil":false,"description":"<p>filter results</p>\n","expected_type":"string","name":"search"},{"required":false,"full_name":"order","validator":"Must be String","allow_nil":false,"description":"<p>for example, name ASC, or name DESC</p>\n","expected_type":"string","name":"order"},{"required":false,"full_name":"page","validator":"Must be String","allow_nil":false,"description":"<p>paginate results</p>\n","expected_type":"string","name":"page"},{"required":false,"full_name":"per_page","validator":"Must be String","allow_nil":false,"description":"<p>number of entries per request</p>\n","expected_type":"string","name":"per_page"}],"apis":[{"http_method":"GET","short_description":"List all media.","api_url":"/api/media"}],"doc_url":"/apidoc/media/index","errors":[],"formats":[],"name":"index","see_url":null},{"examples":["GET /api/media/980190962\n200\n{\n  \"medium\": {\n    \"id\": 980190962,\n    \"path\": \"http://mirror.averse.net/centos/6.0/os/$arch\",\n    \"name\": \"CentOS 5.4\"\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","allow_nil":false,"description":"","expected_type":"string","name":"id"}],"apis":[{"http_method":"GET","short_description":"Show a medium.","api_url":"/api/media/:id"}],"doc_url":"/apidoc/media/show","errors":[],"formats":[],"name":"show","see_url":null},{"examples":["POST /api/media\n{\n  \"medium\": {\n    \"path\": \"http://www.newmedium.com/\",\n    \"name\": \"new medium\"\n  }\n}\n201\n{\n  \"medium\": {\n    \"id\": 1011586619,\n    \"name\": \"new medium\"\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"medium","validator":"Must be a Hash","params":[{"required":true,"full_name":"medium[name]","validator":"Must be String","allow_nil":false,"description":"<p>Name of media</p>\n","expected_type":"string","name":"name"},{"required":true,"full_name":"medium[path]","validator":"Must be String","allow_nil":false,"description":"<p>The path to the medium, can be a URL or a valid NFS server (exclusive of the architecture).</p>\n\n<p>for example http://mirror.averse.net/centos/$version/os/$arch\nwhere $arch will be substituted for the host&#39;s actual OS architecture and $version, $major and $minor\nwill be substituted for the version of the operating system.</p>\n\n<p>Solaris and Debian media may also use $release.</p>\n","expected_type":"string","name":"path"},{"required":false,"full_name":"medium[os_family]","validator":"Must be String","allow_nil":false,"description":"<p>The family that the operating system belongs to.</p>\n\n<p>Available families:</p>\n\n<ul>\n<li>Archlinux</li>\n<li>Debian</li>\n<li>Redhat</li>\n<li>Solaris</li>\n<li>Suse</li>\n<li>Windows</li>\n</ul>\n","expected_type":"string","name":"os_family"}],"allow_nil":false,"description":"","expected_type":"hash","name":"medium"}],"apis":[{"http_method":"POST","short_description":"Create a medium.","api_url":"/api/media"}],"doc_url":"/apidoc/media/create","errors":[],"formats":[],"name":"create","see_url":null},{"examples":["PUT /api/media/980190962\n{\n  \"name\": \"CentOS 5.4\"\n}\n200\n{\n  \"medium\": {\n    \"id\": 980190962,\n    \"name\": \"CentOS 5.4\"\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"id","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"id"},{"required":true,"full_name":"medium","validator":"Must be a Hash","params":[{"required":false,"full_name":"medium[name]","validator":"Must be String","allow_nil":false,"description":"<p>Name of media</p>\n","expected_type":"string","name":"name"},{"required":false,"full_name":"medium[path]","validator":"Must be String","allow_nil":false,"description":"<p>The path to the medium, can be a URL or a valid NFS server (exclusive of the architecture).</p>\n\n<p>for example http://mirror.averse.net/centos/$version/os/$arch\nwhere $arch will be substituted for the host&#39;s actual OS architecture and $version, $major and $minor\nwill be substituted for the version of the operating system.</p>\n\n<p>Solaris and Debian media may also use $release.</p>\n","expected_type":"string","name":"path"},{"required":false,"full_name":"medium[os_family]","validator":"Must be String","allow_nil":true,"description":"<p>The family that the operating system belongs to.</p>\n\n<p>Available families:</p>\n\n<ul>\n<li>Archlinux</li>\n<li>Debian</li>\n<li>Redhat</li>\n<li>Solaris</li>\n<li>Suse</li>\n<li>Windows</li>\n</ul>\n","expected_type":"string","name":"os_family"}],"allow_nil":false,"description":"","expected_type":"hash","name":"medium"}],"apis":[{"http_method":"PUT","short_description":"Update a medium.","api_url":"/api/media/:id"}],"doc_url":"/apidoc/media/update","errors":[],"formats":[],"name":"update","see_url":null},{"examples":["DELETE /api/media/338446587\n200\n{\n  \"medium\": {\n    \"id\": 338446587,\n    \"name\": \"unused\"\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","allow_nil":false,"description":"","expected_type":"string","name":"id"}],"apis":[{"http_method":"DELETE","short_description":"Delete a medium.","api_url":"/api/media/:id"}],"doc_url":"/apidoc/media/destroy","errors":[],"formats":[],"name":"destroy","see_url":null}],"full_description":"","short_description":"","doc_url":"/apidoc/media","api_url":"/api","formats":[],"name":"Media"},"environments":{"version":"1","methods":[{"examples":["GET /api/environments\n200\n[\n  {\n    \"environment\": {\n      \"created_at\": \"2012-12-18T15:24:42Z\",\n      \"id\": 153855663,\n      \"name\": \"global_puppetmaster\",\n      \"updated_at\": \"2012-12-18T15:24:42Z\"\n    }\n  },\n  {\n    \"environment\": {\n      \"created_at\": \"2012-12-18T15:24:42Z\",\n      \"id\": 334344675,\n      \"name\": \"production\",\n      \"updated_at\": \"2012-12-18T15:24:42Z\"\n    }\n  },\n  {\n    \"environment\": {\n      \"created_at\": \"2012-12-18T15:24:42Z\",\n      \"id\": 687036937,\n      \"name\": \"testing\",\n      \"updated_at\": \"2012-12-18T15:24:42Z\"\n    }\n  }\n]"],"full_description":"","see":null,"params":[{"required":false,"full_name":"search","validator":"Must be String","allow_nil":false,"description":"<p>Filter results</p>\n","expected_type":"string","name":"search"},{"required":false,"full_name":"order","validator":"Must be String","allow_nil":false,"description":"<p>Sort results</p>\n","expected_type":"string","name":"order"},{"required":false,"full_name":"page","validator":"Must be String","allow_nil":false,"description":"<p>paginate results</p>\n","expected_type":"string","name":"page"},{"required":false,"full_name":"per_page","validator":"Must be String","allow_nil":false,"description":"<p>number of entries per request</p>\n","expected_type":"string","name":"per_page"}],"apis":[{"http_method":"GET","short_description":"List all environments.","api_url":"/api/environments"}],"doc_url":"/apidoc/environments/index","errors":[],"formats":[],"name":"index","see_url":null},{"examples":["GET /api/environments/production\n200\n{\n  \"environment\": {\n    \"created_at\": \"2012-12-18T15:24:42Z\",\n    \"id\": 334344675,\n    \"name\": \"production\",\n    \"updated_at\": \"2012-12-18T15:24:42Z\"\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","allow_nil":false,"description":"","expected_type":"string","name":"id"}],"apis":[{"http_method":"GET","short_description":"Show an environment.","api_url":"/api/environments/:id"}],"doc_url":"/apidoc/environments/show","errors":[],"formats":[],"name":"show","see_url":null},{"examples":["POST /api/environments\n{\n  \"environment\": {\n    \"name\": \"Development\"\n  }\n}\n200\n{\n  \"environment\": {\n    \"created_at\": \"2012-12-18T15:24:46Z\",\n    \"id\": 687036938,\n    \"name\": \"Development\",\n    \"updated_at\": \"2012-12-18T15:24:46Z\"\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"environment","validator":"Must be a Hash","params":[{"required":true,"full_name":"environment[name]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"name"}],"allow_nil":false,"description":"","expected_type":"hash","name":"environment"}],"apis":[{"http_method":"POST","short_description":"Create an environment.","api_url":"/api/environments"}],"doc_url":"/apidoc/environments/create","errors":[],"formats":[],"name":"create","see_url":null},{"examples":["PUT /api/environments/production\n{\n  \"environment\": {}\n}\n200\n{\n  \"environment\": {\n    \"id\": 334344675,\n    \"name\": \"production\"\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","allow_nil":false,"description":"","expected_type":"string","name":"id"},{"required":true,"full_name":"environment","validator":"Must be a Hash","params":[{"required":false,"full_name":"environment[name]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"name"}],"allow_nil":false,"description":"","expected_type":"hash","name":"environment"}],"apis":[{"http_method":"PUT","short_description":"Update an environment.","api_url":"/api/environments/:id"}],"doc_url":"/apidoc/environments/update","errors":[],"formats":[],"name":"update","see_url":null},{"examples":["DELETE /api/environments/testing\n200\n{\n  \"environment\": {\n    \"id\": 687036937,\n    \"name\": \"testing\"\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","allow_nil":false,"description":"","expected_type":"string","name":"id"}],"apis":[{"http_method":"DELETE","short_description":"Delete an environment.","api_url":"/api/environments/:id"}],"doc_url":"/apidoc/environments/destroy","errors":[],"formats":[],"name":"destroy","see_url":null}],"full_description":"","short_description":"","doc_url":"/apidoc/environments","api_url":"/api","formats":[],"name":"Environments"},"architectures":{"version":"1","methods":[{"examples":["GET /api/architectures\n200\n[\n  {\n    \"architecture\": {\n      \"created_at\": \"2012-12-18T15:24:42Z\",\n      \"id\": 381564594,\n      \"operatingsystem_ids\": [],\n      \"name\": \"s390\",\n      \"updated_at\": \"2012-12-18T15:24:42Z\"\n    }\n  },\n  {\n    \"architecture\": {\n      \"created_at\": \"2012-12-18T15:24:42Z\",\n      \"id\": 331892513,\n      \"operatingsystem_ids\": [\n        442321401\n      ],\n      \"name\": \"sparc\",\n      \"updated_at\": \"2012-12-18T15:24:42Z\"\n    }\n  },\n  {\n    \"architecture\": {\n      \"created_at\": \"2012-12-18T15:24:42Z\",\n      \"id\": 501905019,\n      \"operatingsystem_ids\": [\n        331303656,\n        309172073,\n        1073012828\n      ],\n      \"name\": \"x86_64\",\n      \"updated_at\": \"2012-12-18T15:24:42Z\"\n    }\n  }\n]"],"full_description":"","see":null,"params":[{"required":false,"full_name":"search","validator":"Must be String","allow_nil":false,"description":"<p>filter results</p>\n","expected_type":"string","name":"search"},{"required":false,"full_name":"order","validator":"Must be String","allow_nil":false,"description":"<p>sort results</p>\n","expected_type":"string","name":"order"},{"required":false,"full_name":"page","validator":"Must be String","allow_nil":false,"description":"<p>paginate results</p>\n","expected_type":"string","name":"page"},{"required":false,"full_name":"per_page","validator":"Must be String","allow_nil":false,"description":"<p>number of entries per request</p>\n","expected_type":"string","name":"per_page"}],"apis":[{"http_method":"GET","short_description":"List all architectures.","api_url":"/api/architectures"}],"doc_url":"/apidoc/architectures/index","errors":[],"formats":[],"name":"index","see_url":null},{"examples":["GET /api/architectures/x86_64\n200\n{\n  \"architecture\": {\n    \"created_at\": \"2012-12-18T15:24:42Z\",\n    \"id\": 501905019,\n    \"operatingsystem_ids\": [\n      309172073,\n      1073012828,\n      331303656\n    ],\n    \"name\": \"x86_64\",\n    \"updated_at\": \"2012-12-18T15:24:42Z\"\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","allow_nil":false,"description":"","expected_type":"string","name":"id"}],"apis":[{"http_method":"GET","short_description":"Show an architecture.","api_url":"/api/architectures/:id"}],"doc_url":"/apidoc/architectures/show","errors":[],"formats":[],"name":"show","see_url":null},{"examples":["POST /api/architectures\n{\n  \"architecture\": {\n    \"name\": \"i386\"\n  }\n}\n200\n{\n  \"architecture\": {\n    \"created_at\": \"2012-12-18T15:24:43Z\",\n    \"id\": 501905020,\n    \"operatingsystem_ids\": [],\n    \"name\": \"i386\",\n    \"updated_at\": \"2012-12-18T15:24:43Z\"\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"architecture","validator":"Must be a Hash","params":[{"required":true,"full_name":"architecture[name]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"name"},{"required":false,"full_name":"architecture[operatingsystem_ids]","validator":"Must be Array","allow_nil":false,"description":"<p>Operatingsystem ID&#39;s</p>\n","expected_type":"string","name":"operatingsystem_ids"}],"allow_nil":false,"description":"","expected_type":"hash","name":"architecture"}],"apis":[{"http_method":"POST","short_description":"Create an architecture.","api_url":"/api/architectures"}],"doc_url":"/apidoc/architectures/create","errors":[],"formats":[],"name":"create","see_url":null},{"examples":["PUT /api/architectures/x86_64\n{\n  \"architecture\": {}\n}\n200\n{\n  \"architecture\": {\n    \"id\": 501905019,\n    \"name\": \"x86_64\"\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","allow_nil":false,"description":"","expected_type":"string","name":"id"},{"required":true,"full_name":"architecture","validator":"Must be a Hash","params":[{"required":false,"full_name":"architecture[name]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"name"},{"required":false,"full_name":"architecture[operatingsystem_ids]","validator":"Must be Array","allow_nil":false,"description":"<p>Operatingsystem ID&#39;s</p>\n","expected_type":"string","name":"operatingsystem_ids"}],"allow_nil":false,"description":"","expected_type":"hash","name":"architecture"}],"apis":[{"http_method":"PUT","short_description":"Update an architecture.","api_url":"/api/architectures/:id"}],"doc_url":"/apidoc/architectures/update","errors":[],"formats":[],"name":"update","see_url":null},{"examples":["DELETE /api/architectures/s390\n200\n{\n  \"architecture\": {\n    \"id\": 381564594,\n    \"name\": \"s390\"\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","allow_nil":false,"description":"","expected_type":"string","name":"id"}],"apis":[{"http_method":"DELETE","short_description":"Delete an architecture.","api_url":"/api/architectures/:id"}],"doc_url":"/apidoc/architectures/destroy","errors":[],"formats":[],"name":"destroy","see_url":null}],"full_description":"","short_description":"","doc_url":"/apidoc/architectures","api_url":"/api","formats":[],"name":"Architectures"},"images":{"version":"1","methods":[{"examples":["GET /api/compute_resources/980190962/images\n200\n[\n  {\n    \"image\": {\n      \"created_at\": \"2012-12-18T15:24:42Z\",\n      \"id\": 298486374,\n      \"compute_resource_id\": 980190962,\n      \"architecture_id\": 501905019,\n      \"operatingsystem_id\": 309172073,\n      \"username\": \"MyString\",\n      \"name\": \"centos-2\",\n      \"updated_at\": \"2012-12-18T15:24:42Z\",\n      \"uuid\": \"MyString2\"\n    }\n  },\n  {\n    \"image\": {\n      \"created_at\": \"2012-12-18T15:24:42Z\",\n      \"id\": 980190962,\n      \"compute_resource_id\": 980190962,\n      \"architecture_id\": 501905019,\n      \"operatingsystem_id\": 309172073,\n      \"username\": \"root\",\n      \"name\": \"centos-1\",\n      \"updated_at\": \"2012-12-18T15:24:42Z\",\n      \"uuid\": \"string-of-uuid\"\n    }\n  }\n]"],"full_description":"","see":null,"params":[{"required":false,"full_name":"search","validator":"Must be String","allow_nil":false,"description":"<p>filter results</p>\n","expected_type":"string","name":"search"},{"required":false,"full_name":"order","validator":"Must be String","allow_nil":false,"description":"<p>sort results</p>\n","expected_type":"string","name":"order"},{"required":false,"full_name":"page","validator":"Must be String","allow_nil":false,"description":"<p>paginate results</p>\n","expected_type":"string","name":"page"},{"required":false,"full_name":"per_page","validator":"Must be String","allow_nil":false,"description":"<p>number of entries per request</p>\n","expected_type":"string","name":"per_page"},{"required":true,"full_name":"compute_resource_id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","allow_nil":false,"description":"","expected_type":"string","name":"compute_resource_id"}],"apis":[{"http_method":"GET","short_description":"List all images for compute resource","api_url":"/api/compute_resources/:compute_resource_id/images"}],"doc_url":"/apidoc/images/index","errors":[],"formats":[],"name":"index","see_url":null},{"examples":["GET /api/compute_resources/980190962/images/980190962\n200\n{\n  \"image\": {\n    \"created_at\": \"2012-12-18T15:24:42Z\",\n    \"id\": 980190962,\n    \"compute_resource_id\": 980190962,\n    \"architecture_id\": 501905019,\n    \"operatingsystem_id\": 309172073,\n    \"username\": \"root\",\n    \"name\": \"centos-1\",\n    \"updated_at\": \"2012-12-18T15:24:42Z\",\n    \"uuid\": \"string-of-uuid\"\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","allow_nil":false,"description":"","expected_type":"string","name":"id"},{"required":true,"full_name":"compute_resource_id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","allow_nil":false,"description":"","expected_type":"string","name":"compute_resource_id"}],"apis":[{"http_method":"GET","short_description":"Show an image","api_url":"/api/compute_resources/:compute_resource_id/images/:id"}],"doc_url":"/apidoc/images/show","errors":[],"formats":[],"name":"show","see_url":null},{"examples":["POST /api/compute_resources/980190962/images\n{\n  \"image\": {\n    \"architecture_id\": 381564594,\n    \"compute_resource_id\": 367690737,\n    \"operatingsystem_id\": 309172073,\n    \"username\": \"ec2-user\",\n    \"name\": \"TestImage\",\n    \"uuid\": \"abcdef\"\n  }\n}\n201\n{\n  \"compute_resource\": {\n    \"created_at\": \"2012-12-18T15:24:42Z\",\n    \"id\": 980190962,\n    \"user\": \"MyString\",\n    \"url\": \"qemu://stam/system\",\n    \"description\": \"MyString\",\n    \"name\": \"MyString\",\n    \"attrs\": null,\n    \"updated_at\": \"2012-12-18T15:24:42Z\",\n    \"uuid\": \"MyString\"\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"compute_resource_id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","allow_nil":false,"description":"","expected_type":"string","name":"compute_resource_id"},{"required":true,"full_name":"image","validator":"Must be a Hash","params":[{"required":true,"full_name":"image[name]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"name"},{"required":true,"full_name":"image[username]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"username"},{"required":true,"full_name":"image[uuid]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"uuid"},{"required":true,"full_name":"image[compute_resource_id]","validator":"Must be a number.","allow_nil":false,"description":"","expected_type":"string","name":"compute_resource_id"},{"required":true,"full_name":"image[architecture_id]","validator":"Must be a number.","allow_nil":false,"description":"","expected_type":"string","name":"architecture_id"},{"required":true,"full_name":"image[operatingsystem_id]","validator":"Must be a number.","allow_nil":false,"description":"","expected_type":"string","name":"operatingsystem_id"}],"allow_nil":false,"description":"","expected_type":"hash","name":"image"}],"apis":[{"http_method":"POST","short_description":"Create a image","api_url":"/api/compute_resources/:compute_resource_id/images"}],"doc_url":"/apidoc/images/create","errors":[],"formats":[],"name":"create","see_url":null},{"examples":["PUT /api/compute_resources/980190962/images/980190962\n{\n  \"image\": {}\n}\n200\n{\n  \"image\": {\n    \"created_at\": \"2012-12-18T15:24:42Z\",\n    \"id\": 980190962,\n    \"architecture_id\": 501905019,\n    \"compute_resource_id\": 980190962,\n    \"operatingsystem_id\": 309172073,\n    \"username\": \"root\",\n    \"name\": \"centos-1\",\n    \"updated_at\": \"2012-12-18T15:24:42Z\",\n    \"uuid\": \"string-of-uuid\"\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"compute_resource_id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","allow_nil":false,"description":"","expected_type":"string","name":"compute_resource_id"},{"required":true,"full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","allow_nil":false,"description":"","expected_type":"string","name":"id"},{"required":true,"full_name":"image","validator":"Must be a Hash","params":[{"required":false,"full_name":"image[name]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"name"},{"required":false,"full_name":"image[username]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"username"},{"required":false,"full_name":"image[uuid]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"uuid"},{"required":false,"full_name":"image[compute_resource_id]","validator":"Must be a number.","allow_nil":false,"description":"","expected_type":"string","name":"compute_resource_id"},{"required":false,"full_name":"image[architecture_id]","validator":"Must be a number.","allow_nil":false,"description":"","expected_type":"string","name":"architecture_id"},{"required":false,"full_name":"image[operatingsystem_id]","validator":"Must be a number.","allow_nil":false,"description":"","expected_type":"string","name":"operatingsystem_id"}],"allow_nil":false,"description":"","expected_type":"hash","name":"image"}],"apis":[{"http_method":"PUT","short_description":"Update a image.","api_url":"/api/compute_resources/:compute_resource_id/images/:id"}],"doc_url":"/apidoc/images/update","errors":[],"formats":[],"name":"update","see_url":null},{"examples":["DELETE /api/compute_resources/980190962/images/980190962\n200\n{\n  \"image\": {\n    \"created_at\": \"2012-12-18T15:24:42Z\",\n    \"id\": 980190962,\n    \"architecture_id\": 501905019,\n    \"compute_resource_id\": 980190962,\n    \"operatingsystem_id\": 309172073,\n    \"username\": \"root\",\n    \"name\": \"centos-1\",\n    \"updated_at\": \"2012-12-18T15:24:42Z\",\n    \"uuid\": \"string-of-uuid\"\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"compute_resource_id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","allow_nil":false,"description":"","expected_type":"string","name":"compute_resource_id"},{"required":true,"full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","allow_nil":false,"description":"","expected_type":"string","name":"id"}],"apis":[{"http_method":"DELETE","short_description":"Delete an image.","api_url":"/api/compute_resources/:compute_resource_id/images/:id"}],"doc_url":"/apidoc/images/destroy","errors":[],"formats":[],"name":"destroy","see_url":null}],"full_description":"","short_description":"","doc_url":"/apidoc/images","api_url":"/api","formats":[],"name":"Images"},"auth_source_ldaps":{"version":"1","methods":[{"examples":["GET /api/auth_source_ldaps\n200\n[\n  {\n    \"auth_source_ldap\": {\n      \"onthefly_register\": true,\n      \"created_at\": \"2012-12-18T15:24:43Z\",\n      \"base_dn\": \"dn=x,dn=y\",\n      \"attr_mail\": \"mail\",\n      \"id\": 980190962,\n      \"type\": \"AuthSourceLdap\",\n      \"tls\": true,\n      \"attr_lastname\": \"sn\",\n      \"attr_firstname\": \"givenName\",\n      \"port\": 123,\n      \"host\": \"ldap\",\n      \"name\": \"ldap\",\n      \"account\": null,\n      \"updated_at\": \"2012-12-18T15:24:43Z\",\n      \"attr_login\": \"uid\"\n    }\n  }\n]"],"full_description":"","see":null,"params":[{"required":false,"full_name":"page","validator":"Must be String","allow_nil":false,"description":"<p>paginate results</p>\n","expected_type":"string","name":"page"},{"required":false,"full_name":"per_page","validator":"Must be String","allow_nil":false,"description":"<p>number of entries per request</p>\n","expected_type":"string","name":"per_page"}],"apis":[{"http_method":"GET","short_description":"List all authsource ldaps","api_url":"/api/auth_source_ldaps"}],"doc_url":"/apidoc/auth_source_ldaps/index","errors":[],"formats":[],"name":"index","see_url":null},{"examples":["GET /api/auth_source_ldaps/980190962\n200\n{\n  \"auth_source_ldap\": {\n    \"onthefly_register\": true,\n    \"created_at\": \"2012-12-18T15:24:43Z\",\n    \"base_dn\": \"dn=x,dn=y\",\n    \"attr_mail\": \"mail\",\n    \"id\": 980190962,\n    \"type\": \"AuthSourceLdap\",\n    \"tls\": true,\n    \"attr_lastname\": \"sn\",\n    \"port\": 123,\n    \"attr_firstname\": \"givenName\",\n    \"host\": \"ldap\",\n    \"name\": \"ldap\",\n    \"account\": null,\n    \"updated_at\": \"2012-12-18T15:24:43Z\",\n    \"attr_login\": \"uid\"\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","allow_nil":false,"description":"","expected_type":"string","name":"id"}],"apis":[{"http_method":"GET","short_description":"Show an authsource ldap.","api_url":"/api/auth_source_ldaps/:id"}],"doc_url":"/apidoc/auth_source_ldaps/show","errors":[],"formats":[],"name":"show","see_url":null},{"examples":["POST /api/auth_source_ldaps\n{\n  \"auth_source_ldap\": {\n    \"host\": \"ldap2\",\n    \"name\": \"ldap2\"\n  }\n}\n201\n{\n  \"auth_source_ldap\": {\n    \"onthefly_register\": false,\n    \"created_at\": \"2012-12-18T15:24:44Z\",\n    \"base_dn\": null,\n    \"attr_mail\": null,\n    \"id\": 980190963,\n    \"attr_lastname\": null,\n    \"tls\": false,\n    \"attr_firstname\": null,\n    \"port\": 389,\n    \"account_password\": null,\n    \"host\": \"ldap2\",\n    \"name\": \"ldap2\",\n    \"account\": null,\n    \"updated_at\": \"2012-12-18T15:24:44Z\",\n    \"attr_login\": null\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"auth_source_ldap","validator":"Must be a Hash","params":[{"required":true,"full_name":"auth_source_ldap[name]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"name"},{"required":true,"full_name":"auth_source_ldap[host]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"host"},{"required":false,"full_name":"auth_source_ldap[port]","validator":"Must be a number.","allow_nil":false,"description":"<p>defaults to 389</p>\n","expected_type":"string","name":"port"},{"required":false,"full_name":"auth_source_ldap[account]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"account"},{"required":false,"full_name":"auth_source_ldap[base_dn]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"base_dn"},{"required":false,"full_name":"auth_source_ldap[account_password]","validator":"Must be String","allow_nil":false,"description":"<p>required if onthefly_register is true</p>\n","expected_type":"string","name":"account_password"},{"required":false,"full_name":"auth_source_ldap[attr_login]","validator":"Must be String","allow_nil":false,"description":"<p>required if onthefly_register is true</p>\n","expected_type":"string","name":"attr_login"},{"required":false,"full_name":"auth_source_ldap[attr_firstname]","validator":"Must be String","allow_nil":false,"description":"<p>required if onthefly_register is true</p>\n","expected_type":"string","name":"attr_firstname"},{"required":false,"full_name":"auth_source_ldap[attr_lastname]","validator":"Must be String","allow_nil":false,"description":"<p>required if onthefly_register is true</p>\n","expected_type":"string","name":"attr_lastname"},{"required":false,"full_name":"auth_source_ldap[attr_mail]","validator":"Must be String","allow_nil":false,"description":"<p>required if onthefly_register is true</p>\n","expected_type":"string","name":"attr_mail"},{"required":false,"full_name":"auth_source_ldap[onthefly_register]","validator":"Must be 'true' or 'false'","allow_nil":false,"description":"","expected_type":"string","name":"onthefly_register"},{"required":false,"full_name":"auth_source_ldap[tls]","validator":"Must be 'true' or 'false'","allow_nil":false,"description":"","expected_type":"string","name":"tls"}],"allow_nil":false,"description":"","expected_type":"hash","name":"auth_source_ldap"}],"apis":[{"http_method":"POST","short_description":"Create an auth_source_ldap.","api_url":"/api/auth_source_ldaps"}],"doc_url":"/apidoc/auth_source_ldaps/create","errors":[],"formats":[],"name":"create","see_url":null},{"examples":["PUT /api/auth_source_ldaps/980190962\n{\n  \"auth_source_ldap\": {}\n}\n200\n{\n  \"auth_source_ldap\": {\n    \"onthefly_register\": true,\n    \"created_at\": \"2012-12-18T15:24:43Z\",\n    \"base_dn\": \"dn=x,dn=y\",\n    \"attr_mail\": \"mail\",\n    \"id\": 980190962,\n    \"attr_lastname\": \"sn\",\n    \"tls\": true,\n    \"attr_firstname\": \"givenName\",\n    \"port\": 123,\n    \"account_password\": null,\n    \"host\": \"ldap\",\n    \"name\": \"ldap\",\n    \"account\": null,\n    \"updated_at\": \"2012-12-18T15:24:43Z\",\n    \"attr_login\": \"uid\"\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"id","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"id"},{"required":true,"full_name":"auth_source_ldap","validator":"Must be a Hash","params":[{"required":false,"full_name":"auth_source_ldap[name]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"name"},{"required":false,"full_name":"auth_source_ldap[host]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"host"},{"required":false,"full_name":"auth_source_ldap[port]","validator":"Must be a number.","allow_nil":false,"description":"<p>defaults to 389</p>\n","expected_type":"string","name":"port"},{"required":false,"full_name":"auth_source_ldap[account]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"account"},{"required":false,"full_name":"auth_source_ldap[base_dn]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"base_dn"},{"required":false,"full_name":"auth_source_ldap[account_password]","validator":"Must be String","allow_nil":false,"description":"<p>required if onthefly_register is true</p>\n","expected_type":"string","name":"account_password"},{"required":false,"full_name":"auth_source_ldap[attr_login]","validator":"Must be String","allow_nil":false,"description":"<p>required if onthefly_register is true</p>\n","expected_type":"string","name":"attr_login"},{"required":false,"full_name":"auth_source_ldap[attr_firstname]","validator":"Must be String","allow_nil":false,"description":"<p>required if onthefly_register is true</p>\n","expected_type":"string","name":"attr_firstname"},{"required":false,"full_name":"auth_source_ldap[attr_lastname]","validator":"Must be String","allow_nil":false,"description":"<p>required if onthefly_register is true</p>\n","expected_type":"string","name":"attr_lastname"},{"required":false,"full_name":"auth_source_ldap[attr_mail]","validator":"Must be String","allow_nil":false,"description":"<p>required if onthefly_register is true</p>\n","expected_type":"string","name":"attr_mail"},{"required":false,"full_name":"auth_source_ldap[onthefly_register]","validator":"Must be 'true' or 'false'","allow_nil":false,"description":"","expected_type":"string","name":"onthefly_register"},{"required":false,"full_name":"auth_source_ldap[tls]","validator":"Must be 'true' or 'false'","allow_nil":false,"description":"","expected_type":"string","name":"tls"}],"allow_nil":false,"description":"","expected_type":"hash","name":"auth_source_ldap"}],"apis":[{"http_method":"PUT","short_description":"Update an auth_source_ldap.","api_url":"/api/auth_source_ldaps/:id"}],"doc_url":"/apidoc/auth_source_ldaps/update","errors":[],"formats":[],"name":"update","see_url":null},{"examples":["DELETE /api/auth_source_ldaps/980190962\n200\n{\n  \"auth_source_ldap\": {\n    \"onthefly_register\": true,\n    \"created_at\": \"2012-12-18T15:24:43Z\",\n    \"base_dn\": \"dn=x,dn=y\",\n    \"attr_mail\": \"mail\",\n    \"id\": 980190962,\n    \"attr_lastname\": \"sn\",\n    \"tls\": true,\n    \"attr_firstname\": \"givenName\",\n    \"port\": 123,\n    \"account_password\": null,\n    \"host\": \"ldap\",\n    \"name\": \"ldap\",\n    \"account\": null,\n    \"updated_at\": \"2012-12-18T15:24:43Z\",\n    \"attr_login\": \"uid\"\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"id","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"id"}],"apis":[{"http_method":"DELETE","short_description":"Delete an auth_source_ldap.","api_url":"/api/auth_source_ldaps/:id"}],"doc_url":"/apidoc/auth_source_ldaps/destroy","errors":[],"formats":[],"name":"destroy","see_url":null}],"full_description":"","short_description":"","doc_url":"/apidoc/auth_source_ldaps","api_url":"/api","formats":[],"name":"Auth source ldaps"},"fact_values":{"version":"1","methods":[{"examples":["GET /api/hosts/my5name.mydomain.net/facts\n200\n{\n  \"my5name.mydomain.net\": {\n    \"ipaddress\": \"10.0.19.33\",\n    \"kernelversion\": \"2.6.9\"\n  }\n}"],"full_description":"","see":null,"params":[{"required":false,"full_name":"search","validator":"Must be String","allow_nil":false,"description":"<p>filter results</p>\n","expected_type":"string","name":"search"},{"required":false,"full_name":"order","validator":"Must be String","allow_nil":false,"description":"<p>sort results</p>\n","expected_type":"string","name":"order"},{"required":false,"full_name":"page","validator":"Must be String","allow_nil":false,"description":"<p>paginate results</p>\n","expected_type":"string","name":"page"},{"required":false,"full_name":"per_page","validator":"Must be String","allow_nil":false,"description":"<p>number of entries per request</p>\n","expected_type":"string","name":"per_page"}],"apis":[{"http_method":"GET","short_description":"List all fact values.","api_url":"/api/fact_values"}],"doc_url":"/apidoc/fact_values/index","errors":[],"formats":[],"name":"index","see_url":null}],"full_description":"","short_description":"","doc_url":"/apidoc/fact_values","api_url":"/api","formats":[],"name":"Fact values"},"home":{"version":"1","methods":[{"examples":["GET /api\n200\n{\n  \"links\": {\n    \"List all lookup_keys\": \"/api/lookup_keys\",\n    \"List all ptables\": \"/api/ptables\",\n    \"List templates\": \"/api/config_templates\",\n    \"List all smart_proxies\": \"/api/smart_proxies\",\n    \"List all hosts\": \"/api/hosts\",\n    \"List all architectures\": \"/api/architectures\",\n    \"List all roles\": \"/api/roles\",\n    \"List all bookmarks\": \"/api/bookmarks\",\n    \"List all authsource ldaps\": \"/api/auth_source_ldaps\",\n    \"List of subnets\": \"/api/subnets\",\n    \"List all media\": \"/api/media\",\n    \"List all audits\": \"/api/audits\",\n    \"List all users\": \"/api/users\",\n    \"List all environments\": \"/api/environments\",\n    \"List all reports\": \"/api/reports\",\n    \"List all images for compute resource\": \"/api/compute_resources/:compute_resource_id/images\",\n    \"List of domains\": \"/api/domains\",\n    \"Get Dashboard results\": \"/api/dashboard\",\n    \"Show status\": \"/api/status\",\n    \"List all common parameters\": \"/api/common_parameters\",\n    \"List all usergroups\": \"/api/usergroups\",\n    \"List all models\": \"/api/models\",\n    \"List all template kinds\": \"/api/template_kinds\",\n    \"List all hostgroups\": \"/api/hostgroups\",\n    \"List all compute resources\": \"/api/compute_resources\",\n    \"Show available links\": \"/api\",\n    \"List all puppetclasses\": \"/api/puppetclasses\",\n    \"List all operating systems\": \"/api/operatingsystems\",\n    \"List all settings\": \"/api/settings\",\n    \"List all fact values\": \"/api/fact_values\"\n  }\n}"],"full_description":"","see":null,"params":[],"apis":[{"http_method":"GET","short_description":"Show available links.","api_url":"/api"}],"doc_url":"/apidoc/home/index","errors":[],"formats":[],"name":"index","see_url":null},{"examples":[],"full_description":"","see":null,"params":[],"apis":[{"http_method":"GET","short_description":"Show status.","api_url":"/api/status"}],"doc_url":"/apidoc/home/status","errors":[],"formats":[],"name":"status","see_url":null}],"full_description":"","short_description":"","doc_url":"/apidoc/home","api_url":"/api","formats":[],"name":"Home"},"template_kinds":{"version":"1","methods":[{"examples":["GET /api/template_kinds\n200\n[\n  {\n    \"template_kind\": {\n      \"id\": 452984334,\n      \"name\": \"PXELinux\"\n    }\n  },\n  {\n    \"template_kind\": {\n      \"id\": 478250810,\n      \"name\": \"script\"\n    }\n  },\n  {\n    \"template_kind\": {\n      \"id\": 158998239,\n      \"name\": \"gPXE\"\n    }\n  },\n  {\n    \"template_kind\": {\n      \"id\": 550103832,\n      \"name\": \"finish\"\n    }\n  },\n  {\n    \"template_kind\": {\n      \"id\": 983253650,\n      \"name\": \"provision\"\n    }\n  }\n]"],"full_description":"","see":null,"params":[{"required":false,"full_name":"page","validator":"Must be String","allow_nil":false,"description":"<p>paginate results</p>\n","expected_type":"string","name":"page"},{"required":false,"full_name":"per_page","validator":"Must be String","allow_nil":false,"description":"<p>number of entries per request</p>\n","expected_type":"string","name":"per_page"}],"apis":[{"http_method":"GET","short_description":"List all template kinds.","api_url":"/api/template_kinds"}],"doc_url":"/apidoc/template_kinds/index","errors":[],"formats":[],"name":"index","see_url":null}],"full_description":"","short_description":"","doc_url":"/apidoc/template_kinds","api_url":"/api","formats":[],"name":"Template kinds"},"bookmarks":{"version":"1","methods":[{"examples":["GET /api/bookmarks\n200\n[\n  {\n    \"bookmark\": {\n      \"query\": \"bar=car\",\n      \"id\": 298486374,\n      \"owner_id\": null,\n      \"controller\": \"hosts\",\n      \"owner_type\": null,\n      \"public\": false,\n      \"name\": \"bar\"\n    }\n  },\n  {\n    \"bookmark\": {\n      \"query\": \"foo=boo\",\n      \"id\": 980190962,\n      \"owner_id\": null,\n      \"controller\": \"hosts\",\n      \"owner_type\": null,\n      \"public\": true,\n      \"name\": \"foo\"\n    }\n  }\n]"],"full_description":"","see":null,"params":[{"required":false,"full_name":"page","validator":"Must be String","allow_nil":false,"description":"<p>paginate results</p>\n","expected_type":"string","name":"page"},{"required":false,"full_name":"per_page","validator":"Must be String","allow_nil":false,"description":"<p>number of entries per request</p>\n","expected_type":"string","name":"per_page"}],"apis":[{"http_method":"GET","short_description":"List all bookmarks.","api_url":"/api/bookmarks"}],"doc_url":"/apidoc/bookmarks/index","errors":[],"formats":[],"name":"index","see_url":null},{"examples":["GET /api/bookmarks/foo\n200\n{\n  \"bookmark\": {\n    \"query\": \"foo=boo\",\n    \"id\": 980190962,\n    \"owner_id\": null,\n    \"controller\": \"hosts\",\n    \"owner_type\": null,\n    \"public\": true,\n    \"name\": \"foo\"\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","allow_nil":false,"description":"","expected_type":"string","name":"id"}],"apis":[{"http_method":"GET","short_description":"Show a bookmark.","api_url":"/api/bookmarks/:id"}],"doc_url":"/apidoc/bookmarks/show","errors":[],"formats":[],"name":"show","see_url":null},{"examples":["POST /api/bookmarks\n{\n  \"bookmark\": {\n    \"query\": \"bar\",\n    \"controller\": \"hosts\",\n    \"public\": false,\n    \"name\": \"foo-bar\"\n  }\n}\n200\n{\n  \"bookmark\": {\n    \"query\": \"bar\",\n    \"id\": 980190963,\n    \"owner_id\": 886836129,\n    \"controller\": \"hosts\",\n    \"owner_type\": \"User\",\n    \"public\": false,\n    \"name\": \"foo-bar\"\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"bookmark","validator":"Must be a Hash","params":[{"required":true,"full_name":"bookmark[name]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"name"},{"required":true,"full_name":"bookmark[controller]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"controller"},{"required":true,"full_name":"bookmark[query]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"query"},{"required":false,"full_name":"bookmark[public]","validator":"Must be 'true' or 'false'","allow_nil":false,"description":"","expected_type":"string","name":"public"}],"allow_nil":false,"description":"","expected_type":"hash","name":"bookmark"}],"apis":[{"http_method":"POST","short_description":"Create a bookmark.","api_url":"/api/bookmarks"}],"doc_url":"/apidoc/bookmarks/create","errors":[],"formats":[],"name":"create","see_url":null},{"examples":["PUT /api/bookmarks/foo\n{\n  \"bookmark\": {}\n}\n200\n{\n  \"bookmark\": {\n    \"query\": \"foo=boo\",\n    \"id\": 980190962,\n    \"user\": {\n      \"email\": \"apiadmin@someware.com\",\n      \"name\": \"apiadmin User\",\n      \"login\": \"apiadmin\"\n    },\n    \"controller\": \"hosts\",\n    \"public\": true,\n    \"name\": \"foo\"\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","allow_nil":false,"description":"","expected_type":"string","name":"id"},{"required":true,"full_name":"bookmark","validator":"Must be a Hash","params":[{"required":false,"full_name":"bookmark[name]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"name"},{"required":false,"full_name":"bookmark[controller]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"controller"},{"required":false,"full_name":"bookmark[query]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"query"},{"required":false,"full_name":"bookmark[public]","validator":"Must be 'true' or 'false'","allow_nil":false,"description":"","expected_type":"string","name":"public"}],"allow_nil":false,"description":"","expected_type":"hash","name":"bookmark"}],"apis":[{"http_method":"PUT","short_description":"Update a bookmark.","api_url":"/api/bookmarks/:id"}],"doc_url":"/apidoc/bookmarks/update","errors":[],"formats":[],"name":"update","see_url":null},{"examples":["DELETE /api/bookmarks/foo\n200\n{\n  \"bookmark\": {\n    \"query\": \"foo=boo\",\n    \"id\": 980190962,\n    \"owner_id\": null,\n    \"controller\": \"hosts\",\n    \"owner_type\": null,\n    \"public\": true,\n    \"name\": \"foo\"\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","allow_nil":false,"description":"","expected_type":"string","name":"id"}],"apis":[{"http_method":"DELETE","short_description":"Delete a bookmark.","api_url":"/api/bookmarks/:id"}],"doc_url":"/apidoc/bookmarks/destroy","errors":[],"formats":[],"name":"destroy","see_url":null}],"full_description":"","short_description":"","doc_url":"/apidoc/bookmarks","api_url":"/api","formats":[],"name":"Bookmarks"},"hostgroups":{"version":"1","methods":[{"examples":["GET /api/hostgroups\n200\n[\n  {\n    \"hostgroup\": {\n      \"subnet_id\": null,\n      \"label\": \"db\",\n      \"ancestry\": null,\n      \"id\": 603241515,\n      \"operatingsystem_id\": 309172073,\n      \"puppetclass_ids\": [],\n      \"parameters\": {},\n      \"environment_id\": 334344675,\n      \"name\": \"db\",\n      \"domain_id\": null\n    }\n  },\n  {\n    \"hostgroup\": {\n      \"subnet_id\": null,\n      \"label\": \"Common\",\n      \"ancestry\": null,\n      \"id\": 636252244,\n      \"operatingsystem_id\": 309172073,\n      \"puppetclass_ids\": [\n        980190962\n      ],\n      \"parameters\": {\n        \"group1\": \"group1\"\n      },\n      \"environment_id\": 334344675,\n      \"name\": \"Common\",\n      \"domain_id\": 22495316\n    }\n  },\n  {\n    \"hostgroup\": {\n      \"subnet_id\": null,\n      \"label\": \"Unusual\",\n      \"ancestry\": null,\n      \"id\": 866317115,\n      \"operatingsystem_id\": null,\n      \"puppetclass_ids\": [],\n      \"parameters\": {},\n      \"environment_id\": null,\n      \"name\": \"Unusual\",\n      \"domain_id\": null\n    }\n  }\n]"],"full_description":"","see":null,"params":[{"required":false,"full_name":"search","validator":"Must be String","allow_nil":false,"description":"<p>filter results</p>\n","expected_type":"string","name":"search"},{"required":false,"full_name":"order","validator":"Must be String","allow_nil":false,"description":"<p>sort results</p>\n","expected_type":"string","name":"order"},{"required":false,"full_name":"page","validator":"Must be String","allow_nil":false,"description":"<p>paginate results</p>\n","expected_type":"string","name":"page"},{"required":false,"full_name":"per_page","validator":"Must be String","allow_nil":false,"description":"<p>number of entries per request</p>\n","expected_type":"string","name":"per_page"}],"apis":[{"http_method":"GET","short_description":"List all hostgroups.","api_url":"/api/hostgroups"}],"doc_url":"/apidoc/hostgroups/index","errors":[],"formats":[],"name":"index","see_url":null},{"examples":["GET /api/hostgroups/636252244-common\n200\n{\n  \"hostgroup\": {\n    \"subnet_id\": null,\n    \"label\": \"Common\",\n    \"ancestry\": null,\n    \"id\": 636252244,\n    \"operatingsystem_id\": 309172073,\n    \"puppetclass_ids\": [\n      980190962\n    ],\n    \"parameters\": {\n      \"group1\": \"group1\"\n    },\n    \"environment_id\": 334344675,\n    \"name\": \"Common\",\n    \"domain_id\": 22495316\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","allow_nil":false,"description":"","expected_type":"string","name":"id"}],"apis":[{"http_method":"GET","short_description":"Show a hostgroup.","api_url":"/api/hostgroups/:id"}],"doc_url":"/apidoc/hostgroups/show","errors":[],"formats":[],"name":"show","see_url":null},{"examples":["POST /api/hostgroups\n{\n  \"hostgroup\": {\n    \"name\": \"TestHostgroup\"\n  }\n}\n200\n{\n  \"hostgroup\": {\n    \"subnet_id\": null,\n    \"label\": \"TestHostgroup\",\n    \"ancestry\": null,\n    \"id\": 866317116,\n    \"operatingsystem_id\": null,\n    \"puppetclass_ids\": [],\n    \"parameters\": {},\n    \"environment_id\": null,\n    \"name\": \"TestHostgroup\",\n    \"domain_id\": null\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"hostgroup","validator":"Must be a Hash","params":[{"required":true,"full_name":"hostgroup[name]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"name"},{"required":false,"full_name":"hostgroup[environment_id]","validator":"Must be a number.","allow_nil":false,"description":"","expected_type":"string","name":"environment_id"},{"required":false,"full_name":"hostgroup[operatingsystem_id]","validator":"Must be a number.","allow_nil":false,"description":"","expected_type":"string","name":"operatingsystem_id"},{"required":false,"full_name":"hostgroup[architecture_id]","validator":"Must be a number.","allow_nil":false,"description":"","expected_type":"string","name":"architecture_id"},{"required":false,"full_name":"hostgroup[medium_id]","validator":"Must be a number.","allow_nil":false,"description":"","expected_type":"string","name":"medium_id"},{"required":false,"full_name":"hostgroup[ptable_id]","validator":"Must be a number.","allow_nil":false,"description":"","expected_type":"string","name":"ptable_id"},{"required":false,"full_name":"hostgroup[puppet_ca_proxy_id]","validator":"Must be a number.","allow_nil":false,"description":"","expected_type":"string","name":"puppet_ca_proxy_id"},{"required":false,"full_name":"hostgroup[subnet_id]","validator":"Must be a number.","allow_nil":false,"description":"","expected_type":"string","name":"subnet_id"},{"required":false,"full_name":"hostgroup[domain_id]","validator":"Must be a number.","allow_nil":false,"description":"","expected_type":"string","name":"domain_id"},{"required":false,"full_name":"hostgroup[puppet_proxy_id]","validator":"Must be a number.","allow_nil":false,"description":"","expected_type":"string","name":"puppet_proxy_id"}],"allow_nil":false,"description":"","expected_type":"hash","name":"hostgroup"}],"apis":[{"http_method":"POST","short_description":"Create an hostgroup.","api_url":"/api/hostgroups"}],"doc_url":"/apidoc/hostgroups/create","errors":[],"formats":[],"name":"create","see_url":null},{"examples":["PUT /api/hostgroups/636252244-common\n{\n  \"hostgroup\": {}\n}\n200\n{\n  \"hostgroup\": {\n    \"subnet_id\": null,\n    \"label\": \"Common\",\n    \"ancestry\": null,\n    \"id\": 636252244,\n    \"operatingsystem_id\": 309172073,\n    \"puppetclass_ids\": [\n      980190962\n    ],\n    \"environment_id\": 334344675,\n    \"parameters\": {\n      \"group1\": \"group1\"\n    },\n    \"name\": \"Common\",\n    \"domain_id\": 22495316\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","allow_nil":false,"description":"","expected_type":"string","name":"id"},{"required":true,"full_name":"hostgroup","validator":"Must be a Hash","params":[{"required":false,"full_name":"hostgroup[name]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"name"},{"required":false,"full_name":"hostgroup[environment_id]","validator":"Must be a number.","allow_nil":false,"description":"","expected_type":"string","name":"environment_id"},{"required":false,"full_name":"hostgroup[operatingsystem_id]","validator":"Must be a number.","allow_nil":false,"description":"","expected_type":"string","name":"operatingsystem_id"},{"required":false,"full_name":"hostgroup[architecture_id]","validator":"Must be a number.","allow_nil":false,"description":"","expected_type":"string","name":"architecture_id"},{"required":false,"full_name":"hostgroup[medium_id]","validator":"Must be a number.","allow_nil":false,"description":"","expected_type":"string","name":"medium_id"},{"required":false,"full_name":"hostgroup[ptable_id]","validator":"Must be a number.","allow_nil":false,"description":"","expected_type":"string","name":"ptable_id"},{"required":false,"full_name":"hostgroup[puppet_ca_proxy_id]","validator":"Must be a number.","allow_nil":false,"description":"","expected_type":"string","name":"puppet_ca_proxy_id"},{"required":false,"full_name":"hostgroup[subnet_id]","validator":"Must be a number.","allow_nil":false,"description":"","expected_type":"string","name":"subnet_id"},{"required":false,"full_name":"hostgroup[domain_id]","validator":"Must be a number.","allow_nil":false,"description":"","expected_type":"string","name":"domain_id"},{"required":false,"full_name":"hostgroup[puppet_proxy_id]","validator":"Must be a number.","allow_nil":false,"description":"","expected_type":"string","name":"puppet_proxy_id"}],"allow_nil":false,"description":"","expected_type":"hash","name":"hostgroup"}],"apis":[{"http_method":"PUT","short_description":"Update an hostgroup.","api_url":"/api/hostgroups/:id"}],"doc_url":"/apidoc/hostgroups/update","errors":[],"formats":[],"name":"update","see_url":null},{"examples":["DELETE /api/hostgroups/636252244-common\n200\n{\n  \"hostgroup\": {\n    \"subnet_id\": null,\n    \"label\": \"Common\",\n    \"ancestry\": null,\n    \"id\": 636252244,\n    \"operatingsystem_id\": 309172073,\n    \"puppetclass_ids\": [],\n    \"environment_id\": 334344675,\n    \"parameters\": {},\n    \"name\": \"Common\",\n    \"domain_id\": 22495316\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","allow_nil":false,"description":"","expected_type":"string","name":"id"}],"apis":[{"http_method":"DELETE","short_description":"Delete an hostgroup.","api_url":"/api/hostgroups/:id"}],"doc_url":"/apidoc/hostgroups/destroy","errors":[],"formats":[],"name":"destroy","see_url":null}],"full_description":"","short_description":"","doc_url":"/apidoc/hostgroups","api_url":"/api","formats":[],"name":"Hostgroups"},"operatingsystems":{"version":"1","methods":[{"examples":[],"full_description":"","see":null,"params":[{"required":false,"full_name":"search","validator":"Must be String","allow_nil":false,"description":"<p>filter results</p>\n","expected_type":"string","name":"search"},{"required":false,"full_name":"order","validator":"Must be String","allow_nil":false,"description":"<p>for example, name ASC, or name DESC</p>\n","expected_type":"string","name":"order"},{"required":false,"full_name":"page","validator":"Must be String","allow_nil":false,"description":"<p>paginate results</p>\n","expected_type":"string","name":"page"},{"required":false,"full_name":"per_page","validator":"Must be String","allow_nil":false,"description":"<p>number of entries per request</p>\n","expected_type":"string","name":"per_page"}],"apis":[{"http_method":"GET","short_description":"List all operating systems.","api_url":"/api/operatingsystems"}],"doc_url":"/apidoc/operatingsystems/index","errors":[],"formats":[],"name":"index","see_url":null},{"examples":["GET /api/operatingsystems/1073012828\n200\n{\n  \"operatingsystem\": {\n    \"minor\": \"1\",\n    \"release_name\": null,\n    \"id\": 1073012828,\n    \"major\": \"6\",\n    \"config_templates\": [\n      {\n        \"config_template\": {\n          \"id\": 1007981701,\n          \"name\": \"centos5_3_pxelinux\"\n        }\n      },\n      {\n        \"config_template\": {\n          \"id\": 104314179,\n          \"name\": \"MyFinish\"\n        }\n      },\n      {\n        \"config_template\": {\n          \"id\": 981457253,\n          \"name\": \"MyScript\"\n        }\n      },\n      {\n        \"config_template\": {\n          \"id\": 943779058,\n          \"name\": \"MyString\"\n        }\n      },\n      {\n        \"config_template\": {\n          \"id\": 269958254,\n          \"name\": \"MyString2\"\n        }\n      },\n      {\n        \"config_template\": {\n          \"id\": 352050261,\n          \"name\": \"PXE Default File\"\n        }\n      },\n      {\n        \"config_template\": {\n          \"id\": 821548108,\n          \"name\": \"PXE Localboot Default\"\n        }\n      }\n    ],\n    \"family\": \"Redhat\",\n    \"media\": [\n      {\n        \"medium\": {\n          \"id\": 980190962,\n          \"name\": \"CentOS 5.4\"\n        }\n      }\n    ],\n    \"architectures\": [\n      {\n        \"architecture\": {\n          \"id\": 501905019,\n          \"name\": \"x86_64\"\n        }\n      }\n    ],\n    \"name\": \"Redhat\",\n    \"os_default_templates\": [],\n    \"ptables\": [\n      {\n        \"ptable\": {\n          \"id\": 980190962,\n          \"name\": \"default\"\n        }\n      }\n    ]\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"id","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"id"}],"apis":[{"http_method":"GET","short_description":"Show an OS.","api_url":"/api/operatingsystems/:id"}],"doc_url":"/apidoc/operatingsystems/show","errors":[],"formats":[],"name":"show","see_url":null},{"examples":["POST /api/operatingsystems\n{\n  \"operatingsystem\": {\n    \"minor\": \"2\",\n    \"major\": \"1\",\n    \"name\": \"awsome_os\"\n  }\n}\n200\n{\n  \"operatingsystem\": {\n    \"minor\": \"2\",\n    \"release_name\": null,\n    \"id\": 1073012829,\n    \"major\": \"1\",\n    \"config_templates\": [],\n    \"family\": null,\n    \"media\": [],\n    \"architectures\": [],\n    \"name\": \"awsome_os\",\n    \"os_default_templates\": [],\n    \"ptables\": []\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"operatingsystem","validator":"Must be a Hash","params":[{"required":true,"full_name":"operatingsystem[name]","validator":"Must match regular expression /\\A(\\S+)\\Z/.","allow_nil":false,"description":"","expected_type":"string","name":"name"},{"required":true,"full_name":"operatingsystem[major]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"major"},{"required":true,"full_name":"operatingsystem[minor]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"minor"},{"required":false,"full_name":"operatingsystem[family]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"family"},{"required":false,"full_name":"operatingsystem[release_name]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"release_name"}],"allow_nil":false,"description":"","expected_type":"hash","name":"operatingsystem"}],"apis":[{"http_method":"POST","short_description":"Create an OS.","api_url":"/api/operatingsystems"}],"doc_url":"/apidoc/operatingsystems/create","errors":[],"formats":[],"name":"create","see_url":null},{"examples":["PUT /api/operatingsystems/1073012828\n{\n  \"operatingsystem\": {\n    \"name\": \"new_name\"\n  }\n}\n200\n{\n  \"operatingsystem\": {\n    \"minor\": \"1\",\n    \"release_name\": null,\n    \"id\": 1073012828,\n    \"major\": \"6\",\n    \"config_templates\": [\n      {\n        \"config_template\": {\n          \"id\": 1007981701,\n          \"name\": \"centos5_3_pxelinux\"\n        }\n      },\n      {\n        \"config_template\": {\n          \"id\": 104314179,\n          \"name\": \"MyFinish\"\n        }\n      },\n      {\n        \"config_template\": {\n          \"id\": 981457253,\n          \"name\": \"MyScript\"\n        }\n      },\n      {\n        \"config_template\": {\n          \"id\": 943779058,\n          \"name\": \"MyString\"\n        }\n      },\n      {\n        \"config_template\": {\n          \"id\": 269958254,\n          \"name\": \"MyString2\"\n        }\n      },\n      {\n        \"config_template\": {\n          \"id\": 352050261,\n          \"name\": \"PXE Default File\"\n        }\n      },\n      {\n        \"config_template\": {\n          \"id\": 821548108,\n          \"name\": \"PXE Localboot Default\"\n        }\n      }\n    ],\n    \"family\": \"Redhat\",\n    \"media\": [\n      {\n        \"medium\": {\n          \"id\": 980190962,\n          \"name\": \"CentOS 5.4\"\n        }\n      }\n    ],\n    \"architectures\": [\n      {\n        \"architecture\": {\n          \"id\": 501905019,\n          \"name\": \"x86_64\"\n        }\n      }\n    ],\n    \"name\": \"new_name\",\n    \"os_default_templates\": [],\n    \"ptables\": [\n      {\n        \"ptable\": {\n          \"id\": 980190962,\n          \"name\": \"default\"\n        }\n      }\n    ]\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"id","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"id"},{"required":true,"full_name":"operatingsystem","validator":"Must be a Hash","params":[{"required":false,"full_name":"operatingsystem[name]","validator":"Must match regular expression /\\A(\\S+)\\Z/.","allow_nil":false,"description":"","expected_type":"string","name":"name"},{"required":false,"full_name":"operatingsystem[major]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"major"},{"required":false,"full_name":"operatingsystem[minor]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"minor"},{"required":false,"full_name":"operatingsystem[family]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"family"},{"required":false,"full_name":"operatingsystem[release_name]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"release_name"}],"allow_nil":false,"description":"","expected_type":"hash","name":"operatingsystem"}],"apis":[{"http_method":"PUT","short_description":"Update an OS.","api_url":"/api/operatingsystems/:id"}],"doc_url":"/apidoc/operatingsystems/update","errors":[],"formats":[],"name":"update","see_url":null},{"examples":["DELETE /api/operatingsystems/775246587\n200\n{\n  \"operatingsystem\": {\n    \"id\": 775246587,\n    \"config_templates\": [],\n    \"media\": [],\n    \"architectures\": [],\n    \"name\": \"NoHosts 1.1\",\n    \"ptables\": []\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"id","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"id"}],"apis":[{"http_method":"DELETE","short_description":"Delete an OS.","api_url":"/api/operatingsystems/:id"}],"doc_url":"/apidoc/operatingsystems/destroy","errors":[],"formats":[],"name":"destroy","see_url":null},{"examples":[],"full_description":"","see":null,"params":[{"required":true,"full_name":"id","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"id"},{"required":false,"full_name":"medium","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"medium"},{"required":false,"full_name":"architecture","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"architecture"}],"apis":[{"http_method":"GET","short_description":"List boot files an OS.","api_url":"/api/operatingsystems/:id/bootfiles"}],"doc_url":"/apidoc/operatingsystems/bootfiles","errors":[],"formats":[],"name":"bootfiles","see_url":null}],"full_description":"","short_description":"","doc_url":"/apidoc/operatingsystems","api_url":"/api","formats":[],"name":"Operating systems"},"smart_proxies":{"version":"1","methods":[{"examples":["GET /api/smart_proxies?type=unknown_type\n500\n{\n  \"error\": {\n    \"message\": \"Invalid feature type. Select one of: TFTP, BMC, DNS, DHCP, Puppetca, Puppet.\"\n  }\n}"],"full_description":"","see":null,"params":[{"required":false,"full_name":"type","validator":"Must be String","allow_nil":false,"description":"<p>filter by type</p>\n","expected_type":"string","name":"type"},{"required":false,"full_name":"page","validator":"Must be String","allow_nil":false,"description":"<p>paginate results</p>\n","expected_type":"string","name":"page"},{"required":false,"full_name":"per_page","validator":"Must be String","allow_nil":false,"description":"<p>number of entries per request</p>\n","expected_type":"string","name":"per_page"}],"apis":[{"http_method":"GET","short_description":"List all smart_proxies.","api_url":"/api/smart_proxies"}],"doc_url":"/apidoc/smart_proxies/index","errors":[],"formats":[],"name":"index","see_url":null},{"examples":["GET /api/smart_proxies/980190962-dhcp-proxy\n200\n{\n  \"smart_proxy\": {\n    \"created_at\": \"2012-12-18T15:24:43Z\",\n    \"id\": 980190962,\n    \"url\": \"https://somewhere.net:8443\",\n    \"features\": [],\n    \"name\": \"DHCP Proxy\",\n    \"updated_at\": \"2012-12-18T15:24:43Z\"\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","allow_nil":false,"description":"","expected_type":"string","name":"id"}],"apis":[{"http_method":"GET","short_description":"Show a smart proxy.","api_url":"/api/smart_proxies/:id"}],"doc_url":"/apidoc/smart_proxies/show","errors":[],"formats":[],"name":"show","see_url":null},{"examples":["POST /api/smart_proxies\n{\n  \"smart_proxy\": {\n    \"url\": \"http://server:8443\",\n    \"name\": \"master02\"\n  }\n}\n201\n{\n  \"smart_proxy\": {\n    \"created_at\": \"2012-12-18T15:24:52Z\",\n    \"id\": 980190963,\n    \"url\": \"http://server:8443\",\n    \"name\": \"master02\",\n    \"updated_at\": \"2012-12-18T15:24:52Z\"\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"smart_proxy","validator":"Must be a Hash","params":[{"required":true,"full_name":"smart_proxy[name]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"name"},{"required":true,"full_name":"smart_proxy[url]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"url"}],"allow_nil":false,"description":"","expected_type":"hash","name":"smart_proxy"}],"apis":[{"http_method":"POST","short_description":"Create a smart proxy.","api_url":"/api/smart_proxies"}],"doc_url":"/apidoc/smart_proxies/create","errors":[],"formats":[],"name":"create","see_url":null},{"examples":["PUT /api/smart_proxies/980190962-dhcp-proxy\n{\n  \"smart_proxy\": {}\n}\n200\n{\n  \"smart_proxy\": {\n    \"created_at\": \"2012-12-18T15:24:43Z\",\n    \"id\": 980190962,\n    \"url\": \"https://somewhere.net:8443\",\n    \"name\": \"DHCP Proxy\",\n    \"updated_at\": \"2012-12-18T15:24:43Z\"\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"id","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"id"},{"required":true,"full_name":"smart_proxy","validator":"Must be a Hash","params":[{"required":false,"full_name":"smart_proxy[name]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"name"},{"required":false,"full_name":"smart_proxy[url]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"url"}],"allow_nil":false,"description":"","expected_type":"hash","name":"smart_proxy"}],"apis":[{"http_method":"PUT","short_description":"Update a smart proxy.","api_url":"/api/smart_proxies/:id"}],"doc_url":"/apidoc/smart_proxies/update","errors":[],"formats":[],"name":"update","see_url":null},{"examples":["DELETE /api/smart_proxies/281110143-unused-proxy\n200\n{\n  \"smart_proxy\": {\n    \"created_at\": \"2012-12-18T15:24:43Z\",\n    \"id\": 281110143,\n    \"url\": \"http://else.where:4567\",\n    \"name\": \"Unused Proxy\",\n    \"updated_at\": \"2012-12-18T15:24:43Z\"\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"id","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"id"}],"apis":[{"http_method":"DELETE","short_description":"Delete a smart_proxy.","api_url":"/api/smart_proxies/:id"}],"doc_url":"/apidoc/smart_proxies/destroy","errors":[],"formats":[],"name":"destroy","see_url":null}],"full_description":"","short_description":"","doc_url":"/apidoc/smart_proxies","api_url":"/api","formats":[],"name":"Smart proxies"},"lookup_keys":{"version":"1","methods":[{"examples":["GET /api/lookup_keys\n200\n[\n  {\n    \"lookup_key\": {\n      \"id\": 980190962,\n      \"override\": false,\n      \"default_value\": \"80\",\n      \"is_param\": true,\n      \"key\": \"port\",\n      \"required\": false,\n      \"description\": null\n    }\n  },\n  {\n    \"lookup_key\": {\n      \"id\": 113629430,\n      \"override\": true,\n      \"default_value\": \"t\",\n      \"is_param\": true,\n      \"key\": \"ssl\",\n      \"required\": false,\n      \"description\": null\n    }\n  },\n  {\n    \"lookup_key\": {\n      \"id\": 298486374,\n      \"override\": false,\n      \"default_value\": \"443\",\n      \"is_param\": false,\n      \"key\": \"ssl_port\",\n      \"required\": false,\n      \"description\": null\n    }\n  }\n]"],"full_description":"","see":null,"params":[{"required":false,"full_name":"search","validator":"Must be String","allow_nil":false,"description":"<p>filter results</p>\n","expected_type":"string","name":"search"},{"required":false,"full_name":"order","validator":"Must be String","allow_nil":false,"description":"<p>sort results</p>\n","expected_type":"string","name":"order"},{"required":false,"full_name":"page","validator":"Must be String","allow_nil":false,"description":"<p>paginate results</p>\n","expected_type":"string","name":"page"},{"required":false,"full_name":"per_page","validator":"Must be String","allow_nil":false,"description":"<p>number of entries per request</p>\n","expected_type":"string","name":"per_page"}],"apis":[{"http_method":"GET","short_description":"List all lookup_keys.","api_url":"/api/lookup_keys"}],"doc_url":"/apidoc/lookup_keys/index","errors":[],"formats":[],"name":"index","see_url":null},{"examples":["GET /api/lookup_keys/980190962-port\n200\n{\n  \"lookup_key\": {\n    \"id\": 980190962,\n    \"override\": false,\n    \"default_value\": \"80\",\n    \"is_param\": true,\n    \"key\": \"port\",\n    \"required\": false,\n    \"description\": null\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","allow_nil":false,"description":"","expected_type":"string","name":"id"}],"apis":[{"http_method":"GET","short_description":"Show a lookup key.","api_url":"/api/lookup_keys/:id"}],"doc_url":"/apidoc/lookup_keys/show","errors":[],"formats":[],"name":"show","see_url":null},{"examples":["POST /api/lookup_keys\n{\n  \"lookup_key\": {\n    \"key\": \"testkey\",\n    \"is_param\": true\n  }\n}\n201\n{\n  \"lookup_key\": {\n    \"id\": 980190963,\n    \"override\": false,\n    \"default_value\": null,\n    \"is_param\": true,\n    \"key\": \"testkey\",\n    \"required\": false,\n    \"description\": null\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"lookup_key","validator":"Must be a Hash","params":[{"required":true,"full_name":"lookup_key[key]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"key"},{"required":false,"full_name":"lookup_key[puppetclass_id]","validator":"Must be a number.","allow_nil":false,"description":"","expected_type":"string","name":"puppetclass_id"},{"required":false,"full_name":"lookup_key[default_value]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"default_value"},{"required":false,"full_name":"lookup_key[path]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"path"},{"required":false,"full_name":"lookup_key[description]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"description"},{"required":false,"full_name":"lookup_key[lookup_values_count]","validator":"Must be a number.","allow_nil":false,"description":"","expected_type":"string","name":"lookup_values_count"}],"allow_nil":false,"description":"","expected_type":"hash","name":"lookup_key"}],"apis":[{"http_method":"POST","short_description":"Create a lookup key.","api_url":"/api/lookup_keys"}],"doc_url":"/apidoc/lookup_keys/create","errors":[],"formats":[],"name":"create","see_url":null},{"examples":["PUT /api/lookup_keys/980190962-port\n{\n  \"lookup_key\": {\n    \"default_value\": 8080\n  }\n}\n200\n{\n  \"lookup_key\": {\n    \"id\": 980190962,\n    \"override\": false,\n    \"default_value\": 8080,\n    \"is_param\": true,\n    \"key\": \"port\",\n    \"required\": false,\n    \"description\": null\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","allow_nil":false,"description":"","expected_type":"string","name":"id"},{"required":true,"full_name":"lookup_key","validator":"Must be a Hash","params":[{"required":false,"full_name":"lookup_key[key]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"key"},{"required":false,"full_name":"lookup_key[puppetclass_id]","validator":"Must be a number.","allow_nil":false,"description":"","expected_type":"string","name":"puppetclass_id"},{"required":false,"full_name":"lookup_key[default_value]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"default_value"},{"required":false,"full_name":"lookup_key[path]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"path"},{"required":false,"full_name":"lookup_key[description]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"description"},{"required":false,"full_name":"lookup_key[lookup_values_count]","validator":"Must be a number.","allow_nil":false,"description":"","expected_type":"string","name":"lookup_values_count"}],"allow_nil":false,"description":"","expected_type":"hash","name":"lookup_key"}],"apis":[{"http_method":"PUT","short_description":"Update a lookup key.","api_url":"/api/lookup_keys/:id"}],"doc_url":"/apidoc/lookup_keys/update","errors":[],"formats":[],"name":"update","see_url":null},{"examples":["DELETE /api/lookup_keys/980190962-port\n200\n{\n  \"lookup_key\": {\n    \"id\": 980190962,\n    \"override\": false,\n    \"default_value\": \"80\",\n    \"is_param\": true,\n    \"key\": \"port\",\n    \"required\": false,\n    \"description\": null\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","allow_nil":false,"description":"","expected_type":"string","name":"id"}],"apis":[{"http_method":"DELETE","short_description":"Delete a lookup key.","api_url":"/api/lookup_keys/:id"}],"doc_url":"/apidoc/lookup_keys/destroy","errors":[],"formats":[],"name":"destroy","see_url":null}],"full_description":"","short_description":"","doc_url":"/apidoc/lookup_keys","api_url":"/api","formats":[],"name":"Lookup keys"},"roles":{"version":"1","methods":[{"examples":[],"full_description":"","see":null,"params":[{"required":false,"full_name":"page","validator":"Must be String","allow_nil":false,"description":"<p>paginate results</p>\n","expected_type":"string","name":"page"},{"required":false,"full_name":"per_page","validator":"Must be String","allow_nil":false,"description":"<p>number of entries per request</p>\n","expected_type":"string","name":"per_page"}],"apis":[{"http_method":"GET","short_description":"List all roles.","api_url":"/api/roles"}],"doc_url":"/apidoc/roles/index","errors":[],"formats":[],"name":"index","see_url":null},{"examples":["GET /api/roles/1\n200\n{\n  \"role\": {\n    \"permissions\": [\n      \"view_architectures\",\n      \"create_architectures\",\n      \"edit_architectures\",\n      \"destroy_architectures\",\n      \"view_authenticators\",\n      \"create_authenticators\",\n      \"edit_authenticators\",\n      \"destroy_authenticators\",\n      \"view_environments\",\n      \"create_environments\",\n      \"edit_environments\",\n      \"destroy_environments\",\n      \"import_environments\",\n      \"view_external_variables\",\n      \"create_external_variables\",\n      \"edit_external_variables\",\n      \"destroy_external_variables\",\n      \"view_domains\",\n      \"create_domain\",\n      \"edit_domains\",\n      \"destroy_domains\",\n      \"view_globals\",\n      \"create_globals\",\n      \"edit_globals\",\n      \"destroy_globals\",\n      \"view_hostgroups\",\n      \"create_hostgroups\",\n      \"edit_hostgroups\",\n      \"destroy_hostgroups\",\n      \"view_hosts\",\n      \"create_hosts\",\n      \"edit_hosts\",\n      \"destroy_hosts\",\n      \"view_media\",\n      \"create_media\",\n      \"edit_media\",\n      \"destroy_media\",\n      \"view_models\",\n      \"create_models\",\n      \"edit_models\",\n      \"destroy_models\",\n      \"view_operatingsystems\",\n      \"create_operatingsystems\",\n      \"edit_operatingsystems\",\n      \"destroy_operatingsystems\",\n      \"view_ptables\",\n      \"create_ptables\",\n      \"edit_ptables\",\n      \"destroy_ptables\",\n      \"view_puppetclasses\",\n      \"create_puppetclasses\",\n      \"edit_puppetclasses\",\n      \"destroy_puppetclasses\",\n      \"import_puppetclasses\",\n      \"view_usergroups\",\n      \"create_usergroups\",\n      \"edit_usergroups\",\n      \"destroy_usergroups\",\n      \"view_users\",\n      \"create_users\",\n      \"edit_users\",\n      \"destroy_users\",\n      \"access_settings\",\n      \"access_dashboard\",\n      \"view_reports\",\n      \"destroy_reports\",\n      \"view_facts\",\n      \"view_audit_logs\",\n      \"view_statistics\",\n      \"view_locations\",\n      \"edit_locations\",\n      \"create_locations\",\n      \"destroy_locations\",\n      \"view_organizations\",\n      \"edit_organizations\",\n      \"create_organizations\",\n      \"destroy_organizations\"\n    ],\n    \"id\": 1,\n    \"name\": \"Manager\",\n    \"builtin\": 0\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","allow_nil":false,"description":"","expected_type":"string","name":"id"}],"apis":[{"http_method":"GET","short_description":"Show an role.","api_url":"/api/roles/:id"}],"doc_url":"/apidoc/roles/show","errors":[],"formats":[],"name":"show","see_url":null},{"examples":["POST /api/roles\n{\n  \"role\": {\n    \"name\": \"staff\"\n  }\n}\n200\n{\n  \"role\": {\n    \"permissions\": [],\n    \"id\": 11,\n    \"name\": \"staff\",\n    \"builtin\": 0\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"role","validator":"Must be a Hash","params":[{"required":true,"full_name":"role[name]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"name"}],"allow_nil":false,"description":"","expected_type":"hash","name":"role"}],"apis":[{"http_method":"POST","short_description":"Create an role.","api_url":"/api/roles"}],"doc_url":"/apidoc/roles/create","errors":[],"formats":[],"name":"create","see_url":null},{"examples":["PUT /api/roles/1\n{\n  \"role\": {}\n}\n200\n{\n  \"role\": {\n    \"permissions\": [\n      \"view_architectures\",\n      \"create_architectures\",\n      \"edit_architectures\",\n      \"destroy_architectures\",\n      \"view_authenticators\",\n      \"create_authenticators\",\n      \"edit_authenticators\",\n      \"destroy_authenticators\",\n      \"view_environments\",\n      \"create_environments\",\n      \"edit_environments\",\n      \"destroy_environments\",\n      \"import_environments\",\n      \"view_external_variables\",\n      \"create_external_variables\",\n      \"edit_external_variables\",\n      \"destroy_external_variables\",\n      \"view_domains\",\n      \"create_domain\",\n      \"edit_domains\",\n      \"destroy_domains\",\n      \"view_globals\",\n      \"create_globals\",\n      \"edit_globals\",\n      \"destroy_globals\",\n      \"view_hostgroups\",\n      \"create_hostgroups\",\n      \"edit_hostgroups\",\n      \"destroy_hostgroups\",\n      \"view_hosts\",\n      \"create_hosts\",\n      \"edit_hosts\",\n      \"destroy_hosts\",\n      \"view_media\",\n      \"create_media\",\n      \"edit_media\",\n      \"destroy_media\",\n      \"view_models\",\n      \"create_models\",\n      \"edit_models\",\n      \"destroy_models\",\n      \"view_operatingsystems\",\n      \"create_operatingsystems\",\n      \"edit_operatingsystems\",\n      \"destroy_operatingsystems\",\n      \"view_ptables\",\n      \"create_ptables\",\n      \"edit_ptables\",\n      \"destroy_ptables\",\n      \"view_puppetclasses\",\n      \"create_puppetclasses\",\n      \"edit_puppetclasses\",\n      \"destroy_puppetclasses\",\n      \"import_puppetclasses\",\n      \"view_usergroups\",\n      \"create_usergroups\",\n      \"edit_usergroups\",\n      \"destroy_usergroups\",\n      \"view_users\",\n      \"create_users\",\n      \"edit_users\",\n      \"destroy_users\",\n      \"access_settings\",\n      \"access_dashboard\",\n      \"view_reports\",\n      \"destroy_reports\",\n      \"view_facts\",\n      \"view_audit_logs\",\n      \"view_statistics\",\n      \"view_locations\",\n      \"edit_locations\",\n      \"create_locations\",\n      \"destroy_locations\",\n      \"view_organizations\",\n      \"edit_organizations\",\n      \"create_organizations\",\n      \"destroy_organizations\"\n    ],\n    \"id\": 1,\n    \"name\": \"Manager\",\n    \"builtin\": 0\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"id","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"id"},{"required":true,"full_name":"role","validator":"Must be a Hash","params":[{"required":false,"full_name":"role[name]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"name"}],"allow_nil":false,"description":"","expected_type":"hash","name":"role"}],"apis":[{"http_method":"PUT","short_description":"Update an role.","api_url":"/api/roles/:id"}],"doc_url":"/apidoc/roles/update","errors":[],"formats":[],"name":"update","see_url":null},{"examples":["DELETE /api/roles/1\n200\n{\n  \"role\": {\n    \"permissions\": [\n      \"view_architectures\",\n      \"create_architectures\",\n      \"edit_architectures\",\n      \"destroy_architectures\",\n      \"view_authenticators\",\n      \"create_authenticators\",\n      \"edit_authenticators\",\n      \"destroy_authenticators\",\n      \"view_environments\",\n      \"create_environments\",\n      \"edit_environments\",\n      \"destroy_environments\",\n      \"import_environments\",\n      \"view_external_variables\",\n      \"create_external_variables\",\n      \"edit_external_variables\",\n      \"destroy_external_variables\",\n      \"view_domains\",\n      \"create_domain\",\n      \"edit_domains\",\n      \"destroy_domains\",\n      \"view_globals\",\n      \"create_globals\",\n      \"edit_globals\",\n      \"destroy_globals\",\n      \"view_hostgroups\",\n      \"create_hostgroups\",\n      \"edit_hostgroups\",\n      \"destroy_hostgroups\",\n      \"view_hosts\",\n      \"create_hosts\",\n      \"edit_hosts\",\n      \"destroy_hosts\",\n      \"view_media\",\n      \"create_media\",\n      \"edit_media\",\n      \"destroy_media\",\n      \"view_models\",\n      \"create_models\",\n      \"edit_models\",\n      \"destroy_models\",\n      \"view_operatingsystems\",\n      \"create_operatingsystems\",\n      \"edit_operatingsystems\",\n      \"destroy_operatingsystems\",\n      \"view_ptables\",\n      \"create_ptables\",\n      \"edit_ptables\",\n      \"destroy_ptables\",\n      \"view_puppetclasses\",\n      \"create_puppetclasses\",\n      \"edit_puppetclasses\",\n      \"destroy_puppetclasses\",\n      \"import_puppetclasses\",\n      \"view_usergroups\",\n      \"create_usergroups\",\n      \"edit_usergroups\",\n      \"destroy_usergroups\",\n      \"view_users\",\n      \"create_users\",\n      \"edit_users\",\n      \"destroy_users\",\n      \"access_settings\",\n      \"access_dashboard\",\n      \"view_reports\",\n      \"destroy_reports\",\n      \"view_facts\",\n      \"view_audit_logs\",\n      \"view_statistics\",\n      \"view_locations\",\n      \"edit_locations\",\n      \"create_locations\",\n      \"destroy_locations\",\n      \"view_organizations\",\n      \"edit_organizations\",\n      \"create_organizations\",\n      \"destroy_organizations\"\n    ],\n    \"id\": 1,\n    \"name\": \"Manager\",\n    \"builtin\": 0\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"id","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"id"}],"apis":[{"http_method":"DELETE","short_description":"Delete an role.","api_url":"/api/roles/:id"}],"doc_url":"/apidoc/roles/destroy","errors":[],"formats":[],"name":"destroy","see_url":null}],"full_description":"","short_description":"","doc_url":"/apidoc/roles","api_url":"/api","formats":[],"name":"Roles"},"ptables":{"version":"1","methods":[{"examples":["GET /api/ptables\n200\n[\n  {\n    \"ptable\": {\n      \"created_at\": \"2012-12-18T15:24:43Z\",\n      \"id\": 980190962,\n      \"name\": \"default\",\n      \"updated_at\": \"2012-12-18T15:24:43Z\"\n    }\n  },\n  {\n    \"ptable\": {\n      \"created_at\": \"2012-12-18T15:24:43Z\",\n      \"id\": 281110143,\n      \"name\": \"four\",\n      \"updated_at\": \"2012-12-18T15:24:43Z\"\n    }\n  },\n  {\n    \"ptable\": {\n      \"created_at\": \"2012-12-18T15:24:43Z\",\n      \"id\": 859751735,\n      \"name\": \"suse default\",\n      \"updated_at\": \"2012-12-18T15:24:43Z\"\n    }\n  },\n  {\n    \"ptable\": {\n      \"created_at\": \"2012-12-18T15:24:43Z\",\n      \"id\": 1011586618,\n      \"name\": \"ubuntu default\",\n      \"updated_at\": \"2012-12-18T15:24:43Z\"\n    }\n  }\n]"],"full_description":"","see":null,"params":[{"required":false,"full_name":"search","validator":"Must be String","allow_nil":false,"description":"<p>filter results</p>\n","expected_type":"string","name":"search"},{"required":false,"full_name":"order","validator":"Must be String","allow_nil":false,"description":"<p>sort results</p>\n","expected_type":"string","name":"order"},{"required":false,"full_name":"page","validator":"Must be String","allow_nil":false,"description":"<p>paginate results</p>\n","expected_type":"string","name":"page"},{"required":false,"full_name":"per_page","validator":"Must be String","allow_nil":false,"description":"<p>number of entries per request</p>\n","expected_type":"string","name":"per_page"}],"apis":[{"http_method":"GET","short_description":"List all ptables.","api_url":"/api/ptables"}],"doc_url":"/apidoc/ptables/index","errors":[],"formats":[],"name":"index","see_url":null},{"examples":["GET /api/ptables/980190962\n200\n{\n  \"ptable\": {\n    \"created_at\": \"2012-12-18T15:24:43Z\",\n    \"id\": 980190962,\n    \"name\": \"default\",\n    \"updated_at\": \"2012-12-18T15:24:43Z\"\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","allow_nil":false,"description":"","expected_type":"string","name":"id"}],"apis":[{"http_method":"GET","short_description":"Show a ptable.","api_url":"/api/ptables/:id"}],"doc_url":"/apidoc/ptables/show","errors":[],"formats":[],"name":"show","see_url":null},{"examples":["POST /api/ptables\n{\n  \"ptable\": {\n    \"layout\": \"d-i partman-auto/disk\",\n    \"name\": \"ptable_test\"\n  }\n}\n201\n{\n  \"ptable\": {\n    \"id\": 1011586619,\n    \"name\": \"ptable_test\"\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"ptable","validator":"Must be a Hash","params":[{"required":true,"full_name":"ptable[name]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"name"},{"required":true,"full_name":"ptable[layout]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"layout"},{"required":false,"full_name":"ptable[os_family]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"os_family"}],"allow_nil":false,"description":"","expected_type":"hash","name":"ptable"}],"apis":[{"http_method":"POST","short_description":"Create a ptable.","api_url":"/api/ptables"}],"doc_url":"/apidoc/ptables/create","errors":[],"formats":[],"name":"create","see_url":null},{"examples":["PUT /api/ptables/980190962\n{\n  \"ptable\": {}\n}\n200\n{\n  \"ptable\": {\n    \"id\": 980190962,\n    \"name\": \"default\"\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"id","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"id"},{"required":true,"full_name":"ptable","validator":"Must be a Hash","params":[{"required":false,"full_name":"ptable[name]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"name"},{"required":false,"full_name":"ptable[layout]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"layout"},{"required":false,"full_name":"ptable[os_family]","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"os_family"}],"allow_nil":false,"description":"","expected_type":"hash","name":"ptable"}],"apis":[{"http_method":"PUT","short_description":"Update a ptable.","api_url":"/api/ptables/:id"}],"doc_url":"/apidoc/ptables/update","errors":[],"formats":[],"name":"update","see_url":null},{"examples":["DELETE /api/ptables/980190962\n422\n{\n  \"ptable\": {\n    \"errors\": {\n      \"base\": [\n        \"default is used by temp01.yourdomain.net\",\n        \"default is used by temp.yourdomain.net\",\n        \"default is used by my5name.mydomain.net\",\n        \"default is used by dhcp.mydomain.net\",\n        \"default is used by sdhcp.mydomain.net\"\n      ]\n    },\n    \"id\": 980190962,\n    \"full_messages\": [\n      \"default is used by temp01.yourdomain.net\",\n      \"default is used by temp.yourdomain.net\",\n      \"default is used by my5name.mydomain.net\",\n      \"default is used by dhcp.mydomain.net\",\n      \"default is used by sdhcp.mydomain.net\"\n    ]\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"id","validator":"Must be String","allow_nil":false,"description":"","expected_type":"string","name":"id"}],"apis":[{"http_method":"DELETE","short_description":"Delete a ptable.","api_url":"/api/ptables/:id"}],"doc_url":"/apidoc/ptables/destroy","errors":[],"formats":[],"name":"destroy","see_url":null}],"full_description":"","short_description":"","doc_url":"/apidoc/ptables","api_url":"/api","formats":[],"name":"Ptables"},"subnets":{"version":"1","methods":[{"examples":["GET /api/subnets\n200\n[\n  {\n    \"subnet\": {\n      \"to\": null,\n      \"dns_id\": 113629430,\n      \"dhcp_id\": 980190962,\n      \"id\": 980190962,\n      \"mask\": \"255.255.255.0\",\n      \"tftp_id\": 298486374,\n      \"gateway\": null,\n      \"from\": null,\n      \"priority\": null,\n      \"vlanid\": \"41\",\n      \"name\": \"one\",\n      \"domain_ids\": [\n        822172901\n      ],\n      \"dns_secondary\": null,\n      \"network\": \"2.3.4.0\",\n      \"dns_primary\": null\n    }\n  },\n  {\n    \"subnet\": {\n      \"to\": null,\n      \"dns_id\": null,\n      \"dhcp_id\": 980190962,\n      \"id\": 298486374,\n      \"mask\": \"255.255.255.0\",\n      \"tftp_id\": 298486374,\n      \"gateway\": null,\n      \"from\": null,\n      \"priority\": null,\n      \"vlanid\": \"42\",\n      \"name\": \"two\",\n      \"domain_ids\": [\n        534821992\n      ],\n      \"dns_secondary\": null,\n      \"network\": \"3.3.4.0\",\n      \"dns_primary\": null\n    }\n  },\n  {\n    \"subnet\": {\n      \"to\": null,\n      \"dns_id\": null,\n      \"dhcp_id\": 980190962,\n      \"id\": 113629430,\n      \"mask\": \"255.255.255.0\",\n      \"tftp_id\": 298486374,\n      \"gateway\": null,\n      \"from\": null,\n      \"priority\": null,\n      \"vlanid\": \"43\",\n      \"name\": \"three\",\n      \"domain_ids\": [],\n      \"dns_secondary\": null,\n      \"network\": \"3.3.4.3\",\n      \"dns_primary\": null\n    }\n  }\n]"],"full_description":"","see":null,"params":[{"required":false,"full_name":"search","validator":"Must be String","allow_nil":false,"description":"<p>Filter results</p>\n","expected_type":"string","name":"search"},{"required":false,"full_name":"order","validator":"Must be String","allow_nil":false,"description":"<p>Sort results</p>\n","expected_type":"string","name":"order"},{"required":false,"full_name":"page","validator":"Must be String","allow_nil":false,"description":"<p>paginate results</p>\n","expected_type":"string","name":"page"},{"required":false,"full_name":"per_page","validator":"Must be String","allow_nil":false,"description":"<p>number of entries per request</p>\n","expected_type":"string","name":"per_page"}],"apis":[{"http_method":"GET","short_description":"List of subnets","api_url":"/api/subnets"}],"doc_url":"/apidoc/subnets/index","errors":[],"formats":[],"name":"index","see_url":null},{"examples":["GET /api/subnets/980190962\n200\n{\n  \"subnet\": {\n    \"to\": null,\n    \"dns_id\": 113629430,\n    \"dhcp_id\": 980190962,\n    \"id\": 980190962,\n    \"dns\": {\n      \"id\": 113629430,\n      \"url\": \"http://else.where:4567\",\n      \"name\": \"DNS Proxy\"\n    },\n    \"mask\": \"255.255.255.0\",\n    \"tftp_id\": 298486374,\n    \"gateway\": null,\n    \"from\": null,\n    \"tftp\": {\n      \"id\": 298486374,\n      \"url\": \"http://somewhere.else\",\n      \"name\": \"TFTP Proxy\"\n    },\n    \"dhcp\": {\n      \"id\": 980190962,\n      \"url\": \"https://somewhere.net:8443\",\n      \"name\": \"DHCP Proxy\"\n    },\n    \"priority\": null,\n    \"vlanid\": \"41\",\n    \"name\": \"one\",\n    \"domain_ids\": [\n      822172901\n    ],\n    \"dns_secondary\": null,\n    \"network\": \"2.3.4.0\",\n    \"dns_primary\": null\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","allow_nil":false,"description":"","expected_type":"string","name":"id"}],"apis":[{"http_method":"GET","short_description":"Show a subnet.","api_url":"/api/subnets/:id"}],"doc_url":"/apidoc/subnets/show","errors":[],"formats":[],"name":"show","see_url":null},{"examples":["POST /api/subnets\n{\n  \"subnet\": {\n    \"mask\": \"255.255.255.0\",\n    \"name\": \"QA2\",\n    \"network\": \"10.35.2.27\"\n  }\n}\n200\n{\n  \"subnet\": {\n    \"to\": null,\n    \"dns_id\": null,\n    \"dhcp_id\": null,\n    \"id\": 980190963,\n    \"dns\": null,\n    \"mask\": \"255.255.255.0\",\n    \"tftp_id\": null,\n    \"from\": null,\n    \"gateway\": null,\n    \"tftp\": null,\n    \"dhcp\": null,\n    \"priority\": null,\n    \"vlanid\": null,\n    \"name\": \"QA2\",\n    \"domain_ids\": [],\n    \"dns_secondary\": null,\n    \"network\": \"10.35.2.27\",\n    \"dns_primary\": null\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"subnet","validator":"Must be a Hash","params":[{"required":true,"full_name":"subnet[name]","validator":"Must be String","allow_nil":false,"description":"<p>Subnet name</p>\n","expected_type":"string","name":"name"},{"required":true,"full_name":"subnet[network]","validator":"Must be String","allow_nil":false,"description":"<p>Subnet network</p>\n","expected_type":"string","name":"network"},{"required":true,"full_name":"subnet[mask]","validator":"Must be String","allow_nil":false,"description":"<p>Netmask for this subnet</p>\n","expected_type":"string","name":"mask"},{"required":false,"full_name":"subnet[gateway]","validator":"Must be String","allow_nil":false,"description":"<p>Primary DNS for this subnet</p>\n","expected_type":"string","name":"gateway"},{"required":false,"full_name":"subnet[dns_primary]","validator":"Must be String","allow_nil":false,"description":"<p>Primary DNS for this subnet</p>\n","expected_type":"string","name":"dns_primary"},{"required":false,"full_name":"subnet[dns_secondary]","validator":"Must be String","allow_nil":false,"description":"<p>Secondary DNS for this subnet</p>\n","expected_type":"string","name":"dns_secondary"},{"required":false,"full_name":"subnet[from]","validator":"Must be String","allow_nil":false,"description":"<p>Starting IP Address for IP auto suggestion</p>\n","expected_type":"string","name":"from"},{"required":false,"full_name":"subnet[to]","validator":"Must be String","allow_nil":false,"description":"<p>Ending IP Address for IP auto suggestion</p>\n","expected_type":"string","name":"to"},{"required":false,"full_name":"subnet[vlanid]","validator":"Must be String","allow_nil":false,"description":"<p>VLAN ID for this subnet</p>\n","expected_type":"string","name":"vlanid"},{"required":false,"full_name":"subnet[domain_ids]","validator":"Must be Array","allow_nil":false,"description":"<p>Domains in which this subnet is part</p>\n","expected_type":"string","name":"domain_ids"},{"required":false,"full_name":"subnet[dhcp_id]","validator":"Must be a number.","allow_nil":false,"description":"<p>DHCP Proxy to use within this subnet</p>\n","expected_type":"string","name":"dhcp_id"},{"required":false,"full_name":"subnet[tftp_id]","validator":"Must be a number.","allow_nil":false,"description":"<p>TFTP Proxy to use within this subnet</p>\n","expected_type":"string","name":"tftp_id"},{"required":false,"full_name":"subnet[dns_id]","validator":"Must be a number.","allow_nil":false,"description":"<p>DNS Proxy to use within this subnet</p>\n","expected_type":"string","name":"dns_id"}],"allow_nil":false,"description":"","expected_type":"hash","name":"subnet"}],"apis":[{"http_method":"POST","short_description":"Create a subnet","api_url":"/api/subnets"}],"doc_url":"/apidoc/subnets/create","errors":[],"formats":[],"name":"create","see_url":null},{"examples":["PUT /api/subnets/980190962\n{\n  \"subnet\": {}\n}\n200\n{\n  \"subnet\": {\n    \"to\": null,\n    \"dns_id\": 113629430,\n    \"dhcp_id\": 980190962,\n    \"id\": 980190962,\n    \"dns\": {\n      \"id\": 113629430,\n      \"url\": \"http://else.where:4567\",\n      \"name\": \"DNS Proxy\"\n    },\n    \"mask\": \"255.255.255.0\",\n    \"tftp_id\": 298486374,\n    \"from\": null,\n    \"gateway\": null,\n    \"tftp\": {\n      \"id\": 298486374,\n      \"url\": \"http://somewhere.else\",\n      \"name\": \"TFTP Proxy\"\n    },\n    \"dhcp\": {\n      \"id\": 980190962,\n      \"url\": \"https://somewhere.net:8443\",\n      \"name\": \"DHCP Proxy\"\n    },\n    \"priority\": null,\n    \"vlanid\": \"41\",\n    \"name\": \"one\",\n    \"domain_ids\": [\n      822172901\n    ],\n    \"dns_secondary\": null,\n    \"network\": \"2.3.4.0\",\n    \"dns_primary\": null\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"id","validator":"Must be a number.","allow_nil":false,"description":"<p>Subnet numeric identifier</p>\n","expected_type":"string","name":"id"},{"required":true,"full_name":"subnet","validator":"Must be a Hash","params":[{"required":false,"full_name":"subnet[name]","validator":"Must be String","allow_nil":false,"description":"<p>Subnet name</p>\n","expected_type":"string","name":"name"},{"required":false,"full_name":"subnet[network]","validator":"Must be String","allow_nil":false,"description":"<p>Subnet network</p>\n","expected_type":"string","name":"network"},{"required":false,"full_name":"subnet[mask]","validator":"Must be String","allow_nil":false,"description":"<p>Netmask for this subnet</p>\n","expected_type":"string","name":"mask"},{"required":false,"full_name":"subnet[gateway]","validator":"Must be String","allow_nil":true,"description":"<p>Primary DNS for this subnet</p>\n","expected_type":"string","name":"gateway"},{"required":false,"full_name":"subnet[dns_primary]","validator":"Must be String","allow_nil":true,"description":"<p>Primary DNS for this subnet</p>\n","expected_type":"string","name":"dns_primary"},{"required":false,"full_name":"subnet[dns_secondary]","validator":"Must be String","allow_nil":true,"description":"<p>Secondary DNS for this subnet</p>\n","expected_type":"string","name":"dns_secondary"},{"required":false,"full_name":"subnet[from]","validator":"Must be String","allow_nil":true,"description":"<p>Starting IP Address for IP auto suggestion</p>\n","expected_type":"string","name":"from"},{"required":false,"full_name":"subnet[to]","validator":"Must be String","allow_nil":true,"description":"<p>Ending IP Address for IP auto suggestion</p>\n","expected_type":"string","name":"to"},{"required":false,"full_name":"subnet[vlanid]","validator":"Must be String","allow_nil":true,"description":"<p>VLAN ID for this subnet</p>\n","expected_type":"string","name":"vlanid"},{"required":false,"full_name":"subnet[domain_ids]","validator":"Must be Array","allow_nil":true,"description":"<p>Domains in which this subnet is part</p>\n","expected_type":"string","name":"domain_ids"},{"required":false,"full_name":"subnet[dhcp_id]","validator":"Must be a number.","allow_nil":true,"description":"<p>DHCP Proxy to use within this subnet</p>\n","expected_type":"string","name":"dhcp_id"},{"required":false,"full_name":"subnet[tftp_id]","validator":"Must be a number.","allow_nil":true,"description":"<p>TFTP Proxy to use within this subnet</p>\n","expected_type":"string","name":"tftp_id"},{"required":false,"full_name":"subnet[dns_id]","validator":"Must be a number.","allow_nil":true,"description":"<p>DNS Proxy to use within this subnet</p>\n","expected_type":"string","name":"dns_id"}],"allow_nil":false,"description":"","expected_type":"hash","name":"subnet"}],"apis":[{"http_method":"PUT","short_description":"Update a subnet","api_url":"/api/subnets/:id"}],"doc_url":"/apidoc/subnets/update","errors":[],"formats":[],"name":"update","see_url":null},{"examples":["DELETE /api/subnets/980190962\n422\n{\n  \"subnet\": {\n    \"errors\": {\n      \"base\": [\n        \"2.3.4.0/24 is used by temp-01.yourdomain.net\",\n        \"2.3.4.0/24 is used by suse01.yourdomain.net\",\n        \"2.3.4.0/24 is used by temp01.yourdomain.net\",\n        \"2.3.4.0/24 is used by anotherfullhost\",\n        \"2.3.4.0/24 is used by temp.yourdomain.net\",\n        \"2.3.4.0/24 is used by my5name.mydomain.net\",\n        \"2.3.4.0/24 is used by dhcp.mydomain.net\",\n        \"2.3.4.0/24 is used by otherfullhost\",\n        \"2.3.4.0/24 is used by sdhcp.mydomain.net\",\n        \"2.3.4.0/24 is used by sol10host\",\n        \"2.3.4.0/24 is used by sdhcp.mydomain.net\"\n      ]\n    },\n    \"id\": 980190962,\n    \"full_messages\": [\n      \"2.3.4.0/24 is used by temp-01.yourdomain.net\",\n      \"2.3.4.0/24 is used by suse01.yourdomain.net\",\n      \"2.3.4.0/24 is used by temp01.yourdomain.net\",\n      \"2.3.4.0/24 is used by anotherfullhost\",\n      \"2.3.4.0/24 is used by temp.yourdomain.net\",\n      \"2.3.4.0/24 is used by my5name.mydomain.net\",\n      \"2.3.4.0/24 is used by dhcp.mydomain.net\",\n      \"2.3.4.0/24 is used by otherfullhost\",\n      \"2.3.4.0/24 is used by sdhcp.mydomain.net\",\n      \"2.3.4.0/24 is used by sol10host\",\n      \"2.3.4.0/24 is used by sdhcp.mydomain.net\"\n    ]\n  }\n}"],"full_description":"","see":null,"params":[{"required":true,"full_name":"id","validator":"Must be a number.","allow_nil":false,"description":"<p>Subnet numeric identifier</p>\n","expected_type":"string","name":"id"}],"apis":[{"http_method":"DELETE","short_description":"Delete a subnet","api_url":"/api/subnets/:id"}],"doc_url":"/apidoc/subnets/destroy","errors":[],"formats":[],"name":"destroy","see_url":null}],"full_description":"","short_description":"","doc_url":"/apidoc/subnets","api_url":"/api","formats":[],"name":"Subnets"}},"doc_url":"/apidoc","copyright":"","api_url":"/api","info":"<p>The Foreman is aimed to be a single address for all machines life cycle management.</p>\n","name":"Foreman"}}
+{"docs":{"name":"Foreman","api_url":"/api","resources":{"hostgroup_classes":{"name":"Hostgroup classes","formats":null,"api_url":"/api","version":"v2","short_description":null,"full_description":null,"doc_url":"/apidoc/v2/hostgroup_classes","methods":[{"see":null,"name":"index","examples":[],"errors":[],"params":[],"formats":null,"see_url":null,"apis":[{"api_url":"/api/hostgroups/:hostgroup_id/puppetclass_ids","short_description":"List all puppetclass id's for hostgroup","http_method":"GET"}],"full_description":"","doc_url":"/apidoc/v2/hostgroup_classes/index"},{"see":null,"name":"create","examples":[],"errors":[],"params":[{"allow_nil":false,"name":"hostgroup_id","full_name":"hostgroup_id","validator":"Must be String","description":"<p>id of hostgroup</p>","expected_type":"string","required":true},{"allow_nil":false,"name":"puppetclass_id","full_name":"puppetclass_id","validator":"Must be String","description":"<p>id of puppetclass</p>","expected_type":"string","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/hostgroups/:hostgroup_id/puppetclass_ids","short_description":"Add a puppetclass to hostgroup","http_method":"POST"}],"full_description":"","doc_url":"/apidoc/v2/hostgroup_classes/create"},{"see":null,"name":"destroy","examples":[],"errors":[],"params":[{"allow_nil":false,"name":"hostgroup_id","full_name":"hostgroup_id","validator":"Must be String","description":"<p>id of hostgroup</p>","expected_type":"string","required":true},{"allow_nil":false,"name":"puppetclass_id","full_name":"puppetclass_id","validator":"Must be String","description":"<p>id of puppetclass</p>","expected_type":"string","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/hostgroups/:hostgroup_id/puppetclass_ids/:id","short_description":"Remove a puppetclass from hostgroup","http_method":"DELETE"}],"full_description":"","doc_url":"/apidoc/v2/hostgroup_classes/destroy"}]},"lookup_keys":{"name":"Lookup keys","formats":null,"api_url":"/api","version":"v2","short_description":null,"full_description":null,"doc_url":"/apidoc/v2/lookup_keys","methods":[{"see":null,"name":"index","examples":["GET /api/lookup_keys\n200\n[\n  {\n    \"lookup_key\": {\n      \"is_param\": true,\n      \"id\": 980190962,\n      \"description\": null,\n      \"default_value\": \"80\",\n      \"override\": false,\n      \"key\": \"port\",\n      \"required\": false\n    }\n  },\n  {\n    \"lookup_key\": {\n      \"is_param\": true,\n      \"id\": 113629430,\n      \"description\": null,\n      \"default_value\": \"t\",\n      \"override\": true,\n      \"key\": \"ssl\",\n      \"required\": false\n    }\n  },\n  {\n    \"lookup_key\": {\n      \"is_param\": false,\n      \"id\": 298486374,\n      \"description\": null,\n      \"default_value\": \"443\",\n      \"override\": false,\n      \"key\": \"ssl_port\",\n      \"required\": false\n    }\n  }\n]"],"errors":[],"params":[{"allow_nil":false,"name":"search","full_name":"search","validator":"Must be String","description":"<p>filter results</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"order","full_name":"order","validator":"Must be String","description":"<p>sort results</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"page","full_name":"page","validator":"Must be String","description":"<p>paginate results</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"per_page","full_name":"per_page","validator":"Must be String","description":"<p>number of entries per request</p>","expected_type":"string","required":false}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/lookup_keys","short_description":"List all lookup_keys.","http_method":"GET"},{"api_url":"/api/hosts/:host_id/lookup_keys","short_description":"List all lookup_keys of a given host.","http_method":"GET"}],"full_description":"","doc_url":"/apidoc/v2/lookup_keys/index"},{"see":null,"name":"show","examples":["GET /api/lookup_keys/980190962-port\n200\n{\n  \"lookup_key\": {\n    \"is_param\": true,\n    \"id\": 980190962,\n    \"description\": null,\n    \"default_value\": \"80\",\n    \"override\": false,\n    \"key\": \"port\",\n    \"required\": false\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"id","full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","description":"","expected_type":"string","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/lookup_keys/:id","short_description":"Show a lookup key.","http_method":"GET"}],"full_description":"","doc_url":"/apidoc/v2/lookup_keys/show"},{"see":null,"name":"create","examples":["POST /api/lookup_keys\n{\n  \"lookup_key\": {\n    \"is_param\": true,\n    \"key\": \"testkey\"\n  }\n}\n201\n{\n  \"lookup_key\": {\n    \"is_param\": true,\n    \"id\": 980190963,\n    \"description\": null,\n    \"default_value\": null,\n    \"override\": false,\n    \"key\": \"testkey\",\n    \"required\": false\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"lookup_key","full_name":"lookup_key","params":[{"name":"key","allow_nil":false,"full_name":"lookup_key[key]","validator":"Must be String","expected_type":"string","description":"","required":true},{"name":"puppetclass_id","allow_nil":false,"full_name":"lookup_key[puppetclass_id]","validator":"Must be a number.","expected_type":"string","description":"","required":false},{"name":"default_value","allow_nil":false,"full_name":"lookup_key[default_value]","validator":"Must be String","expected_type":"string","description":"","required":false},{"name":"path","allow_nil":false,"full_name":"lookup_key[path]","validator":"Must be String","expected_type":"string","description":"","required":false},{"name":"description","allow_nil":false,"full_name":"lookup_key[description]","validator":"Must be String","expected_type":"string","description":"","required":false},{"name":"lookup_values_count","allow_nil":false,"full_name":"lookup_key[lookup_values_count]","validator":"Must be a number.","expected_type":"string","description":"","required":false}],"validator":"Must be a Hash","description":"","expected_type":"hash","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/lookup_keys","short_description":"Create a lookup key.","http_method":"POST"}],"full_description":"","doc_url":"/apidoc/v2/lookup_keys/create"},{"see":null,"name":"update","examples":["PUT /api/lookup_keys/980190962-port\n{\n  \"lookup_key\": {\n    \"default_value\": 8080\n  }\n}\n200\n{\n  \"lookup_key\": {\n    \"is_param\": true,\n    \"id\": 980190962,\n    \"description\": null,\n    \"default_value\": 8080,\n    \"override\": false,\n    \"key\": \"port\",\n    \"required\": false\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"id","full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","description":"","expected_type":"string","required":true},{"allow_nil":false,"name":"lookup_key","full_name":"lookup_key","params":[{"name":"key","allow_nil":false,"full_name":"lookup_key[key]","validator":"Must be String","expected_type":"string","description":"","required":false},{"name":"puppetclass_id","allow_nil":false,"full_name":"lookup_key[puppetclass_id]","validator":"Must be a number.","expected_type":"string","description":"","required":false},{"name":"default_value","allow_nil":false,"full_name":"lookup_key[default_value]","validator":"Must be String","expected_type":"string","description":"","required":false},{"name":"path","allow_nil":false,"full_name":"lookup_key[path]","validator":"Must be String","expected_type":"string","description":"","required":false},{"name":"description","allow_nil":false,"full_name":"lookup_key[description]","validator":"Must be String","expected_type":"string","description":"","required":false},{"name":"lookup_values_count","allow_nil":false,"full_name":"lookup_key[lookup_values_count]","validator":"Must be a number.","expected_type":"string","description":"","required":false}],"validator":"Must be a Hash","description":"","expected_type":"hash","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/lookup_keys/:id","short_description":"Update a lookup key.","http_method":"PUT"}],"full_description":"","doc_url":"/apidoc/v2/lookup_keys/update"},{"see":null,"name":"destroy","examples":["DELETE /api/lookup_keys/980190962-port\n200\n{\n  \"lookup_key\": {\n    \"is_param\": true,\n    \"id\": 980190962,\n    \"description\": null,\n    \"default_value\": \"80\",\n    \"override\": false,\n    \"key\": \"port\",\n    \"required\": false\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"id","full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","description":"","expected_type":"string","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/lookup_keys/:id","short_description":"Delete a lookup key.","http_method":"DELETE"}],"full_description":"","doc_url":"/apidoc/v2/lookup_keys/destroy"}]},"parameters":{"name":"Parameters","formats":null,"api_url":"/api","version":"v2","short_description":null,"full_description":"<p>These API calls are related to <b>nested parameters for host, domain, hostgroup, operating system</b>. If you are looking for <a href='common_parameters.html'>global parameters</a>, go to <a href='common_parameters.html'>this link</a>.</p>","doc_url":"/apidoc/v2/parameters","methods":[{"see":null,"name":"index","examples":[],"errors":[],"params":[{"allow_nil":false,"name":"host_id","full_name":"host_id","validator":"Must be String","description":"<p>id of host</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"hostgroup_id","full_name":"hostgroup_id","validator":"Must be String","description":"<p>id of hostgroup</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"domain_id","full_name":"domain_id","validator":"Must be String","description":"<p>id of domain</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"operatingsystem_id","full_name":"operatingsystem_id","validator":"Must be String","description":"<p>id of operating system</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"page","full_name":"page","validator":"Must be String","description":"<p>paginate results</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"per_page","full_name":"per_page","validator":"Must be String","description":"<p>number of entries per request</p>","expected_type":"string","required":false}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/host/:host_id/parameters","short_description":"List all parameters for host","http_method":"GET"},{"api_url":"/api/hostgroup/:hostgroup_id/parameters","short_description":"List all parameters for hostgroup","http_method":"GET"},{"api_url":"/api/domain/:domain_id/parameters","short_description":"List all parameters for domain","http_method":"GET"},{"api_url":"/api/operatingsystem/:operatingsystem_id/parameters","short_description":"List all parameters for operating system","http_method":"GET"}],"full_description":"","doc_url":"/apidoc/v2/parameters/index"},{"see":null,"name":"show","examples":[],"errors":[],"params":[{"allow_nil":false,"name":"host_id","full_name":"host_id","validator":"Must be String","description":"<p>id of host</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"hostgroup_id","full_name":"hostgroup_id","validator":"Must be String","description":"<p>id of hostgroup</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"domain_id","full_name":"domain_id","validator":"Must be String","description":"<p>id of domain</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"operatingsystem_id","full_name":"operatingsystem_id","validator":"Must be String","description":"<p>id of operating system</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"id","full_name":"id","validator":"Must be String","description":"<p>id of parameter</p>","expected_type":"string","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/host/:host_id/parameters/:id","short_description":"Show a nested parameter for host","http_method":"GET"},{"api_url":"/api/hostgroup/:hostgroup_id/parameters/:id","short_description":"Show a nested parameter for hostgroup","http_method":"GET"},{"api_url":"/api/domain/:domain_id/parameters/:id","short_description":"Show a nested parameter for domain","http_method":"GET"},{"api_url":"/api/operatingsystem/:operatingsystem_id/parameters/:id","short_description":"Show a nested parameter for operating system","http_method":"GET"}],"full_description":"","doc_url":"/apidoc/v2/parameters/show"},{"see":null,"name":"create","examples":[],"errors":[],"params":[{"allow_nil":false,"name":"host_id","full_name":"host_id","validator":"Must be String","description":"<p>id of host</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"hostgroup_id","full_name":"hostgroup_id","validator":"Must be String","description":"<p>id of hostgroup</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"domain_id","full_name":"domain_id","validator":"Must be String","description":"<p>id of domain</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"operatingsystem_id","full_name":"operatingsystem_id","validator":"Must be String","description":"<p>id of operating system</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"id","full_name":"id","validator":"Must be String","description":"<p>id of parameter</p>","expected_type":"string","required":true},{"allow_nil":false,"name":"parameter","full_name":"parameter","params":[{"name":"name","allow_nil":false,"full_name":"parameter[name]","validator":"Must be String","expected_type":"string","description":"","required":false},{"name":"value","allow_nil":false,"full_name":"parameter[value]","validator":"Must be String","expected_type":"string","description":"","required":false}],"validator":"Must be a Hash","description":"","expected_type":"hash","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/host/:host_id/parameters/:id","short_description":"Create a nested parameter for host","http_method":"POST"},{"api_url":"/api/hostgroup/:hostgroup_id/parameters/:id","short_description":"Create a nested parameter for hostgroup","http_method":"POST"},{"api_url":"/api/domain/:domain_id/parameters/:id","short_description":"Create a nested parameter for domain","http_method":"POST"},{"api_url":"/api/operatingsystem/:operatingsystem_id/parameters/:id","short_description":"Create a nested parameter for operating system","http_method":"POST"}],"full_description":"","doc_url":"/apidoc/v2/parameters/create"},{"see":null,"name":"update","examples":[],"errors":[],"params":[{"allow_nil":false,"name":"host_id","full_name":"host_id","validator":"Must be String","description":"<p>id of host</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"hostgroup_id","full_name":"hostgroup_id","validator":"Must be String","description":"<p>id of hostgroup</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"domain_id","full_name":"domain_id","validator":"Must be String","description":"<p>id of domain</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"operatingsystem_id","full_name":"operatingsystem_id","validator":"Must be String","description":"<p>id of operating system</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"id","full_name":"id","validator":"Must be String","description":"<p>id of parameter</p>","expected_type":"string","required":true},{"allow_nil":false,"name":"parameter","full_name":"parameter","params":[{"name":"name","allow_nil":false,"full_name":"parameter[name]","validator":"Must be String","expected_type":"string","description":"","required":false},{"name":"value","allow_nil":false,"full_name":"parameter[value]","validator":"Must be String","expected_type":"string","description":"","required":false}],"validator":"Must be a Hash","description":"","expected_type":"hash","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/host/:host_id/parameters/:id","short_description":"Update a nested parameter for host","http_method":"PUT"},{"api_url":"/api/hostgroup/:hostgroup_id/parameters/:id","short_description":"Update a nested parameter for hostgroup","http_method":"PUT"},{"api_url":"/api/domain/:domain_id/parameters/:id","short_description":"Update a nested parameter for domain","http_method":"PUT"},{"api_url":"/api/operatingsystem/:operatingsystem_id/parameters/:id","short_description":"Update a nested parameter for operating system","http_method":"PUT"}],"full_description":"","doc_url":"/apidoc/v2/parameters/update"},{"see":null,"name":"destroy","examples":[],"errors":[],"params":[{"allow_nil":false,"name":"host_id","full_name":"host_id","validator":"Must be String","description":"<p>id of host</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"hostgroup_id","full_name":"hostgroup_id","validator":"Must be String","description":"<p>id of hostgroup</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"domain_id","full_name":"domain_id","validator":"Must be String","description":"<p>id of domain</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"operatingsystem_id","full_name":"operatingsystem_id","validator":"Must be String","description":"<p>id of operating system</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"id","full_name":"id","validator":"Must be String","description":"<p>id of parameter</p>","expected_type":"string","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/host/:host_id/parameters/:id","short_description":"Delete a nested parameter for host","http_method":"DELETE"},{"api_url":"/api/hostgroup/:hostgroup_id/parameters/:id","short_description":"Delete a nested parameter for hostgroup","http_method":"DELETE"},{"api_url":"/api/domain/:domain_id/parameters/:id","short_description":"Delete a nested parameter for domain","http_method":"DELETE"},{"api_url":"/api/operatingsystem/:operatingsystem_id/parameters/:id","short_description":"Delete a nested parameter for operating system","http_method":"DELETE"}],"full_description":"","doc_url":"/apidoc/v2/parameters/destroy"},{"see":null,"name":"reset","examples":[],"errors":[],"params":[],"formats":null,"see_url":null,"apis":[{"api_url":"/api/host/:host_id/parameters","short_description":"Delete all nested parameters for host","http_method":"DELETE"},{"api_url":"/api/hostgroup/:hostgroup_id/parameters","short_description":"Delete all nested parameters for hostgroup","http_method":"DELETE"},{"api_url":"/api/domain/:domain_id/parameters","short_description":"Delete all nested parameters for domain","http_method":"DELETE"},{"api_url":"/api/operatingsystem/:operatingsystem_id/parameters","short_description":"Delete all nested parameters for operating system","http_method":"DELETE"}],"full_description":"","doc_url":"/apidoc/v2/parameters/reset"}]},"operatingsystems":{"name":"Operating systems","formats":null,"api_url":"/api","version":"v2","short_description":null,"full_description":"","doc_url":"/apidoc/v2/operatingsystems","methods":[{"see":null,"name":"index","examples":[],"errors":[],"params":[{"allow_nil":false,"name":"search","full_name":"search","validator":"Must be String","description":"<p>filter results</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"order","full_name":"order","validator":"Must be String","description":"<p>for example, name ASC, or name DESC</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"page","full_name":"page","validator":"Must be String","description":"<p>paginate results</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"per_page","full_name":"per_page","validator":"Must be String","description":"<p>number of entries per request</p>","expected_type":"string","required":false}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/operatingsystems","short_description":"List all operating systems.","http_method":"GET"}],"full_description":"","doc_url":"/apidoc/v2/operatingsystems/index"},{"see":null,"name":"show","examples":["GET /api/operatingsystems/1073012828\n200\n{\n  \"operatingsystem\": {\n    \"family\": \"Redhat\",\n    \"major\": \"6\",\n    \"os_default_templates\": [],\n    \"minor\": \"1\",\n    \"name\": \"Redhat\",\n    \"architectures\": [\n      {\n        \"architecture\": {\n          \"name\": \"x86_64\",\n          \"id\": 501905019\n        }\n      }\n    ],\n    \"id\": 1073012828,\n    \"config_templates\": [\n      {\n        \"config_template\": {\n          \"name\": \"centos5_3_pxelinux\",\n          \"id\": 1007981701\n        }\n      },\n      {\n        \"config_template\": {\n          \"name\": \"MyFinish\",\n          \"id\": 104314179\n        }\n      },\n      {\n        \"config_template\": {\n          \"name\": \"MyScript\",\n          \"id\": 981457253\n        }\n      },\n      {\n        \"config_template\": {\n          \"name\": \"MyString\",\n          \"id\": 943779058\n        }\n      },\n      {\n        \"config_template\": {\n          \"name\": \"MyString2\",\n          \"id\": 269958254\n        }\n      },\n      {\n        \"config_template\": {\n          \"name\": \"PXE Default File\",\n          \"id\": 352050261\n        }\n      },\n      {\n        \"config_template\": {\n          \"name\": \"PXE Localboot Default\",\n          \"id\": 821548108\n        }\n      }\n    ],\n    \"release_name\": null,\n    \"media\": [\n      {\n        \"medium\": {\n          \"name\": \"CentOS 5.4\",\n          \"id\": 980190962\n        }\n      }\n    ],\n    \"ptables\": [\n      {\n        \"ptable\": {\n          \"name\": \"default\",\n          \"id\": 980190962\n        }\n      }\n    ]\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"id","full_name":"id","validator":"Must be String","description":"","expected_type":"string","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/operatingsystems/:id","short_description":"Show an OS.","http_method":"GET"}],"full_description":"","doc_url":"/apidoc/v2/operatingsystems/show"},{"see":null,"name":"create","examples":["POST /api/operatingsystems\n{\n  \"operatingsystem\": {\n    \"major\": \"1\",\n    \"name\": \"awsome_os\",\n    \"minor\": \"2\"\n  }\n}\n200\n{\n  \"operatingsystem\": {\n    \"family\": null,\n    \"major\": \"1\",\n    \"os_default_templates\": [],\n    \"minor\": \"2\",\n    \"name\": \"awsome_os\",\n    \"architectures\": [],\n    \"id\": 1073012829,\n    \"config_templates\": [],\n    \"release_name\": null,\n    \"media\": [],\n    \"ptables\": []\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"operatingsystem","full_name":"operatingsystem","params":[{"name":"name","allow_nil":false,"full_name":"operatingsystem[name]","validator":"Must match regular expression /\\A(\\S+)\\Z/.","expected_type":"string","description":"","required":true},{"name":"major","allow_nil":false,"full_name":"operatingsystem[major]","validator":"Must be String","expected_type":"string","description":"","required":true},{"name":"minor","allow_nil":false,"full_name":"operatingsystem[minor]","validator":"Must be String","expected_type":"string","description":"","required":true},{"name":"family","allow_nil":false,"full_name":"operatingsystem[family]","validator":"Must be String","expected_type":"string","description":"","required":false},{"name":"release_name","allow_nil":false,"full_name":"operatingsystem[release_name]","validator":"Must be String","expected_type":"string","description":"","required":false}],"validator":"Must be a Hash","description":"","expected_type":"hash","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/operatingsystems","short_description":"Create an OS.","http_method":"POST"}],"full_description":"","doc_url":"/apidoc/v2/operatingsystems/create"},{"see":null,"name":"update","examples":["PUT /api/operatingsystems/1073012828\n{\n  \"operatingsystem\": {\n    \"name\": \"new_name\"\n  }\n}\n200\n{\n  \"operatingsystem\": {\n    \"family\": \"Redhat\",\n    \"major\": \"6\",\n    \"os_default_templates\": [],\n    \"minor\": \"1\",\n    \"name\": \"new_name\",\n    \"architectures\": [\n      {\n        \"architecture\": {\n          \"name\": \"x86_64\",\n          \"id\": 501905019\n        }\n      }\n    ],\n    \"id\": 1073012828,\n    \"config_templates\": [\n      {\n        \"config_template\": {\n          \"name\": \"centos5_3_pxelinux\",\n          \"id\": 1007981701\n        }\n      },\n      {\n        \"config_template\": {\n          \"name\": \"MyFinish\",\n          \"id\": 104314179\n        }\n      },\n      {\n        \"config_template\": {\n          \"name\": \"MyScript\",\n          \"id\": 981457253\n        }\n      },\n      {\n        \"config_template\": {\n          \"name\": \"MyString\",\n          \"id\": 943779058\n        }\n      },\n      {\n        \"config_template\": {\n          \"name\": \"MyString2\",\n          \"id\": 269958254\n        }\n      },\n      {\n        \"config_template\": {\n          \"name\": \"PXE Default File\",\n          \"id\": 352050261\n        }\n      },\n      {\n        \"config_template\": {\n          \"name\": \"PXE Localboot Default\",\n          \"id\": 821548108\n        }\n      }\n    ],\n    \"release_name\": null,\n    \"media\": [\n      {\n        \"medium\": {\n          \"name\": \"CentOS 5.4\",\n          \"id\": 980190962\n        }\n      }\n    ],\n    \"ptables\": [\n      {\n        \"ptable\": {\n          \"name\": \"default\",\n          \"id\": 980190962\n        }\n      }\n    ]\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"id","full_name":"id","validator":"Must be String","description":"","expected_type":"string","required":true},{"allow_nil":false,"name":"operatingsystem","full_name":"operatingsystem","params":[{"name":"name","allow_nil":false,"full_name":"operatingsystem[name]","validator":"Must match regular expression /\\A(\\S+)\\Z/.","expected_type":"string","description":"","required":false},{"name":"major","allow_nil":false,"full_name":"operatingsystem[major]","validator":"Must be String","expected_type":"string","description":"","required":false},{"name":"minor","allow_nil":false,"full_name":"operatingsystem[minor]","validator":"Must be String","expected_type":"string","description":"","required":false},{"name":"family","allow_nil":false,"full_name":"operatingsystem[family]","validator":"Must be String","expected_type":"string","description":"","required":false},{"name":"release_name","allow_nil":false,"full_name":"operatingsystem[release_name]","validator":"Must be String","expected_type":"string","description":"","required":false}],"validator":"Must be a Hash","description":"","expected_type":"hash","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/operatingsystems/:id","short_description":"Update an OS.","http_method":"PUT"}],"full_description":"","doc_url":"/apidoc/v2/operatingsystems/update"},{"see":null,"name":"destroy","examples":["DELETE /api/operatingsystems/775246587\n200\n{\n  \"operatingsystem\": {\n    \"name\": \"NoHosts 1.1\",\n    \"architectures\": [],\n    \"id\": 775246587,\n    \"config_templates\": [],\n    \"media\": [],\n    \"ptables\": []\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"id","full_name":"id","validator":"Must be String","description":"","expected_type":"string","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/operatingsystems/:id","short_description":"Delete an OS.","http_method":"DELETE"}],"full_description":"","doc_url":"/apidoc/v2/operatingsystems/destroy"},{"see":null,"name":"bootfiles","examples":[],"errors":[],"params":[{"allow_nil":false,"name":"id","full_name":"id","validator":"Must be String","description":"","expected_type":"string","required":true},{"allow_nil":false,"name":"medium","full_name":"medium","validator":"Must be String","description":"","expected_type":"string","required":false},{"allow_nil":false,"name":"architecture","full_name":"architecture","validator":"Must be String","description":"","expected_type":"string","required":false}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/operatingsystems/:id/bootfiles","short_description":"List boot files an OS.","http_method":"GET"}],"full_description":"","doc_url":"/apidoc/v2/operatingsystems/bootfiles"}]},"fact_values":{"name":"Fact values","formats":null,"api_url":"/api","version":"v2","short_description":null,"full_description":null,"doc_url":"/apidoc/v2/fact_values","methods":[{"see":null,"name":"index","examples":["GET /api/hosts/my5name.mydomain.net/facts\n200\n{\n  \"my5name.mydomain.net\": {\n    \"kernelversion\": \"2.6.9\",\n    \"ipaddress\": \"10.0.19.33\"\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"search","full_name":"search","validator":"Must be String","description":"<p>filter results</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"order","full_name":"order","validator":"Must be String","description":"<p>sort results</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"page","full_name":"page","validator":"Must be String","description":"<p>paginate results</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"per_page","full_name":"per_page","validator":"Must be String","description":"<p>number of entries per request</p>","expected_type":"string","required":false}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/fact_values","short_description":"List all fact values.","http_method":"GET"},{"api_url":"/api/hosts/:host_id/facts","short_description":"List all fact values of a given host.","http_method":"GET"}],"full_description":"","doc_url":"/apidoc/v2/fact_values/index"}]},"template_combinations":{"name":"Template combinations","formats":null,"api_url":"/api","version":"v2","short_description":null,"full_description":null,"doc_url":"/apidoc/v2/template_combinations","methods":[{"see":null,"name":"index","examples":[],"errors":[],"params":[{"allow_nil":false,"name":"config_template_id","full_name":"config_template_id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","description":"","expected_type":"string","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/config_templates/:config_template_id/template_combinations","short_description":"List Template Combination","http_method":"GET"}],"full_description":"","doc_url":"/apidoc/v2/template_combinations/index"},{"see":null,"name":"create","examples":[],"errors":[],"params":[{"allow_nil":false,"name":"config_template_id","full_name":"config_template_id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","description":"","expected_type":"string","required":true},{"allow_nil":false,"name":"template_combination","full_name":"template_combination","params":[{"name":"environment_id","allow_nil":true,"full_name":"template_combination[environment_id]","validator":"Must be a number.","expected_type":"string","description":"<p>environment id</p>","required":false},{"name":"hostgroup_id","allow_nil":true,"full_name":"template_combination[hostgroup_id]","validator":"Must be a number.","expected_type":"string","description":"<p>hostgroup id</p>","required":false}],"validator":"Must be a Hash","description":"","expected_type":"hash","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/config_templates/:config_template_id/template_combinations","short_description":"Add a Template Combination","http_method":"POST"}],"full_description":"","doc_url":"/apidoc/v2/template_combinations/create"},{"see":null,"name":"show","examples":[],"errors":[],"params":[{"allow_nil":false,"name":"id","full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","description":"","expected_type":"string","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/template_combinations/:id","short_description":"Show Template Combination","http_method":"GET"}],"full_description":"","doc_url":"/apidoc/v2/template_combinations/show"},{"see":null,"name":"destroy","examples":[],"errors":[],"params":[{"allow_nil":false,"name":"id","full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","description":"","expected_type":"string","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/template_combinations/:id","short_description":"Delete a template","http_method":"DELETE"}],"full_description":"","doc_url":"/apidoc/v2/template_combinations/destroy"}]},"smart_proxies":{"name":"Smart proxies","formats":null,"api_url":"/api","version":"v2","short_description":null,"full_description":null,"doc_url":"/apidoc/v2/smart_proxies","methods":[{"see":null,"name":"index","examples":["GET /api/smart_proxies?type=unknown_type\n500\n{\n  \"error\": {\n    \"message\": \"Invalid feature type. Select one of: TFTP, BMC, DNS, DHCP, Puppetca, Puppet.\"\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"type","full_name":"type","validator":"Must be String","description":"<p>filter by type</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"page","full_name":"page","validator":"Must be String","description":"<p>paginate results</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"per_page","full_name":"per_page","validator":"Must be String","description":"<p>number of entries per request</p>","expected_type":"string","required":false}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/smart_proxies","short_description":"List all smart_proxies.","http_method":"GET"}],"full_description":"","doc_url":"/apidoc/v2/smart_proxies/index"},{"see":null,"name":"show","examples":["GET /api/smart_proxies/980190962-dhcp-proxy\n200\n{\n  \"smart_proxy\": {\n    \"name\": \"DHCP Proxy\",\n    \"created_at\": \"2012-12-18T15:24:43Z\",\n    \"url\": \"https://somewhere.net:8443\",\n    \"updated_at\": \"2012-12-18T15:24:43Z\",\n    \"id\": 980190962,\n    \"features\": []\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"id","full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","description":"","expected_type":"string","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/smart_proxies/:id","short_description":"Show a smart proxy.","http_method":"GET"}],"full_description":"","doc_url":"/apidoc/v2/smart_proxies/show"},{"see":null,"name":"create","examples":["POST /api/smart_proxies\n{\n  \"smart_proxy\": {\n    \"name\": \"master02\",\n    \"url\": \"http://server:8443\"\n  }\n}\n201\n{\n  \"smart_proxy\": {\n    \"name\": \"master02\",\n    \"created_at\": \"2012-12-18T15:24:52Z\",\n    \"url\": \"http://server:8443\",\n    \"updated_at\": \"2012-12-18T15:24:52Z\",\n    \"id\": 980190963\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"smart_proxy","full_name":"smart_proxy","params":[{"name":"name","allow_nil":false,"full_name":"smart_proxy[name]","validator":"Must be String","expected_type":"string","description":"","required":true},{"name":"url","allow_nil":false,"full_name":"smart_proxy[url]","validator":"Must be String","expected_type":"string","description":"","required":true}],"validator":"Must be a Hash","description":"","expected_type":"hash","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/smart_proxies","short_description":"Create a smart proxy.","http_method":"POST"}],"full_description":"","doc_url":"/apidoc/v2/smart_proxies/create"},{"see":null,"name":"update","examples":["PUT /api/smart_proxies/980190962-dhcp-proxy\n{\n  \"smart_proxy\": {}\n}\n200\n{\n  \"smart_proxy\": {\n    \"name\": \"DHCP Proxy\",\n    \"created_at\": \"2012-12-18T15:24:43Z\",\n    \"url\": \"https://somewhere.net:8443\",\n    \"updated_at\": \"2012-12-18T15:24:43Z\",\n    \"id\": 980190962\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"id","full_name":"id","validator":"Must be String","description":"","expected_type":"string","required":true},{"allow_nil":false,"name":"smart_proxy","full_name":"smart_proxy","params":[{"name":"name","allow_nil":false,"full_name":"smart_proxy[name]","validator":"Must be String","expected_type":"string","description":"","required":false},{"name":"url","allow_nil":false,"full_name":"smart_proxy[url]","validator":"Must be String","expected_type":"string","description":"","required":false}],"validator":"Must be a Hash","description":"","expected_type":"hash","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/smart_proxies/:id","short_description":"Update a smart proxy.","http_method":"PUT"}],"full_description":"","doc_url":"/apidoc/v2/smart_proxies/update"},{"see":null,"name":"destroy","examples":["DELETE /api/smart_proxies/281110143-unused-proxy\n200\n{\n  \"smart_proxy\": {\n    \"name\": \"Unused Proxy\",\n    \"created_at\": \"2012-12-18T15:24:43Z\",\n    \"url\": \"http://else.where:4567\",\n    \"updated_at\": \"2012-12-18T15:24:43Z\",\n    \"id\": 281110143\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"id","full_name":"id","validator":"Must be String","description":"","expected_type":"string","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/smart_proxies/:id","short_description":"Delete a smart_proxy.","http_method":"DELETE"}],"full_description":"","doc_url":"/apidoc/v2/smart_proxies/destroy"}]},"images":{"name":"Images","formats":null,"api_url":"/api","version":"v2","short_description":null,"full_description":null,"doc_url":"/apidoc/v2/images","methods":[{"see":null,"name":"index","examples":["GET /api/compute_resources/980190962/images\n200\n[\n  {\n    \"image\": {\n      \"operatingsystem_id\": 309172073,\n      \"name\": \"centos-2\",\n      \"architecture_id\": 501905019,\n      \"created_at\": \"2012-12-18T15:24:42Z\",\n      \"uuid\": \"MyString2\",\n      \"compute_resource_id\": 980190962,\n      \"updated_at\": \"2012-12-18T15:24:42Z\",\n      \"id\": 298486374,\n      \"username\": \"MyString\"\n    }\n  },\n  {\n    \"image\": {\n      \"operatingsystem_id\": 309172073,\n      \"name\": \"centos-1\",\n      \"architecture_id\": 501905019,\n      \"created_at\": \"2012-12-18T15:24:42Z\",\n      \"uuid\": \"string-of-uuid\",\n      \"compute_resource_id\": 980190962,\n      \"updated_at\": \"2012-12-18T15:24:42Z\",\n      \"id\": 980190962,\n      \"username\": \"root\"\n    }\n  }\n]"],"errors":[],"params":[{"allow_nil":false,"name":"search","full_name":"search","validator":"Must be String","description":"<p>filter results</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"order","full_name":"order","validator":"Must be String","description":"<p>sort results</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"page","full_name":"page","validator":"Must be String","description":"<p>paginate results</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"per_page","full_name":"per_page","validator":"Must be String","description":"<p>number of entries per request</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"compute_resource_id","full_name":"compute_resource_id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","description":"","expected_type":"string","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/compute_resources/:compute_resource_id/images","short_description":"List all images for compute resource","http_method":"GET"}],"full_description":"","doc_url":"/apidoc/v2/images/index"},{"see":null,"name":"show","examples":["GET /api/compute_resources/980190962/images/980190962\n200\n{\n  \"image\": {\n    \"operatingsystem_id\": 309172073,\n    \"name\": \"centos-1\",\n    \"architecture_id\": 501905019,\n    \"created_at\": \"2012-12-18T15:24:42Z\",\n    \"uuid\": \"string-of-uuid\",\n    \"compute_resource_id\": 980190962,\n    \"updated_at\": \"2012-12-18T15:24:42Z\",\n    \"id\": 980190962,\n    \"username\": \"root\"\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"id","full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","description":"","expected_type":"string","required":true},{"allow_nil":false,"name":"compute_resource_id","full_name":"compute_resource_id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","description":"","expected_type":"string","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/compute_resources/:compute_resource_id/images/:id","short_description":"Show an image","http_method":"GET"}],"full_description":"","doc_url":"/apidoc/v2/images/show"},{"see":null,"name":"create","examples":["POST /api/compute_resources/980190962/images\n{\n  \"image\": {\n    \"operatingsystem_id\": 309172073,\n    \"name\": \"TestImage\",\n    \"architecture_id\": 381564594,\n    \"uuid\": \"abcdef\",\n    \"compute_resource_id\": 367690737,\n    \"username\": \"ec2-user\"\n  }\n}\n201\n{\n  \"compute_resource\": {\n    \"user\": \"MyString\",\n    \"name\": \"MyString\",\n    \"created_at\": \"2012-12-18T15:24:42Z\",\n    \"uuid\": \"MyString\",\n    \"url\": \"qemu://stam/system\",\n    \"updated_at\": \"2012-12-18T15:24:42Z\",\n    \"id\": 980190962,\n    \"description\": \"MyString\",\n    \"attrs\": null\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"compute_resource_id","full_name":"compute_resource_id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","description":"","expected_type":"string","required":true},{"allow_nil":false,"name":"image","full_name":"image","params":[{"name":"name","allow_nil":false,"full_name":"image[name]","validator":"Must be String","expected_type":"string","description":"","required":true},{"name":"username","allow_nil":false,"full_name":"image[username]","validator":"Must be String","expected_type":"string","description":"","required":true},{"name":"uuid","allow_nil":false,"full_name":"image[uuid]","validator":"Must be String","expected_type":"string","description":"","required":true},{"name":"compute_resource_id","allow_nil":false,"full_name":"image[compute_resource_id]","validator":"Must be a number.","expected_type":"string","description":"","required":true},{"name":"architecture_id","allow_nil":false,"full_name":"image[architecture_id]","validator":"Must be a number.","expected_type":"string","description":"","required":true},{"name":"operatingsystem_id","allow_nil":false,"full_name":"image[operatingsystem_id]","validator":"Must be a number.","expected_type":"string","description":"","required":true}],"validator":"Must be a Hash","description":"","expected_type":"hash","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/compute_resources/:compute_resource_id/images","short_description":"Create a image","http_method":"POST"}],"full_description":"","doc_url":"/apidoc/v2/images/create"},{"see":null,"name":"update","examples":["PUT /api/compute_resources/980190962/images/980190962\n{\n  \"image\": {}\n}\n200\n{\n  \"image\": {\n    \"operatingsystem_id\": 309172073,\n    \"name\": \"centos-1\",\n    \"architecture_id\": 501905019,\n    \"created_at\": \"2012-12-18T15:24:42Z\",\n    \"uuid\": \"string-of-uuid\",\n    \"compute_resource_id\": 980190962,\n    \"updated_at\": \"2012-12-18T15:24:42Z\",\n    \"id\": 980190962,\n    \"username\": \"root\"\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"compute_resource_id","full_name":"compute_resource_id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","description":"","expected_type":"string","required":true},{"allow_nil":false,"name":"id","full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","description":"","expected_type":"string","required":true},{"allow_nil":false,"name":"image","full_name":"image","params":[{"name":"name","allow_nil":false,"full_name":"image[name]","validator":"Must be String","expected_type":"string","description":"","required":false},{"name":"username","allow_nil":false,"full_name":"image[username]","validator":"Must be String","expected_type":"string","description":"","required":false},{"name":"uuid","allow_nil":false,"full_name":"image[uuid]","validator":"Must be String","expected_type":"string","description":"","required":false},{"name":"compute_resource_id","allow_nil":false,"full_name":"image[compute_resource_id]","validator":"Must be a number.","expected_type":"string","description":"","required":false},{"name":"architecture_id","allow_nil":false,"full_name":"image[architecture_id]","validator":"Must be a number.","expected_type":"string","description":"","required":false},{"name":"operatingsystem_id","allow_nil":false,"full_name":"image[operatingsystem_id]","validator":"Must be a number.","expected_type":"string","description":"","required":false}],"validator":"Must be a Hash","description":"","expected_type":"hash","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/compute_resources/:compute_resource_id/images/:id","short_description":"Update a image.","http_method":"PUT"}],"full_description":"","doc_url":"/apidoc/v2/images/update"},{"see":null,"name":"destroy","examples":["DELETE /api/compute_resources/980190962/images/980190962\n200\n{\n  \"image\": {\n    \"operatingsystem_id\": 309172073,\n    \"name\": \"centos-1\",\n    \"architecture_id\": 501905019,\n    \"created_at\": \"2012-12-18T15:24:42Z\",\n    \"uuid\": \"string-of-uuid\",\n    \"compute_resource_id\": 980190962,\n    \"updated_at\": \"2012-12-18T15:24:42Z\",\n    \"id\": 980190962,\n    \"username\": \"root\"\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"compute_resource_id","full_name":"compute_resource_id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","description":"","expected_type":"string","required":true},{"allow_nil":false,"name":"id","full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","description":"","expected_type":"string","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/compute_resources/:compute_resource_id/images/:id","short_description":"Delete an image.","http_method":"DELETE"}],"full_description":"","doc_url":"/apidoc/v2/images/destroy"}]},"architectures":{"name":"Architectures","formats":null,"api_url":"/api","version":"v2","short_description":null,"full_description":null,"doc_url":"/apidoc/v2/architectures","methods":[{"see":null,"name":"index","examples":["GET /api/architectures\n200\n[\n  {\n    \"architecture\": {\n      \"name\": \"s390\",\n      \"created_at\": \"2012-12-18T15:24:42Z\",\n      \"updated_at\": \"2012-12-18T15:24:42Z\",\n      \"id\": 381564594,\n      \"operatingsystem_ids\": []\n    }\n  },\n  {\n    \"architecture\": {\n      \"name\": \"sparc\",\n      \"created_at\": \"2012-12-18T15:24:42Z\",\n      \"updated_at\": \"2012-12-18T15:24:42Z\",\n      \"id\": 331892513,\n      \"operatingsystem_ids\": [\n        442321401\n      ]\n    }\n  },\n  {\n    \"architecture\": {\n      \"name\": \"x86_64\",\n      \"created_at\": \"2012-12-18T15:24:42Z\",\n      \"updated_at\": \"2012-12-18T15:24:42Z\",\n      \"id\": 501905019,\n      \"operatingsystem_ids\": [\n        331303656,\n        309172073,\n        1073012828\n      ]\n    }\n  }\n]"],"errors":[],"params":[{"allow_nil":false,"name":"search","full_name":"search","validator":"Must be String","description":"<p>filter results</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"order","full_name":"order","validator":"Must be String","description":"<p>sort results</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"page","full_name":"page","validator":"Must be String","description":"<p>paginate results</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"per_page","full_name":"per_page","validator":"Must be String","description":"<p>number of entries per request</p>","expected_type":"string","required":false}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/architectures","short_description":"List all architectures.","http_method":"GET"}],"full_description":"","doc_url":"/apidoc/v2/architectures/index"},{"see":null,"name":"show","examples":["GET /api/architectures/x86_64\n200\n{\n  \"architecture\": {\n    \"name\": \"x86_64\",\n    \"created_at\": \"2012-12-18T15:24:42Z\",\n    \"updated_at\": \"2012-12-18T15:24:42Z\",\n    \"id\": 501905019,\n    \"operatingsystem_ids\": [\n      309172073,\n      1073012828,\n      331303656\n    ]\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"id","full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","description":"","expected_type":"string","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/architectures/:id","short_description":"Show an architecture.","http_method":"GET"}],"full_description":"","doc_url":"/apidoc/v2/architectures/show"},{"see":null,"name":"create","examples":["POST /api/architectures\n{\n  \"architecture\": {\n    \"name\": \"i386\"\n  }\n}\n200\n{\n  \"architecture\": {\n    \"name\": \"i386\",\n    \"created_at\": \"2012-12-18T15:24:43Z\",\n    \"updated_at\": \"2012-12-18T15:24:43Z\",\n    \"id\": 501905020,\n    \"operatingsystem_ids\": []\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"architecture","full_name":"architecture","params":[{"name":"name","allow_nil":false,"full_name":"architecture[name]","validator":"Must be String","expected_type":"string","description":"","required":true},{"name":"operatingsystem_ids","allow_nil":false,"full_name":"architecture[operatingsystem_ids]","validator":"Must be Array","expected_type":"string","description":"<p>Operatingsystem ID&#8217;s</p>","required":false}],"validator":"Must be a Hash","description":"","expected_type":"hash","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/architectures","short_description":"Create an architecture.","http_method":"POST"}],"full_description":"","doc_url":"/apidoc/v2/architectures/create"},{"see":null,"name":"update","examples":["PUT /api/architectures/x86_64\n{\n  \"architecture\": {}\n}\n200\n{\n  \"architecture\": {\n    \"name\": \"x86_64\",\n    \"id\": 501905019\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"id","full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","description":"","expected_type":"string","required":true},{"allow_nil":false,"name":"architecture","full_name":"architecture","params":[{"name":"name","allow_nil":false,"full_name":"architecture[name]","validator":"Must be String","expected_type":"string","description":"","required":false},{"name":"operatingsystem_ids","allow_nil":false,"full_name":"architecture[operatingsystem_ids]","validator":"Must be Array","expected_type":"string","description":"<p>Operatingsystem ID&#8217;s</p>","required":false}],"validator":"Must be a Hash","description":"","expected_type":"hash","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/architectures/:id","short_description":"Update an architecture.","http_method":"PUT"}],"full_description":"","doc_url":"/apidoc/v2/architectures/update"},{"see":null,"name":"destroy","examples":["DELETE /api/architectures/s390\n200\n{\n  \"architecture\": {\n    \"name\": \"s390\",\n    \"id\": 381564594\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"id","full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","description":"","expected_type":"string","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/architectures/:id","short_description":"Delete an architecture.","http_method":"DELETE"}],"full_description":"","doc_url":"/apidoc/v2/architectures/destroy"}]},"bookmarks":{"name":"Bookmarks","formats":null,"api_url":"/api","version":"v2","short_description":null,"full_description":null,"doc_url":"/apidoc/v2/bookmarks","methods":[{"see":null,"name":"index","examples":["GET /api/bookmarks\n200\n[\n  {\n    \"bookmark\": {\n      \"query\": \"bar=car\",\n      \"name\": \"bar\",\n      \"id\": 298486374,\n      \"public\": false,\n      \"owner_type\": null,\n      \"owner_id\": null,\n      \"controller\": \"hosts\"\n    }\n  },\n  {\n    \"bookmark\": {\n      \"query\": \"foo=boo\",\n      \"name\": \"foo\",\n      \"id\": 980190962,\n      \"public\": true,\n      \"owner_type\": null,\n      \"owner_id\": null,\n      \"controller\": \"hosts\"\n    }\n  }\n]"],"errors":[],"params":[{"allow_nil":false,"name":"page","full_name":"page","validator":"Must be String","description":"<p>paginate results</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"per_page","full_name":"per_page","validator":"Must be String","description":"<p>number of entries per request</p>","expected_type":"string","required":false}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/bookmarks","short_description":"List all bookmarks.","http_method":"GET"}],"full_description":"","doc_url":"/apidoc/v2/bookmarks/index"},{"see":null,"name":"show","examples":["GET /api/bookmarks/foo\n200\n{\n  \"bookmark\": {\n    \"query\": \"foo=boo\",\n    \"name\": \"foo\",\n    \"id\": 980190962,\n    \"public\": true,\n    \"owner_type\": null,\n    \"owner_id\": null,\n    \"controller\": \"hosts\"\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"id","full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","description":"","expected_type":"string","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/bookmarks/:id","short_description":"Show a bookmark.","http_method":"GET"}],"full_description":"","doc_url":"/apidoc/v2/bookmarks/show"},{"see":null,"name":"create","examples":["POST /api/bookmarks\n{\n  \"bookmark\": {\n    \"query\": \"bar\",\n    \"name\": \"foo-bar\",\n    \"public\": false,\n    \"controller\": \"hosts\"\n  }\n}\n200\n{\n  \"bookmark\": {\n    \"query\": \"bar\",\n    \"name\": \"foo-bar\",\n    \"id\": 980190963,\n    \"public\": false,\n    \"owner_type\": \"User\",\n    \"owner_id\": 886836129,\n    \"controller\": \"hosts\"\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"bookmark","full_name":"bookmark","params":[{"name":"name","allow_nil":false,"full_name":"bookmark[name]","validator":"Must be String","expected_type":"string","description":"","required":true},{"name":"controller","allow_nil":false,"full_name":"bookmark[controller]","validator":"Must be String","expected_type":"string","description":"","required":true},{"name":"query","allow_nil":false,"full_name":"bookmark[query]","validator":"Must be String","expected_type":"string","description":"","required":true},{"name":"public","allow_nil":false,"full_name":"bookmark[public]","validator":"Must be 'true' or 'false'","expected_type":"string","description":"","required":false}],"validator":"Must be a Hash","description":"","expected_type":"hash","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/bookmarks","short_description":"Create a bookmark.","http_method":"POST"}],"full_description":"","doc_url":"/apidoc/v2/bookmarks/create"},{"see":null,"name":"update","examples":["PUT /api/bookmarks/foo\n{\n  \"bookmark\": {}\n}\n200\n{\n  \"bookmark\": {\n    \"user\": {\n      \"email\": \"apiadmin@someware.com\",\n      \"name\": \"apiadmin User\",\n      \"login\": \"apiadmin\"\n    },\n    \"query\": \"foo=boo\",\n    \"name\": \"foo\",\n    \"id\": 980190962,\n    \"public\": true,\n    \"controller\": \"hosts\"\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"id","full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","description":"","expected_type":"string","required":true},{"allow_nil":false,"name":"bookmark","full_name":"bookmark","params":[{"name":"name","allow_nil":false,"full_name":"bookmark[name]","validator":"Must be String","expected_type":"string","description":"","required":false},{"name":"controller","allow_nil":false,"full_name":"bookmark[controller]","validator":"Must be String","expected_type":"string","description":"","required":false},{"name":"query","allow_nil":false,"full_name":"bookmark[query]","validator":"Must be String","expected_type":"string","description":"","required":false},{"name":"public","allow_nil":false,"full_name":"bookmark[public]","validator":"Must be 'true' or 'false'","expected_type":"string","description":"","required":false}],"validator":"Must be a Hash","description":"","expected_type":"hash","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/bookmarks/:id","short_description":"Update a bookmark.","http_method":"PUT"}],"full_description":"","doc_url":"/apidoc/v2/bookmarks/update"},{"see":null,"name":"destroy","examples":["DELETE /api/bookmarks/foo\n200\n{\n  \"bookmark\": {\n    \"query\": \"foo=boo\",\n    \"name\": \"foo\",\n    \"id\": 980190962,\n    \"public\": true,\n    \"owner_type\": null,\n    \"owner_id\": null,\n    \"controller\": \"hosts\"\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"id","full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","description":"","expected_type":"string","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/bookmarks/:id","short_description":"Delete a bookmark.","http_method":"DELETE"}],"full_description":"","doc_url":"/apidoc/v2/bookmarks/destroy"}]},"auth_source_ldaps":{"name":"Auth source ldaps","formats":null,"api_url":"/api","version":"v2","short_description":null,"full_description":null,"doc_url":"/apidoc/v2/auth_source_ldaps","methods":[{"see":null,"name":"index","examples":["GET /api/auth_source_ldaps\n200\n[\n  {\n    \"auth_source_ldap\": {\n      \"port\": 123,\n      \"account\": null,\n      \"name\": \"ldap\",\n      \"onthefly_register\": true,\n      \"attr_mail\": \"mail\",\n      \"created_at\": \"2012-12-18T15:24:43Z\",\n      \"host\": \"ldap\",\n      \"updated_at\": \"2012-12-18T15:24:43Z\",\n      \"id\": 980190962,\n      \"attr_firstname\": \"givenName\",\n      \"attr_lastname\": \"sn\",\n      \"tls\": true,\n      \"type\": \"AuthSourceLdap\",\n      \"base_dn\": \"dn=x,dn=y\",\n      \"attr_login\": \"uid\"\n    }\n  }\n]"],"errors":[],"params":[{"allow_nil":false,"name":"page","full_name":"page","validator":"Must be String","description":"<p>paginate results</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"per_page","full_name":"per_page","validator":"Must be String","description":"<p>number of entries per request</p>","expected_type":"string","required":false}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/auth_source_ldaps","short_description":"List all authsource ldaps","http_method":"GET"}],"full_description":"","doc_url":"/apidoc/v2/auth_source_ldaps/index"},{"see":null,"name":"show","examples":["GET /api/auth_source_ldaps/980190962\n200\n{\n  \"auth_source_ldap\": {\n    \"port\": 123,\n    \"account\": null,\n    \"name\": \"ldap\",\n    \"onthefly_register\": true,\n    \"attr_mail\": \"mail\",\n    \"created_at\": \"2012-12-18T15:24:43Z\",\n    \"host\": \"ldap\",\n    \"updated_at\": \"2012-12-18T15:24:43Z\",\n    \"id\": 980190962,\n    \"attr_firstname\": \"givenName\",\n    \"attr_lastname\": \"sn\",\n    \"tls\": true,\n    \"type\": \"AuthSourceLdap\",\n    \"base_dn\": \"dn=x,dn=y\",\n    \"attr_login\": \"uid\"\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"id","full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","description":"","expected_type":"string","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/auth_source_ldaps/:id","short_description":"Show an authsource ldap.","http_method":"GET"}],"full_description":"","doc_url":"/apidoc/v2/auth_source_ldaps/show"},{"see":null,"name":"create","examples":["POST /api/auth_source_ldaps\n{\n  \"auth_source_ldap\": {\n    \"name\": \"ldap2\",\n    \"host\": \"ldap2\"\n  }\n}\n201\n{\n  \"auth_source_ldap\": {\n    \"port\": 389,\n    \"account\": null,\n    \"name\": \"ldap2\",\n    \"onthefly_register\": false,\n    \"account_password\": null,\n    \"attr_mail\": null,\n    \"created_at\": \"2012-12-18T15:24:44Z\",\n    \"host\": \"ldap2\",\n    \"updated_at\": \"2012-12-18T15:24:44Z\",\n    \"id\": 980190963,\n    \"attr_firstname\": null,\n    \"attr_lastname\": null,\n    \"tls\": false,\n    \"base_dn\": null,\n    \"attr_login\": null\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"auth_source_ldap","full_name":"auth_source_ldap","params":[{"name":"name","allow_nil":false,"full_name":"auth_source_ldap[name]","validator":"Must be String","expected_type":"string","description":"","required":true},{"name":"host","allow_nil":false,"full_name":"auth_source_ldap[host]","validator":"Must be String","expected_type":"string","description":"","required":true},{"name":"port","allow_nil":false,"full_name":"auth_source_ldap[port]","validator":"Must be a number.","expected_type":"string","description":"<p>defaults to 389</p>","required":false},{"name":"account","allow_nil":false,"full_name":"auth_source_ldap[account]","validator":"Must be String","expected_type":"string","description":"","required":false},{"name":"base_dn","allow_nil":false,"full_name":"auth_source_ldap[base_dn]","validator":"Must be String","expected_type":"string","description":"","required":false},{"name":"account_password","allow_nil":false,"full_name":"auth_source_ldap[account_password]","validator":"Must be String","expected_type":"string","description":"<p>required if onthefly_register is true</p>","required":false},{"name":"attr_login","allow_nil":false,"full_name":"auth_source_ldap[attr_login]","validator":"Must be String","expected_type":"string","description":"<p>required if onthefly_register is true</p>","required":false},{"name":"attr_firstname","allow_nil":false,"full_name":"auth_source_ldap[attr_firstname]","validator":"Must be String","expected_type":"string","description":"<p>required if onthefly_register is true</p>","required":false},{"name":"attr_lastname","allow_nil":false,"full_name":"auth_source_ldap[attr_lastname]","validator":"Must be String","expected_type":"string","description":"<p>required if onthefly_register is true</p>","required":false},{"name":"attr_mail","allow_nil":false,"full_name":"auth_source_ldap[attr_mail]","validator":"Must be String","expected_type":"string","description":"<p>required if onthefly_register is true</p>","required":false},{"name":"onthefly_register","allow_nil":false,"full_name":"auth_source_ldap[onthefly_register]","validator":"Must be 'true' or 'false'","expected_type":"string","description":"","required":false},{"name":"tls","allow_nil":false,"full_name":"auth_source_ldap[tls]","validator":"Must be 'true' or 'false'","expected_type":"string","description":"","required":false}],"validator":"Must be a Hash","description":"","expected_type":"hash","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/auth_source_ldaps","short_description":"Create an auth_source_ldap.","http_method":"POST"}],"full_description":"","doc_url":"/apidoc/v2/auth_source_ldaps/create"},{"see":null,"name":"update","examples":["PUT /api/auth_source_ldaps/980190962\n{\n  \"auth_source_ldap\": {}\n}\n200\n{\n  \"auth_source_ldap\": {\n    \"port\": 123,\n    \"account\": null,\n    \"name\": \"ldap\",\n    \"onthefly_register\": true,\n    \"account_password\": null,\n    \"attr_mail\": \"mail\",\n    \"created_at\": \"2012-12-18T15:24:43Z\",\n    \"host\": \"ldap\",\n    \"updated_at\": \"2012-12-18T15:24:43Z\",\n    \"id\": 980190962,\n    \"attr_firstname\": \"givenName\",\n    \"attr_lastname\": \"sn\",\n    \"tls\": true,\n    \"base_dn\": \"dn=x,dn=y\",\n    \"attr_login\": \"uid\"\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"id","full_name":"id","validator":"Must be String","description":"","expected_type":"string","required":true},{"allow_nil":false,"name":"auth_source_ldap","full_name":"auth_source_ldap","params":[{"name":"name","allow_nil":false,"full_name":"auth_source_ldap[name]","validator":"Must be String","expected_type":"string","description":"","required":false},{"name":"host","allow_nil":false,"full_name":"auth_source_ldap[host]","validator":"Must be String","expected_type":"string","description":"","required":false},{"name":"port","allow_nil":false,"full_name":"auth_source_ldap[port]","validator":"Must be a number.","expected_type":"string","description":"<p>defaults to 389</p>","required":false},{"name":"account","allow_nil":false,"full_name":"auth_source_ldap[account]","validator":"Must be String","expected_type":"string","description":"","required":false},{"name":"base_dn","allow_nil":false,"full_name":"auth_source_ldap[base_dn]","validator":"Must be String","expected_type":"string","description":"","required":false},{"name":"account_password","allow_nil":false,"full_name":"auth_source_ldap[account_password]","validator":"Must be String","expected_type":"string","description":"<p>required if onthefly_register is true</p>","required":false},{"name":"attr_login","allow_nil":false,"full_name":"auth_source_ldap[attr_login]","validator":"Must be String","expected_type":"string","description":"<p>required if onthefly_register is true</p>","required":false},{"name":"attr_firstname","allow_nil":false,"full_name":"auth_source_ldap[attr_firstname]","validator":"Must be String","expected_type":"string","description":"<p>required if onthefly_register is true</p>","required":false},{"name":"attr_lastname","allow_nil":false,"full_name":"auth_source_ldap[attr_lastname]","validator":"Must be String","expected_type":"string","description":"<p>required if onthefly_register is true</p>","required":false},{"name":"attr_mail","allow_nil":false,"full_name":"auth_source_ldap[attr_mail]","validator":"Must be String","expected_type":"string","description":"<p>required if onthefly_register is true</p>","required":false},{"name":"onthefly_register","allow_nil":false,"full_name":"auth_source_ldap[onthefly_register]","validator":"Must be 'true' or 'false'","expected_type":"string","description":"","required":false},{"name":"tls","allow_nil":false,"full_name":"auth_source_ldap[tls]","validator":"Must be 'true' or 'false'","expected_type":"string","description":"","required":false}],"validator":"Must be a Hash","description":"","expected_type":"hash","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/auth_source_ldaps/:id","short_description":"Update an auth_source_ldap.","http_method":"PUT"}],"full_description":"","doc_url":"/apidoc/v2/auth_source_ldaps/update"},{"see":null,"name":"destroy","examples":["DELETE /api/auth_source_ldaps/980190962\n200\n{\n  \"auth_source_ldap\": {\n    \"port\": 123,\n    \"account\": null,\n    \"name\": \"ldap\",\n    \"onthefly_register\": true,\n    \"account_password\": null,\n    \"attr_mail\": \"mail\",\n    \"created_at\": \"2012-12-18T15:24:43Z\",\n    \"host\": \"ldap\",\n    \"updated_at\": \"2012-12-18T15:24:43Z\",\n    \"id\": 980190962,\n    \"attr_firstname\": \"givenName\",\n    \"attr_lastname\": \"sn\",\n    \"tls\": true,\n    \"base_dn\": \"dn=x,dn=y\",\n    \"attr_login\": \"uid\"\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"id","full_name":"id","validator":"Must be String","description":"","expected_type":"string","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/auth_source_ldaps/:id","short_description":"Delete an auth_source_ldap.","http_method":"DELETE"}],"full_description":"","doc_url":"/apidoc/v2/auth_source_ldaps/destroy"}]},"users":{"name":"Users","formats":null,"api_url":"/api","version":"v2","short_description":null,"full_description":null,"doc_url":"/apidoc/v2/users","methods":[{"see":null,"name":"index","examples":["GET /api/users\n200\n[\n  {\n    \"user\": {\n      \"mail\": \"admin@someware.com\",\n      \"created_at\": \"2012-12-18T15:24:42Z\",\n      \"updated_at\": \"2012-12-18T15:24:42Z\",\n      \"id\": 135138680,\n      \"auth_source_id\": 980190962,\n      \"lastname\": \"User\",\n      \"filter_on_owner\": null,\n      \"domains_andor\": \"or\",\n      \"facts_andor\": \"or\",\n      \"firstname\": \"Admin\",\n      \"compute_resources_andor\": \"or\",\n      \"admin\": true,\n      \"login\": \"admin\",\n      \"last_login_on\": \"2009-10-12T21:50:04Z\",\n      \"hostgroups_andor\": \"or\",\n      \"role_id\": null\n    }\n  },\n  {\n    \"user\": {\n      \"mail\": \"apiadmin@someware.com\",\n      \"created_at\": \"2012-12-18T15:24:42Z\",\n      \"updated_at\": \"2012-12-18T15:24:42Z\",\n      \"id\": 886836129,\n      \"auth_source_id\": 200482051,\n      \"lastname\": \"User\",\n      \"filter_on_owner\": null,\n      \"domains_andor\": \"or\",\n      \"facts_andor\": \"or\",\n      \"firstname\": \"apiadmin\",\n      \"compute_resources_andor\": \"or\",\n      \"admin\": true,\n      \"login\": \"apiadmin\",\n      \"last_login_on\": \"2009-10-12T21:50:04Z\",\n      \"hostgroups_andor\": \"or\",\n      \"role_id\": null\n    }\n  },\n  {\n    \"user\": {\n      \"mail\": \"userone@someware.com\",\n      \"created_at\": \"2012-12-18T15:24:42Z\",\n      \"updated_at\": \"2012-12-18T15:24:42Z\",\n      \"id\": 980190962,\n      \"auth_source_id\": 980190962,\n      \"lastname\": \"User\",\n      \"filter_on_owner\": null,\n      \"domains_andor\": \"or\",\n      \"facts_andor\": \"or\",\n      \"firstname\": \"One\",\n      \"compute_resources_andor\": \"or\",\n      \"admin\": false,\n      \"login\": \"one\",\n      \"last_login_on\": \"2009-10-12T21:50:04Z\",\n      \"hostgroups_andor\": \"or\",\n      \"role_id\": null\n    }\n  },\n  {\n    \"user\": {\n      \"mail\": \"testuser@someware.com\",\n      \"created_at\": \"2012-12-18T15:24:42Z\",\n      \"updated_at\": \"2012-12-18T15:24:42Z\",\n      \"id\": 200482051,\n      \"auth_source_id\": 200482051,\n      \"lastname\": \"User\",\n      \"filter_on_owner\": null,\n      \"domains_andor\": \"or\",\n      \"facts_andor\": \"or\",\n      \"firstname\": \"test\",\n      \"compute_resources_andor\": \"or\",\n      \"admin\": false,\n      \"login\": \"test\",\n      \"last_login_on\": \"2009-10-12T21:50:04Z\",\n      \"hostgroups_andor\": \"or\",\n      \"role_id\": null\n    }\n  },\n  {\n    \"user\": {\n      \"mail\": \"usertwo@someware.com\",\n      \"created_at\": \"2012-12-18T15:24:42Z\",\n      \"updated_at\": \"2012-12-18T15:24:42Z\",\n      \"id\": 298486374,\n      \"auth_source_id\": 980190962,\n      \"lastname\": \"User\",\n      \"filter_on_owner\": null,\n      \"domains_andor\": \"or\",\n      \"facts_andor\": \"or\",\n      \"firstname\": \"Two\",\n      \"compute_resources_andor\": \"or\",\n      \"admin\": false,\n      \"login\": \"two\",\n      \"last_login_on\": \"2009-10-12T21:50:04Z\",\n      \"hostgroups_andor\": \"or\",\n      \"role_id\": null\n    }\n  }\n]"],"errors":[],"params":[{"allow_nil":false,"name":"search","full_name":"search","validator":"Must be String","description":"<p>filter results</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"order","full_name":"order","validator":"Must be String","description":"<p>sort results</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"page","full_name":"page","validator":"Must be String","description":"<p>paginate results</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"per_page","full_name":"per_page","validator":"Must be String","description":"<p>number of entries per request</p>","expected_type":"string","required":false}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/users","short_description":"List all users.","http_method":"GET"}],"full_description":"","doc_url":"/apidoc/v2/users/index"},{"see":null,"name":"show","examples":["GET /api/users/980190962-one\n200\n{\n  \"user\": {\n    \"mail\": \"userone@someware.com\",\n    \"auth_source_ldap\": {\n      \"port\": 123,\n      \"account\": null,\n      \"name\": \"ldap\",\n      \"onthefly_register\": true,\n      \"attr_mail\": \"mail\",\n      \"created_at\": \"2012-12-18T15:24:43Z\",\n      \"host\": \"ldap\",\n      \"updated_at\": \"2012-12-18T15:24:43Z\",\n      \"id\": 980190962,\n      \"attr_lastname\": \"sn\",\n      \"attr_firstname\": \"givenName\",\n      \"tls\": true,\n      \"type\": \"AuthSourceLdap\",\n      \"base_dn\": \"dn=x,dn=y\",\n      \"attr_login\": \"uid\"\n    },\n    \"created_at\": \"2012-12-18T15:24:42Z\",\n    \"updated_at\": \"2012-12-18T15:24:42Z\",\n    \"id\": 980190962,\n    \"auth_source_id\": 980190962,\n    \"lastname\": \"User\",\n    \"filter_on_owner\": null,\n    \"domains_andor\": \"or\",\n    \"facts_andor\": \"or\",\n    \"firstname\": \"One\",\n    \"compute_resources_andor\": \"or\",\n    \"admin\": false,\n    \"login\": \"one\",\n    \"last_login_on\": \"2009-10-12T21:50:04Z\",\n    \"hostgroups_andor\": \"or\",\n    \"role_id\": null,\n    \"roles\": [\n      {\n        \"role\": {\n          \"name\": \"Viewer\",\n          \"builtin\": 0,\n          \"id\": 5,\n          \"permissions\": [\n            \"view_architectures\",\n            \"view_audit_logs\",\n            \"view_authenticators\",\n            \"access_dashboard\",\n            \"view_domains\",\n            \"view_environments\",\n            \"view_external_variables\",\n            \"view_facts\",\n            \"view_globals\",\n            \"view_hostgroups\",\n            \"view_hosts\",\n            \"view_locations\",\n            \"view_media\",\n            \"view_models\",\n            \"view_operatingsystems\",\n            \"view_ptables\",\n            \"view_puppetclasses\",\n            \"view_reports\",\n            \"access_settings\",\n            \"view_statistics\",\n            \"view_organizations\",\n            \"view_usergroups\",\n            \"view_users\"\n          ]\n        }\n      },\n      {\n        \"role\": {\n          \"name\": \"Anonymous\",\n          \"builtin\": 2,\n          \"id\": 7,\n          \"permissions\": [\n            \"view_hosts\"\n          ]\n        }\n      }\n    ]\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"id","full_name":"id","validator":"Must be String","description":"","expected_type":"string","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/users/:id","short_description":"Show an user.","http_method":"GET"}],"full_description":"","doc_url":"/apidoc/v2/users/show"},{"see":null,"name":"create","examples":[],"errors":[],"params":[{"allow_nil":false,"name":"user","full_name":"user","params":[{"name":"login","allow_nil":false,"full_name":"user[login]","validator":"Must be String","expected_type":"string","description":"","required":true},{"name":"firstname","allow_nil":false,"full_name":"user[firstname]","validator":"Must be String","expected_type":"string","description":"","required":false},{"name":"lastname","allow_nil":false,"full_name":"user[lastname]","validator":"Must be String","expected_type":"string","description":"","required":false},{"name":"mail","allow_nil":false,"full_name":"user[mail]","validator":"Must be String","expected_type":"string","description":"","required":true},{"name":"admin","allow_nil":false,"full_name":"user[admin]","validator":"Must be 'true' or 'false'","expected_type":"string","description":"<p>Is an admin account?</p>","required":false},{"name":"password","allow_nil":false,"full_name":"user[password]","validator":"Must be String","expected_type":"string","description":"","required":true},{"name":"auth_source_id","allow_nil":false,"full_name":"user[auth_source_id]","validator":"Must be Integer","expected_type":"numeric","description":"","required":true}],"validator":"Must be a Hash","description":"","expected_type":"hash","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/users","short_description":"Create an user.","http_method":"POST"}],"full_description":"<p>Adds role &#8216;Anonymous&#8217; to the user by default</p>","doc_url":"/apidoc/v2/users/create"},{"see":null,"name":"update","examples":["PUT /api/users/980190963\n{\n  \"user\": {\n    \"password\": \"dummy\",\n    \"password_confirmation\": \"DUMMY\",\n    \"login\": \"johnsmith\"\n  }\n}\n422\n{\n  \"user\": {\n    \"full_messages\": [\n      \"Password doesn't match confirmation\"\n    ],\n    \"errors\": {\n      \"password\": [\n        \"doesn't match confirmation\"\n      ]\n    },\n    \"id\": 980190963\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"id","full_name":"id","validator":"Must be String","description":"","expected_type":"string","required":true},{"allow_nil":false,"name":"user","full_name":"user","params":[{"name":"login","allow_nil":false,"full_name":"user[login]","validator":"Must be String","expected_type":"string","description":"","required":false},{"name":"firstname","allow_nil":true,"full_name":"user[firstname]","validator":"Must be String","expected_type":"string","description":"","required":false},{"name":"lastname","allow_nil":true,"full_name":"user[lastname]","validator":"Must be String","expected_type":"string","description":"","required":false},{"name":"mail","allow_nil":false,"full_name":"user[mail]","validator":"Must be String","expected_type":"string","description":"","required":false},{"name":"admin","allow_nil":false,"full_name":"user[admin]","validator":"Must be 'true' or 'false'","expected_type":"string","description":"<p>Is an admin account?</p>","required":false},{"name":"password","allow_nil":false,"full_name":"user[password]","validator":"Must be String","expected_type":"string","description":"","required":false}],"validator":"Must be a Hash","description":"","expected_type":"hash","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/users/:id","short_description":"Update an user.","http_method":"PUT"}],"full_description":"<p>Adds role &#8216;Anonymous&#8217; to the user if it is not already present. Only admin can set admin account.</p>","doc_url":"/apidoc/v2/users/update"},{"see":null,"name":"destroy","examples":["DELETE /api/users/980190962\n200\n{\n  \"user\": {\n    \"organizations_andor\": \"or\",\n    \"mail\": \"userone@someware.com\",\n    \"password_salt\": null,\n    \"locations_andor\": \"or\",\n    \"created_at\": \"2012-12-18T15:24:42Z\",\n    \"password_hash\": null,\n    \"updated_at\": \"2012-12-18T15:24:42Z\",\n    \"id\": 980190962,\n    \"auth_source_id\": 980190962,\n    \"lastname\": \"User\",\n    \"domains_andor\": \"or\",\n    \"filter_on_owner\": null,\n    \"facts_andor\": \"or\",\n    \"firstname\": \"One\",\n    \"compute_resources_andor\": \"or\",\n    \"admin\": false,\n    \"login\": \"one\",\n    \"last_login_on\": \"2009-10-12T21:50:04Z\",\n    \"hostgroups_andor\": \"or\",\n    \"role_id\": null\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"id","full_name":"id","validator":"Must be String","description":"","expected_type":"string","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/users/:id","short_description":"Delete an user.","http_method":"DELETE"}],"full_description":"","doc_url":"/apidoc/v2/users/destroy"}]},"puppetclasses":{"name":"Puppetclasses","formats":null,"api_url":"/api","version":"v2","short_description":null,"full_description":null,"doc_url":"/apidoc/v2/puppetclasses","methods":[{"see":null,"name":"index","examples":["GET /api/puppetclasses\n200\n{\n  \"base\": [\n    {\n      \"puppetclass\": {\n        \"lookup_keys\": [\n          {\n            \"id\": 298486374\n          }\n        ],\n        \"name\": \"base\",\n        \"id\": 980190962\n      }\n    }\n  ],\n  \"apache\": [\n    {\n      \"puppetclass\": {\n        \"lookup_keys\": [],\n        \"name\": \"apache\",\n        \"id\": 298486374\n      }\n    }\n  ]\n}"],"errors":[],"params":[{"allow_nil":false,"name":"host_id","full_name":"host_id","validator":"Must be String","description":"<p>id of nested host</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"hostgroup_id","full_name":"hostgroup_id","validator":"Must be String","description":"<p>id of nested hostgroup</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"environment_id","full_name":"environment_id","validator":"Must be String","description":"<p>id of nested environment</p>","expected_type":"string","required":false}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/puppetclasses","short_description":"List all puppetclasses.","http_method":"GET"},{"api_url":"/api/hosts/:host_id/puppetclasses","short_description":"List all puppetclasses for host","http_method":"GET"},{"api_url":"/api/hostgroups/:hostgroup_id/puppetclasses","short_description":"List all puppetclasses for hostgroup","http_method":"GET"},{"api_url":"/api/environments/:environment_id/puppetclasses","short_description":"List all puppetclasses for environment","http_method":"GET"}],"full_description":"","doc_url":"/apidoc/v2/puppetclasses/index"},{"see":null,"name":"show","examples":["GET /api/puppetclasses/base\n200\n{\n  \"puppetclass\": {\n    \"lookup_keys\": [\n      {\n        \"lookup_key\": {\n          \"is_param\": false,\n          \"id\": 298486374,\n          \"description\": null,\n          \"default_value\": \"443\",\n          \"override\": false,\n          \"key\": \"ssl_port\",\n          \"required\": false\n        }\n      }\n    ],\n    \"name\": \"base\",\n    \"id\": 980190962\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"host_id","full_name":"host_id","validator":"Must be String","description":"<p>id of nested host</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"hostgroup_id","full_name":"hostgroup_id","validator":"Must be String","description":"<p>id of nested hostgroup</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"environment_id","full_name":"environment_id","validator":"Must be String","description":"<p>id of nested environment</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"id","full_name":"id","validator":"Must be String","description":"<p>id of puppetclass</p>","expected_type":"string","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/puppetclasses/:id","short_description":"Show a puppetclass","http_method":"GET"},{"api_url":"/api/hosts/:host_id/puppetclasses/:id","short_description":"Show a puppetclass for host","http_method":"GET"},{"api_url":"/api/hostgroups/:hostgroup_id/puppetclasses/:id","short_description":"Show a puppetclass for hostgroup","http_method":"GET"},{"api_url":"/api/environments/:environment_id/puppetclasses/:id","short_description":"Show a puppetclass for environment","http_method":"GET"}],"full_description":"","doc_url":"/apidoc/v2/puppetclasses/show"},{"see":null,"name":"create","examples":["POST /api/puppetclasses\n{\n  \"puppetclass\": {\n    \"name\": \"test_puppetclass\"\n  }\n}\n201\n{\n  \"puppetclass\": {\n    \"lookup_keys\": [],\n    \"name\": \"test_puppetclass\",\n    \"id\": 980190963\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"puppetclass","full_name":"puppetclass","params":[{"name":"name","allow_nil":false,"full_name":"puppetclass[name]","validator":"Must be String","expected_type":"string","description":"","required":true}],"validator":"Must be a Hash","description":"","expected_type":"hash","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/puppetclasses","short_description":"Create a puppetclass.","http_method":"POST"}],"full_description":"","doc_url":"/apidoc/v2/puppetclasses/create"},{"see":null,"name":"update","examples":["PUT /api/puppetclasses/base\n{\n  \"puppetclass\": {}\n}\n200\n{\n  \"puppetclass\": {\n    \"lookup_keys\": [\n      {\n        \"id\": 298486374\n      }\n    ],\n    \"name\": \"base\",\n    \"id\": 980190962\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"id","full_name":"id","validator":"Must be String","description":"","expected_type":"string","required":true},{"allow_nil":false,"name":"puppetclass","full_name":"puppetclass","params":[{"name":"name","allow_nil":false,"full_name":"puppetclass[name]","validator":"Must be String","expected_type":"string","description":"","required":false}],"validator":"Must be a Hash","description":"","expected_type":"hash","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/puppetclasses/:id","short_description":"Update a puppetclass.","http_method":"PUT"}],"full_description":"","doc_url":"/apidoc/v2/puppetclasses/update"},{"see":null,"name":"destroy","examples":["DELETE /api/puppetclasses/base\n200\n{\n  \"puppetclass\": {\n    \"lookup_keys\": [\n      {\n        \"id\": 298486374\n      }\n    ],\n    \"name\": \"base\",\n    \"id\": 980190962\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"id","full_name":"id","validator":"Must be String","description":"","expected_type":"string","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/puppetclasses/:id","short_description":"Delete a puppetclass.","http_method":"DELETE"}],"full_description":"","doc_url":"/apidoc/v2/puppetclasses/destroy"}]},"subnets":{"name":"Subnets","formats":null,"api_url":"/api","version":"v2","short_description":null,"full_description":null,"doc_url":"/apidoc/v2/subnets","methods":[{"see":null,"name":"index","examples":["GET /api/subnets\n200\n[\n  {\n    \"subnet\": {\n      \"gateway\": null,\n      \"vlanid\": \"41\",\n      \"name\": \"one\",\n      \"priority\": null,\n      \"domain_ids\": [\n        822172901\n      ],\n      \"dhcp_id\": 980190962,\n      \"id\": 980190962,\n      \"dns_id\": 113629430,\n      \"to\": null,\n      \"tftp_id\": 298486374,\n      \"dns_secondary\": null,\n      \"mask\": \"255.255.255.0\",\n      \"from\": null,\n      \"network\": \"2.3.4.0\",\n      \"dns_primary\": null\n    }\n  },\n  {\n    \"subnet\": {\n      \"gateway\": null,\n      \"vlanid\": \"42\",\n      \"name\": \"two\",\n      \"priority\": null,\n      \"domain_ids\": [\n        534821992\n      ],\n      \"dhcp_id\": 980190962,\n      \"id\": 298486374,\n      \"dns_id\": null,\n      \"to\": null,\n      \"tftp_id\": 298486374,\n      \"dns_secondary\": null,\n      \"mask\": \"255.255.255.0\",\n      \"from\": null,\n      \"network\": \"3.3.4.0\",\n      \"dns_primary\": null\n    }\n  },\n  {\n    \"subnet\": {\n      \"gateway\": null,\n      \"vlanid\": \"43\",\n      \"name\": \"three\",\n      \"priority\": null,\n      \"domain_ids\": [],\n      \"dhcp_id\": 980190962,\n      \"id\": 113629430,\n      \"dns_id\": null,\n      \"to\": null,\n      \"tftp_id\": 298486374,\n      \"dns_secondary\": null,\n      \"mask\": \"255.255.255.0\",\n      \"from\": null,\n      \"network\": \"3.3.4.3\",\n      \"dns_primary\": null\n    }\n  }\n]"],"errors":[],"params":[{"allow_nil":false,"name":"search","full_name":"search","validator":"Must be String","description":"<p>Filter results</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"order","full_name":"order","validator":"Must be String","description":"<p>Sort results</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"page","full_name":"page","validator":"Must be String","description":"<p>paginate results</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"per_page","full_name":"per_page","validator":"Must be String","description":"<p>number of entries per request</p>","expected_type":"string","required":false}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/subnets","short_description":"List of subnets","http_method":"GET"}],"full_description":"","doc_url":"/apidoc/v2/subnets/index"},{"see":null,"name":"show","examples":["GET /api/subnets/980190962\n200\n{\n  \"subnet\": {\n    \"gateway\": null,\n    \"vlanid\": \"41\",\n    \"name\": \"one\",\n    \"priority\": null,\n    \"domain_ids\": [\n      822172901\n    ],\n    \"dhcp_id\": 980190962,\n    \"dhcp\": {\n      \"name\": \"DHCP Proxy\",\n      \"url\": \"https://somewhere.net:8443\",\n      \"id\": 980190962\n    },\n    \"id\": 980190962,\n    \"dns\": {\n      \"name\": \"DNS Proxy\",\n      \"url\": \"http://else.where:4567\",\n      \"id\": 113629430\n    },\n    \"dns_id\": 113629430,\n    \"to\": null,\n    \"tftp_id\": 298486374,\n    \"dns_secondary\": null,\n    \"tftp\": {\n      \"name\": \"TFTP Proxy\",\n      \"url\": \"http://somewhere.else\",\n      \"id\": 298486374\n    },\n    \"mask\": \"255.255.255.0\",\n    \"from\": null,\n    \"network\": \"2.3.4.0\",\n    \"dns_primary\": null\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"id","full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","description":"","expected_type":"string","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/subnets/:id","short_description":"Show a subnet.","http_method":"GET"}],"full_description":"","doc_url":"/apidoc/v2/subnets/show"},{"see":null,"name":"create","examples":["POST /api/subnets\n{\n  \"subnet\": {\n    \"name\": \"QA2\",\n    \"mask\": \"255.255.255.0\",\n    \"network\": \"10.35.2.27\"\n  }\n}\n200\n{\n  \"subnet\": {\n    \"gateway\": null,\n    \"vlanid\": null,\n    \"name\": \"QA2\",\n    \"priority\": null,\n    \"domain_ids\": [],\n    \"dhcp_id\": null,\n    \"dhcp\": null,\n    \"id\": 980190963,\n    \"dns\": null,\n    \"dns_id\": null,\n    \"to\": null,\n    \"tftp_id\": null,\n    \"dns_secondary\": null,\n    \"tftp\": null,\n    \"mask\": \"255.255.255.0\",\n    \"from\": null,\n    \"network\": \"10.35.2.27\",\n    \"dns_primary\": null\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"subnet","full_name":"subnet","params":[{"name":"name","allow_nil":false,"full_name":"subnet[name]","validator":"Must be String","expected_type":"string","description":"<p>Subnet name</p>","required":true},{"name":"network","allow_nil":false,"full_name":"subnet[network]","validator":"Must be String","expected_type":"string","description":"<p>Subnet network</p>","required":true},{"name":"mask","allow_nil":false,"full_name":"subnet[mask]","validator":"Must be String","expected_type":"string","description":"<p>Netmask for this subnet</p>","required":true},{"name":"gateway","allow_nil":false,"full_name":"subnet[gateway]","validator":"Must be String","expected_type":"string","description":"<p>Primary DNS for this subnet</p>","required":false},{"name":"dns_primary","allow_nil":false,"full_name":"subnet[dns_primary]","validator":"Must be String","expected_type":"string","description":"<p>Primary DNS for this subnet</p>","required":false},{"name":"dns_secondary","allow_nil":false,"full_name":"subnet[dns_secondary]","validator":"Must be String","expected_type":"string","description":"<p>Secondary DNS for this subnet</p>","required":false},{"name":"from","allow_nil":false,"full_name":"subnet[from]","validator":"Must be String","expected_type":"string","description":"<p>Starting IP Address for IP auto suggestion</p>","required":false},{"name":"to","allow_nil":false,"full_name":"subnet[to]","validator":"Must be String","expected_type":"string","description":"<p>Ending IP Address for IP auto suggestion</p>","required":false},{"name":"vlanid","allow_nil":false,"full_name":"subnet[vlanid]","validator":"Must be String","expected_type":"string","description":"<p>VLAN ID for this subnet</p>","required":false},{"name":"domain_ids","allow_nil":false,"full_name":"subnet[domain_ids]","validator":"Must be Array","expected_type":"string","description":"<p>Domains in which this subnet is part</p>","required":false},{"name":"dhcp_id","allow_nil":false,"full_name":"subnet[dhcp_id]","validator":"Must be a number.","expected_type":"string","description":"<p>DHCP Proxy to use within this subnet</p>","required":false},{"name":"tftp_id","allow_nil":false,"full_name":"subnet[tftp_id]","validator":"Must be a number.","expected_type":"string","description":"<p>TFTP Proxy to use within this subnet</p>","required":false},{"name":"dns_id","allow_nil":false,"full_name":"subnet[dns_id]","validator":"Must be a number.","expected_type":"string","description":"<p>DNS Proxy to use within this subnet</p>","required":false}],"validator":"Must be a Hash","description":"","expected_type":"hash","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/subnets","short_description":"Create a subnet","http_method":"POST"}],"full_description":"","doc_url":"/apidoc/v2/subnets/create"},{"see":null,"name":"update","examples":["PUT /api/subnets/980190962\n{\n  \"subnet\": {}\n}\n200\n{\n  \"subnet\": {\n    \"gateway\": null,\n    \"vlanid\": \"41\",\n    \"name\": \"one\",\n    \"priority\": null,\n    \"domain_ids\": [\n      822172901\n    ],\n    \"dhcp_id\": 980190962,\n    \"dhcp\": {\n      \"name\": \"DHCP Proxy\",\n      \"url\": \"https://somewhere.net:8443\",\n      \"id\": 980190962\n    },\n    \"id\": 980190962,\n    \"dns\": {\n      \"name\": \"DNS Proxy\",\n      \"url\": \"http://else.where:4567\",\n      \"id\": 113629430\n    },\n    \"dns_id\": 113629430,\n    \"to\": null,\n    \"tftp_id\": 298486374,\n    \"dns_secondary\": null,\n    \"tftp\": {\n      \"name\": \"TFTP Proxy\",\n      \"url\": \"http://somewhere.else\",\n      \"id\": 298486374\n    },\n    \"mask\": \"255.255.255.0\",\n    \"from\": null,\n    \"network\": \"2.3.4.0\",\n    \"dns_primary\": null\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"id","full_name":"id","validator":"Must be a number.","description":"<p>Subnet numeric identifier</p>","expected_type":"string","required":true},{"allow_nil":false,"name":"subnet","full_name":"subnet","params":[{"name":"name","allow_nil":false,"full_name":"subnet[name]","validator":"Must be String","expected_type":"string","description":"<p>Subnet name</p>","required":false},{"name":"network","allow_nil":false,"full_name":"subnet[network]","validator":"Must be String","expected_type":"string","description":"<p>Subnet network</p>","required":false},{"name":"mask","allow_nil":false,"full_name":"subnet[mask]","validator":"Must be String","expected_type":"string","description":"<p>Netmask for this subnet</p>","required":false},{"name":"gateway","allow_nil":true,"full_name":"subnet[gateway]","validator":"Must be String","expected_type":"string","description":"<p>Primary DNS for this subnet</p>","required":false},{"name":"dns_primary","allow_nil":true,"full_name":"subnet[dns_primary]","validator":"Must be String","expected_type":"string","description":"<p>Primary DNS for this subnet</p>","required":false},{"name":"dns_secondary","allow_nil":true,"full_name":"subnet[dns_secondary]","validator":"Must be String","expected_type":"string","description":"<p>Secondary DNS for this subnet</p>","required":false},{"name":"from","allow_nil":true,"full_name":"subnet[from]","validator":"Must be String","expected_type":"string","description":"<p>Starting IP Address for IP auto suggestion</p>","required":false},{"name":"to","allow_nil":true,"full_name":"subnet[to]","validator":"Must be String","expected_type":"string","description":"<p>Ending IP Address for IP auto suggestion</p>","required":false},{"name":"vlanid","allow_nil":true,"full_name":"subnet[vlanid]","validator":"Must be String","expected_type":"string","description":"<p>VLAN ID for this subnet</p>","required":false},{"name":"domain_ids","allow_nil":true,"full_name":"subnet[domain_ids]","validator":"Must be Array","expected_type":"string","description":"<p>Domains in which this subnet is part</p>","required":false},{"name":"dhcp_id","allow_nil":true,"full_name":"subnet[dhcp_id]","validator":"Must be a number.","expected_type":"string","description":"<p>DHCP Proxy to use within this subnet</p>","required":false},{"name":"tftp_id","allow_nil":true,"full_name":"subnet[tftp_id]","validator":"Must be a number.","expected_type":"string","description":"<p>TFTP Proxy to use within this subnet</p>","required":false},{"name":"dns_id","allow_nil":true,"full_name":"subnet[dns_id]","validator":"Must be a number.","expected_type":"string","description":"<p>DNS Proxy to use within this subnet</p>","required":false}],"validator":"Must be a Hash","description":"","expected_type":"hash","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/subnets/:id","short_description":"Update a subnet","http_method":"PUT"}],"full_description":"","doc_url":"/apidoc/v2/subnets/update"},{"see":null,"name":"destroy","examples":["DELETE /api/subnets/980190962\n422\n{\n  \"subnet\": {\n    \"full_messages\": [\n      \"2.3.4.0/24 is used by temp-01.yourdomain.net\",\n      \"2.3.4.0/24 is used by suse01.yourdomain.net\",\n      \"2.3.4.0/24 is used by temp01.yourdomain.net\",\n      \"2.3.4.0/24 is used by anotherfullhost\",\n      \"2.3.4.0/24 is used by temp.yourdomain.net\",\n      \"2.3.4.0/24 is used by my5name.mydomain.net\",\n      \"2.3.4.0/24 is used by dhcp.mydomain.net\",\n      \"2.3.4.0/24 is used by otherfullhost\",\n      \"2.3.4.0/24 is used by sdhcp.mydomain.net\",\n      \"2.3.4.0/24 is used by sol10host\",\n      \"2.3.4.0/24 is used by sdhcp.mydomain.net\"\n    ],\n    \"errors\": {\n      \"base\": [\n        \"2.3.4.0/24 is used by temp-01.yourdomain.net\",\n        \"2.3.4.0/24 is used by suse01.yourdomain.net\",\n        \"2.3.4.0/24 is used by temp01.yourdomain.net\",\n        \"2.3.4.0/24 is used by anotherfullhost\",\n        \"2.3.4.0/24 is used by temp.yourdomain.net\",\n        \"2.3.4.0/24 is used by my5name.mydomain.net\",\n        \"2.3.4.0/24 is used by dhcp.mydomain.net\",\n        \"2.3.4.0/24 is used by otherfullhost\",\n        \"2.3.4.0/24 is used by sdhcp.mydomain.net\",\n        \"2.3.4.0/24 is used by sol10host\",\n        \"2.3.4.0/24 is used by sdhcp.mydomain.net\"\n      ]\n    },\n    \"id\": 980190962\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"id","full_name":"id","validator":"Must be a number.","description":"<p>Subnet numeric identifier</p>","expected_type":"string","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/subnets/:id","short_description":"Delete a subnet","http_method":"DELETE"}],"full_description":"","doc_url":"/apidoc/v2/subnets/destroy"}]},"settings":{"name":"Settings","formats":null,"api_url":"/api","version":"v2","short_description":null,"full_description":null,"doc_url":"/apidoc/v2/settings","methods":[{"see":null,"name":"index","examples":[],"errors":[],"params":[{"allow_nil":false,"name":"search","full_name":"search","validator":"Must be String","description":"<p>Filter results</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"order","full_name":"order","validator":"Must be String","description":"<p>Sort results</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"page","full_name":"page","validator":"Must be String","description":"<p>paginate results</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"per_page","full_name":"per_page","validator":"Must be String","description":"<p>number of entries per request</p>","expected_type":"string","required":false}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/settings","short_description":"List all settings.","http_method":"GET"}],"full_description":"","doc_url":"/apidoc/v2/settings/index"},{"see":null,"name":"show","examples":["GET /api/settings/333972760\n200\n{\n  \"setting\": {\n    \"settings_type\": null,\n    \"name\": \"administrator\",\n    \"created_at\": \"2012-12-18T15:24:43Z\",\n    \"category\": \"General\",\n    \"updated_at\": \"2012-12-18T15:24:43Z\",\n    \"id\": 333972760,\n    \"description\": \"The Default administrator email address\",\n    \"value\": \"root@some.host.fqdn\",\n    \"default\": \"root@some.host.fqdn\"\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"id","full_name":"id","validator":"Must be String","description":"","expected_type":"string","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/settings/:id","short_description":"Show an setting.","http_method":"GET"}],"full_description":"","doc_url":"/apidoc/v2/settings/show"},{"see":null,"name":"update","examples":["PUT /api/settings/333972760\n{\n  \"setting\": {}\n}\n200\n{\n  \"setting\": {\n    \"settings_type\": null,\n    \"name\": \"administrator\",\n    \"created_at\": \"2012-12-18T15:24:43Z\",\n    \"category\": \"General\",\n    \"updated_at\": \"2012-12-18T15:24:43Z\",\n    \"id\": 333972760,\n    \"description\": \"The Default administrator email address\",\n    \"value\": \"root@some.host.fqdn\",\n    \"default\": \"root@some.host.fqdn\"\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"id","full_name":"id","validator":"Must be String","description":"","expected_type":"string","required":true},{"allow_nil":false,"name":"setting","full_name":"setting","params":[{"name":"value","allow_nil":false,"full_name":"setting[value]","validator":"Must be String","expected_type":"string","description":"","required":false}],"validator":"Must be a Hash","description":"","expected_type":"hash","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/settings/:id","short_description":"Update a setting.","http_method":"PUT"}],"full_description":"","doc_url":"/apidoc/v2/settings/update"}]},"config_templates":{"name":"Config templates","formats":null,"api_url":"/api","version":"v2","short_description":null,"full_description":null,"doc_url":"/apidoc/v2/config_templates","methods":[{"see":null,"name":"index","examples":["GET /api/config_templates\n200\n[\n  {\n    \"config_template\": {\n      \"snippet\": null,\n      \"template\": \"default linux~label linux~kernel <%= @kernel %>~append initrd=<%= @initrd %> ks=<%= foreman_url(\\\"kickstart\\\")%> ksdevice=bootif network kssendmac\",\n      \"name\": \"centos5_3_pxelinux\",\n      \"audit_comment\": null,\n      \"template_kind\": {\n        \"name\": \"PXELinux\",\n        \"id\": 452984334\n      },\n      \"id\": 1007981701\n    }\n  },\n  {\n    \"config_template\": {\n      \"snippet\": null,\n      \"template\": \"MyFinish\",\n      \"name\": \"MyFinish\",\n      \"audit_comment\": null,\n      \"template_kind\": {\n        \"name\": \"finish\",\n        \"id\": 550103832\n      },\n      \"id\": 104314179\n    }\n  },\n  {\n    \"config_template\": {\n      \"snippet\": null,\n      \"template\": \"MyText\",\n      \"name\": \"MyScript\",\n      \"audit_comment\": null,\n      \"template_kind\": {\n        \"name\": \"script\",\n        \"id\": 478250810\n      },\n      \"id\": 981457253\n    }\n  },\n  {\n    \"config_template\": {\n      \"snippet\": null,\n      \"template\": \"MyText\",\n      \"name\": \"MyString\",\n      \"audit_comment\": null,\n      \"template_kind\": {\n        \"name\": \"gPXE\",\n        \"id\": 158998239\n      },\n      \"id\": 943779058\n    }\n  },\n  {\n    \"config_template\": {\n      \"snippet\": null,\n      \"template\": \"MyText\",\n      \"name\": \"MyString2\",\n      \"audit_comment\": null,\n      \"template_kind\": {\n        \"name\": \"provision\",\n        \"id\": 983253650\n      },\n      \"id\": 269958254\n    }\n  },\n  {\n    \"config_template\": {\n      \"snippet\": null,\n      \"template\": \"default linux~label linux~kernel <%= @kernel %>~append initrd=<%= @initrd %> ksdevice=bootif network kssendmac\",\n      \"name\": \"PXE Default File\",\n      \"audit_comment\": null,\n      \"template_kind\": {\n        \"name\": \"PXELinux\",\n        \"id\": 452984334\n      },\n      \"id\": 352050261\n    }\n  },\n  {\n    \"config_template\": {\n      \"snippet\": null,\n      \"template\": \"FOO\",\n      \"\": null,\n      \"name\": \"PXE Default Menu\",\n      \"audit_comment\": null,\n      \"id\": 684651467\n    }\n  },\n  {\n    \"config_template\": {\n      \"snippet\": null,\n      \"template\": \"DEFAULT menu~PROMPT 0~MENU TITLE PXE Menu~TIMEOUT 200~TOTALTIMEOUT 6000~ONTIMEOUT local~~LABEL local~MENU LABEL (local)~MENU DEFAULT~LOCALBOOT 0\",\n      \"name\": \"PXE Localboot Default\",\n      \"audit_comment\": null,\n      \"template_kind\": {\n        \"name\": \"PXELinux\",\n        \"id\": 452984334\n      },\n      \"id\": 821548108\n    }\n  }\n]"],"errors":[],"params":[{"allow_nil":false,"name":"search","full_name":"search","validator":"Must be String","description":"<p>filter results</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"order","full_name":"order","validator":"Must be String","description":"<p>sort results</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"page","full_name":"page","validator":"Must be String","description":"<p>paginate results</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"per_page","full_name":"per_page","validator":"Must be String","description":"<p>number of entries per request</p>","expected_type":"string","required":false}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/config_templates","short_description":"List templates","http_method":"GET"}],"full_description":"","doc_url":"/apidoc/v2/config_templates/index"},{"see":null,"name":"show","examples":["GET /api/config_templates/centos5_3_pxelinux\n200\n{\n  \"config_template\": {\n    \"snippet\": null,\n    \"template\": \"default linux~label linux~kernel <%= @kernel %>~append initrd=<%= @initrd %> ks=<%= foreman_url(\\\"kickstart\\\")%> ksdevice=bootif network kssendmac\",\n    \"name\": \"centos5_3_pxelinux\",\n    \"audit_comment\": null,\n    \"template_kind\": {\n      \"name\": \"PXELinux\",\n      \"id\": 452984334\n    },\n    \"id\": 1007981701\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"id","full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","description":"","expected_type":"string","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/config_templates/:id","short_description":"Show template details","http_method":"GET"}],"full_description":"","doc_url":"/apidoc/v2/config_templates/show"},{"see":null,"name":"create","examples":["POST /api/config_templates\n{\n  \"config_template\": {\n    \"template\": \"This is a test template\",\n    \"name\": \"RandomName\",\n    \"template_kind_id\": 1\n  }\n}\n200\n{\n  \"config_template\": {\n    \"snippet\": null,\n    \"template\": \"This is a test template\",\n    \"\": null,\n    \"name\": \"RandomName\",\n    \"audit_comment\": null,\n    \"id\": 1007981702\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"config_template","full_name":"config_template","params":[{"name":"name","allow_nil":false,"full_name":"config_template[name]","validator":"Must be String","expected_type":"string","description":"<p>template name</p>","required":true},{"name":"template","allow_nil":false,"full_name":"config_template[template]","validator":"Must be String","expected_type":"string","description":"","required":true},{"name":"snippet","allow_nil":true,"full_name":"config_template[snippet]","validator":"Must be 'true' or 'false'","expected_type":"string","description":"","required":false},{"name":"audit_comment","allow_nil":true,"full_name":"config_template[audit_comment]","validator":"Must be String","expected_type":"string","description":"","required":false},{"name":"template_kind_id","allow_nil":true,"full_name":"config_template[template_kind_id]","validator":"Must be a number.","expected_type":"string","description":"<p>not relevant for snippet</p>","required":false},{"name":"template_combinations_attributes","allow_nil":false,"full_name":"config_template[template_combinations_attributes]","validator":"Must be Array","expected_type":"string","description":"<p>Array of template combinations (hostgroup_id, environment_id)</p>","required":false},{"name":"operatingsystem_ids","allow_nil":false,"full_name":"config_template[operatingsystem_ids]","validator":"Must be Array","expected_type":"string","description":"<p>Array of operating systems ID to associate the template with</p>","required":false}],"validator":"Must be a Hash","description":"","expected_type":"hash","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/config_templates","short_description":"Create a template","http_method":"POST"}],"full_description":"","doc_url":"/apidoc/v2/config_templates/create"},{"see":null,"name":"update","examples":["PUT /api/config_templates/centos5_3_pxelinux\n{\n  \"config_template\": {\n    \"template\": \"tmp\",\n    \"audit_comment\": \"aha\"\n  }\n}\n200\n{\n  \"config_template\": {\n    \"snippet\": null,\n    \"template\": \"tmp\",\n    \"name\": \"centos5_3_pxelinux\",\n    \"template_kind\": {\n      \"name\": \"PXELinux\",\n      \"id\": 452984334\n    },\n    \"id\": 1007981701\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"id","full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","description":"","expected_type":"string","required":true},{"allow_nil":false,"name":"config_template","full_name":"config_template","params":[{"name":"name","allow_nil":false,"full_name":"config_template[name]","validator":"Must be String","expected_type":"string","description":"<p>template name</p>","required":false},{"name":"template","allow_nil":false,"full_name":"config_template[template]","validator":"Must be String","expected_type":"string","description":"","required":false},{"name":"snippet","allow_nil":false,"full_name":"config_template[snippet]","validator":"Must be 'true' or 'false'","expected_type":"string","description":"","required":false},{"name":"audit_comment","allow_nil":true,"full_name":"config_template[audit_comment]","validator":"Must be String","expected_type":"string","description":"","required":false},{"name":"template_kind_id","allow_nil":true,"full_name":"config_template[template_kind_id]","validator":"Must be a number.","expected_type":"string","description":"<p>not relevant for snippet</p>","required":false},{"name":"template_combinations_attributes","allow_nil":false,"full_name":"config_template[template_combinations_attributes]","validator":"Must be Array","expected_type":"string","description":"<p>Array of template combinations (hostgroup_id, environment_id)</p>","required":false},{"name":"operatingsystem_ids","allow_nil":false,"full_name":"config_template[operatingsystem_ids]","validator":"Must be Array","expected_type":"string","description":"<p>Array of operating systems ID to associate the template with</p>","required":false}],"validator":"Must be a Hash","description":"","expected_type":"hash","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/config_templates/:id","short_description":"Update a template","http_method":"PUT"}],"full_description":"","doc_url":"/apidoc/v2/config_templates/update"},{"see":null,"name":"revision","examples":[],"errors":[],"params":[{"allow_nil":false,"name":"version","full_name":"version","validator":"Must be String","description":"<p>template version</p>","expected_type":"string","required":false}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/config_templates/revision","short_description":null,"http_method":"GET"}],"full_description":"","doc_url":"/apidoc/v2/config_templates/revision"},{"see":null,"name":"destroy","examples":["DELETE /api/config_templates/centos5_3_pxelinux\n200\n{\n  \"config_template\": {\n    \"snippet\": null,\n    \"template\": \"default linux~label linux~kernel <%= @kernel %>~append initrd=<%= @initrd %> ks=<%= foreman_url(\\\"kickstart\\\")%> ksdevice=bootif network kssendmac\",\n    \"name\": \"centos5_3_pxelinux\",\n    \"template_kind\": {\n      \"name\": \"PXELinux\",\n      \"id\": 452984334\n    },\n    \"id\": 1007981701\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"id","full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","description":"","expected_type":"string","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/config_templates/:id","short_description":"Delete a template","http_method":"DELETE"}],"full_description":"","doc_url":"/apidoc/v2/config_templates/destroy"},{"see":null,"name":"build_pxe_default","examples":["GET /api/config_templates/build_pxe_default\n200\nPXE Default file has been deployed to all Smart Proxies"],"errors":[],"params":[],"formats":null,"see_url":null,"apis":[{"api_url":"/api/config_templates/build_pxe_default","short_description":"Change the default PXE menu on all configured TFTP servers","http_method":"GET"}],"full_description":"","doc_url":"/apidoc/v2/config_templates/build_pxe_default"}]},"template_kinds":{"name":"Template kinds","formats":null,"api_url":"/api","version":"v2","short_description":null,"full_description":null,"doc_url":"/apidoc/v2/template_kinds","methods":[{"see":null,"name":"index","examples":["GET /api/template_kinds\n200\n[\n  {\n    \"template_kind\": {\n      \"name\": \"PXELinux\",\n      \"id\": 452984334\n    }\n  },\n  {\n    \"template_kind\": {\n      \"name\": \"script\",\n      \"id\": 478250810\n    }\n  },\n  {\n    \"template_kind\": {\n      \"name\": \"gPXE\",\n      \"id\": 158998239\n    }\n  },\n  {\n    \"template_kind\": {\n      \"name\": \"finish\",\n      \"id\": 550103832\n    }\n  },\n  {\n    \"template_kind\": {\n      \"name\": \"provision\",\n      \"id\": 983253650\n    }\n  }\n]"],"errors":[],"params":[{"allow_nil":false,"name":"page","full_name":"page","validator":"Must be String","description":"<p>paginate results</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"per_page","full_name":"per_page","validator":"Must be String","description":"<p>number of entries per request</p>","expected_type":"string","required":false}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/template_kinds","short_description":"List all template kinds.","http_method":"GET"}],"full_description":"","doc_url":"/apidoc/v2/template_kinds/index"}]},"hostgroups":{"name":"Hostgroups","formats":null,"api_url":"/api","version":"v2","short_description":null,"full_description":null,"doc_url":"/apidoc/v2/hostgroups","methods":[{"see":null,"name":"index","examples":["GET /api/hostgroups\n200\n[\n  {\n    \"hostgroup\": {\n      \"puppetclass_ids\": [],\n      \"domain_id\": null,\n      \"ancestry\": null,\n      \"parameters\": {},\n      \"operatingsystem_id\": 309172073,\n      \"name\": \"db\",\n      \"environment_id\": 334344675,\n      \"id\": 603241515,\n      \"label\": \"db\",\n      \"subnet_id\": null\n    }\n  },\n  {\n    \"hostgroup\": {\n      \"puppetclass_ids\": [\n        980190962\n      ],\n      \"domain_id\": 22495316,\n      \"ancestry\": null,\n      \"parameters\": {\n        \"group1\": \"group1\"\n      },\n      \"operatingsystem_id\": 309172073,\n      \"name\": \"Common\",\n      \"environment_id\": 334344675,\n      \"id\": 636252244,\n      \"label\": \"Common\",\n      \"subnet_id\": null\n    }\n  },\n  {\n    \"hostgroup\": {\n      \"puppetclass_ids\": [],\n      \"domain_id\": null,\n      \"ancestry\": null,\n      \"parameters\": {},\n      \"operatingsystem_id\": null,\n      \"name\": \"Unusual\",\n      \"environment_id\": null,\n      \"id\": 866317115,\n      \"label\": \"Unusual\",\n      \"subnet_id\": null\n    }\n  }\n]"],"errors":[],"params":[{"allow_nil":false,"name":"search","full_name":"search","validator":"Must be String","description":"<p>filter results</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"order","full_name":"order","validator":"Must be String","description":"<p>sort results</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"page","full_name":"page","validator":"Must be String","description":"<p>paginate results</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"per_page","full_name":"per_page","validator":"Must be String","description":"<p>number of entries per request</p>","expected_type":"string","required":false}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/hostgroups","short_description":"List all hostgroups.","http_method":"GET"}],"full_description":"","doc_url":"/apidoc/v2/hostgroups/index"},{"see":null,"name":"show","examples":["GET /api/hostgroups/636252244-common\n200\n{\n  \"hostgroup\": {\n    \"puppetclass_ids\": [\n      980190962\n    ],\n    \"domain_id\": 22495316,\n    \"ancestry\": null,\n    \"parameters\": {\n      \"group1\": \"group1\"\n    },\n    \"operatingsystem_id\": 309172073,\n    \"name\": \"Common\",\n    \"environment_id\": 334344675,\n    \"id\": 636252244,\n    \"label\": \"Common\",\n    \"subnet_id\": null\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"id","full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","description":"","expected_type":"string","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/hostgroups/:id","short_description":"Show a hostgroup.","http_method":"GET"}],"full_description":"","doc_url":"/apidoc/v2/hostgroups/show"},{"see":null,"name":"create","examples":["POST /api/hostgroups\n{\n  \"hostgroup\": {\n    \"name\": \"TestHostgroup\"\n  }\n}\n200\n{\n  \"hostgroup\": {\n    \"puppetclass_ids\": [],\n    \"domain_id\": null,\n    \"ancestry\": null,\n    \"parameters\": {},\n    \"operatingsystem_id\": null,\n    \"name\": \"TestHostgroup\",\n    \"environment_id\": null,\n    \"id\": 866317116,\n    \"label\": \"TestHostgroup\",\n    \"subnet_id\": null\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"hostgroup","full_name":"hostgroup","params":[{"name":"name","allow_nil":false,"full_name":"hostgroup[name]","validator":"Must be String","expected_type":"string","description":"","required":true},{"name":"environment_id","allow_nil":false,"full_name":"hostgroup[environment_id]","validator":"Must be a number.","expected_type":"string","description":"","required":false},{"name":"operatingsystem_id","allow_nil":false,"full_name":"hostgroup[operatingsystem_id]","validator":"Must be a number.","expected_type":"string","description":"","required":false},{"name":"architecture_id","allow_nil":false,"full_name":"hostgroup[architecture_id]","validator":"Must be a number.","expected_type":"string","description":"","required":false},{"name":"medium_id","allow_nil":false,"full_name":"hostgroup[medium_id]","validator":"Must be a number.","expected_type":"string","description":"","required":false},{"name":"ptable_id","allow_nil":false,"full_name":"hostgroup[ptable_id]","validator":"Must be a number.","expected_type":"string","description":"","required":false},{"name":"puppet_ca_proxy_id","allow_nil":false,"full_name":"hostgroup[puppet_ca_proxy_id]","validator":"Must be a number.","expected_type":"string","description":"","required":false},{"name":"subnet_id","allow_nil":false,"full_name":"hostgroup[subnet_id]","validator":"Must be a number.","expected_type":"string","description":"","required":false},{"name":"domain_id","allow_nil":false,"full_name":"hostgroup[domain_id]","validator":"Must be a number.","expected_type":"string","description":"","required":false},{"name":"puppet_proxy_id","allow_nil":false,"full_name":"hostgroup[puppet_proxy_id]","validator":"Must be a number.","expected_type":"string","description":"","required":false}],"validator":"Must be a Hash","description":"","expected_type":"hash","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/hostgroups","short_description":"Create an hostgroup.","http_method":"POST"}],"full_description":"","doc_url":"/apidoc/v2/hostgroups/create"},{"see":null,"name":"update","examples":["PUT /api/hostgroups/636252244-common\n{\n  \"hostgroup\": {}\n}\n200\n{\n  \"hostgroup\": {\n    \"puppetclass_ids\": [\n      980190962\n    ],\n    \"domain_id\": 22495316,\n    \"ancestry\": null,\n    \"parameters\": {\n      \"group1\": \"group1\"\n    },\n    \"operatingsystem_id\": 309172073,\n    \"name\": \"Common\",\n    \"environment_id\": 334344675,\n    \"id\": 636252244,\n    \"label\": \"Common\",\n    \"subnet_id\": null\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"id","full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","description":"","expected_type":"string","required":true},{"allow_nil":false,"name":"hostgroup","full_name":"hostgroup","params":[{"name":"name","allow_nil":false,"full_name":"hostgroup[name]","validator":"Must be String","expected_type":"string","description":"","required":false},{"name":"environment_id","allow_nil":false,"full_name":"hostgroup[environment_id]","validator":"Must be a number.","expected_type":"string","description":"","required":false},{"name":"operatingsystem_id","allow_nil":false,"full_name":"hostgroup[operatingsystem_id]","validator":"Must be a number.","expected_type":"string","description":"","required":false},{"name":"architecture_id","allow_nil":false,"full_name":"hostgroup[architecture_id]","validator":"Must be a number.","expected_type":"string","description":"","required":false},{"name":"medium_id","allow_nil":false,"full_name":"hostgroup[medium_id]","validator":"Must be a number.","expected_type":"string","description":"","required":false},{"name":"ptable_id","allow_nil":false,"full_name":"hostgroup[ptable_id]","validator":"Must be a number.","expected_type":"string","description":"","required":false},{"name":"puppet_ca_proxy_id","allow_nil":false,"full_name":"hostgroup[puppet_ca_proxy_id]","validator":"Must be a number.","expected_type":"string","description":"","required":false},{"name":"subnet_id","allow_nil":false,"full_name":"hostgroup[subnet_id]","validator":"Must be a number.","expected_type":"string","description":"","required":false},{"name":"domain_id","allow_nil":false,"full_name":"hostgroup[domain_id]","validator":"Must be a number.","expected_type":"string","description":"","required":false},{"name":"puppet_proxy_id","allow_nil":false,"full_name":"hostgroup[puppet_proxy_id]","validator":"Must be a number.","expected_type":"string","description":"","required":false}],"validator":"Must be a Hash","description":"","expected_type":"hash","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/hostgroups/:id","short_description":"Update an hostgroup.","http_method":"PUT"}],"full_description":"","doc_url":"/apidoc/v2/hostgroups/update"},{"see":null,"name":"destroy","examples":["DELETE /api/hostgroups/636252244-common\n200\n{\n  \"hostgroup\": {\n    \"puppetclass_ids\": [],\n    \"domain_id\": 22495316,\n    \"ancestry\": null,\n    \"parameters\": {},\n    \"operatingsystem_id\": 309172073,\n    \"name\": \"Common\",\n    \"environment_id\": 334344675,\n    \"id\": 636252244,\n    \"label\": \"Common\",\n    \"subnet_id\": null\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"id","full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","description":"","expected_type":"string","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/hostgroups/:id","short_description":"Delete an hostgroup.","http_method":"DELETE"}],"full_description":"","doc_url":"/apidoc/v2/hostgroups/destroy"}]},"audits":{"name":"Audits","formats":null,"api_url":"/api","version":"v2","short_description":null,"full_description":null,"doc_url":"/apidoc/v2/audits","methods":[{"see":null,"name":"index","examples":["GET /api/audits\n200\n[\n  {\n    \"audit\": {\n      \"associated_type\": \"Host\",\n      \"associated_id\": 272,\n      \"auditable_type\": \"Host\",\n      \"auditable_id\": 0,\n      \"user_id\": null,\n      \"created_at\": \"2009-12-14T08:01:17Z\",\n      \"remote_address\": null,\n      \"id\": 1,\n      \"associated_name\": null,\n      \"user_type\": null,\n      \"audited_changes\": {\n        \"architecture_id\": [\n          10463,\n          10466\n        ]\n      },\n      \"comment\": null,\n      \"version\": 1,\n      \"action\": \"update\",\n      \"auditable_name\": null\n    }\n  }\n]"],"errors":[],"params":[{"allow_nil":false,"name":"search","full_name":"search","validator":"Must be String","description":"<p>filter results</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"order","full_name":"order","validator":"Must be String","description":"<p>sort results</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"page","full_name":"page","validator":"Must be String","description":"<p>paginate results</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"per_page","full_name":"per_page","validator":"Must be String","description":"<p>number of entries per request</p>","expected_type":"string","required":false}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/audits","short_description":"List all audits.","http_method":"GET"},{"api_url":"/api/hosts/:host_id/audits","short_description":"List all audits for a given host.","http_method":"GET"}],"full_description":"","doc_url":"/apidoc/v2/audits/index"},{"see":null,"name":"show","examples":["GET /api/audits/1\n200\n{\n  \"audit\": {\n    \"associated_type\": \"Host\",\n    \"associated_id\": 272,\n    \"auditable_type\": \"Host\",\n    \"auditable_id\": 0,\n    \"user_id\": null,\n    \"created_at\": \"2009-12-14T08:01:17Z\",\n    \"remote_address\": null,\n    \"id\": 1,\n    \"associated_name\": null,\n    \"user_type\": null,\n    \"audited_changes\": {\n      \"architecture_id\": [\n        10463,\n        10466\n      ]\n    },\n    \"comment\": null,\n    \"version\": 1,\n    \"action\": \"update\",\n    \"auditable_name\": null\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"id","full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","description":"","expected_type":"string","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/audits/:id","short_description":"Show an audit","http_method":"GET"}],"full_description":"","doc_url":"/apidoc/v2/audits/show"}]},"hosts":{"name":"Hosts","formats":null,"api_url":"/api","version":"v2","short_description":null,"full_description":null,"doc_url":"/apidoc/v2/hosts","methods":[{"see":null,"name":"index","examples":["GET /api/hosts\n200\n[\n  {\n    \"host\": {\n      \"operatingsystem_id\": 1073012828,\n      \"name\": \"anotherfullhost\",\n      \"hostgroup_id\": null,\n      \"id\": 55602819\n    }\n  },\n  {\n    \"host\": {\n      \"operatingsystem_id\": 1073012828,\n      \"name\": \"dhcp.mydomain.net\",\n      \"hostgroup_id\": null,\n      \"id\": 219245707\n    }\n  },\n  {\n    \"host\": {\n      \"operatingsystem_id\": 1073012828,\n      \"name\": \"my5name.mydomain.net\",\n      \"hostgroup_id\": null,\n      \"id\": 980190962\n    }\n  },\n  {\n    \"host\": {\n      \"operatingsystem_id\": 309172073,\n      \"name\": \"myfullname.mydomain.net\",\n      \"hostgroup_id\": null,\n      \"id\": 1053842695\n    }\n  },\n  {\n    \"host\": {\n      \"operatingsystem_id\": 1073012828,\n      \"name\": \"otherfullhost\",\n      \"hostgroup_id\": null,\n      \"id\": 661942085\n    }\n  },\n  {\n    \"host\": {\n      \"operatingsystem_id\": 1073012828,\n      \"name\": \"sdhcp.mydomain.net\",\n      \"hostgroup_id\": null,\n      \"id\": 500757383\n    }\n  },\n  {\n    \"host\": {\n      \"operatingsystem_id\": 442321401,\n      \"name\": \"sol10host\",\n      \"hostgroup_id\": null,\n      \"id\": 715054938\n    }\n  },\n  {\n    \"host\": {\n      \"operatingsystem_id\": 859751735,\n      \"name\": \"suse01.yourdomain.net\",\n      \"hostgroup_id\": null,\n      \"id\": 859751735\n    }\n  },\n  {\n    \"host\": {\n      \"operatingsystem_id\": 331303656,\n      \"name\": \"temp-01.yourdomain.net\",\n      \"hostgroup_id\": null,\n      \"id\": 1011586618\n    }\n  },\n  {\n    \"host\": {\n      \"operatingsystem_id\": 1073012828,\n      \"name\": \"temp01.yourdomain.net\",\n      \"hostgroup_id\": null,\n      \"id\": 1073012828\n    }\n  },\n  {\n    \"host\": {\n      \"operatingsystem_id\": 331303656,\n      \"name\": \"temp-02.useless.net\",\n      \"hostgroup_id\": null,\n      \"id\": 3666571\n    }\n  },\n  {\n    \"host\": {\n      \"operatingsystem_id\": 309172073,\n      \"name\": \"temp.yourdomain.net\",\n      \"hostgroup_id\": null,\n      \"id\": 298486374\n    }\n  }\n]"],"errors":[],"params":[{"allow_nil":false,"name":"search","full_name":"search","validator":"Must be String","description":"<p>Filter results</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"order","full_name":"order","validator":"Must be String","description":"<p>Sort results</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"page","full_name":"page","validator":"Must be String","description":"<p>paginate results</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"per_page","full_name":"per_page","validator":"Must be String","description":"<p>number of entries per request</p>","expected_type":"string","required":false}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/hosts","short_description":"List all hosts.","http_method":"GET"}],"full_description":"","doc_url":"/apidoc/v2/hosts/index"},{"see":null,"name":"show","examples":["GET /api/hosts/my5name.mydomain.net\n200\n{\n  \"host\": {\n    \"image_id\": null,\n    \"managed\": true,\n    \"environment\": {\n      \"environment\": {\n        \"name\": \"production\",\n        \"id\": 334344675\n      }\n    },\n    \"domain_id\": 22495316,\n    \"puppet_ca_proxy_id\": null,\n    \"image_file\": \"\",\n    \"operatingsystem_id\": 1073012828,\n    \"last_report\": null,\n    \"sp_name\": \"\",\n    \"name\": \"my5name.mydomain.net\",\n    \"architecture_id\": 501905019,\n    \"hostgroup_id\": null,\n    \"environment_id\": 334344675,\n    \"sp_ip\": \"\",\n    \"created_at\": \"2012-12-18T15:24:43Z\",\n    \"puppet_proxy_id\": 182953976,\n    \"uuid\": null,\n    \"compute_resource_id\": 980190962,\n    \"build\": false,\n    \"updated_at\": \"2012-12-18T15:24:43Z\",\n    \"id\": 980190962,\n    \"ip\": \"2.3.4.1\",\n    \"sp_subnet_id\": null,\n    \"sp_mac\": \"\",\n    \"installed_at\": null,\n    \"use_image\": null,\n    \"comment\": null,\n    \"enabled\": true,\n    \"ptable_id\": 980190962,\n    \"subnet_id\": 980190962,\n    \"mac\": \"aabbCCddeeee\",\n    \"certname\": \"my5name.mydomain.net\",\n    \"disk\": null,\n    \"owner_type\": null,\n    \"owner_id\": null,\n    \"model_id\": null,\n    \"host_parameters\": [\n      {\n        \"host_parameter\": {\n          \"reference_id\": 980190962,\n          \"name\": \"host1\",\n          \"priority\": 4,\n          \"created_at\": \"2012-12-18T15:24:43Z\",\n          \"updated_at\": \"2012-12-18T15:24:43Z\",\n          \"id\": 254219264,\n          \"value\": \"host1\"\n        }\n      }\n    ],\n    \"medium_id\": null\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"id","full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","description":"","expected_type":"string","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/hosts/:id","short_description":"Show a host.","http_method":"GET"}],"full_description":"","doc_url":"/apidoc/v2/hosts/show"},{"see":null,"name":"create","examples":["POST /api/hosts\n{\n  \"host\": {\n    \"domain_id\": 22495316,\n    \"operatingsystem_id\": 1073012828,\n    \"name\": \"testhost11\",\n    \"architecture_id\": 501905019,\n    \"environment_id\": 334344675,\n    \"puppet_proxy_id\": 7,\n    \"ip\": \"10.0.0.20\",\n    \"mac\": \"52:53:00:1e:85:93\"\n  }\n}\n200\n{\n  \"host\": {\n    \"image_id\": null,\n    \"managed\": true,\n    \"domain_id\": 22495316,\n    \"environment\": {\n      \"environment\": {\n        \"name\": \"production\",\n        \"id\": 334344675\n      }\n    },\n    \"puppet_ca_proxy_id\": null,\n    \"image_file\": \"\",\n    \"operatingsystem_id\": 1073012828,\n    \"last_report\": null,\n    \"sp_name\": \"\",\n    \"name\": \"testhost11.mydomain.net\",\n    \"architecture_id\": 501905019,\n    \"hostgroup_id\": null,\n    \"environment_id\": 334344675,\n    \"sp_ip\": \"\",\n    \"created_at\": \"2012-12-18T15:24:48Z\",\n    \"puppet_proxy_id\": 7,\n    \"uuid\": null,\n    \"compute_resource_id\": null,\n    \"build\": false,\n    \"updated_at\": \"2012-12-18T15:24:48Z\",\n    \"ip\": \"10.0.0.20\",\n    \"id\": 1073012829,\n    \"sp_subnet_id\": null,\n    \"sp_mac\": \"\",\n    \"installed_at\": null,\n    \"use_image\": null,\n    \"comment\": null,\n    \"enabled\": true,\n    \"ptable_id\": null,\n    \"subnet_id\": null,\n    \"mac\": \"52:53:00:1e:85:93\",\n    \"certname\": \"fcfce82c-33d1-4565-843a-4f58ff8e371a\",\n    \"disk\": null,\n    \"owner_type\": \"User\",\n    \"owner_id\": 886836129,\n    \"model_id\": null,\n    \"host_parameters\": [],\n    \"medium_id\": null\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"host","full_name":"host","params":[{"name":"name","allow_nil":false,"full_name":"host[name]","validator":"Must be String","expected_type":"string","description":"","required":true},{"name":"environment_id","allow_nil":false,"full_name":"host[environment_id]","validator":"Must be String","expected_type":"string","description":"","required":true},{"name":"ip","allow_nil":false,"full_name":"host[ip]","validator":"Must be String","expected_type":"string","description":"<p>not required if using a subnet with dhcp proxy</p>","required":false},{"name":"mac","allow_nil":false,"full_name":"host[mac]","validator":"Must be String","expected_type":"string","description":"<p>not required if its a virtual machine</p>","required":false},{"name":"architecture_id","allow_nil":false,"full_name":"host[architecture_id]","validator":"Must be a number.","expected_type":"string","description":"","required":true},{"name":"domain_id","allow_nil":false,"full_name":"host[domain_id]","validator":"Must be a number.","expected_type":"string","description":"","required":true},{"name":"puppet_proxy_id","allow_nil":false,"full_name":"host[puppet_proxy_id]","validator":"Must be a number.","expected_type":"string","description":"","required":true},{"name":"operatingsystem_id","allow_nil":false,"full_name":"host[operatingsystem_id]","validator":"Must be String","expected_type":"string","description":"","required":true},{"name":"medium_id","allow_nil":false,"full_name":"host[medium_id]","validator":"Must be a number.","expected_type":"string","description":"","required":false},{"name":"ptable_id","allow_nil":false,"full_name":"host[ptable_id]","validator":"Must be a number.","expected_type":"string","description":"","required":false},{"name":"subnet_id","allow_nil":false,"full_name":"host[subnet_id]","validator":"Must be a number.","expected_type":"string","description":"","required":false},{"name":"sp_subnet_id","allow_nil":false,"full_name":"host[sp_subnet_id]","validator":"Must be a number.","expected_type":"string","description":"","required":false},{"name":"model_id_id","allow_nil":false,"full_name":"host[model_id_id]","validator":"Must be a number.","expected_type":"string","description":"","required":false},{"name":"hostgroup_id","allow_nil":false,"full_name":"host[hostgroup_id]","validator":"Must be a number.","expected_type":"string","description":"","required":false},{"name":"owner_id","allow_nil":false,"full_name":"host[owner_id]","validator":"Must be a number.","expected_type":"string","description":"","required":false},{"name":"puppet_ca_proxy_id","allow_nil":false,"full_name":"host[puppet_ca_proxy_id]","validator":"Must be a number.","expected_type":"string","description":"","required":false},{"name":"image_id","allow_nil":false,"full_name":"host[image_id]","validator":"Must be a number.","expected_type":"string","description":"","required":false},{"name":"host_parameters_attributes","allow_nil":false,"full_name":"host[host_parameters_attributes]","validator":"Must be Array","expected_type":"string","description":"","required":false}],"validator":"Must be a Hash","description":"","expected_type":"hash","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/hosts","short_description":"Create a host.","http_method":"POST"}],"full_description":"","doc_url":"/apidoc/v2/hosts/create"},{"see":null,"name":"update","examples":["PUT /api/hosts/temp.yourdomain.net\n{\n  \"host\": {}\n}\n200\n{\n  \"host\": {\n    \"image_id\": null,\n    \"managed\": null,\n    \"domain_id\": 589326610,\n    \"environment\": {\n      \"environment\": {\n        \"name\": \"production\",\n        \"id\": 334344675\n      }\n    },\n    \"location_id\": null,\n    \"puppet_ca_proxy_id\": null,\n    \"image_file\": \"\",\n    \"operatingsystem_id\": 309172073,\n    \"root_pass\": \"xybxa6JUkz63w\",\n    \"last_report\": null,\n    \"name\": \"temp.yourdomain.net\",\n    \"sp_name\": \"\",\n    \"architecture_id\": 501905019,\n    \"puppet_status\": 0,\n    \"source_file_id\": null,\n    \"hostgroup_id\": null,\n    \"environment_id\": 334344675,\n    \"sp_ip\": \"\",\n    \"created_at\": \"2012-12-18T15:24:43Z\",\n    \"puppet_proxy_id\": 182953976,\n    \"uuid\": null,\n    \"compute_resource_id\": 980190962,\n    \"build\": false,\n    \"updated_at\": \"2012-12-18T15:24:48Z\",\n    \"id\": 298486374,\n    \"ip\": \"2.3.4.5\",\n    \"last_freshcheck\": null,\n    \"sp_subnet_id\": null,\n    \"sp_mac\": \"\",\n    \"installed_at\": null,\n    \"comment\": null,\n    \"use_image\": null,\n    \"enabled\": true,\n    \"ptable_id\": 980190962,\n    \"subnet_id\": 980190962,\n    \"organization_id\": null,\n    \"mac\": \"aa:bb:cc:dd:ee:ff\",\n    \"certname\": \"temp.yourdomain.net\",\n    \"disk\": null,\n    \"owner_type\": \"User\",\n    \"owner_id\": 886836129,\n    \"model_id\": null,\n    \"last_compile\": null,\n    \"serial\": null,\n    \"medium_id\": 980190962\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"id","full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","description":"","expected_type":"string","required":true},{"allow_nil":false,"name":"host","full_name":"host","params":[{"name":"name","allow_nil":false,"full_name":"host[name]","validator":"Must be String","expected_type":"string","description":"","required":false},{"name":"environment_id","allow_nil":false,"full_name":"host[environment_id]","validator":"Must be String","expected_type":"string","description":"","required":false},{"name":"ip","allow_nil":false,"full_name":"host[ip]","validator":"Must be String","expected_type":"string","description":"<p>not required if using a subnet with dhcp proxy</p>","required":false},{"name":"mac","allow_nil":false,"full_name":"host[mac]","validator":"Must be String","expected_type":"string","description":"<p>not required if its a virtual machine</p>","required":false},{"name":"architecture_id","allow_nil":false,"full_name":"host[architecture_id]","validator":"Must be a number.","expected_type":"string","description":"","required":false},{"name":"domain_id","allow_nil":false,"full_name":"host[domain_id]","validator":"Must be a number.","expected_type":"string","description":"","required":false},{"name":"puppet_proxy_id","allow_nil":false,"full_name":"host[puppet_proxy_id]","validator":"Must be a number.","expected_type":"string","description":"","required":false},{"name":"operatingsystem_id","allow_nil":false,"full_name":"host[operatingsystem_id]","validator":"Must be String","expected_type":"string","description":"","required":false},{"name":"medium_id","allow_nil":false,"full_name":"host[medium_id]","validator":"Must be a number.","expected_type":"string","description":"","required":false},{"name":"ptable_id","allow_nil":false,"full_name":"host[ptable_id]","validator":"Must be a number.","expected_type":"string","description":"","required":false},{"name":"subnet_id","allow_nil":false,"full_name":"host[subnet_id]","validator":"Must be a number.","expected_type":"string","description":"","required":false},{"name":"sp_subnet_id","allow_nil":false,"full_name":"host[sp_subnet_id]","validator":"Must be a number.","expected_type":"string","description":"","required":false},{"name":"model_id_id","allow_nil":false,"full_name":"host[model_id_id]","validator":"Must be a number.","expected_type":"string","description":"","required":false},{"name":"hostgroup_id","allow_nil":false,"full_name":"host[hostgroup_id]","validator":"Must be a number.","expected_type":"string","description":"","required":false},{"name":"owner_id","allow_nil":false,"full_name":"host[owner_id]","validator":"Must be a number.","expected_type":"string","description":"","required":false},{"name":"puppet_ca_proxy_id","allow_nil":false,"full_name":"host[puppet_ca_proxy_id]","validator":"Must be a number.","expected_type":"string","description":"","required":false},{"name":"image_id","allow_nil":false,"full_name":"host[image_id]","validator":"Must be a number.","expected_type":"string","description":"","required":false},{"name":"host_parameters_attributes","allow_nil":false,"full_name":"host[host_parameters_attributes]","validator":"Must be Array","expected_type":"string","description":"","required":false}],"validator":"Must be a Hash","description":"","expected_type":"hash","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/hosts/:id","short_description":"Update a host.","http_method":"PUT"}],"full_description":"","doc_url":"/apidoc/v2/hosts/update"},{"see":null,"name":"destroy","examples":["DELETE /api/hosts/my5name.mydomain.net\n200\n{\n  \"host\": {\n    \"image_id\": null,\n    \"managed\": true,\n    \"domain_id\": 22495316,\n    \"environment\": {\n      \"environment\": {\n        \"name\": \"production\",\n        \"id\": 334344675\n      }\n    },\n    \"location_id\": null,\n    \"puppet_ca_proxy_id\": null,\n    \"image_file\": \"\",\n    \"operatingsystem_id\": 1073012828,\n    \"root_pass\": \"xybxa6JUkz63w\",\n    \"last_report\": null,\n    \"name\": \"my5name.mydomain.net\",\n    \"sp_name\": \"\",\n    \"architecture_id\": 501905019,\n    \"puppet_status\": 0,\n    \"source_file_id\": null,\n    \"hostgroup_id\": null,\n    \"environment_id\": 334344675,\n    \"sp_ip\": \"\",\n    \"created_at\": \"2012-12-18T15:24:43Z\",\n    \"puppet_proxy_id\": 182953976,\n    \"uuid\": null,\n    \"compute_resource_id\": 980190962,\n    \"build\": false,\n    \"updated_at\": \"2012-12-18T15:24:43Z\",\n    \"id\": 980190962,\n    \"ip\": \"2.3.4.1\",\n    \"last_freshcheck\": null,\n    \"sp_subnet_id\": null,\n    \"sp_mac\": \"\",\n    \"installed_at\": null,\n    \"comment\": null,\n    \"use_image\": null,\n    \"enabled\": true,\n    \"ptable_id\": 980190962,\n    \"subnet_id\": 980190962,\n    \"organization_id\": null,\n    \"mac\": \"aabbCCddeeee\",\n    \"certname\": \"my5name.mydomain.net\",\n    \"disk\": null,\n    \"owner_type\": null,\n    \"owner_id\": null,\n    \"model_id\": null,\n    \"last_compile\": null,\n    \"serial\": null,\n    \"medium_id\": null\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"id","full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","description":"","expected_type":"string","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/hosts/:id","short_description":"Delete an host.","http_method":"DELETE"}],"full_description":"","doc_url":"/apidoc/v2/hosts/destroy"},{"see":null,"name":"status","examples":["GET /api/hosts/my5name.mydomain.net/status\n200\n{\n  \"status\": \"missing\"\n}"],"errors":[],"params":[{"allow_nil":false,"name":"id","full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","description":"","expected_type":"string","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/hosts/:id/status","short_description":"Get status of host","http_method":"GET"}],"full_description":"<p>Return value may either be one of the following:</p>\n\n<ul>\n<li>missing</li>\n\n<li>failed</li>\n\n<li>pending</li>\n\n<li>changed</li>\n\n<li>unchanged</li>\n\n<li>unreported</li>\n</ul>","doc_url":"/apidoc/v2/hosts/status"}]},"domains":{"name":"Domains","formats":null,"api_url":"/api","version":"v2","short_description":null,"full_description":"<p>Foreman considers a domain and a DNS zone as the same thing. That is, if you are planning to manage a site where all the machines are or the form <i>hostname</i>.<b>somewhere.com</b> then the domain is <b>somewhere.com</b>. This allows Foreman to associate a puppet variable with a domain/site and automatically append this variable to all external node requests made by machines at that site.</p>","doc_url":"/apidoc/v2/domains","methods":[{"see":null,"name":"index","examples":["GET /api/domains\n200\n[\n  {\n    \"domain\": {\n      \"name\": \"mydomain.net\",\n      \"created_at\": \"2012-12-18T15:24:43Z\",\n      \"updated_at\": \"2012-12-18T15:24:43Z\",\n      \"id\": 22495316,\n      \"dns_id\": 113629430,\n      \"fullname\": null\n    }\n  },\n  {\n    \"domain\": {\n      \"name\": \"unused.net\",\n      \"created_at\": \"2012-12-18T15:24:43Z\",\n      \"updated_at\": \"2012-12-18T15:24:43Z\",\n      \"id\": 759776763,\n      \"dns_id\": 113629430,\n      \"fullname\": \"somewhare that is never used\"\n    }\n  },\n  {\n    \"domain\": {\n      \"name\": \"useless.net\",\n      \"created_at\": \"2012-12-18T15:24:43Z\",\n      \"updated_at\": \"2012-12-18T15:24:43Z\",\n      \"id\": 229305443,\n      \"dns_id\": null,\n      \"fullname\": null\n    }\n  },\n  {\n    \"domain\": {\n      \"name\": \"yourdomain.net\",\n      \"created_at\": \"2012-12-18T15:24:43Z\",\n      \"updated_at\": \"2012-12-18T15:24:43Z\",\n      \"id\": 589326610,\n      \"dns_id\": 113629430,\n      \"fullname\": \"somewhere in yourdomain\"\n    }\n  }\n]"],"errors":[],"params":[{"allow_nil":false,"name":"search","full_name":"search","validator":"Must be String","description":"<p>Filter results</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"order","full_name":"order","validator":"Must be String","description":"<p>Sort results</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"page","full_name":"page","validator":"Must be String","description":"<p>paginate results</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"per_page","full_name":"per_page","validator":"Must be String","description":"<p>number of entries per request</p>","expected_type":"string","required":false}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/domains","short_description":"List of domains","http_method":"GET"}],"full_description":"","doc_url":"/apidoc/v2/domains/index"},{"see":null,"name":"show","examples":["GET /api/domains/mydomain.net\n200\n{\n  \"domain\": {\n    \"name\": \"mydomain.net\",\n    \"created_at\": \"2012-12-18T15:24:43Z\",\n    \"updated_at\": \"2012-12-18T15:24:43Z\",\n    \"id\": 22495316,\n    \"dns_id\": 113629430,\n    \"fullname\": null\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"id","full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","description":"<p>May be numerical id or domain name</p>","expected_type":"string","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/domains/:id","short_description":"Show a domain.","http_method":"GET"}],"full_description":"","doc_url":"/apidoc/v2/domains/show"},{"see":null,"name":"create","examples":["POST /api/domains\n{\n  \"domain\": {\n    \"name\": \"domain.net\"\n  }\n}\n201\n{\n  \"domain\": {\n    \"name\": \"domain.net\",\n    \"id\": 759776764\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"domain","full_name":"domain","params":[{"name":"name","allow_nil":false,"full_name":"domain[name]","validator":"Must be String","expected_type":"string","description":"<p>The full DNS Domain name</p>","required":true},{"name":"fullname","allow_nil":true,"full_name":"domain[fullname]","validator":"Must be String","expected_type":"string","description":"<p>Full name describing the domain</p>","required":false},{"name":"dns_id","allow_nil":true,"full_name":"domain[dns_id]","validator":"Must be a number.","expected_type":"string","description":"<p>DNS Proxy to use within this domain</p>","required":false},{"name":"domain_parameters_attributes","allow_nil":false,"full_name":"domain[domain_parameters_attributes]","validator":"Must be Array","expected_type":"string","description":"<p>Array of parameters (name, value)</p>","required":false}],"validator":"Must be a Hash","description":"","expected_type":"hash","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/domains","short_description":"Create a domain.","http_method":"POST"}],"full_description":"<p>The <b>fullname</b> field is used for human readability in reports and other pages that refer to domains, and also available as an external node parameter</p>","doc_url":"/apidoc/v2/domains/create"},{"see":null,"name":"update","examples":["PUT /api/domains/mydomain.net\n{\n  \"domain\": {\n    \"name\": \"\"\n  }\n}\n422\n{\n  \"domain\": {\n    \"full_messages\": [\n      \"Name can't be blank\"\n    ],\n    \"errors\": {\n      \"name\": [\n        \"can't be blank\"\n      ]\n    },\n    \"id\": 22495316\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"id","full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","description":"","expected_type":"string","required":true},{"allow_nil":false,"name":"domain","full_name":"domain","params":[{"name":"name","allow_nil":true,"full_name":"domain[name]","validator":"Must be String","expected_type":"string","description":"<p>The full DNS Domain name</p>","required":false},{"name":"fullname","allow_nil":true,"full_name":"domain[fullname]","validator":"Must be String","expected_type":"string","description":"<p>Full name describing the domain</p>","required":false},{"name":"dns_id","allow_nil":true,"full_name":"domain[dns_id]","validator":"Must be a number.","expected_type":"string","description":"<p>DNS Proxy to use within this domain</p>","required":false},{"name":"domain_parameters_attributes","allow_nil":false,"full_name":"domain[domain_parameters_attributes]","validator":"Must be Array","expected_type":"string","description":"<p>Array of parameters (name, value)</p>","required":false}],"validator":"Must be a Hash","description":"","expected_type":"hash","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/domains/:id","short_description":"Update a domain.","http_method":"PUT"}],"full_description":"","doc_url":"/apidoc/v2/domains/update"},{"see":null,"name":"destroy","examples":["DELETE /api/domains/mydomain.net\n200\n{\n  \"domain\": {\n    \"name\": \"mydomain.net\",\n    \"id\": 22495316\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"id","full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","description":"","expected_type":"string","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/domains/:id","short_description":"Delete a domain.","http_method":"DELETE"}],"full_description":"","doc_url":"/apidoc/v2/domains/destroy"}]},"dashboard":{"name":"Dashboard","formats":null,"api_url":"/api","version":"v2","short_description":null,"full_description":null,"doc_url":"/apidoc/v2/dashboard","methods":[{"see":null,"name":"index","examples":["GET /api/dashboard\n200\n{\n  \"ok_hosts_enabled\": 0,\n  \"disabled_hosts\": 0,\n  \"bad_hosts_enabled\": 0,\n  \"pending_hosts\": 0,\n  \"active_hosts\": 0,\n  \"active_hosts_ok_enabled\": 0,\n  \"good_hosts_enabled\": 0,\n  \"out_of_sync_hosts\": 0,\n  \"good_hosts\": 0,\n  \"total_hosts\": 12,\n  \"percentage\": 0,\n  \"pending_hosts_enabled\": 0,\n  \"ok_hosts\": 0,\n  \"bad_hosts\": 0,\n  \"reports_missing\": 12,\n  \"out_of_sync_hosts_enabled\": 0,\n  \"active_hosts_ok\": 0\n}"],"errors":[],"params":[{"allow_nil":false,"name":"search","full_name":"search","validator":"Must be String","description":"<p>filter results</p>","expected_type":"string","required":false}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/dashboard","short_description":"Get Dashboard results","http_method":"GET"}],"full_description":"","doc_url":"/apidoc/v2/dashboard/index"}]},"usergroups":{"name":"Usergroups","formats":null,"api_url":"/api","version":"v2","short_description":null,"full_description":null,"doc_url":"/apidoc/v2/usergroups","methods":[{"see":null,"name":"index","examples":["GET /api/usergroups\n200\n[\n  {\n    \"usergroup\": {\n      \"name\": \"MyString\",\n      \"created_at\": \"2012-12-18T15:24:43Z\",\n      \"updated_at\": \"2012-12-18T15:24:43Z\",\n      \"id\": 980190962\n    }\n  },\n  {\n    \"usergroup\": {\n      \"name\": \"MyString2\",\n      \"created_at\": \"2012-12-18T15:24:43Z\",\n      \"updated_at\": \"2012-12-18T15:24:43Z\",\n      \"id\": 298486374\n    }\n  }\n]"],"errors":[],"params":[{"allow_nil":false,"name":"page","full_name":"page","validator":"Must be String","description":"<p>paginate results</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"per_page","full_name":"per_page","validator":"Must be String","description":"<p>number of entries per request</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"search","full_name":"search","validator":"Must be String","description":"<p>filter results</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"order","full_name":"order","validator":"Must be String","description":"<p>sort results</p>","expected_type":"string","required":false}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/usergroups","short_description":"List all usergroups.","http_method":"GET"}],"full_description":"","doc_url":"/apidoc/v2/usergroups/index"},{"see":null,"name":"show","examples":["GET /api/usergroups/980190962\n200\n{\n  \"usergroup\": {\n    \"name\": \"MyString\",\n    \"created_at\": \"2012-12-18T15:24:43Z\",\n    \"updated_at\": \"2012-12-18T15:24:43Z\",\n    \"id\": 980190962\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"id","full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","description":"","expected_type":"string","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/usergroups/:id","short_description":"Show a usergroup.","http_method":"GET"}],"full_description":"","doc_url":"/apidoc/v2/usergroups/show"},{"see":null,"name":"create","examples":["POST /api/usergroups\n{\n  \"usergroup\": {\n    \"name\": \"test_usergroup\"\n  }\n}\n201\n{\n  \"usergroup\": {\n    \"name\": \"test_usergroup\",\n    \"id\": 980190963\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"usergroup","full_name":"usergroup","params":[{"name":"name","allow_nil":false,"full_name":"usergroup[name]","validator":"Must be String","expected_type":"string","description":"","required":true}],"validator":"Must be a Hash","description":"","expected_type":"hash","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/usergroups","short_description":"Create a usergroup.","http_method":"POST"}],"full_description":"","doc_url":"/apidoc/v2/usergroups/create"},{"see":null,"name":"update","examples":["PUT /api/usergroups/980190962\n{\n  \"usergroup\": {}\n}\n200\n{\n  \"usergroup\": {\n    \"name\": \"MyString\",\n    \"id\": 980190962\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"id","full_name":"id","validator":"Must be String","description":"","expected_type":"string","required":true},{"allow_nil":false,"name":"usergroup","full_name":"usergroup","params":[{"name":"name","allow_nil":false,"full_name":"usergroup[name]","validator":"Must be String","expected_type":"string","description":"","required":false}],"validator":"Must be a Hash","description":"","expected_type":"hash","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/usergroups/:id","short_description":"Update a usergroup.","http_method":"PUT"}],"full_description":"","doc_url":"/apidoc/v2/usergroups/update"},{"see":null,"name":"destroy","examples":["DELETE /api/usergroups/980190962\n200\n{\n  \"usergroup\": {\n    \"name\": \"MyString\",\n    \"id\": 980190962\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"id","full_name":"id","validator":"Must be String","description":"","expected_type":"string","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/usergroups/:id","short_description":"Delete a usergroup.","http_method":"DELETE"}],"full_description":"","doc_url":"/apidoc/v2/usergroups/destroy"}]},"models":{"name":"Models","formats":null,"api_url":"/api","version":"v2","short_description":null,"full_description":null,"doc_url":"/apidoc/v2/models","methods":[{"see":null,"name":"index","examples":["GET /api/models\n200\n[\n  {\n    \"model\": {\n      \"vendor_class\": null,\n      \"name\": \"KVM\",\n      \"created_at\": \"2012-12-18T15:24:43Z\",\n      \"updated_at\": \"2012-12-18T15:24:43Z\",\n      \"id\": 980190962,\n      \"info\": \"Virtual Machine\",\n      \"hardware_model\": null\n    }\n  },\n  {\n    \"model\": {\n      \"vendor_class\": \"Sun-Fire-V210\",\n      \"name\": \"SUN V210\",\n      \"created_at\": \"2012-12-18T15:24:43Z\",\n      \"updated_at\": \"2012-12-18T15:24:43Z\",\n      \"id\": 139037058,\n      \"info\": null,\n      \"hardware_model\": \"SUN4U\"\n    }\n  }\n]"],"errors":[],"params":[{"allow_nil":false,"name":"search","full_name":"search","validator":"Must be String","description":"<p>filter results</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"order","full_name":"order","validator":"Must be String","description":"<p>sort results</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"page","full_name":"page","validator":"Must be String","description":"<p>paginate results</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"per_page","full_name":"per_page","validator":"Must be String","description":"<p>number of entries per request</p>","expected_type":"string","required":false}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/models","short_description":"List all models.","http_method":"GET"}],"full_description":"","doc_url":"/apidoc/v2/models/index"},{"see":null,"name":"show","examples":["GET /api/models/980190962\n200\n{\n  \"model\": {\n    \"vendor_class\": null,\n    \"name\": \"KVM\",\n    \"created_at\": \"2012-12-18T15:24:43Z\",\n    \"updated_at\": \"2012-12-18T15:24:43Z\",\n    \"id\": 980190962,\n    \"info\": \"Virtual Machine\",\n    \"hardware_model\": null\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"id","full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","description":"","expected_type":"string","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/models/:id","short_description":"Show a model.","http_method":"GET"}],"full_description":"","doc_url":"/apidoc/v2/models/show"},{"see":null,"name":"create","examples":["POST /api/models\n{\n  \"model\": {\n    \"name\": \"new model\"\n  }\n}\n201\n{\n  \"model\": {\n    \"vendor_class\": null,\n    \"name\": \"new model\",\n    \"created_at\": \"2012-12-18T15:24:49Z\",\n    \"updated_at\": \"2012-12-18T15:24:49Z\",\n    \"id\": 980190963,\n    \"info\": null,\n    \"hardware_model\": null\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"model","full_name":"model","params":[{"name":"name","allow_nil":false,"full_name":"model[name]","validator":"Must be String","expected_type":"string","description":"","required":true},{"name":"info","allow_nil":false,"full_name":"model[info]","validator":"Must be String","expected_type":"string","description":"","required":false},{"name":"vendor_class","allow_nil":false,"full_name":"model[vendor_class]","validator":"Must be String","expected_type":"string","description":"","required":false},{"name":"hardware_model","allow_nil":false,"full_name":"model[hardware_model]","validator":"Must be String","expected_type":"string","description":"","required":false}],"validator":"Must be a Hash","description":"","expected_type":"hash","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/models","short_description":"Create a model.","http_method":"POST"}],"full_description":"","doc_url":"/apidoc/v2/models/create"},{"see":null,"name":"update","examples":["PUT /api/models/980190962\n{\n  \"name\": \"KVM\"\n}\n200\n{\n  \"model\": {\n    \"vendor_class\": null,\n    \"name\": \"KVM\",\n    \"created_at\": \"2012-12-18T15:24:43Z\",\n    \"updated_at\": \"2012-12-18T15:24:43Z\",\n    \"id\": 980190962,\n    \"info\": \"Virtual Machine\",\n    \"hardware_model\": null\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"id","full_name":"id","validator":"Must be String","description":"","expected_type":"string","required":true},{"allow_nil":false,"name":"model","full_name":"model","params":[{"name":"name","allow_nil":false,"full_name":"model[name]","validator":"Must be String","expected_type":"string","description":"","required":false},{"name":"info","allow_nil":false,"full_name":"model[info]","validator":"Must be String","expected_type":"string","description":"","required":false},{"name":"vendor_class","allow_nil":false,"full_name":"model[vendor_class]","validator":"Must be String","expected_type":"string","description":"","required":false},{"name":"hardware_model","allow_nil":false,"full_name":"model[hardware_model]","validator":"Must be String","expected_type":"string","description":"","required":false}],"validator":"Must be a Hash","description":"","expected_type":"hash","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/models/:id","short_description":"Update a model.","http_method":"PUT"}],"full_description":"","doc_url":"/apidoc/v2/models/update"},{"see":null,"name":"destroy","examples":["DELETE /api/models/980190962\n200\n{\n  \"model\": {\n    \"vendor_class\": null,\n    \"name\": \"KVM\",\n    \"created_at\": \"2012-12-18T15:24:43Z\",\n    \"updated_at\": \"2012-12-18T15:24:43Z\",\n    \"id\": 980190962,\n    \"info\": \"Virtual Machine\",\n    \"hardware_model\": null\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"id","full_name":"id","validator":"Must be String","description":"","expected_type":"string","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/models/:id","short_description":"Delete a model.","http_method":"DELETE"}],"full_description":"","doc_url":"/apidoc/v2/models/destroy"}]},"host_classes":{"name":"Host classes","formats":null,"api_url":"/api","version":"v2","short_description":null,"full_description":null,"doc_url":"/apidoc/v2/host_classes","methods":[{"see":null,"name":"index","examples":[],"errors":[],"params":[],"formats":null,"see_url":null,"apis":[{"api_url":"/api/hosts/:host_id/puppetclass_ids","short_description":"List all puppetclass id's for host","http_method":"GET"}],"full_description":"","doc_url":"/apidoc/v2/host_classes/index"},{"see":null,"name":"create","examples":[],"errors":[],"params":[{"allow_nil":false,"name":"host_id","full_name":"host_id","validator":"Must be String","description":"<p>id of host</p>","expected_type":"string","required":true},{"allow_nil":false,"name":"puppetclass_id","full_name":"puppetclass_id","validator":"Must be String","description":"<p>id of puppetclass</p>","expected_type":"string","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/hosts/:host_id/puppetclass_ids","short_description":"Add a puppetclass to host","http_method":"POST"}],"full_description":"","doc_url":"/apidoc/v2/host_classes/create"},{"see":null,"name":"destroy","examples":[],"errors":[],"params":[{"allow_nil":false,"name":"host_id","full_name":"host_id","validator":"Must be String","description":"<p>id of host</p>","expected_type":"string","required":true},{"allow_nil":false,"name":"id","full_name":"id","validator":"Must be String","description":"<p>id of puppetclass</p>","expected_type":"string","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/hosts/:host_id/puppetclass_ids/:id","short_description":"Remove a puppetclass from host","http_method":"DELETE"}],"full_description":"","doc_url":"/apidoc/v2/host_classes/destroy"}]},"reports":{"name":"Reports","formats":null,"api_url":"/api","version":"v2","short_description":null,"full_description":null,"doc_url":"/apidoc/v2/reports","methods":[{"see":null,"name":"index","examples":["GET /api/reports\n200\n[\n  {\n    \"report\": {\n      \"logs\": [],\n      \"summary\": \"Success\",\n      \"status\": {\n        \"failed_restarts\": 0,\n        \"restarted\": 0,\n        \"pending\": 0,\n        \"skipped\": 0,\n        \"failed\": 0,\n        \"applied\": 0\n      },\n      \"metrics\": {\n        \"changes\": {},\n        \"time\": {\n          \"cron\": 0.000419,\n          \"mailalias\": 0.000283,\n          \"exec\": 0.000299,\n          \"filebucket\": 0.000171,\n          \"config_retrieval\": 16.3637869358063,\n          \"package\": 0.003989,\n          \"file\": 0.007025,\n          \"service\": 0.149739,\n          \"schedule\": 0.00083\n        },\n        \"events\": {\n          \"total\": 0\n        },\n        \"resources\": {\n          \"total\": 33\n        }\n      },\n      \"id\": 70219655,\n      \"reported_at\": \"2012-12-11T15:24:42Z\"\n    }\n  }\n]"],"errors":[],"params":[{"allow_nil":false,"name":"search","full_name":"search","validator":"Must be String","description":"<p>filter results</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"order","full_name":"order","validator":"Must be String","description":"<p>sort results</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"page","full_name":"page","validator":"Must be String","description":"<p>paginate results</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"per_page","full_name":"per_page","validator":"Must be String","description":"<p>number of entries per request</p>","expected_type":"string","required":false}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/reports","short_description":"List all reports.","http_method":"GET"}],"full_description":"","doc_url":"/apidoc/v2/reports/index"},{"see":null,"name":"show","examples":["GET /api/reports/70219655\n200\n{\n  \"report\": {\n    \"logs\": [],\n    \"summary\": \"Success\",\n    \"status\": {\n      \"failed_restarts\": 0,\n      \"restarted\": 0,\n      \"pending\": 0,\n      \"skipped\": 0,\n      \"failed\": 0,\n      \"applied\": 0\n    },\n    \"metrics\": {\n      \"changes\": {},\n      \"time\": {\n        \"cron\": 0.000419,\n        \"mailalias\": 0.000283,\n        \"exec\": 0.000299,\n        \"filebucket\": 0.000171,\n        \"config_retrieval\": 16.3637869358063,\n        \"package\": 0.003989,\n        \"file\": 0.007025,\n        \"service\": 0.149739,\n        \"schedule\": 0.00083\n      },\n      \"events\": {\n        \"total\": 0\n      },\n      \"resources\": {\n        \"total\": 33\n      }\n    },\n    \"id\": 70219655,\n    \"reported_at\": \"2012-12-11T15:24:42Z\"\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"id","full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","description":"","expected_type":"string","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/reports/:id","short_description":"Show a report.","http_method":"GET"}],"full_description":"","doc_url":"/apidoc/v2/reports/show"},{"see":null,"name":"destroy","examples":["DELETE /api/reports/70219655\n200\n{\n  \"report\": {\n    \"logs\": [],\n    \"summary\": \"Success\",\n    \"status\": {\n      \"failed_restarts\": 0,\n      \"restarted\": 0,\n      \"pending\": 0,\n      \"skipped\": 0,\n      \"failed\": 0,\n      \"applied\": 0\n    },\n    \"metrics\": {\n      \"changes\": {},\n      \"time\": {\n        \"cron\": 0.000419,\n        \"mailalias\": 0.000283,\n        \"exec\": 0.000299,\n        \"filebucket\": 0.000171,\n        \"config_retrieval\": 16.3637869358063,\n        \"package\": 0.003989,\n        \"file\": 0.007025,\n        \"service\": 0.149739,\n        \"schedule\": 0.00083\n      },\n      \"events\": {\n        \"total\": 0\n      },\n      \"resources\": {\n        \"total\": 33\n      }\n    },\n    \"host\": \"my5name.mydomain.net\",\n    \"id\": 70219655,\n    \"reported_at\": \"2012-12-11T15:24:42Z\"\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"id","full_name":"id","validator":"Must be String","description":"","expected_type":"string","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/ptables/:id","short_description":"Delete a report.","http_method":"DELETE"}],"full_description":"","doc_url":"/apidoc/v2/reports/destroy"},{"see":null,"name":"last","examples":["GET /api/reports/last\n200\n{\n  \"report\": {\n    \"logs\": [],\n    \"summary\": \"Success\",\n    \"status\": {\n      \"failed_restarts\": 0,\n      \"restarted\": 0,\n      \"pending\": 0,\n      \"skipped\": 0,\n      \"failed\": 0,\n      \"applied\": 0\n    },\n    \"metrics\": {\n      \"changes\": {},\n      \"time\": {\n        \"cron\": 0.000419,\n        \"mailalias\": 0.000283,\n        \"exec\": 0.000299,\n        \"filebucket\": 0.000171,\n        \"config_retrieval\": 16.3637869358063,\n        \"package\": 0.003989,\n        \"file\": 0.007025,\n        \"service\": 0.149739,\n        \"schedule\": 0.00083\n      },\n      \"events\": {\n        \"total\": 0\n      },\n      \"resources\": {\n        \"total\": 33\n      }\n    },\n    \"id\": 70219655,\n    \"reported_at\": \"2012-12-11T15:24:42Z\"\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"id","full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","description":"","expected_type":"string","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/hosts/:host_id/reports/last","short_description":"Show the last report for a given host.","http_method":"GET"}],"full_description":"","doc_url":"/apidoc/v2/reports/last"}]},"home":{"name":"Home","formats":null,"api_url":"/api","version":"v2","short_description":null,"full_description":null,"doc_url":"/apidoc/v2/home","methods":[{"see":null,"name":"index","examples":["GET /api\n200\n{\n  \"links\": {\n    \"List all bookmarks\": \"/api/bookmarks\",\n    \"List all common parameters\": \"/api/common_parameters\",\n    \"List all architectures\": \"/api/architectures\",\n    \"List all settings\": \"/api/settings\",\n    \"List all compute resources\": \"/api/compute_resources\",\n    \"List all models\": \"/api/models\",\n    \"List all fact values\": \"/api/fact_values\",\n    \"List all lookup_keys\": \"/api/lookup_keys\",\n    \"Show available links\": \"/api\",\n    \"List all usergroups\": \"/api/usergroups\",\n    \"List all operating systems\": \"/api/operatingsystems\",\n    \"List of domains\": \"/api/domains\",\n    \"List all environments\": \"/api/environments\",\n    \"List all puppetclasses\": \"/api/puppetclasses\",\n    \"List all template kinds\": \"/api/template_kinds\",\n    \"List of subnets\": \"/api/subnets\",\n    \"List all hosts\": \"/api/hosts\",\n    \"List all audits\": \"/api/audits\",\n    \"List all roles\": \"/api/roles\",\n    \"List templates\": \"/api/config_templates\",\n    \"List all smart_proxies\": \"/api/smart_proxies\",\n    \"List all images for compute resource\": \"/api/compute_resources/:compute_resource_id/images\",\n    \"Get Dashboard results\": \"/api/dashboard\",\n    \"List all media\": \"/api/media\",\n    \"List all authsource ldaps\": \"/api/auth_source_ldaps\",\n    \"Show status\": \"/api/status\",\n    \"List all ptables\": \"/api/ptables\",\n    \"List all reports\": \"/api/reports\",\n    \"List all users\": \"/api/users\",\n    \"List all hostgroups\": \"/api/hostgroups\"\n  }\n}"],"errors":[],"params":[],"formats":null,"see_url":null,"apis":[{"api_url":"/api","short_description":"Show available links.","http_method":"GET"}],"full_description":"","doc_url":"/apidoc/v2/home/index"},{"see":null,"name":"status","examples":[],"errors":[],"params":[],"formats":null,"see_url":null,"apis":[{"api_url":"/api/status","short_description":"Show status.","http_method":"GET"}],"full_description":"","doc_url":"/apidoc/v2/home/status"}]},"environments":{"name":"Environments","formats":null,"api_url":"/api","version":"v2","short_description":null,"full_description":null,"doc_url":"/apidoc/v2/environments","methods":[{"see":null,"name":"index","examples":["GET /api/environments\n200\n[\n  {\n    \"environment\": {\n      \"name\": \"global_puppetmaster\",\n      \"created_at\": \"2012-12-18T15:24:42Z\",\n      \"updated_at\": \"2012-12-18T15:24:42Z\",\n      \"id\": 153855663\n    }\n  },\n  {\n    \"environment\": {\n      \"name\": \"production\",\n      \"created_at\": \"2012-12-18T15:24:42Z\",\n      \"updated_at\": \"2012-12-18T15:24:42Z\",\n      \"id\": 334344675\n    }\n  },\n  {\n    \"environment\": {\n      \"name\": \"testing\",\n      \"created_at\": \"2012-12-18T15:24:42Z\",\n      \"updated_at\": \"2012-12-18T15:24:42Z\",\n      \"id\": 687036937\n    }\n  }\n]"],"errors":[],"params":[{"allow_nil":false,"name":"search","full_name":"search","validator":"Must be String","description":"<p>Filter results</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"order","full_name":"order","validator":"Must be String","description":"<p>Sort results</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"page","full_name":"page","validator":"Must be String","description":"<p>paginate results</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"per_page","full_name":"per_page","validator":"Must be String","description":"<p>number of entries per request</p>","expected_type":"string","required":false}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/environments","short_description":"List all environments.","http_method":"GET"}],"full_description":"","doc_url":"/apidoc/v2/environments/index"},{"see":null,"name":"show","examples":["GET /api/environments/production\n200\n{\n  \"environment\": {\n    \"name\": \"production\",\n    \"created_at\": \"2012-12-18T15:24:42Z\",\n    \"updated_at\": \"2012-12-18T15:24:42Z\",\n    \"id\": 334344675\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"id","full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","description":"","expected_type":"string","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/environments/:id","short_description":"Show an environment.","http_method":"GET"}],"full_description":"","doc_url":"/apidoc/v2/environments/show"},{"see":null,"name":"create","examples":["POST /api/environments\n{\n  \"environment\": {\n    \"name\": \"Development\"\n  }\n}\n200\n{\n  \"environment\": {\n    \"name\": \"Development\",\n    \"created_at\": \"2012-12-18T15:24:46Z\",\n    \"updated_at\": \"2012-12-18T15:24:46Z\",\n    \"id\": 687036938\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"environment","full_name":"environment","params":[{"name":"name","allow_nil":false,"full_name":"environment[name]","validator":"Must be String","expected_type":"string","description":"","required":true}],"validator":"Must be a Hash","description":"","expected_type":"hash","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/environments","short_description":"Create an environment.","http_method":"POST"}],"full_description":"","doc_url":"/apidoc/v2/environments/create"},{"see":null,"name":"update","examples":["PUT /api/environments/production\n{\n  \"environment\": {}\n}\n200\n{\n  \"environment\": {\n    \"name\": \"production\",\n    \"id\": 334344675\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"id","full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","description":"","expected_type":"string","required":true},{"allow_nil":false,"name":"environment","full_name":"environment","params":[{"name":"name","allow_nil":false,"full_name":"environment[name]","validator":"Must be String","expected_type":"string","description":"","required":false}],"validator":"Must be a Hash","description":"","expected_type":"hash","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/environments/:id","short_description":"Update an environment.","http_method":"PUT"}],"full_description":"","doc_url":"/apidoc/v2/environments/update"},{"see":null,"name":"destroy","examples":["DELETE /api/environments/testing\n200\n{\n  \"environment\": {\n    \"name\": \"testing\",\n    \"id\": 687036937\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"id","full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","description":"","expected_type":"string","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/environments/:id","short_description":"Delete an environment.","http_method":"DELETE"}],"full_description":"","doc_url":"/apidoc/v2/environments/destroy"}]},"ptables":{"name":"Ptables","formats":null,"api_url":"/api","version":"v2","short_description":null,"full_description":null,"doc_url":"/apidoc/v2/ptables","methods":[{"see":null,"name":"index","examples":["GET /api/ptables\n200\n[\n  {\n    \"ptable\": {\n      \"name\": \"default\",\n      \"created_at\": \"2012-12-18T15:24:43Z\",\n      \"updated_at\": \"2012-12-18T15:24:43Z\",\n      \"id\": 980190962\n    }\n  },\n  {\n    \"ptable\": {\n      \"name\": \"four\",\n      \"created_at\": \"2012-12-18T15:24:43Z\",\n      \"updated_at\": \"2012-12-18T15:24:43Z\",\n      \"id\": 281110143\n    }\n  },\n  {\n    \"ptable\": {\n      \"name\": \"suse default\",\n      \"created_at\": \"2012-12-18T15:24:43Z\",\n      \"updated_at\": \"2012-12-18T15:24:43Z\",\n      \"id\": 859751735\n    }\n  },\n  {\n    \"ptable\": {\n      \"name\": \"ubuntu default\",\n      \"created_at\": \"2012-12-18T15:24:43Z\",\n      \"updated_at\": \"2012-12-18T15:24:43Z\",\n      \"id\": 1011586618\n    }\n  }\n]"],"errors":[],"params":[{"allow_nil":false,"name":"search","full_name":"search","validator":"Must be String","description":"<p>filter results</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"order","full_name":"order","validator":"Must be String","description":"<p>sort results</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"page","full_name":"page","validator":"Must be String","description":"<p>paginate results</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"per_page","full_name":"per_page","validator":"Must be String","description":"<p>number of entries per request</p>","expected_type":"string","required":false}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/ptables","short_description":"List all ptables.","http_method":"GET"}],"full_description":"","doc_url":"/apidoc/v2/ptables/index"},{"see":null,"name":"show","examples":["GET /api/ptables/980190962\n200\n{\n  \"ptable\": {\n    \"name\": \"default\",\n    \"created_at\": \"2012-12-18T15:24:43Z\",\n    \"updated_at\": \"2012-12-18T15:24:43Z\",\n    \"id\": 980190962\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"id","full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","description":"","expected_type":"string","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/ptables/:id","short_description":"Show a ptable.","http_method":"GET"}],"full_description":"","doc_url":"/apidoc/v2/ptables/show"},{"see":null,"name":"create","examples":["POST /api/ptables\n{\n  \"ptable\": {\n    \"name\": \"ptable_test\",\n    \"layout\": \"d-i partman-auto/disk\"\n  }\n}\n201\n{\n  \"ptable\": {\n    \"name\": \"ptable_test\",\n    \"id\": 1011586619\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"ptable","full_name":"ptable","params":[{"name":"name","allow_nil":false,"full_name":"ptable[name]","validator":"Must be String","expected_type":"string","description":"","required":true},{"name":"layout","allow_nil":false,"full_name":"ptable[layout]","validator":"Must be String","expected_type":"string","description":"","required":true},{"name":"os_family","allow_nil":false,"full_name":"ptable[os_family]","validator":"Must be String","expected_type":"string","description":"","required":false}],"validator":"Must be a Hash","description":"","expected_type":"hash","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/ptables","short_description":"Create a ptable.","http_method":"POST"}],"full_description":"","doc_url":"/apidoc/v2/ptables/create"},{"see":null,"name":"update","examples":["PUT /api/ptables/980190962\n{\n  \"ptable\": {}\n}\n200\n{\n  \"ptable\": {\n    \"name\": \"default\",\n    \"id\": 980190962\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"id","full_name":"id","validator":"Must be String","description":"","expected_type":"string","required":true},{"allow_nil":false,"name":"ptable","full_name":"ptable","params":[{"name":"name","allow_nil":false,"full_name":"ptable[name]","validator":"Must be String","expected_type":"string","description":"","required":false},{"name":"layout","allow_nil":false,"full_name":"ptable[layout]","validator":"Must be String","expected_type":"string","description":"","required":false},{"name":"os_family","allow_nil":false,"full_name":"ptable[os_family]","validator":"Must be String","expected_type":"string","description":"","required":false}],"validator":"Must be a Hash","description":"","expected_type":"hash","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/ptables/:id","short_description":"Update a ptable.","http_method":"PUT"}],"full_description":"","doc_url":"/apidoc/v2/ptables/update"},{"see":null,"name":"destroy","examples":["DELETE /api/ptables/980190962\n422\n{\n  \"ptable\": {\n    \"full_messages\": [\n      \"default is used by temp01.yourdomain.net\",\n      \"default is used by temp.yourdomain.net\",\n      \"default is used by my5name.mydomain.net\",\n      \"default is used by dhcp.mydomain.net\",\n      \"default is used by sdhcp.mydomain.net\"\n    ],\n    \"errors\": {\n      \"base\": [\n        \"default is used by temp01.yourdomain.net\",\n        \"default is used by temp.yourdomain.net\",\n        \"default is used by my5name.mydomain.net\",\n        \"default is used by dhcp.mydomain.net\",\n        \"default is used by sdhcp.mydomain.net\"\n      ]\n    },\n    \"id\": 980190962\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"id","full_name":"id","validator":"Must be String","description":"","expected_type":"string","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/ptables/:id","short_description":"Delete a ptable.","http_method":"DELETE"}],"full_description":"","doc_url":"/apidoc/v2/ptables/destroy"}]},"compute_resources":{"name":"Compute resources","formats":null,"api_url":"/api","version":"v2","short_description":null,"full_description":null,"doc_url":"/apidoc/v2/compute_resources","methods":[{"see":null,"name":"index","examples":["GET /api/compute_resources\n200\n[\n  {\n    \"compute_resource\": {\n      \"user\": \"MyString\",\n      \"name\": \"mycompute\",\n      \"created_at\": \"2012-12-18T15:24:42Z\",\n      \"url\": \"test:///default\",\n      \"updated_at\": \"2012-12-18T15:24:42Z\",\n      \"id\": 367690737,\n      \"provider\": \"Libvirt\",\n      \"description\": \"mycompute\"\n    }\n  },\n  {\n    \"compute_resource\": {\n      \"user\": \"MyString\",\n      \"name\": \"MyString\",\n      \"created_at\": \"2012-12-18T15:24:42Z\",\n      \"url\": \"qemu://stam/system\",\n      \"updated_at\": \"2012-12-18T15:24:42Z\",\n      \"id\": 980190962,\n      \"provider\": \"Libvirt\",\n      \"description\": \"MyString\"\n    }\n  },\n  {\n    \"compute_resource\": {\n      \"user\": \"MyString\",\n      \"name\": \"yourcompute\",\n      \"created_at\": \"2012-12-18T15:24:42Z\",\n      \"url\": \"test:///default\",\n      \"updated_at\": \"2012-12-18T15:24:42Z\",\n      \"id\": 932571420,\n      \"provider\": \"Libvirt\",\n      \"description\": \"yourcompute\"\n    }\n  }\n]"],"errors":[],"params":[{"allow_nil":false,"name":"search","full_name":"search","validator":"Must be String","description":"<p>filter results</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"order","full_name":"order","validator":"Must be String","description":"<p>sort results</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"page","full_name":"page","validator":"Must be String","description":"<p>paginate results</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"per_page","full_name":"per_page","validator":"Must be String","description":"<p>number of entries per request</p>","expected_type":"string","required":false}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/compute_resources","short_description":"List all compute resources.","http_method":"GET"}],"full_description":"","doc_url":"/apidoc/v2/compute_resources/index"},{"see":null,"name":"show","examples":["GET /api/compute_resources/980190962-mystring\n200\n{\n  \"compute_resource\": {\n    \"user\": \"MyString\",\n    \"name\": \"MyString\",\n    \"created_at\": \"2012-12-18T15:24:42Z\",\n    \"url\": \"qemu://stam/system\",\n    \"updated_at\": \"2012-12-18T15:24:42Z\",\n    \"id\": 980190962,\n    \"provider\": \"Libvirt\",\n    \"description\": \"MyString\"\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"id","full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","description":"","expected_type":"string","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/compute_resources/:id","short_description":"Show an compute resource.","http_method":"GET"}],"full_description":"","doc_url":"/apidoc/v2/compute_resources/show"},{"see":null,"name":"create","examples":["POST /api/compute_resources\n{\n  \"compute_resource\": {\n    \"user\": \"user@example.com\",\n    \"name\": \"special_compute\",\n    \"provider\": \"EC2\",\n    \"password\": \"secret\",\n    \"region\": \"eu-west-1\"\n  }\n}\n200\n{\n  \"compute_resource\": {\n    \"user\": \"user@example.com\",\n    \"name\": \"special_compute\",\n    \"created_at\": \"2012-12-18T15:24:44Z\",\n    \"url\": \"eu-west-1\",\n    \"updated_at\": \"2012-12-18T15:24:44Z\",\n    \"id\": 980190963,\n    \"provider\": \"EC2\",\n    \"description\": null\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"compute_resource","full_name":"compute_resource","params":[{"name":"name","allow_nil":false,"full_name":"compute_resource[name]","validator":"Must be String","expected_type":"string","description":"","required":false},{"name":"provider","allow_nil":false,"full_name":"compute_resource[provider]","validator":"Must be String","expected_type":"string","description":"<p>Providers include Libvirt, Ovirt, EC2, Vmware, Openstack, Rackspace</p>","required":false},{"name":"url","allow_nil":false,"full_name":"compute_resource[url]","validator":"Must be String","expected_type":"string","description":"<p>URL for Libvirt, Ovirt, and Openstack</p>","required":true},{"name":"description","allow_nil":false,"full_name":"compute_resource[description]","validator":"Must be String","expected_type":"string","description":"","required":false},{"name":"user","allow_nil":false,"full_name":"compute_resource[user]","validator":"Must be String","expected_type":"string","description":"<p>Username for Ovirt, EC2, Vmware, Openstack. Access Key for EC2.</p>","required":false},{"name":"password","allow_nil":false,"full_name":"compute_resource[password]","validator":"Must be String","expected_type":"string","description":"<p>Password for Ovirt, EC2, Vmware, Openstack. Secret key for EC2</p>","required":false},{"name":"uuid","allow_nil":false,"full_name":"compute_resource[uuid]","validator":"Must be String","expected_type":"string","description":"<p>for Ovirt, Vmware Datacenter</p>","required":false},{"name":"region","allow_nil":false,"full_name":"compute_resource[region]","validator":"Must be String","expected_type":"string","description":"<p>for EC2 only</p>","required":false},{"name":"tenant","allow_nil":false,"full_name":"compute_resource[tenant]","validator":"Must be String","expected_type":"string","description":"<p>for Openstack only</p>","required":false},{"name":"server","allow_nil":false,"full_name":"compute_resource[server]","validator":"Must be String","expected_type":"string","description":"<p>for Vmware</p>","required":false}],"validator":"Must be a Hash","description":"","expected_type":"hash","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/compute_resources","short_description":"Create a compute resource.","http_method":"POST"}],"full_description":"","doc_url":"/apidoc/v2/compute_resources/create"},{"see":null,"name":"update","examples":["PUT /api/compute_resources/367690737-mycompute\n{\n  \"compute_resource\": {\n    \"description\": \"new_description\"\n  }\n}\n200\n{\n  \"compute_resource\": {\n    \"user\": \"MyString\",\n    \"name\": \"mycompute\",\n    \"created_at\": \"2012-12-18T15:24:42Z\",\n    \"uuid\": \"mycompute\",\n    \"url\": \"test:///default\",\n    \"updated_at\": \"2012-12-18T15:24:45Z\",\n    \"id\": 367690737,\n    \"description\": \"new_description\",\n    \"attrs\": {}\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"id","full_name":"id","validator":"Must be String","description":"","expected_type":"string","required":true},{"allow_nil":false,"name":"compute_resource","full_name":"compute_resource","params":[{"name":"name","allow_nil":false,"full_name":"compute_resource[name]","validator":"Must be String","expected_type":"string","description":"","required":false},{"name":"provider","allow_nil":false,"full_name":"compute_resource[provider]","validator":"Must be String","expected_type":"string","description":"<p>Providers include Libvirt, Ovirt, EC2, Vmware, Openstack, Rackspace</p>","required":false},{"name":"url","allow_nil":false,"full_name":"compute_resource[url]","validator":"Must be String","expected_type":"string","description":"<p>URL for Libvirt, Ovirt, and Openstack</p>","required":false},{"name":"description","allow_nil":false,"full_name":"compute_resource[description]","validator":"Must be String","expected_type":"string","description":"","required":false},{"name":"user","allow_nil":false,"full_name":"compute_resource[user]","validator":"Must be String","expected_type":"string","description":"<p>Username for Ovirt, EC2, Vmware, Openstack. Access Key for EC2.</p>","required":false},{"name":"password","allow_nil":false,"full_name":"compute_resource[password]","validator":"Must be String","expected_type":"string","description":"<p>Password for Ovirt, EC2, Vmware, Openstack. Secret key for EC2</p>","required":false},{"name":"uuid","allow_nil":false,"full_name":"compute_resource[uuid]","validator":"Must be String","expected_type":"string","description":"<p>for Ovirt, Vmware Datacenter</p>","required":false},{"name":"region","allow_nil":false,"full_name":"compute_resource[region]","validator":"Must be String","expected_type":"string","description":"<p>for EC2 only</p>","required":false},{"name":"tenant","allow_nil":false,"full_name":"compute_resource[tenant]","validator":"Must be String","expected_type":"string","description":"<p>for Openstack only</p>","required":false},{"name":"server","allow_nil":false,"full_name":"compute_resource[server]","validator":"Must be String","expected_type":"string","description":"<p>for Vmware</p>","required":false}],"validator":"Must be a Hash","description":"","expected_type":"hash","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/compute_resources/:id","short_description":"Update a compute resource.","http_method":"PUT"}],"full_description":"","doc_url":"/apidoc/v2/compute_resources/update"},{"see":null,"name":"destroy","examples":["DELETE /api/compute_resources/932571420\n200\n{\n  \"compute_resource\": {\n    \"user\": \"MyString\",\n    \"name\": \"yourcompute\",\n    \"created_at\": \"2012-12-18T15:24:42Z\",\n    \"uuid\": \"yourcompute\",\n    \"url\": \"test:///default\",\n    \"updated_at\": \"2012-12-18T15:24:42Z\",\n    \"id\": 932571420,\n    \"description\": \"yourcompute\",\n    \"attrs\": null\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"id","full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","description":"","expected_type":"string","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/compute_resources/:id","short_description":"Delete a compute resource.","http_method":"DELETE"}],"full_description":"","doc_url":"/apidoc/v2/compute_resources/destroy"}]},"roles":{"name":"Roles","formats":null,"api_url":"/api","version":"v2","short_description":null,"full_description":null,"doc_url":"/apidoc/v2/roles","methods":[{"see":null,"name":"index","examples":[],"errors":[],"params":[{"allow_nil":false,"name":"page","full_name":"page","validator":"Must be String","description":"<p>paginate results</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"per_page","full_name":"per_page","validator":"Must be String","description":"<p>number of entries per request</p>","expected_type":"string","required":false}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/roles","short_description":"List all roles.","http_method":"GET"}],"full_description":"","doc_url":"/apidoc/v2/roles/index"},{"see":null,"name":"show","examples":["GET /api/roles/1\n200\n{\n  \"role\": {\n    \"name\": \"Manager\",\n    \"builtin\": 0,\n    \"id\": 1,\n    \"permissions\": [\n      \"view_architectures\",\n      \"create_architectures\",\n      \"edit_architectures\",\n      \"destroy_architectures\",\n      \"view_authenticators\",\n      \"create_authenticators\",\n      \"edit_authenticators\",\n      \"destroy_authenticators\",\n      \"view_environments\",\n      \"create_environments\",\n      \"edit_environments\",\n      \"destroy_environments\",\n      \"import_environments\",\n      \"view_external_variables\",\n      \"create_external_variables\",\n      \"edit_external_variables\",\n      \"destroy_external_variables\",\n      \"view_domains\",\n      \"create_domain\",\n      \"edit_domains\",\n      \"destroy_domains\",\n      \"view_globals\",\n      \"create_globals\",\n      \"edit_globals\",\n      \"destroy_globals\",\n      \"view_hostgroups\",\n      \"create_hostgroups\",\n      \"edit_hostgroups\",\n      \"destroy_hostgroups\",\n      \"view_hosts\",\n      \"create_hosts\",\n      \"edit_hosts\",\n      \"destroy_hosts\",\n      \"view_media\",\n      \"create_media\",\n      \"edit_media\",\n      \"destroy_media\",\n      \"view_models\",\n      \"create_models\",\n      \"edit_models\",\n      \"destroy_models\",\n      \"view_operatingsystems\",\n      \"create_operatingsystems\",\n      \"edit_operatingsystems\",\n      \"destroy_operatingsystems\",\n      \"view_ptables\",\n      \"create_ptables\",\n      \"edit_ptables\",\n      \"destroy_ptables\",\n      \"view_puppetclasses\",\n      \"create_puppetclasses\",\n      \"edit_puppetclasses\",\n      \"destroy_puppetclasses\",\n      \"import_puppetclasses\",\n      \"view_usergroups\",\n      \"create_usergroups\",\n      \"edit_usergroups\",\n      \"destroy_usergroups\",\n      \"view_users\",\n      \"create_users\",\n      \"edit_users\",\n      \"destroy_users\",\n      \"access_settings\",\n      \"access_dashboard\",\n      \"view_reports\",\n      \"destroy_reports\",\n      \"view_facts\",\n      \"view_audit_logs\",\n      \"view_statistics\",\n      \"view_locations\",\n      \"edit_locations\",\n      \"create_locations\",\n      \"destroy_locations\",\n      \"view_organizations\",\n      \"edit_organizations\",\n      \"create_organizations\",\n      \"destroy_organizations\"\n    ]\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"id","full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","description":"","expected_type":"string","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/roles/:id","short_description":"Show an role.","http_method":"GET"}],"full_description":"","doc_url":"/apidoc/v2/roles/show"},{"see":null,"name":"create","examples":["POST /api/roles\n{\n  \"role\": {\n    \"name\": \"staff\"\n  }\n}\n200\n{\n  \"role\": {\n    \"name\": \"staff\",\n    \"builtin\": 0,\n    \"id\": 11,\n    \"permissions\": []\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"role","full_name":"role","params":[{"name":"name","allow_nil":false,"full_name":"role[name]","validator":"Must be String","expected_type":"string","description":"","required":true}],"validator":"Must be a Hash","description":"","expected_type":"hash","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/roles","short_description":"Create an role.","http_method":"POST"}],"full_description":"","doc_url":"/apidoc/v2/roles/create"},{"see":null,"name":"update","examples":["PUT /api/roles/1\n{\n  \"role\": {}\n}\n200\n{\n  \"role\": {\n    \"name\": \"Manager\",\n    \"builtin\": 0,\n    \"id\": 1,\n    \"permissions\": [\n      \"view_architectures\",\n      \"create_architectures\",\n      \"edit_architectures\",\n      \"destroy_architectures\",\n      \"view_authenticators\",\n      \"create_authenticators\",\n      \"edit_authenticators\",\n      \"destroy_authenticators\",\n      \"view_environments\",\n      \"create_environments\",\n      \"edit_environments\",\n      \"destroy_environments\",\n      \"import_environments\",\n      \"view_external_variables\",\n      \"create_external_variables\",\n      \"edit_external_variables\",\n      \"destroy_external_variables\",\n      \"view_domains\",\n      \"create_domain\",\n      \"edit_domains\",\n      \"destroy_domains\",\n      \"view_globals\",\n      \"create_globals\",\n      \"edit_globals\",\n      \"destroy_globals\",\n      \"view_hostgroups\",\n      \"create_hostgroups\",\n      \"edit_hostgroups\",\n      \"destroy_hostgroups\",\n      \"view_hosts\",\n      \"create_hosts\",\n      \"edit_hosts\",\n      \"destroy_hosts\",\n      \"view_media\",\n      \"create_media\",\n      \"edit_media\",\n      \"destroy_media\",\n      \"view_models\",\n      \"create_models\",\n      \"edit_models\",\n      \"destroy_models\",\n      \"view_operatingsystems\",\n      \"create_operatingsystems\",\n      \"edit_operatingsystems\",\n      \"destroy_operatingsystems\",\n      \"view_ptables\",\n      \"create_ptables\",\n      \"edit_ptables\",\n      \"destroy_ptables\",\n      \"view_puppetclasses\",\n      \"create_puppetclasses\",\n      \"edit_puppetclasses\",\n      \"destroy_puppetclasses\",\n      \"import_puppetclasses\",\n      \"view_usergroups\",\n      \"create_usergroups\",\n      \"edit_usergroups\",\n      \"destroy_usergroups\",\n      \"view_users\",\n      \"create_users\",\n      \"edit_users\",\n      \"destroy_users\",\n      \"access_settings\",\n      \"access_dashboard\",\n      \"view_reports\",\n      \"destroy_reports\",\n      \"view_facts\",\n      \"view_audit_logs\",\n      \"view_statistics\",\n      \"view_locations\",\n      \"edit_locations\",\n      \"create_locations\",\n      \"destroy_locations\",\n      \"view_organizations\",\n      \"edit_organizations\",\n      \"create_organizations\",\n      \"destroy_organizations\"\n    ]\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"id","full_name":"id","validator":"Must be String","description":"","expected_type":"string","required":true},{"allow_nil":false,"name":"role","full_name":"role","params":[{"name":"name","allow_nil":false,"full_name":"role[name]","validator":"Must be String","expected_type":"string","description":"","required":false}],"validator":"Must be a Hash","description":"","expected_type":"hash","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/roles/:id","short_description":"Update an role.","http_method":"PUT"}],"full_description":"","doc_url":"/apidoc/v2/roles/update"},{"see":null,"name":"destroy","examples":["DELETE /api/roles/1\n200\n{\n  \"role\": {\n    \"name\": \"Manager\",\n    \"builtin\": 0,\n    \"id\": 1,\n    \"permissions\": [\n      \"view_architectures\",\n      \"create_architectures\",\n      \"edit_architectures\",\n      \"destroy_architectures\",\n      \"view_authenticators\",\n      \"create_authenticators\",\n      \"edit_authenticators\",\n      \"destroy_authenticators\",\n      \"view_environments\",\n      \"create_environments\",\n      \"edit_environments\",\n      \"destroy_environments\",\n      \"import_environments\",\n      \"view_external_variables\",\n      \"create_external_variables\",\n      \"edit_external_variables\",\n      \"destroy_external_variables\",\n      \"view_domains\",\n      \"create_domain\",\n      \"edit_domains\",\n      \"destroy_domains\",\n      \"view_globals\",\n      \"create_globals\",\n      \"edit_globals\",\n      \"destroy_globals\",\n      \"view_hostgroups\",\n      \"create_hostgroups\",\n      \"edit_hostgroups\",\n      \"destroy_hostgroups\",\n      \"view_hosts\",\n      \"create_hosts\",\n      \"edit_hosts\",\n      \"destroy_hosts\",\n      \"view_media\",\n      \"create_media\",\n      \"edit_media\",\n      \"destroy_media\",\n      \"view_models\",\n      \"create_models\",\n      \"edit_models\",\n      \"destroy_models\",\n      \"view_operatingsystems\",\n      \"create_operatingsystems\",\n      \"edit_operatingsystems\",\n      \"destroy_operatingsystems\",\n      \"view_ptables\",\n      \"create_ptables\",\n      \"edit_ptables\",\n      \"destroy_ptables\",\n      \"view_puppetclasses\",\n      \"create_puppetclasses\",\n      \"edit_puppetclasses\",\n      \"destroy_puppetclasses\",\n      \"import_puppetclasses\",\n      \"view_usergroups\",\n      \"create_usergroups\",\n      \"edit_usergroups\",\n      \"destroy_usergroups\",\n      \"view_users\",\n      \"create_users\",\n      \"edit_users\",\n      \"destroy_users\",\n      \"access_settings\",\n      \"access_dashboard\",\n      \"view_reports\",\n      \"destroy_reports\",\n      \"view_facts\",\n      \"view_audit_logs\",\n      \"view_statistics\",\n      \"view_locations\",\n      \"edit_locations\",\n      \"create_locations\",\n      \"destroy_locations\",\n      \"view_organizations\",\n      \"edit_organizations\",\n      \"create_organizations\",\n      \"destroy_organizations\"\n    ]\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"id","full_name":"id","validator":"Must be String","description":"","expected_type":"string","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/roles/:id","short_description":"Delete an role.","http_method":"DELETE"}],"full_description":"","doc_url":"/apidoc/v2/roles/destroy"}]},"common_parameters":{"name":"Common parameters","formats":null,"api_url":"/api","version":"v2","short_description":null,"full_description":null,"doc_url":"/apidoc/v2/common_parameters","methods":[{"see":null,"name":"index","examples":["GET /api/common_parameters\n200\n[\n  {\n    \"common_parameter\": {\n      \"name\": \"test\",\n      \"id\": 636252244,\n      \"value\": \"myvalue\"\n    }\n  }\n]"],"errors":[],"params":[{"allow_nil":false,"name":"search","full_name":"search","validator":"Must be String","description":"<p>filter results</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"order","full_name":"order","validator":"Must be String","description":"<p>sort results</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"page","full_name":"page","validator":"Must be String","description":"<p>paginate results</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"per_page","full_name":"per_page","validator":"Must be String","description":"<p>number of entries per request</p>","expected_type":"string","required":false}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/common_parameters","short_description":"List all common parameters.","http_method":"GET"}],"full_description":"","doc_url":"/apidoc/v2/common_parameters/index"},{"see":null,"name":"show","examples":["GET /api/common_parameters/636252244\n200\n{\n  \"common_parameter\": {\n    \"name\": \"test\",\n    \"id\": 636252244,\n    \"value\": \"myvalue\"\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"id","full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","description":"","expected_type":"string","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/common_parameters/:id","short_description":"Show a common parameter.","http_method":"GET"}],"full_description":"","doc_url":"/apidoc/v2/common_parameters/show"},{"see":null,"name":"create","examples":["POST /api/common_parameters\n{\n  \"common_parameter\": {\n    \"name\": \"special_key\",\n    \"value\": \"123\"\n  }\n}\n200\n{\n  \"common_parameter\": {\n    \"name\": \"special_key\",\n    \"id\": 767575239,\n    \"value\": \"123\"\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"common_parameter","full_name":"common_parameter","params":[{"name":"name","allow_nil":false,"full_name":"common_parameter[name]","validator":"Must be String","expected_type":"string","description":"","required":true},{"name":"value","allow_nil":false,"full_name":"common_parameter[value]","validator":"Must be String","expected_type":"string","description":"","required":true}],"validator":"Must be a Hash","description":"","expected_type":"hash","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/common_parameters","short_description":"Create a common_parameter","http_method":"POST"}],"full_description":"","doc_url":"/apidoc/v2/common_parameters/create"},{"see":null,"name":"update","examples":["PUT /api/common_parameters/636252244\n{\n  \"common_parameter\": {}\n}\n200\n{\n  \"common_parameter\": {\n    \"name\": \"test\",\n    \"id\": 636252244,\n    \"value\": \"myvalue\"\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"id","full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","description":"","expected_type":"string","required":true},{"allow_nil":false,"name":"common_parameter","full_name":"common_parameter","params":[{"name":"name","allow_nil":false,"full_name":"common_parameter[name]","validator":"Must be String","expected_type":"string","description":"","required":false},{"name":"value","allow_nil":false,"full_name":"common_parameter[value]","validator":"Must be String","expected_type":"string","description":"","required":false}],"validator":"Must be a Hash","description":"","expected_type":"hash","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/common_parameters/:id","short_description":"Update a common_parameter","http_method":"PUT"}],"full_description":"","doc_url":"/apidoc/v2/common_parameters/update"},{"see":null,"name":"destroy","examples":["DELETE /api/common_parameters/636252244\n200\n{\n  \"common_parameter\": {\n    \"name\": \"test\",\n    \"id\": 636252244,\n    \"value\": \"myvalue\"\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"id","full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","description":"","expected_type":"string","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/common_parameters/:id","short_description":"Delete a common_parameter","http_method":"DELETE"}],"full_description":"","doc_url":"/apidoc/v2/common_parameters/destroy"}]},"media":{"name":"Media","formats":null,"api_url":"/api","version":"v2","short_description":null,"full_description":null,"doc_url":"/apidoc/v2/media","methods":[{"see":null,"name":"index","examples":["GET /api/media\n200\n[\n  {\n    \"medium\": {\n      \"name\": \"CentOS 5.4\",\n      \"id\": 980190962,\n      \"path\": \"http://mirror.averse.net/centos/6.0/os/$arch\"\n    }\n  },\n  {\n    \"medium\": {\n      \"name\": \"OpenSuse Mirror\",\n      \"id\": 859751735,\n      \"path\": \"http://mirror.isoc.org.il/pub/opensuse/distribution/$major.$minor/repo/oss\"\n    }\n  },\n  {\n    \"medium\": {\n      \"name\": \"Solaris 10\",\n      \"id\": 442321401,\n      \"path\": \"http://brsla01/vol/solgi_5.10/sol$minor_$release_$arch\"\n    }\n  },\n  {\n    \"medium\": {\n      \"name\": \"Ubuntu Mirror\",\n      \"id\": 1011586618,\n      \"path\": \"http://sg.archive.ubuntu.com\"\n    }\n  },\n  {\n    \"medium\": {\n      \"name\": \"unused\",\n      \"id\": 338446587,\n      \"path\": \"http://nothing.intersting.com\"\n    }\n  }\n]"],"errors":[],"params":[{"allow_nil":false,"name":"search","full_name":"search","validator":"Must be String","description":"<p>filter results</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"order","full_name":"order","validator":"Must be String","description":"<p>for example, name ASC, or name DESC</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"page","full_name":"page","validator":"Must be String","description":"<p>paginate results</p>","expected_type":"string","required":false},{"allow_nil":false,"name":"per_page","full_name":"per_page","validator":"Must be String","description":"<p>number of entries per request</p>","expected_type":"string","required":false}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/media","short_description":"List all media.","http_method":"GET"}],"full_description":"","doc_url":"/apidoc/v2/media/index"},{"see":null,"name":"show","examples":["GET /api/media/980190962\n200\n{\n  \"medium\": {\n    \"name\": \"CentOS 5.4\",\n    \"id\": 980190962,\n    \"path\": \"http://mirror.averse.net/centos/6.0/os/$arch\"\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"id","full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","description":"","expected_type":"string","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/media/:id","short_description":"Show a medium.","http_method":"GET"}],"full_description":"","doc_url":"/apidoc/v2/media/show"},{"see":null,"name":"create","examples":["POST /api/media\n{\n  \"medium\": {\n    \"name\": \"new medium\",\n    \"path\": \"http://www.newmedium.com/\"\n  }\n}\n201\n{\n  \"medium\": {\n    \"name\": \"new medium\",\n    \"id\": 1011586619\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"medium","full_name":"medium","params":[{"name":"name","allow_nil":false,"full_name":"medium[name]","validator":"Must be String","expected_type":"string","description":"<p>Name of media</p>","required":true},{"name":"path","allow_nil":false,"full_name":"medium[path]","validator":"Must be String","expected_type":"string","description":"<p>The path to the medium, can be a URL or a valid NFS server (exclusive of the architecture).</p>\n\n<p>for example http://mirror.averse.net/centos/$version/os/$arch where $arch will be substituted for the host&#8217;s actual OS architecture and $version, $major and $minor will be substituted for the version of the operating system.</p>\n\n<p>Solaris and Debian media may also use $release.</p>","required":true},{"name":"os_family","allow_nil":false,"full_name":"medium[os_family]","validator":"Must be String","expected_type":"string","description":"<p>The family that the operating system belongs to.</p>\n\n<p>Available families:</p>\n\n<ul>\n<li>Archlinux</li>\n\n<li>Debian</li>\n\n<li>Redhat</li>\n\n<li>Solaris</li>\n\n<li>Suse</li>\n\n<li>Windows</li>\n</ul>","required":false}],"validator":"Must be a Hash","description":"","expected_type":"hash","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/media","short_description":"Create a medium.","http_method":"POST"}],"full_description":"","doc_url":"/apidoc/v2/media/create"},{"see":null,"name":"update","examples":["PUT /api/media/980190962\n{\n  \"name\": \"CentOS 5.4\"\n}\n200\n{\n  \"medium\": {\n    \"name\": \"CentOS 5.4\",\n    \"id\": 980190962\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"id","full_name":"id","validator":"Must be String","description":"","expected_type":"string","required":true},{"allow_nil":false,"name":"medium","full_name":"medium","params":[{"name":"name","allow_nil":false,"full_name":"medium[name]","validator":"Must be String","expected_type":"string","description":"<p>Name of media</p>","required":false},{"name":"path","allow_nil":false,"full_name":"medium[path]","validator":"Must be String","expected_type":"string","description":"<p>The path to the medium, can be a URL or a valid NFS server (exclusive of the architecture).</p>\n\n<p>for example http://mirror.averse.net/centos/$version/os/$arch where $arch will be substituted for the host&#8217;s actual OS architecture and $version, $major and $minor will be substituted for the version of the operating system.</p>\n\n<p>Solaris and Debian media may also use $release.</p>","required":false},{"name":"os_family","allow_nil":true,"full_name":"medium[os_family]","validator":"Must be String","expected_type":"string","description":"<p>The family that the operating system belongs to.</p>\n\n<p>Available families:</p>\n\n<ul>\n<li>Archlinux</li>\n\n<li>Debian</li>\n\n<li>Redhat</li>\n\n<li>Solaris</li>\n\n<li>Suse</li>\n\n<li>Windows</li>\n</ul>","required":false}],"validator":"Must be a Hash","description":"","expected_type":"hash","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/media/:id","short_description":"Update a medium.","http_method":"PUT"}],"full_description":"","doc_url":"/apidoc/v2/media/update"},{"see":null,"name":"destroy","examples":["DELETE /api/media/338446587\n200\n{\n  \"medium\": {\n    \"name\": \"unused\",\n    \"id\": 338446587\n  }\n}"],"errors":[],"params":[{"allow_nil":false,"name":"id","full_name":"id","validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","description":"","expected_type":"string","required":true}],"formats":null,"see_url":null,"apis":[{"api_url":"/api/media/:id","short_description":"Delete a medium.","http_method":"DELETE"}],"full_description":"","doc_url":"/apidoc/v2/media/destroy"}]}},"info":"Another API description","doc_url":"/apidoc/v2","copyright":""}}

data/lib/foreman_api/resources/architecture.rb

@@ -4,7 +4,7 @@ module ForemanApi
       def self.doc
         @doc ||= ForemanApi.doc['resources']["architectures"]
       end
-      
+
       # @param [Hash] params a hash of params to be passed to the service
       # @option params [String] order Sort results
       # @option params [String] page Paginate results
@@ -12,57 +12,52 @@ module ForemanApi
       # @option params [String] search Filter results
       #
       # @param [Hash] headers additional http headers
-      def index(params = { }, headers = { })
-        check_params params, :allowed => true, :method => __method__
-        url, params = fill_params_in_url "/api/architectures", params
-        call(:"get", url, params, headers)
+      # @return [Array] First item: parsed data; second item: raw body
+      def index(params = {}, headers = {})
+        perform_call(__method__, params, headers)
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # @option params [String] id 
+      # @option params [String] id
       #
       # @param [Hash] headers additional http headers
-      def show(params = { }, headers = { })
-        check_params params, :allowed => true, :method => __method__
-        url, params = fill_params_in_url "/api/architectures/:id", params
-        call(:"get", url, params, headers)
+      # @return [Array] First item: parsed data; second item: raw body
+      def show(params = {}, headers = {})
+        perform_call(__method__, params, headers)
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # @option params [Hash] architecture 
-      #   allowed keys are: 
-      #   * name [String],
-      #   * operatingsystem_ids [String] Operatingsystem id’s,
+      # @option params [Hash] architecture
+      #   allowed keys are:
+      #   * operatingsystem_ids [String] Operatingsystem id’s
+      #   * name [String]
       #
       # @param [Hash] headers additional http headers
-      def create(params = { }, headers = { })
-        check_params params, :allowed => true, :method => __method__
-        url, params = fill_params_in_url "/api/architectures", params
-        call(:"post", url, params, headers)
+      # @return [Array] First item: parsed data; second item: raw body
+      def create(params = {}, headers = {})
+        perform_call(__method__, params, headers)
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # @option params [String] id 
-      # @option params [Hash] architecture 
-      #   allowed keys are: 
-      #   * name [String],
-      #   * operatingsystem_ids [String] Operatingsystem id’s,
+      # @option params [String] id
+      # @option params [Hash] architecture
+      #   allowed keys are:
+      #   * operatingsystem_ids [String] Operatingsystem id’s
+      #   * name [String]
       #
       # @param [Hash] headers additional http headers
-      def update(params = { }, headers = { })
-        check_params params, :allowed => true, :method => __method__
-        url, params = fill_params_in_url "/api/architectures/:id", params
-        call(:"put", url, params, headers)
+      # @return [Array] First item: parsed data; second item: raw body
+      def update(params = {}, headers = {})
+        perform_call(__method__, params, headers)
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # @option params [String] id 
+      # @option params [String] id
       #
       # @param [Hash] headers additional http headers
-      def destroy(params = { }, headers = { })
-        check_params params, :allowed => true, :method => __method__
-        url, params = fill_params_in_url "/api/architectures/:id", params
-        call(:"delete", url, params, headers)
+      # @return [Array] First item: parsed data; second item: raw body
+      def destroy(params = {}, headers = {})
+        perform_call(__method__, params, headers)
       end
 
     end

data/lib/foreman_api/resources/audit.rb

@@ -4,28 +4,27 @@ module ForemanApi
       def self.doc
         @doc ||= ForemanApi.doc['resources']["audits"]
       end
-      
+
       # @param [Hash] params a hash of params to be passed to the service
+      # @option params [Object] host_id Part of +/api/hosts/:host_id/audits+ path
       # @option params [String] order Sort results
       # @option params [String] page Paginate results
       # @option params [String] per_page Number of entries per request
       # @option params [String] search Filter results
       #
       # @param [Hash] headers additional http headers
-      def index(params = { }, headers = { })
-        check_params params, :allowed => true, :method => __method__
-        url, params = fill_params_in_url "/api/audits", params
-        call(:"get", url, params, headers)
+      # @return [Array] First item: parsed data; second item: raw body
+      def index(params = {}, headers = {})
+        perform_call(__method__, params, headers)
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # @option params [String] id 
+      # @option params [String] id
       #
       # @param [Hash] headers additional http headers
-      def show(params = { }, headers = { })
-        check_params params, :allowed => true, :method => __method__
-        url, params = fill_params_in_url "/api/audits/:id", params
-        call(:"get", url, params, headers)
+      # @return [Array] First item: parsed data; second item: raw body
+      def show(params = {}, headers = {})
+        perform_call(__method__, params, headers)
       end
 
     end

data/lib/foreman_api/resources/auth_source_ldap.rb

@@ -4,83 +4,78 @@ module ForemanApi
       def self.doc
         @doc ||= ForemanApi.doc['resources']["auth_source_ldaps"]
       end
-      
+
       # @param [Hash] params a hash of params to be passed to the service
       # @option params [String] page Paginate results
       # @option params [String] per_page Number of entries per request
       #
       # @param [Hash] headers additional http headers
-      def index(params = { }, headers = { })
-        check_params params, :allowed => true, :method => __method__
-        url, params = fill_params_in_url "/api/auth_source_ldaps", params
-        call(:"get", url, params, headers)
+      # @return [Array] First item: parsed data; second item: raw body
+      def index(params = {}, headers = {})
+        perform_call(__method__, params, headers)
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # @option params [String] id 
+      # @option params [String] id
       #
       # @param [Hash] headers additional http headers
-      def show(params = { }, headers = { })
-        check_params params, :allowed => true, :method => __method__
-        url, params = fill_params_in_url "/api/auth_source_ldaps/:id", params
-        call(:"get", url, params, headers)
+      # @return [Array] First item: parsed data; second item: raw body
+      def show(params = {}, headers = {})
+        perform_call(__method__, params, headers)
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # @option params [Hash] auth_source_ldap 
-      #   allowed keys are: 
-      #   * account [String],
-      #   * account_password [String] Required if onthefly_register is true,
-      #   * attr_firstname [String] Required if onthefly_register is true,
-      #   * attr_lastname [String] Required if onthefly_register is true,
-      #   * attr_login [String] Required if onthefly_register is true,
-      #   * attr_mail [String] Required if onthefly_register is true,
-      #   * base_dn [String],
-      #   * host [String],
-      #   * name [String],
-      #   * onthefly_register [String],
-      #   * port [String] Defaults to 389,
-      #   * tls [String],
+      # @option params [Hash] auth_source_ldap
+      #   allowed keys are:
+      #   * account [String]
+      #   * account_password [String] Required if onthefly_register is true
+      #   * attr_firstname [String] Required if onthefly_register is true
+      #   * attr_lastname [String] Required if onthefly_register is true
+      #   * attr_login [String] Required if onthefly_register is true
+      #   * attr_mail [String] Required if onthefly_register is true
+      #   * base_dn [String]
+      #   * host [String]
+      #   * name [String]
+      #   * onthefly_register [String]
+      #   * port [String] Defaults to 389
+      #   * tls [String]
       #
       # @param [Hash] headers additional http headers
-      def create(params = { }, headers = { })
-        check_params params, :allowed => true, :method => __method__
-        url, params = fill_params_in_url "/api/auth_source_ldaps", params
-        call(:"post", url, params, headers)
+      # @return [Array] First item: parsed data; second item: raw body
+      def create(params = {}, headers = {})
+        perform_call(__method__, params, headers)
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # @option params [String] id 
-      # @option params [Hash] auth_source_ldap 
-      #   allowed keys are: 
-      #   * account [String],
-      #   * account_password [String] Required if onthefly_register is true,
-      #   * attr_firstname [String] Required if onthefly_register is true,
-      #   * attr_lastname [String] Required if onthefly_register is true,
-      #   * attr_login [String] Required if onthefly_register is true,
-      #   * attr_mail [String] Required if onthefly_register is true,
-      #   * base_dn [String],
-      #   * host [String],
-      #   * name [String],
-      #   * onthefly_register [String],
-      #   * port [String] Defaults to 389,
-      #   * tls [String],
+      # @option params [String] id
+      # @option params [Hash] auth_source_ldap
+      #   allowed keys are:
+      #   * account [String]
+      #   * account_password [String] Required if onthefly_register is true
+      #   * attr_firstname [String] Required if onthefly_register is true
+      #   * attr_lastname [String] Required if onthefly_register is true
+      #   * attr_login [String] Required if onthefly_register is true
+      #   * attr_mail [String] Required if onthefly_register is true
+      #   * base_dn [String]
+      #   * host [String]
+      #   * name [String]
+      #   * onthefly_register [String]
+      #   * port [String] Defaults to 389
+      #   * tls [String]
       #
       # @param [Hash] headers additional http headers
-      def update(params = { }, headers = { })
-        check_params params, :allowed => true, :method => __method__
-        url, params = fill_params_in_url "/api/auth_source_ldaps/:id", params
-        call(:"put", url, params, headers)
+      # @return [Array] First item: parsed data; second item: raw body
+      def update(params = {}, headers = {})
+        perform_call(__method__, params, headers)
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # @option params [String] id 
+      # @option params [String] id
       #
       # @param [Hash] headers additional http headers
-      def destroy(params = { }, headers = { })
-        check_params params, :allowed => true, :method => __method__
-        url, params = fill_params_in_url "/api/auth_source_ldaps/:id", params
-        call(:"delete", url, params, headers)
+      # @return [Array] First item: parsed data; second item: raw body
+      def destroy(params = {}, headers = {})
+        perform_call(__method__, params, headers)
       end
 
     end