hammer_cli_katello 0.0.23 → 0.0.24

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 69e84ee2a98406cccb9fc75f4db2184a61200114
-  data.tar.gz: 36c004e396879c8baaeb1dc4421af7fea9239b29
+  metadata.gz: 7b5a3be27eb8f7e7652ea66673432162879a55d9
+  data.tar.gz: a6205c061e84fca880057d9369650271300dad5b
 SHA512:
-  metadata.gz: 3bbfe87eb52de1ed64ec35079b335b3eb9a1e16e571943ff50df5cbde0a926dc3e11dcd23ad0d0d2809d791f55b94fc4ec6e80de65f0db145cc63e65909c6f52
-  data.tar.gz: 57c908541776b112a89faf91601f4cfb727f8fb9cdd808f55c4ed47c77c067de4bed7bbf33bfb1869a2bd1cef9f0b020ebb8d6494c1cc5684902d38e4d064177
+  metadata.gz: ca9eb16c655bff58be0162b0933bf50fe2ed3361bc79c429aa2001550564dee28bff7e8344f31fd1196b2843b9d4eb8f1124bd22f76a92f69332eefb561a00a6
+  data.tar.gz: bb7008968db6aec201bf65774fd4882664ced950ce8a36941e6622e1b89264c0bb1dcbe11142ce31f179e8c97c6bf7afc2ba18df43dc08087eda4b2bdedc5da6

data/lib/hammer_cli_katello.rb

@@ -22,6 +22,7 @@ module HammerCLIKatello
   require 'hammer_cli_katello/i18n'
   require "hammer_cli_katello/version"
   require 'hammer_cli_katello/id_resolver'
+  require 'hammer_cli_katello/capsule'
 
   # commands
   HammerCLI::MainCommand.lazy_subcommand("activation-key", _("Manipulate activation keys."),
@@ -97,9 +98,10 @@ module HammerCLIKatello
                                          'hammer_cli_katello/content_view'
   )
 
+  # Capsule is just an alias to smart proxy
   HammerCLI::MainCommand.lazy_subcommand("capsule", _("Manipulate capsule"),
-                                         'HammerCLIKatello::Capsule',
-                                         'hammer_cli_katello/capsule'
+                                         'HammerCLIForeman::SmartProxy',
+                                         'hammer_cli_foreman/smart_proxy'
   )
 
   HammerCLI::MainCommand.lazy_subcommand("package", _("Manipulate packages."),
@@ -117,6 +119,11 @@ module HammerCLIKatello
                                          'hammer_cli_katello/erratum'
   )
 
+  HammerCLI::MainCommand.lazy_subcommand("ostree-branch", _("Manipulate ostree branches"),
+                                         'HammerCLIKatello::OstreeBranchCommand',
+                                         'hammer_cli_katello/ostree_branch'
+  )
+
   # subcommands to hammer_cli_foreman commands
   require 'hammer_cli_katello/host'
 

data/lib/hammer_cli_katello/activation_key.rb

@@ -10,7 +10,7 @@ module HammerCLIKatello
       output do
         field :id, _("ID")
         field :name, _("Name")
-        field :format_consumed, _("Consumed")
+        field :format_consumed, _("Host Limit")
         from :environment do
           field :name, _("Lifecycle Environment")
         end
@@ -23,7 +23,7 @@ module HammerCLIKatello
         data["format_consumed"] = _("%{consumed} of %{limit}") %
           {
             :consumed => data["usage_count"],
-            :limit => data["unlimited_content_hosts"] ? _("Unlimited") : data["max_content_hosts"]
+            :limit => data["unlimited_hosts"] ? _("Unlimited") : data["max_hosts"]
           }
         data
       end
@@ -48,7 +48,7 @@ module HammerCLIKatello
         field :name, _("Name")
         field :id, _("ID")
         field :description, _("Description")
-        field :format_limit, _("Content Host Limit")
+        field :format_limit, _("Host Limit")
         field :auto_attach, _("Auto Attach")
         from :environment do
           field :name, _("Lifecycle Environment")
@@ -65,7 +65,7 @@ module HammerCLIKatello
 
       def extend_data(data)
         data["format_limit"] =
-          data["unlimited_content_hosts"] ? _("Unlimited") : data["max_content_hosts"]
+          data["unlimited_hosts"] ? _("Unlimited") : data["max_hosts"]
         data
       end
 
@@ -78,10 +78,10 @@ module HammerCLIKatello
       success_message _("Activation key created")
       failure_message _("Could not create the activation key")
 
-      option "--unlimited-content-hosts", :flag, "Set content hosts max to unlimited"
+      option "--unlimited-hosts", :flag, "Set hosts max to unlimited"
 
       validate_options do
-        all(:option_unlimited_content_hosts, :option_max_content_hosts).rejected
+        all(:option_unlimited_hosts, :option_max_hosts).rejected
       end
 
       build_options
@@ -107,7 +107,7 @@ module HammerCLIKatello
       failure_message _("Could not update the activation key")
 
       validate_options do
-        all(:option_unlimited_content_hosts, :option_max_content_hosts).rejected
+        all(:option_unlimited_hosts, :option_max_hosts).rejected
       end
 
       build_options

data/lib/hammer_cli_katello/associating_commands.rb

@@ -28,6 +28,11 @@ module HammerCLIKatello
         command_name 'add-repository'
         associated_resource :repositories
 
+        def validate_options
+          super
+          validator.any(:option_repository_id, :option_repository_name).required
+        end
+
         success_message _("The repository has been associated")
         failure_message _("Could not add repository")
       end
@@ -38,6 +43,11 @@ module HammerCLIKatello
         command_name 'remove-repository'
         associated_resource :repositories
 
+        def validate_options
+          super
+          validator.any(:option_repository_id, :option_repository_name).required
+        end
+
         success_message _("The repository has been removed")
         failure_message _("Could not remove repository")
       end

data/lib/hammer_cli_katello/capsule.rb

@@ -1,7 +1,7 @@
-module HammerCLIKatello
-  class Capsule < HammerCLIForeman::Command
-    resource :capsules
+require 'hammer_cli_foreman/smart_proxy'
 
+module HammerCLIKatello
+  module Capsule
     module LifecycleEnvironmentNameResolvable
       def lifecycle_environment_resolve_options(options)
         {
@@ -22,40 +22,12 @@ module HammerCLIKatello
       end
     end
 
-    class ListCommand < HammerCLIKatello::ListCommand
-      action :index
-
-      output do
-        field :id, _("Id")
-        field :name, _("Name")
-        field :url, _("URL")
-      end
-
-      build_options
-    end
-
-    class InfoCommand < HammerCLIKatello::InfoCommand
-
-      action :show
-
-      output ListCommand.output_definition do
-        field :_features, _("Features"),   Fields::List
-        field :created_at, _("Created at"), Fields::Date
-        field :updated_at, _("Updated at"), Fields::Date
-      end
-
-      def extend_data(proxy)
-        proxy['_features'] = proxy['features'].map { |f| f['name'] }
-        proxy
-      end
-
-      build_options
-    end
-
-    class Content < HammerCLI::AbstractCommand
+    class Content < HammerCLIKatello::Command
       command_name 'content'
       desc _('Manage the capsule content')
 
+      resource :capsules
+
       class ListLifecycleEnvironmentsCommand < HammerCLIKatello::ListCommand
         resource :capsule_content, :lifecycle_environments
         command_name 'lifecycle-environments'
@@ -133,10 +105,108 @@ module HammerCLIKatello
         build_options
       end
 
+      class SyncStatusCommand < HammerCLIKatello::InfoCommand
+        resource :capsule_content, :sync_status
+        command_name "synchronization-status"
+
+        output do
+          field :last_sync_time, _('Last sync'), Fields::Date
+          field :_status, _('Status')
+          collection :active_sync_tasks, _('Currently running sync tasks') do
+            field :id, _('Task id')
+            field :_progress, _('Progress')
+          end
+          label _('Last failure') do
+            from :_last_failure do
+              field :id, _('Task id')
+              from :humanized do
+                field :errors, _('Messages'), Fields::List, :on_new_line => true, :separator => "\n"
+              end
+            end
+          end
+        end
+
+        private
+
+        def extend_data(data)
+          data["_status"] = sync_status(data)
+          data['_last_failure'] = data["last_failed_sync_tasks"][-1]
+
+          data["active_sync_tasks"].each do |task|
+            task['_progress'] =  format_progress(task['progress'])
+          end
+          data
+        end
+
+        def sync_status(data)
+          syncable_envs = data["lifecycle_environments"].select { |env| env['syncable'] }
+          if syncable_envs.empty?
+            _("Capsule is synchronized")
+          else
+            env_names = syncable_envs.map { |env| env['name'] }.join(", ")
+            _("%{count} environment(s) can be synchronized: %{names}") % {
+              :count => syncable_envs.size,
+              :names => env_names
+            }
+          end
+        end
+
+        def format_progress(progress)
+          "#{(progress * 100).floor}%"
+        end
+
+        build_options
+      end
+
+      class InfoCommand < HammerCLIKatello::InfoCommand
+        resource :capsule_content, :sync_status
+        command_name "info"
+
+        output do
+          collection :lifecycle_environments, _("Lifecycle Environments") do
+            field :name, _('Name')
+            field :organization, _("Organization"), Fields::Reference
+            collection :content_views, _("Content Views") do
+              field nil, _("Name"), Fields::Reference
+              field :composite, _('Composite'), Fields::Boolean
+              field :last_published, _('Last Published'), Fields::Date
+              label _('Content') do
+                from :counts do
+                  field :content_hosts, _('Hosts')
+                  field :products, _('Products')
+                  field :yum_repositories, _('Yum repos')
+                  field :docker_repositories, _('Docker repos')
+                  field :packages, _('Packages')
+                  field :package_groups, _('Package groups')
+                  field :errata, _('Errata')
+                  field :puppet_modules, _('Puppet modules')
+                end
+              end
+            end
+          end
+        end
+
+        build_options
+      end
+
+      class CancelSyncCommand < HammerCLIKatello::Command
+        resource :capsule_content, :cancel_sync
+        command_name "cancel-synchronization"
+
+        def print_data(message)
+          print_message message
+        end
+
+        build_options
+      end
+
       autoload_subcommands
     end
 
-    autoload_subcommands
+    HammerCLIForeman::SmartProxy.subcommand(
+      HammerCLIKatello::Capsule::Content.command_name,
+      HammerCLIKatello::Capsule::Content.desc,
+      HammerCLIKatello::Capsule::Content
+    )
   end
-
 end

data/lib/hammer_cli_katello/content_view.rb

@@ -45,6 +45,12 @@ module HammerCLIKatello
           field :label, _("Label")
         end
 
+        collection :_ostree_repositories, _("OSTree Repositories") do
+          field :id, _("ID")
+          field :name, _("Name")
+          field :label, _("Label")
+        end
+
         collection :puppet_modules, _("Puppet Modules") do
           field :id, _("ID")
           field :uuid, _("UUID"), Fields::Field, :hide_blank => true
@@ -76,13 +82,12 @@ module HammerCLIKatello
       end
 
       def extend_data(data)
-        data["_yum_repositories"] = data["repositories"].select do |repo|
-          repo["content_type"] == "yum"
+        %w(yum docker ostree).each do |content_type|
+          data["_#{content_type}_repositories"] = data["repositories"].select do |repo|
+            repo["content_type"] == content_type
+          end
         end
 
-        data["_docker_repositories"] = data["repositories"].select do |repo|
-          repo["content_type"] == "docker"
-        end
         data
       end
 

data/lib/hammer_cli_katello/content_view_puppet_module.rb

@@ -29,14 +29,9 @@ module HammerCLIKatello
     class CreateCommand < HammerCLIKatello::CreateCommand
       command_name "add"
 
-      option "--id", "ID", _("(deprecated) id of the puppet module to associate"),
-        :attribute_name => "option_uuid",
-        :deprecated => _("This option will be removed in Katello 2.5, Use --uuid")
-
       success_message _("Puppet module added to content view")
       failure_message _("Could not add the puppet module")
 
-      #build_options :without => :uuid
       build_options
     end
 

data/lib/hammer_cli_katello/host_collection.rb

@@ -41,7 +41,6 @@ module HammerCLIKatello
     end
 
     class CreateCommand < HammerCLIKatello::CreateCommand
-      include UuidRequestable
       resource :host_collections, :create
       def request_params
         super.tap do |params|
@@ -53,7 +52,10 @@ module HammerCLIKatello
 
       success_message _("Host collection created")
       failure_message _("Could not create the host collection")
-      build_options :without => [:host_ids]
+      build_options do |o|
+        o.expand.except(:hosts)
+        o.without(:host_ids)
+      end
     end
 
     class InfoCommand < HammerCLIKatello::InfoCommand

data/lib/hammer_cli_katello/ostree_branch.rb

@@ -0,0 +1,32 @@
+module HammerCLIKatello
+
+  class OstreeBranchCommand < HammerCLIKatello::Command
+    resource :ostree_branches
+
+    class ListCommand < HammerCLIKatello::ListCommand
+      output do
+        field :id, _("ID")
+        field :name, _("Name")
+        field :version, _("version")
+      end
+
+      build_options do |o|
+        o.expand.including(:products, :organizations, :content_views)
+      end
+    end
+
+    class InfoCommand < HammerCLIKatello::InfoCommand
+      output do
+        field :id, _("ID")
+        field :name, _("Name")
+        field :version, _("Version")
+        field :commit, _("Commit")
+        field :version_date, _("Date")
+      end
+
+      build_options
+    end
+
+    autoload_subcommands
+  end
+end

data/lib/hammer_cli_katello/puppet_module.rb

@@ -9,6 +9,7 @@ module HammerCLIKatello
         field :name, _("Name")
         field :author, _("Author")
         field :version, _("Version")
+        field :uuid, _("Uuid")
       end
 
       build_options do |o|
@@ -22,6 +23,7 @@ module HammerCLIKatello
         field :name, _("Name")
         field :version, _("Version")
         field :author, _("Author")
+        field :uuid, _("Uuid")
 
         field :summary, _("Summary")
         field :description, _("Description")

data/lib/hammer_cli_katello/repository.rb

@@ -69,6 +69,7 @@ module HammerCLIKatello
           field :puppet_total, _("Puppet Modules"), Fields::Field, :hide_blank => true
           field :docker_manifest_total, _("Docker Manifests"), Fields::Field, :hide_blank => true
           field :docker_tag_total, _("Docker Tags"), Fields::Field, :hide_blank => true
+          field :ostree_branch_total, _("OSTree Branches"), Fields::Field, :hide_blank => true
         end
       end
 
@@ -106,6 +107,8 @@ module HammerCLIKatello
           data["docker_tag_total"] = content_counts["docker_tag"]
         when "puppet"
           data["puppet_total"] = content_counts["puppet_module"]
+        when "ostree"
+          data["ostree_branch_total"] = content_counts["ostree_branch"]
         end
       end
 

data/lib/hammer_cli_katello/version.rb

@@ -1,5 +1,5 @@
 module HammerCLIKatello
   def self.version
-    @version ||= Gem::Version.new('0.0.23')
+    @version ||= Gem::Version.new('0.0.24')
   end
 end

data/test/data/2.5/foreman_api.json

@@ -0,0 +1 @@
+{"docs":{"name":"Foreman","info":"\n\u003cp\u003eForeman API v2 is currently the default API version.\u003c/p\u003e\n","copyright":"","doc_url":"../apidoc/v2","api_url":"/api","resources":{"hosts":{"doc_url":"../apidoc/v2/hosts","api_url":"/api","name":"Hosts","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/hosts/index","name":"index","apis":[{"api_url":"/api/hosts","http_method":"GET","short_description":"List all hosts","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/hosts","http_method":"GET","short_description":"List all hosts for a host group","deprecated":null},{"api_url":"/api/locations/:location_id/hosts","http_method":"GET","short_description":"List hosts per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/hosts","http_method":"GET","short_description":"List hosts per organization","deprecated":null},{"api_url":"/api/environments/:environment_id/hosts","http_method":"GET","short_description":"List hosts per environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of location\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of organization\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eID of environment\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003cp\u003esort results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003cp\u003epaginate results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003enumber of entries per request\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/show","name":"show","apis":[{"api_url":"/api/hosts/:id","http_method":"GET","short_description":"Show a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/create","name":"create","apis":[{"api_url":"/api/hosts","http_method":"POST","short_description":"Create a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host","full_name":"host","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"host[name]","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"location_id","full_name":"host[location_id]","description":"\n\u003cp\u003erequired if locations are enabled\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"organization_id","full_name":"host[organization_id]","description":"\n\u003cp\u003erequired if organizations are enabled\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"environment_id","full_name":"host[environment_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"ip","full_name":"host[ip]","description":"\n\u003cp\u003enot required if using a subnet with DHCP proxy\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"mac","full_name":"host[mac]","description":"\n\u003cp\u003erequired for managed host that is bare metal, not required if it’s a virtual machine\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"architecture_id","full_name":"host[architecture_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"domain_id","full_name":"host[domain_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"realm_id","full_name":"host[realm_id]","description":"","required":false,"allow_nil":true,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"puppet_proxy_id","full_name":"host[puppet_proxy_id]","description":"","required":false,"allow_nil":true,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"puppet_class_ids","full_name":"host[puppet_class_ids]","description":"","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"operatingsystem_id","full_name":"host[operatingsystem_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"medium_id","full_name":"host[medium_id]","description":"\n\u003cp\u003erequired if not imaged based provisioning and host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"ptable_id","full_name":"host[ptable_id]","description":"\n\u003cp\u003erequired if host is managed and custom partition has not been defined\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"subnet_id","full_name":"host[subnet_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"compute_resource_id","full_name":"host[compute_resource_id]","description":"\n\u003cp\u003enil means host is bare metal\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"root_pass","full_name":"host[root_pass]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group or default password in settings\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"model_id","full_name":"host[model_id]","description":"","required":false,"allow_nil":true,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"hostgroup_id","full_name":"host[hostgroup_id]","description":"","required":false,"allow_nil":true,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"owner_id","full_name":"host[owner_id]","description":"","required":false,"allow_nil":true,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"owner_type","full_name":"host[owner_type]","description":"\n\u003cp\u003eHost’s owner type\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be one of: User, Usergroup.","expected_type":"string","metadata":null,"show":true},{"name":"puppet_ca_proxy_id","full_name":"host[puppet_ca_proxy_id]","description":"","required":false,"allow_nil":true,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"image_id","full_name":"host[image_id]","description":"","required":false,"allow_nil":true,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"host_parameters_attributes","full_name":"host[host_parameters_attributes]","description":"\n\u003cp\u003eHost’s parameters (array or indexed hash)\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"name","full_name":"host[host_parameters_attributes][name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"value","full_name":"host[host_parameters_attributes][value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}]},{"name":"build","full_name":"host[build]","description":"","required":false,"allow_nil":true,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"enabled","full_name":"host[enabled]","description":"","required":false,"allow_nil":true,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"provision_method","full_name":"host[provision_method]","description":"\n\u003cp\u003eThe method used to provision the host. Possible provision_methods may be build (Network Based), image (Image Based)\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"managed","full_name":"host[managed]","description":"\n\u003cp\u003eTrue/False flag whether a host is managed or unmanaged. Note: this value also determines whether several parameters are required or not\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"progress_report_id","full_name":"host[progress_report_id]","description":"\n\u003cp\u003eUUID to track orchestration tasks status, GET /api/orchestration/:UUID/tasks\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"comment","full_name":"host[comment]","description":"\n\u003cp\u003eAdditional information about this host\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"capabilities","full_name":"host[capabilities]","description":"","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"compute_profile_id","full_name":"host[compute_profile_id]","description":"","required":false,"allow_nil":true,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"interfaces_attributes","full_name":"host[interfaces_attributes]","description":"\n\u003cp\u003eHost’s network interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"mac","full_name":"host[interfaces_attributes][mac]","description":"\n\u003cp\u003eMAC address of interface. Required for managed interfaces on bare metal.\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"ip","full_name":"host[interfaces_attributes][ip]","description":"\n\u003cp\u003eIP address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"type","full_name":"host[interfaces_attributes][type]","description":"\n\u003cp\u003eInterface type, e.g. bmc. Default is interface\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be one of: interface, bmc, bond, bridge.","expected_type":"string","metadata":null,"show":true},{"name":"name","full_name":"host[interfaces_attributes][name]","description":"\n\u003cp\u003eInterface’s DNS name\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"subnet_id","full_name":"host[interfaces_attributes][subnet_id]","description":"\n\u003cp\u003eForeman subnet ID of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Fixnum","expected_type":"numeric","metadata":null,"show":true},{"name":"domain_id","full_name":"host[interfaces_attributes][domain_id]","description":"\n\u003cp\u003eForeman domain ID of interface. Required for primary interfaces on managed hosts.\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Fixnum","expected_type":"numeric","metadata":null,"show":true},{"name":"identifier","full_name":"host[interfaces_attributes][identifier]","description":"\n\u003cp\u003eDevice identifier, e.g. eth0 or eth1.1\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"managed","full_name":"host[interfaces_attributes][managed]","description":"\n\u003cp\u003eShould this interface be managed via DHCP and DNS smart proxy and should it be configured during provisioning?\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"primary","full_name":"host[interfaces_attributes][primary]","description":"\n\u003cp\u003eShould this interface be used for constructing the FQDN of the host? Each managed hosts needs to have one primary interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"provision","full_name":"host[interfaces_attributes][provision]","description":"\n\u003cp\u003eShould this interface be used for TFTP of PXELinux (or SSH for image-based hosts)? Each managed hosts needs to have one provision interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"username","full_name":"host[interfaces_attributes][username]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"password","full_name":"host[interfaces_attributes][password]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"provider","full_name":"host[interfaces_attributes][provider]","description":"\n\u003cp\u003eInterface provider, e.g. IPMI. Only for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be one of: IPMI.","expected_type":"string","metadata":null,"show":true},{"name":"virtual","full_name":"host[interfaces_attributes][virtual]","description":"\n\u003cp\u003eAlias or VLAN device\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"tag","full_name":"host[interfaces_attributes][tag]","description":"\n\u003cp\u003eVLAN tag, this attribute has precedence over the subnet VLAN ID. Only for virtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"attached_to","full_name":"host[interfaces_attributes][attached_to]","description":"\n\u003cp\u003eIdentifier of the interface to which this interface belongs, e.g. eth1. Only for virtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"mode","full_name":"host[interfaces_attributes][mode]","description":"\n\u003cp\u003eBond mode of the interface, e.g. balance-rr. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be one of: balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb.","expected_type":"string","metadata":null,"show":true},{"name":"attached_devices","full_name":"host[interfaces_attributes][attached_devices]","description":"\n\u003cp\u003eIdentifiers of attached interfaces, e.g. \u003ccode\u003e[\u0026#39;eth1\u0026#39;, \u0026#39;eth2\u0026#39;]\u003c/code\u003e. For bond interfaces those are the slaves. Only for bond and bridges interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"bond_options","full_name":"host[interfaces_attributes][bond_options]","description":"\n\u003cp\u003eSpace separated options, e.g. miimon=100. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"compute_attributes","full_name":"host[interfaces_attributes][compute_attributes]","description":"\n\u003cp\u003eAdditional compute resource specific attributes for the interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Hash","expected_type":"hash","metadata":null,"show":true}]},{"name":"compute_attributes","full_name":"host[compute_attributes]","description":"\n\u003cp\u003eAdditional compute resource specific attributes.\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Hash","expected_type":"hash","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/update","name":"update","apis":[{"api_url":"/api/hosts/:id","http_method":"PUT","short_description":"Update a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"host","full_name":"host","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"host[name]","description":"","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"location_id","full_name":"host[location_id]","description":"\n\u003cp\u003erequired if locations are enabled\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"organization_id","full_name":"host[organization_id]","description":"\n\u003cp\u003erequired if organizations are enabled\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"environment_id","full_name":"host[environment_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"ip","full_name":"host[ip]","description":"\n\u003cp\u003enot required if using a subnet with DHCP proxy\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"mac","full_name":"host[mac]","description":"\n\u003cp\u003erequired for managed host that is bare metal, not required if it’s a virtual machine\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"architecture_id","full_name":"host[architecture_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"domain_id","full_name":"host[domain_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"realm_id","full_name":"host[realm_id]","description":"","required":false,"allow_nil":true,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"puppet_proxy_id","full_name":"host[puppet_proxy_id]","description":"","required":false,"allow_nil":true,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"puppet_class_ids","full_name":"host[puppet_class_ids]","description":"","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"operatingsystem_id","full_name":"host[operatingsystem_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"medium_id","full_name":"host[medium_id]","description":"\n\u003cp\u003erequired if not imaged based provisioning and host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"ptable_id","full_name":"host[ptable_id]","description":"\n\u003cp\u003erequired if host is managed and custom partition has not been defined\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"subnet_id","full_name":"host[subnet_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"compute_resource_id","full_name":"host[compute_resource_id]","description":"\n\u003cp\u003enil means host is bare metal\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"root_pass","full_name":"host[root_pass]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group or default password in settings\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"model_id","full_name":"host[model_id]","description":"","required":false,"allow_nil":true,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"hostgroup_id","full_name":"host[hostgroup_id]","description":"","required":false,"allow_nil":true,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"owner_id","full_name":"host[owner_id]","description":"","required":false,"allow_nil":true,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"owner_type","full_name":"host[owner_type]","description":"\n\u003cp\u003eHost’s owner type\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be one of: User, Usergroup.","expected_type":"string","metadata":null,"show":true},{"name":"puppet_ca_proxy_id","full_name":"host[puppet_ca_proxy_id]","description":"","required":false,"allow_nil":true,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"image_id","full_name":"host[image_id]","description":"","required":false,"allow_nil":true,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"host_parameters_attributes","full_name":"host[host_parameters_attributes]","description":"\n\u003cp\u003eHost’s parameters (array or indexed hash)\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"name","full_name":"host[host_parameters_attributes][name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"value","full_name":"host[host_parameters_attributes][value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}]},{"name":"build","full_name":"host[build]","description":"","required":false,"allow_nil":true,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"enabled","full_name":"host[enabled]","description":"","required":false,"allow_nil":true,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"provision_method","full_name":"host[provision_method]","description":"\n\u003cp\u003eThe method used to provision the host. Possible provision_methods may be build (Network Based), image (Image Based)\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"managed","full_name":"host[managed]","description":"\n\u003cp\u003eTrue/False flag whether a host is managed or unmanaged. Note: this value also determines whether several parameters are required or not\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"progress_report_id","full_name":"host[progress_report_id]","description":"\n\u003cp\u003eUUID to track orchestration tasks status, GET /api/orchestration/:UUID/tasks\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"comment","full_name":"host[comment]","description":"\n\u003cp\u003eAdditional information about this host\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"capabilities","full_name":"host[capabilities]","description":"","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"compute_profile_id","full_name":"host[compute_profile_id]","description":"","required":false,"allow_nil":true,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"interfaces_attributes","full_name":"host[interfaces_attributes]","description":"\n\u003cp\u003eHost’s network interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"mac","full_name":"host[interfaces_attributes][mac]","description":"\n\u003cp\u003eMAC address of interface. Required for managed interfaces on bare metal.\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"ip","full_name":"host[interfaces_attributes][ip]","description":"\n\u003cp\u003eIP address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"type","full_name":"host[interfaces_attributes][type]","description":"\n\u003cp\u003eInterface type, e.g. bmc. Default is interface\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be one of: interface, bmc, bond, bridge.","expected_type":"string","metadata":null,"show":true},{"name":"name","full_name":"host[interfaces_attributes][name]","description":"\n\u003cp\u003eInterface’s DNS name\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"subnet_id","full_name":"host[interfaces_attributes][subnet_id]","description":"\n\u003cp\u003eForeman subnet ID of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Fixnum","expected_type":"numeric","metadata":null,"show":true},{"name":"domain_id","full_name":"host[interfaces_attributes][domain_id]","description":"\n\u003cp\u003eForeman domain ID of interface. Required for primary interfaces on managed hosts.\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Fixnum","expected_type":"numeric","metadata":null,"show":true},{"name":"identifier","full_name":"host[interfaces_attributes][identifier]","description":"\n\u003cp\u003eDevice identifier, e.g. eth0 or eth1.1\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"managed","full_name":"host[interfaces_attributes][managed]","description":"\n\u003cp\u003eShould this interface be managed via DHCP and DNS smart proxy and should it be configured during provisioning?\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"primary","full_name":"host[interfaces_attributes][primary]","description":"\n\u003cp\u003eShould this interface be used for constructing the FQDN of the host? Each managed hosts needs to have one primary interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"provision","full_name":"host[interfaces_attributes][provision]","description":"\n\u003cp\u003eShould this interface be used for TFTP of PXELinux (or SSH for image-based hosts)? Each managed hosts needs to have one provision interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"username","full_name":"host[interfaces_attributes][username]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"password","full_name":"host[interfaces_attributes][password]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"provider","full_name":"host[interfaces_attributes][provider]","description":"\n\u003cp\u003eInterface provider, e.g. IPMI. Only for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be one of: IPMI.","expected_type":"string","metadata":null,"show":true},{"name":"virtual","full_name":"host[interfaces_attributes][virtual]","description":"\n\u003cp\u003eAlias or VLAN device\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"tag","full_name":"host[interfaces_attributes][tag]","description":"\n\u003cp\u003eVLAN tag, this attribute has precedence over the subnet VLAN ID. Only for virtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"attached_to","full_name":"host[interfaces_attributes][attached_to]","description":"\n\u003cp\u003eIdentifier of the interface to which this interface belongs, e.g. eth1. Only for virtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"mode","full_name":"host[interfaces_attributes][mode]","description":"\n\u003cp\u003eBond mode of the interface, e.g. balance-rr. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be one of: balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb.","expected_type":"string","metadata":null,"show":true},{"name":"attached_devices","full_name":"host[interfaces_attributes][attached_devices]","description":"\n\u003cp\u003eIdentifiers of attached interfaces, e.g. \u003ccode\u003e[\u0026#39;eth1\u0026#39;, \u0026#39;eth2\u0026#39;]\u003c/code\u003e. For bond interfaces those are the slaves. Only for bond and bridges interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"bond_options","full_name":"host[interfaces_attributes][bond_options]","description":"\n\u003cp\u003eSpace separated options, e.g. miimon=100. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"compute_attributes","full_name":"host[interfaces_attributes][compute_attributes]","description":"\n\u003cp\u003eAdditional compute resource specific attributes for the interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Hash","expected_type":"hash","metadata":null,"show":true}]},{"name":"compute_attributes","full_name":"host[compute_attributes]","description":"\n\u003cp\u003eAdditional compute resource specific attributes.\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Hash","expected_type":"hash","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/destroy","name":"destroy","apis":[{"api_url":"/api/hosts/:id","http_method":"DELETE","short_description":"Delete a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/status","name":"status","apis":[{"api_url":"/api/hosts/:id/status","http_method":"GET","short_description":"Get configuration status of host","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eReturn value may either be one of the following:\u003c/p\u003e\n\n\u003cul\u003e\n\u003cli\u003emissing\u003c/li\u003e\n\n\u003cli\u003efailed\u003c/li\u003e\n\n\u003cli\u003epending\u003c/li\u003e\n\n\u003cli\u003echanged\u003c/li\u003e\n\n\u003cli\u003eunchanged\u003c/li\u003e\n\n\u003cli\u003eunreported\u003c/li\u003e\n\u003c/ul\u003e\n","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/get_status","name":"get_status","apis":[{"api_url":"/api/hosts/:id/status/:type","http_method":"GET","short_description":"Get status of host","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eReturns string representing a host status of a given type\u003c/p\u003e\n","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true},{"name":"type","full_name":"type","description":"\n\u003cp\u003estatus type, can be one of\u003c/p\u003e\n\n\u003cul\u003e\n\u003cli\u003eglobal\u003c/li\u003e\n\n\u003cli\u003econfiguration\u003c/li\u003e\n\n\u003cli\u003ebuild\u003c/li\u003e\n\u003c/ul\u003e\n","required":true,"allow_nil":false,"validator":"Must be one of: HostStatus::Global, configuration, build.","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/vm_compute_attributes","name":"vm_compute_attributes","apis":[{"api_url":"/api/hosts/:id/vm_compute_attributes","http_method":"GET","short_description":"Get vm attributes of host","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eReturn the host’s compute attributes that can be used to create a clone of this VM\u003c/p\u003e\n","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/puppetrun","name":"puppetrun","apis":[{"api_url":"/api/hosts/:id/puppetrun","http_method":"PUT","short_description":"Force a Puppet agent run on the host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/disassociate","name":"disassociate","apis":[{"api_url":"/api/hosts/:id/disassociate","http_method":"PUT","short_description":"Disassociate the host from a VM","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/power","name":"power","apis":[{"api_url":"/api/hosts/:id/power","http_method":"PUT","short_description":"Run a power operation on host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true},{"name":"power_action","full_name":"power_action","description":"\n\u003cp\u003epower action, valid actions are (on/start), (off/stop), (soft/reboot), (cycle/reset), (state/status)\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/boot","name":"boot","apis":[{"api_url":"/api/hosts/:id/boot","http_method":"PUT","short_description":"Boot host from specified device","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true},{"name":"device","full_name":"device","description":"\n\u003cp\u003eboot device, valid devices are disk, cdrom, pxe, bios\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/facts","name":"facts","apis":[{"api_url":"/api/hosts/facts","http_method":"POST","short_description":"Upload facts for a host, creating the host if required","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n\u003cp\u003ehostname of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"facts","full_name":"facts","description":"\n\u003cp\u003ehash containing the facts for the host\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true},{"name":"certname","full_name":"certname","description":"\n\u003cp\u003eoptional: certname of the host\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"type","full_name":"type","description":"\n\u003cp\u003eoptional: the STI type of host to create\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/rebuild_config","name":"rebuild_config","apis":[{"api_url":"/api/hosts/:id/rebuild_config","http_method":"PUT","short_description":"Rebuild orchestration config","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/template","name":"template","apis":[{"api_url":"/api/hosts/:id/template/:kind","http_method":"GET","short_description":"Preview rendered provisioning template content","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true},{"name":"kind","full_name":"kind","description":"\n\u003cp\u003eTemplate kinds, available values: Bootdisk, PXELinux, PXEGrub, iPXE, provision, finish, script, user_data, ZTP, POAP\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/host_collections","name":"host_collections","apis":[{"api_url":"/api/hosts/:host_id/host_collections","http_method":"PUT","short_description":"Alter a hosts host collections","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eThe id of the host to alter\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"host_collection_ids","full_name":"host_collection_ids","description":"\n\u003cp\u003eList of host collection ids to update\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null},"interfaces":{"doc_url":"../apidoc/v2/interfaces","api_url":"/api","name":"Interfaces","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/interfaces/index","name":"index","apis":[{"api_url":"/api/hosts/:host_id/interfaces","http_method":"GET","short_description":"List all interfaces for host","deprecated":null},{"api_url":"/api/domains/:domain_id/interfaces","http_method":"GET","short_description":"List all interfaces for domain","deprecated":null},{"api_url":"/api/subnets/:subnet_id/interfaces","http_method":"GET","short_description":"List all interfaces for subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID or name of host\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID or name of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID or name of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003cp\u003epaginate results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003enumber of entries per request\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/interfaces/show","name":"show","apis":[{"api_url":"/api/hosts/:host_id/interfaces/:id","http_method":"GET","short_description":"Show an interface for host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID or name of host\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID or name of interface\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/interfaces/create","name":"create","apis":[{"api_url":"/api/hosts/:host_id/interfaces","http_method":"POST","short_description":"Create an interface on a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID or name of host\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"interface","full_name":"interface","description":"\n\u003cp\u003einterface information\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"mac","full_name":"interface[mac]","description":"\n\u003cp\u003eMAC address of interface. Required for managed interfaces on bare metal.\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"ip","full_name":"interface[ip]","description":"\n\u003cp\u003eIP address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"type","full_name":"interface[type]","description":"\n\u003cp\u003eInterface type, e.g. bmc. Default is interface\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be one of: interface, bmc, bond, bridge.","expected_type":"string","metadata":null,"show":true},{"name":"name","full_name":"interface[name]","description":"\n\u003cp\u003eInterface’s DNS name\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"subnet_id","full_name":"interface[subnet_id]","description":"\n\u003cp\u003eForeman subnet ID of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Fixnum","expected_type":"numeric","metadata":null,"show":true},{"name":"domain_id","full_name":"interface[domain_id]","description":"\n\u003cp\u003eForeman domain ID of interface. Required for primary interfaces on managed hosts.\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Fixnum","expected_type":"numeric","metadata":null,"show":true},{"name":"identifier","full_name":"interface[identifier]","description":"\n\u003cp\u003eDevice identifier, e.g. eth0 or eth1.1\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"managed","full_name":"interface[managed]","description":"\n\u003cp\u003eShould this interface be managed via DHCP and DNS smart proxy and should it be configured during provisioning?\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"primary","full_name":"interface[primary]","description":"\n\u003cp\u003eShould this interface be used for constructing the FQDN of the host? Each managed hosts needs to have one primary interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"provision","full_name":"interface[provision]","description":"\n\u003cp\u003eShould this interface be used for TFTP of PXELinux (or SSH for image-based hosts)? Each managed hosts needs to have one provision interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"username","full_name":"interface[username]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"password","full_name":"interface[password]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"provider","full_name":"interface[provider]","description":"\n\u003cp\u003eInterface provider, e.g. IPMI. Only for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be one of: IPMI.","expected_type":"string","metadata":null,"show":true},{"name":"virtual","full_name":"interface[virtual]","description":"\n\u003cp\u003eAlias or VLAN device\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"tag","full_name":"interface[tag]","description":"\n\u003cp\u003eVLAN tag, this attribute has precedence over the subnet VLAN ID. Only for virtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"attached_to","full_name":"interface[attached_to]","description":"\n\u003cp\u003eIdentifier of the interface to which this interface belongs, e.g. eth1. Only for virtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"mode","full_name":"interface[mode]","description":"\n\u003cp\u003eBond mode of the interface, e.g. balance-rr. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be one of: balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb.","expected_type":"string","metadata":null,"show":true},{"name":"attached_devices","full_name":"interface[attached_devices]","description":"\n\u003cp\u003eIdentifiers of attached interfaces, e.g. \u003ccode\u003e[\u0026#39;eth1\u0026#39;, \u0026#39;eth2\u0026#39;]\u003c/code\u003e. For bond interfaces those are the slaves. Only for bond and bridges interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"bond_options","full_name":"interface[bond_options]","description":"\n\u003cp\u003eSpace separated options, e.g. miimon=100. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"compute_attributes","full_name":"interface[compute_attributes]","description":"\n\u003cp\u003eAdditional compute resource specific attributes for the interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Hash","expected_type":"hash","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/interfaces/update","name":"update","apis":[{"api_url":"/api/hosts/:host_id/interfaces/:id","http_method":"PUT","short_description":"Update a host's interface","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID or name of host\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of interface\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"interface","full_name":"interface","description":"\n\u003cp\u003einterface information\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"mac","full_name":"interface[mac]","description":"\n\u003cp\u003eMAC address of interface. Required for managed interfaces on bare metal.\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"ip","full_name":"interface[ip]","description":"\n\u003cp\u003eIP address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"type","full_name":"interface[type]","description":"\n\u003cp\u003eInterface type, e.g. bmc. Default is interface\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be one of: interface, bmc, bond, bridge.","expected_type":"string","metadata":null,"show":true},{"name":"name","full_name":"interface[name]","description":"\n\u003cp\u003eInterface’s DNS name\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"subnet_id","full_name":"interface[subnet_id]","description":"\n\u003cp\u003eForeman subnet ID of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Fixnum","expected_type":"numeric","metadata":null,"show":true},{"name":"domain_id","full_name":"interface[domain_id]","description":"\n\u003cp\u003eForeman domain ID of interface. Required for primary interfaces on managed hosts.\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Fixnum","expected_type":"numeric","metadata":null,"show":true},{"name":"identifier","full_name":"interface[identifier]","description":"\n\u003cp\u003eDevice identifier, e.g. eth0 or eth1.1\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"managed","full_name":"interface[managed]","description":"\n\u003cp\u003eShould this interface be managed via DHCP and DNS smart proxy and should it be configured during provisioning?\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"primary","full_name":"interface[primary]","description":"\n\u003cp\u003eShould this interface be used for constructing the FQDN of the host? Each managed hosts needs to have one primary interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"provision","full_name":"interface[provision]","description":"\n\u003cp\u003eShould this interface be used for TFTP of PXELinux (or SSH for image-based hosts)? Each managed hosts needs to have one provision interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"username","full_name":"interface[username]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"password","full_name":"interface[password]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"provider","full_name":"interface[provider]","description":"\n\u003cp\u003eInterface provider, e.g. IPMI. Only for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be one of: IPMI.","expected_type":"string","metadata":null,"show":true},{"name":"virtual","full_name":"interface[virtual]","description":"\n\u003cp\u003eAlias or VLAN device\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"tag","full_name":"interface[tag]","description":"\n\u003cp\u003eVLAN tag, this attribute has precedence over the subnet VLAN ID. Only for virtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"attached_to","full_name":"interface[attached_to]","description":"\n\u003cp\u003eIdentifier of the interface to which this interface belongs, e.g. eth1. Only for virtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"mode","full_name":"interface[mode]","description":"\n\u003cp\u003eBond mode of the interface, e.g. balance-rr. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be one of: balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb.","expected_type":"string","metadata":null,"show":true},{"name":"attached_devices","full_name":"interface[attached_devices]","description":"\n\u003cp\u003eIdentifiers of attached interfaces, e.g. \u003ccode\u003e[\u0026#39;eth1\u0026#39;, \u0026#39;eth2\u0026#39;]\u003c/code\u003e. For bond interfaces those are the slaves. Only for bond and bridges interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"bond_options","full_name":"interface[bond_options]","description":"\n\u003cp\u003eSpace separated options, e.g. miimon=100. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"compute_attributes","full_name":"interface[compute_attributes]","description":"\n\u003cp\u003eAdditional compute resource specific attributes for the interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Hash","expected_type":"hash","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/interfaces/destroy","name":"destroy","apis":[{"api_url":"/api/hosts/:host_id/interfaces/:id","http_method":"DELETE","short_description":"Delete a host's interface","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID or name of host\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of interface\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null},"hostgroups":{"doc_url":"../apidoc/v2/hostgroups","api_url":"/api","name":"Hostgroups","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/hostgroups/index","name":"index","apis":[{"api_url":"/api/hostgroups","http_method":"GET","short_description":"List all host groups","deprecated":null},{"api_url":"/api/puppetclasses/:puppetclass_id/hostgroups","http_method":"GET","short_description":"List all host groups for a Puppet class","deprecated":null},{"api_url":"/api/locations/:location_id/hostgroups","http_method":"GET","short_description":"List all host groups per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/hostgroups","http_method":"GET","short_description":"List all host groups per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"puppetclass_id","full_name":"puppetclass_id","description":"\n\u003cp\u003eID of Puppet class\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003cp\u003esort results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003cp\u003epaginate results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003enumber of entries per request\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hostgroups/show","name":"show","apis":[{"api_url":"/api/hostgroups/:id","http_method":"GET","short_description":"Show a host group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hostgroups/create","name":"create","apis":[{"api_url":"/api/hostgroups","http_method":"POST","short_description":"Create a host group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"hostgroup","full_name":"hostgroup","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"hostgroup[name]","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"parent_id","full_name":"hostgroup[parent_id]","description":"","required":false,"allow_nil":true,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"environment_id","full_name":"hostgroup[environment_id]","description":"","required":false,"allow_nil":true,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"operatingsystem_id","full_name":"hostgroup[operatingsystem_id]","description":"","required":false,"allow_nil":true,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"architecture_id","full_name":"hostgroup[architecture_id]","description":"","required":false,"allow_nil":true,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"medium_id","full_name":"hostgroup[medium_id]","description":"","required":false,"allow_nil":true,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"ptable_id","full_name":"hostgroup[ptable_id]","description":"","required":false,"allow_nil":true,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"puppet_ca_proxy_id","full_name":"hostgroup[puppet_ca_proxy_id]","description":"","required":false,"allow_nil":true,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"subnet_id","full_name":"hostgroup[subnet_id]","description":"","required":false,"allow_nil":true,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"domain_id","full_name":"hostgroup[domain_id]","description":"","required":false,"allow_nil":true,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"realm_id","full_name":"hostgroup[realm_id]","description":"","required":false,"allow_nil":true,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"puppet_proxy_id","full_name":"hostgroup[puppet_proxy_id]","description":"","required":false,"allow_nil":true,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"content_source_id","full_name":"hostgroup[content_source_id]","description":"","required":false,"allow_nil":true,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"content_view_id","full_name":"hostgroup[content_view_id]","description":"","required":false,"allow_nil":true,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"lifecycle_environment_id","full_name":"hostgroup[lifecycle_environment_id]","description":"","required":false,"allow_nil":true,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"location_ids","full_name":"hostgroup[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"organization_ids","full_name":"hostgroup[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hostgroups/update","name":"update","apis":[{"api_url":"/api/hostgroups/:id","http_method":"PUT","short_description":"Update a host group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"hostgroup","full_name":"hostgroup","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"hostgroup[name]","description":"","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"parent_id","full_name":"hostgroup[parent_id]","description":"","required":false,"allow_nil":true,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"environment_id","full_name":"hostgroup[environment_id]","description":"","required":false,"allow_nil":true,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"operatingsystem_id","full_name":"hostgroup[operatingsystem_id]","description":"","required":false,"allow_nil":true,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"architecture_id","full_name":"hostgroup[architecture_id]","description":"","required":false,"allow_nil":true,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"medium_id","full_name":"hostgroup[medium_id]","description":"","required":false,"allow_nil":true,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"ptable_id","full_name":"hostgroup[ptable_id]","description":"","required":false,"allow_nil":true,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"puppet_ca_proxy_id","full_name":"hostgroup[puppet_ca_proxy_id]","description":"","required":false,"allow_nil":true,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"subnet_id","full_name":"hostgroup[subnet_id]","description":"","required":false,"allow_nil":true,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"domain_id","full_name":"hostgroup[domain_id]","description":"","required":false,"allow_nil":true,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"realm_id","full_name":"hostgroup[realm_id]","description":"","required":false,"allow_nil":true,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"puppet_proxy_id","full_name":"hostgroup[puppet_proxy_id]","description":"","required":false,"allow_nil":true,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"content_source_id","full_name":"hostgroup[content_source_id]","description":"","required":false,"allow_nil":true,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"content_view_id","full_name":"hostgroup[content_view_id]","description":"","required":false,"allow_nil":true,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"lifecycle_environment_id","full_name":"hostgroup[lifecycle_environment_id]","description":"","required":false,"allow_nil":true,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"location_ids","full_name":"hostgroup[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"organization_ids","full_name":"hostgroup[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hostgroups/destroy","name":"destroy","apis":[{"api_url":"/api/hostgroups/:id","http_method":"DELETE","short_description":"Delete a host group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hostgroups/clone","name":"clone","apis":[{"api_url":"/api/hostgroups/:id/clone","http_method":"POST","short_description":"Clone a host group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null},"config_templates":{"doc_url":"../apidoc/v2/config_templates","api_url":"/api","name":"Config templates","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/config_templates/index","name":"index","apis":[{"api_url":"/api/config_templates","http_method":"GET","short_description":"List provisioning templates","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/config_templates","http_method":"GET","short_description":"List provisioning templates per operating system","deprecated":null},{"api_url":"/api/locations/:location_id/config_templates","http_method":"GET","short_description":"List provisioning templates per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/config_templates","http_method":"GET","short_description":"List provisioning templates per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003cp\u003esort results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003cp\u003epaginate results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003enumber of entries per request\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/config_templates/show","name":"show","apis":[{"api_url":"/api/config_templates/:id","http_method":"GET","short_description":"Show provisioning template details","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/config_templates/create","name":"create","apis":[{"api_url":"/api/config_templates","http_method":"POST","short_description":"Create a provisioning template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"config_template","full_name":"config_template","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"config_template[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"template","full_name":"config_template[template]","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"snippet","full_name":"config_template[snippet]","description":"","required":false,"allow_nil":true,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"audit_comment","full_name":"config_template[audit_comment]","description":"","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"template_kind_id","full_name":"config_template[template_kind_id]","description":"\n\u003cp\u003enot relevant for snippet\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"template_combinations_attributes","full_name":"config_template[template_combinations_attributes]","description":"\n\u003cp\u003eArray of template combinations (hostgroup_id, environment_id)\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"operatingsystem_ids","full_name":"config_template[operatingsystem_ids]","description":"\n\u003cp\u003eArray of operating system IDs to associate with the template\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"locked","full_name":"config_template[locked]","description":"\n\u003cp\u003eWhether or not the template is locked for editing\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"location_ids","full_name":"config_template[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"organization_ids","full_name":"config_template[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/config_templates/update","name":"update","apis":[{"api_url":"/api/config_templates/:id","http_method":"PUT","short_description":"Update a provisioning template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"config_template","full_name":"config_template","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"config_template[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"template","full_name":"config_template[template]","description":"","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"snippet","full_name":"config_template[snippet]","description":"","required":false,"allow_nil":true,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"audit_comment","full_name":"config_template[audit_comment]","description":"","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"template_kind_id","full_name":"config_template[template_kind_id]","description":"\n\u003cp\u003enot relevant for snippet\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"template_combinations_attributes","full_name":"config_template[template_combinations_attributes]","description":"\n\u003cp\u003eArray of template combinations (hostgroup_id, environment_id)\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"operatingsystem_ids","full_name":"config_template[operatingsystem_ids]","description":"\n\u003cp\u003eArray of operating system IDs to associate with the template\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"locked","full_name":"config_template[locked]","description":"\n\u003cp\u003eWhether or not the template is locked for editing\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"location_ids","full_name":"config_template[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"organization_ids","full_name":"config_template[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/config_templates/revision","name":"revision","apis":[{"api_url":"/api/config_templates/revision","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"version","full_name":"version","description":"\n\u003cp\u003etemplate version\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/config_templates/destroy","name":"destroy","apis":[{"api_url":"/api/config_templates/:id","http_method":"DELETE","short_description":"Delete a provisioning template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/config_templates/build_pxe_default","name":"build_pxe_default","apis":[{"api_url":"/api/config_templates/build_pxe_default","http_method":"POST","short_description":"Update the default PXE menu on all configured TFTP servers","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/config_templates/clone","name":"clone","apis":[{"api_url":"/api/config_templates/:id/clone","http_method":"POST","short_description":"Clone a provision template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"config_template","full_name":"config_template","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"config_template[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null},"compute_resources":{"doc_url":"../apidoc/v2/compute_resources","api_url":"/api","name":"Compute resources","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/compute_resources/index","name":"index","apis":[{"api_url":"/api/compute_resources","http_method":"GET","short_description":"List all compute resources","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003cp\u003esort results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003cp\u003epaginate results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003enumber of entries per request\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/show","name":"show","apis":[{"api_url":"/api/compute_resources/:id","http_method":"GET","short_description":"Show a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/create","name":"create","apis":[{"api_url":"/api/compute_resources","http_method":"POST","short_description":"Create a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"compute_resource","full_name":"compute_resource","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"compute_resource[name]","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"provider","full_name":"compute_resource[provider]","description":"\n\u003cp\u003eProviders include Libvirt, Ovirt, EC2, Vmware, Openstack, Rackspace, GCE\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"url","full_name":"compute_resource[url]","description":"\n\u003cp\u003eURL for Libvirt, oVirt, and OpenStack\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"description","full_name":"compute_resource[description]","description":"","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"user","full_name":"compute_resource[user]","description":"\n\u003cp\u003eUsername for oVirt, EC2, VMware, OpenStack. Access Key for EC2.\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"password","full_name":"compute_resource[password]","description":"\n\u003cp\u003ePassword for oVirt, EC2, VMware, OpenStack. Secret key for EC2\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"uuid","full_name":"compute_resource[uuid]","description":"\n\u003cp\u003efor oVirt, VMware Datacenter\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"region","full_name":"compute_resource[region]","description":"\n\u003cp\u003efor EC2 only\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"tenant","full_name":"compute_resource[tenant]","description":"\n\u003cp\u003efor OpenStack only\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"server","full_name":"compute_resource[server]","description":"\n\u003cp\u003efor VMware\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"set_console_password","full_name":"compute_resource[set_console_password]","description":"\n\u003cp\u003efor Libvirt and VMware only\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"location_ids","full_name":"compute_resource[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"organization_ids","full_name":"compute_resource[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/update","name":"update","apis":[{"api_url":"/api/compute_resources/:id","http_method":"PUT","short_description":"Update a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"compute_resource","full_name":"compute_resource","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"compute_resource[name]","description":"","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"provider","full_name":"compute_resource[provider]","description":"\n\u003cp\u003eProviders include Libvirt, Ovirt, EC2, Vmware, Openstack, Rackspace, GCE\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"url","full_name":"compute_resource[url]","description":"\n\u003cp\u003eURL for Libvirt, oVirt, and OpenStack\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"description","full_name":"compute_resource[description]","description":"","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"user","full_name":"compute_resource[user]","description":"\n\u003cp\u003eUsername for oVirt, EC2, VMware, OpenStack. Access Key for EC2.\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"password","full_name":"compute_resource[password]","description":"\n\u003cp\u003ePassword for oVirt, EC2, VMware, OpenStack. Secret key for EC2\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"uuid","full_name":"compute_resource[uuid]","description":"\n\u003cp\u003efor oVirt, VMware Datacenter\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"region","full_name":"compute_resource[region]","description":"\n\u003cp\u003efor EC2 only\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"tenant","full_name":"compute_resource[tenant]","description":"\n\u003cp\u003efor OpenStack only\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"server","full_name":"compute_resource[server]","description":"\n\u003cp\u003efor VMware\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"set_console_password","full_name":"compute_resource[set_console_password]","description":"\n\u003cp\u003efor Libvirt and VMware only\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"location_ids","full_name":"compute_resource[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"organization_ids","full_name":"compute_resource[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/destroy","name":"destroy","apis":[{"api_url":"/api/compute_resources/:id","http_method":"DELETE","short_description":"Delete a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/available_images","name":"available_images","apis":[{"api_url":"/api/compute_resources/:id/available_images","http_method":"GET","short_description":"List available images for a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/available_clusters","name":"available_clusters","apis":[{"api_url":"/api/compute_resources/:id/available_clusters","http_method":"GET","short_description":"List available clusters for a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/available_flavors","name":"available_flavors","apis":[{"api_url":"/api/compute_resources/:id/available_flavors","http_method":"GET","short_description":"List available flavors for a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/available_folders","name":"available_folders","apis":[{"api_url":"/api/compute_resources/:id/available_folders","http_method":"GET","short_description":"List available folders for a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/available_zones","name":"available_zones","apis":[{"api_url":"/api/compute_resources/:id/available_zones","http_method":"GET","short_description":"List available zone for a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/available_networks","name":"available_networks","apis":[{"api_url":"/api/compute_resources/:id/available_networks","http_method":"GET","short_description":"List available networks for a compute resource","deprecated":null},{"api_url":"/api/compute_resources/:id/available_clusters/:cluster_id/available_networks","http_method":"GET","short_description":"List available networks for a compute resource cluster","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"cluster_id","full_name":"cluster_id","description":"","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/available_resource_pools","name":"available_resource_pools","apis":[{"api_url":"/api/compute_resources/:id/available_clusters/:cluster_id/available_resource_pools","http_method":"GET","short_description":"List resource pools for a compute resource cluster","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"cluster_id","full_name":"cluster_id","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/available_storage_domains","name":"available_storage_domains","apis":[{"api_url":"/api/compute_resources/:id/available_storage_domains","http_method":"GET","short_description":"List storage domains for a compute resource","deprecated":null},{"api_url":"/api/compute_resources/:id/available_storage_domains/:storage_domain","http_method":"GET","short_description":"List attributes for a given storage domain","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"storage_domain","full_name":"storage_domain","description":"","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/available_storage_pods","name":"available_storage_pods","apis":[{"api_url":"/api/compute_resources/:id/available_storage_pods","http_method":"GET","short_description":"List storage pods for a compute resource","deprecated":null},{"api_url":"/api/compute_resources/:id/available_storage_pods/:storage_pod","http_method":"GET","short_description":"List attributes for a given storage pod","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"storage_pod","full_name":"storage_pod","description":"","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/available_security_groups","name":"available_security_groups","apis":[{"api_url":"/api/compute_resources/:id/available_security_groups","http_method":"GET","short_description":"List available security groups for a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/associate","name":"associate","apis":[{"api_url":"/api/compute_resources/:id/associate","http_method":"PUT","short_description":"Associate VMs to Hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null},"smart_proxies":{"doc_url":"../apidoc/v2/smart_proxies","api_url":"/api","name":"Smart proxies","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/smart_proxies/import_puppetclasses","name":"import_puppetclasses","apis":[{"api_url":"/api/smart_proxies/:id/import_puppetclasses","http_method":"POST","short_description":"Import puppet classes from puppet proxy.","deprecated":null},{"api_url":"/api/smart_proxies/:smart_proxy_id/environments/:id/import_puppetclasses","http_method":"POST","short_description":"Import puppet classes from puppet proxy for an environment","deprecated":null},{"api_url":"/api/environments/:environment_id/smart_proxies/:id/import_puppetclasses","http_method":"POST","short_description":"Import puppet classes from puppet proxy for an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"smart_proxy_id","full_name":"smart_proxy_id","description":"","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"environment_id","full_name":"environment_id","description":"","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"dryrun","full_name":"dryrun","description":"","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"except","full_name":"except","description":"\n\u003cp\u003eOptional comma-delimited string containing either ‘new’, ‘updated’, or ‘obsolete’ that is used to limit the imported Puppet classes\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/smart_proxies/index","name":"index","apis":[{"api_url":"/api/smart_proxies","http_method":"GET","short_description":"List all smart proxies","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003cp\u003esort results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003cp\u003epaginate results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003enumber of entries per request\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/smart_proxies/show","name":"show","apis":[{"api_url":"/api/smart_proxies/:id","http_method":"GET","short_description":"Show a smart proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/smart_proxies/create","name":"create","apis":[{"api_url":"/api/smart_proxies","http_method":"POST","short_description":"Create a smart proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"smart_proxy","full_name":"smart_proxy","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"smart_proxy[name]","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"url","full_name":"smart_proxy[url]","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"location_ids","full_name":"smart_proxy[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"organization_ids","full_name":"smart_proxy[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/smart_proxies/update","name":"update","apis":[{"api_url":"/api/smart_proxies/:id","http_method":"PUT","short_description":"Update a smart proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"smart_proxy","full_name":"smart_proxy","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"smart_proxy[name]","description":"","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"url","full_name":"smart_proxy[url]","description":"","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"location_ids","full_name":"smart_proxy[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"organization_ids","full_name":"smart_proxy[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/smart_proxies/destroy","name":"destroy","apis":[{"api_url":"/api/smart_proxies/:id","http_method":"DELETE","short_description":"Delete a smart proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/smart_proxies/refresh","name":"refresh","apis":[{"api_url":"/api/smart_proxies/:id/refresh","http_method":"PUT","short_description":"Refresh smart proxy features","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null},"architectures":{"doc_url":"../apidoc/v2/architectures","api_url":"/api","name":"Architectures","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/architectures/index","name":"index","apis":[{"api_url":"/api/architectures","http_method":"GET","short_description":"List all architectures","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/architectures","http_method":"GET","short_description":"List all architectures for operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003cp\u003esort results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003cp\u003epaginate results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003enumber of entries per request\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/architectures/show","name":"show","apis":[{"api_url":"/api/architectures/:id","http_method":"GET","short_description":"Show an architecture","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/architectures/create","name":"create","apis":[{"api_url":"/api/architectures","http_method":"POST","short_description":"Create an architecture","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"architecture","full_name":"architecture","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"architecture[name]","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"operatingsystem_ids","full_name":"architecture[operatingsystem_ids]","description":"\n\u003cp\u003eOperating system IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/architectures/update","name":"update","apis":[{"api_url":"/api/architectures/:id","http_method":"PUT","short_description":"Update an architecture","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"architecture","full_name":"architecture","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"architecture[name]","description":"","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"operatingsystem_ids","full_name":"architecture[operatingsystem_ids]","description":"\n\u003cp\u003eOperating system IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/architectures/destroy","name":"destroy","apis":[{"api_url":"/api/architectures/:id","http_method":"DELETE","short_description":"Delete an architecture","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null},"audits":{"doc_url":"../apidoc/v2/audits","api_url":"/api","name":"Audits","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/audits/index","name":"index","apis":[{"api_url":"/api/audits","http_method":"GET","short_description":"List all audits","deprecated":null},{"api_url":"/api/hosts/:host_id/audits","http_method":"GET","short_description":"List all audits for a given host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003cp\u003esort results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003cp\u003epaginate results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003enumber of entries per request\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/audits/show","name":"show","apis":[{"api_url":"/api/audits/:id","http_method":"GET","short_description":"Show an audit","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null},"auth_source_ldaps":{"doc_url":"../apidoc/v2/auth_source_ldaps","api_url":"/api","name":"Auth source ldaps","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/auth_source_ldaps/index","name":"index","apis":[{"api_url":"/api/auth_source_ldaps","http_method":"GET","short_description":"List all LDAP authentication sources","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003cp\u003esort results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003cp\u003epaginate results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003enumber of entries per request\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/auth_source_ldaps/show","name":"show","apis":[{"api_url":"/api/auth_source_ldaps/:id","http_method":"GET","short_description":"Show an LDAP authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/auth_source_ldaps/create","name":"create","apis":[{"api_url":"/api/auth_source_ldaps","http_method":"POST","short_description":"Create an LDAP authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"auth_source_ldap","full_name":"auth_source_ldap","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"auth_source_ldap[name]","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"host","full_name":"auth_source_ldap[host]","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"port","full_name":"auth_source_ldap[port]","description":"\n\u003cp\u003edefaults to 389\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"account","full_name":"auth_source_ldap[account]","description":"","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"base_dn","full_name":"auth_source_ldap[base_dn]","description":"","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"account_password","full_name":"auth_source_ldap[account_password]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"attr_login","full_name":"auth_source_ldap[attr_login]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"attr_firstname","full_name":"auth_source_ldap[attr_firstname]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"attr_lastname","full_name":"auth_source_ldap[attr_lastname]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"attr_mail","full_name":"auth_source_ldap[attr_mail]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"attr_photo","full_name":"auth_source_ldap[attr_photo]","description":"","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"onthefly_register","full_name":"auth_source_ldap[onthefly_register]","description":"","required":false,"allow_nil":true,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"usergroup_sync","full_name":"auth_source_ldap[usergroup_sync]","description":"\n\u003cp\u003esync external user groups on login\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"tls","full_name":"auth_source_ldap[tls]","description":"","required":false,"allow_nil":true,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"groups_base","full_name":"auth_source_ldap[groups_base]","description":"\n\u003cp\u003egroups base DN\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"server_type","full_name":"auth_source_ldap[server_type]","description":"\n\u003cp\u003etype of the LDAP server\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be one of: free_ipa, active_directory, posix.","expected_type":"string","metadata":null,"show":true},{"name":"ldap_filter","full_name":"auth_source_ldap[ldap_filter]","description":"\n\u003cp\u003eLDAP filter\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/auth_source_ldaps/update","name":"update","apis":[{"api_url":"/api/auth_source_ldaps/:id","http_method":"PUT","short_description":"Update an LDAP authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"auth_source_ldap","full_name":"auth_source_ldap","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"auth_source_ldap[name]","description":"","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"host","full_name":"auth_source_ldap[host]","description":"","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"port","full_name":"auth_source_ldap[port]","description":"\n\u003cp\u003edefaults to 389\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"account","full_name":"auth_source_ldap[account]","description":"","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"base_dn","full_name":"auth_source_ldap[base_dn]","description":"","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"account_password","full_name":"auth_source_ldap[account_password]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"attr_login","full_name":"auth_source_ldap[attr_login]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"attr_firstname","full_name":"auth_source_ldap[attr_firstname]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"attr_lastname","full_name":"auth_source_ldap[attr_lastname]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"attr_mail","full_name":"auth_source_ldap[attr_mail]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"attr_photo","full_name":"auth_source_ldap[attr_photo]","description":"","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"onthefly_register","full_name":"auth_source_ldap[onthefly_register]","description":"","required":false,"allow_nil":true,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"usergroup_sync","full_name":"auth_source_ldap[usergroup_sync]","description":"\n\u003cp\u003esync external user groups on login\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"tls","full_name":"auth_source_ldap[tls]","description":"","required":false,"allow_nil":true,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"groups_base","full_name":"auth_source_ldap[groups_base]","description":"\n\u003cp\u003egroups base DN\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"server_type","full_name":"auth_source_ldap[server_type]","description":"\n\u003cp\u003etype of the LDAP server\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be one of: free_ipa, active_directory, posix.","expected_type":"string","metadata":null,"show":true},{"name":"ldap_filter","full_name":"auth_source_ldap[ldap_filter]","description":"\n\u003cp\u003eLDAP filter\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/auth_source_ldaps/test","name":"test","apis":[{"api_url":"/api/auth_source_ldaps/:id/test","http_method":"PUT","short_description":"Test LDAP connection","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/auth_source_ldaps/destroy","name":"destroy","apis":[{"api_url":"/api/auth_source_ldaps/:id","http_method":"DELETE","short_description":"Delete an LDAP authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null},"autosign":{"doc_url":"../apidoc/v2/autosign","api_url":"/api","name":"Autosign","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/autosign/index","name":"index","apis":[{"api_url":"/api/smart_proxies/smart_proxy_id/autosign","http_method":"GET","short_description":"List all autosign entries","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null},"bookmarks":{"doc_url":"../apidoc/v2/bookmarks","api_url":"/api","name":"Bookmarks","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/bookmarks/index","name":"index","apis":[{"api_url":"/api/bookmarks","http_method":"GET","short_description":"List all bookmarks","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003cp\u003esort results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003cp\u003epaginate results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003enumber of entries per request\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/bookmarks/show","name":"show","apis":[{"api_url":"/api/bookmarks/:id","http_method":"GET","short_description":"Show a bookmark","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/bookmarks/create","name":"create","apis":[{"api_url":"/api/bookmarks","http_method":"POST","short_description":"Create a bookmark","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"bookmark","full_name":"bookmark","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"bookmark[name]","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"controller","full_name":"bookmark[controller]","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"query","full_name":"bookmark[query]","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"public","full_name":"bookmark[public]","description":"","required":false,"allow_nil":true,"validator":"boolean","expected_type":"string","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/bookmarks/update","name":"update","apis":[{"api_url":"/api/bookmarks/:id","http_method":"PUT","short_description":"Update a bookmark","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"bookmark","full_name":"bookmark","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"bookmark[name]","description":"","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"controller","full_name":"bookmark[controller]","description":"","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"query","full_name":"bookmark[query]","description":"","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"public","full_name":"bookmark[public]","description":"","required":false,"allow_nil":true,"validator":"boolean","expected_type":"string","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/bookmarks/destroy","name":"destroy","apis":[{"api_url":"/api/bookmarks/:id","http_method":"DELETE","short_description":"Delete a bookmark","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null},"common_parameters":{"doc_url":"../apidoc/v2/common_parameters","api_url":"/api","name":"Common parameters","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/common_parameters/index","name":"index","apis":[{"api_url":"/api/common_parameters","http_method":"GET","short_description":"List all global parameters.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003cp\u003esort results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003cp\u003epaginate results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003enumber of entries per request\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/common_parameters/show","name":"show","apis":[{"api_url":"/api/common_parameters/:id","http_method":"GET","short_description":"Show a global parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/common_parameters/create","name":"create","apis":[{"api_url":"/api/common_parameters","http_method":"POST","short_description":"Create a global parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"common_parameter","full_name":"common_parameter","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"common_parameter[name]","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"value","full_name":"common_parameter[value]","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"hidden_value","full_name":"common_parameter[hidden_value]","description":"","required":false,"allow_nil":true,"validator":"Must be one of: true, false.","expected_type":"string","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/common_parameters/update","name":"update","apis":[{"api_url":"/api/common_parameters/:id","http_method":"PUT","short_description":"Update a global parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"common_parameter","full_name":"common_parameter","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"common_parameter[name]","description":"","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"value","full_name":"common_parameter[value]","description":"","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"hidden_value","full_name":"common_parameter[hidden_value]","description":"","required":false,"allow_nil":true,"validator":"Must be one of: true, false.","expected_type":"string","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/common_parameters/destroy","name":"destroy","apis":[{"api_url":"/api/common_parameters/:id","http_method":"DELETE","short_description":"Delete a global parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null},"compute_attributes":{"doc_url":"../apidoc/v2/compute_attributes","api_url":"/api","name":"Compute attributes","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/compute_attributes/create","name":"create","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/compute_profiles/:compute_profile_id/compute_attributes","http_method":"POST","short_description":"Create a compute attributes set","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_resources/:compute_resource_id/compute_attributes","http_method":"POST","short_description":"Create a compute attributes set","deprecated":null},{"api_url":"/api/compute_resources/:compute_resource_id/compute_attributes","http_method":"POST","short_description":"Create a compute attributes set","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_attributes","http_method":"POST","short_description":"Create a compute attributes set","deprecated":null},{"api_url":"/api/compute_attributes","http_method":"POST","short_description":"Create a compute attributes set","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"compute_profile_id","full_name":"compute_profile_id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"compute_attribute","full_name":"compute_attribute","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"vm_attrs","full_name":"compute_attribute[vm_attrs]","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_attributes/update","name":"update","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/compute_profiles/:compute_profile_id/compute_attributes/:id","http_method":"PUT","short_description":"Update a compute attributes set","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_resources/:compute_resource_id/compute_attributes/:id","http_method":"PUT","short_description":"Update a compute attributes set","deprecated":null},{"api_url":"/api/compute_resources/:compute_resource_id/compute_attributes/:id","http_method":"PUT","short_description":"Update a compute attributes set","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_attributes/:id","http_method":"PUT","short_description":"Update a compute attributes set","deprecated":null},{"api_url":"/api/compute_attributes/:id","http_method":"PUT","short_description":"Update a compute attributes set","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"compute_profile_id","full_name":"compute_profile_id","description":"","required":false,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"","required":false,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"compute_attribute","full_name":"compute_attribute","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"vm_attrs","full_name":"compute_attribute[vm_attrs]","description":"","required":false,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null},"compute_profiles":{"doc_url":"../apidoc/v2/compute_profiles","api_url":"/api","name":"Compute profiles","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/compute_profiles/index","name":"index","apis":[{"api_url":"/api/compute_profiles","http_method":"GET","short_description":"List of compute profiles","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003cp\u003esort results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003cp\u003epaginate results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003enumber of entries per request\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_profiles/show","name":"show","apis":[{"api_url":"/api/compute_profiles/:id","http_method":"GET","short_description":"Show a compute profile","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_profiles/create","name":"create","apis":[{"api_url":"/api/compute_profiles","http_method":"POST","short_description":"Create a compute profile","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"compute_profile","full_name":"compute_profile","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"compute_profile[name]","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_profiles/update","name":"update","apis":[{"api_url":"/api/compute_profiles/:id","http_method":"PUT","short_description":"Update a compute profile","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"compute_profile","full_name":"compute_profile","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"compute_profile[name]","description":"","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_profiles/destroy","name":"destroy","apis":[{"api_url":"/api/compute_profiles/:id","http_method":"DELETE","short_description":"Delete a compute profile","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null},"config_groups":{"doc_url":"../apidoc/v2/config_groups","api_url":"/api","name":"Config groups","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/config_groups/index","name":"index","apis":[{"api_url":"/api/config_groups","http_method":"GET","short_description":"List of config groups","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003cp\u003esort results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003cp\u003epaginate results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003enumber of entries per request\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/config_groups/show","name":"show","apis":[{"api_url":"/api/config_groups/:id","http_method":"GET","short_description":"Show a config group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/config_groups/create","name":"create","apis":[{"api_url":"/api/config_groups","http_method":"POST","short_description":"Create a config group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"config_group","full_name":"config_group","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"config_group[name]","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/config_groups/update","name":"update","apis":[{"api_url":"/api/config_groups/:id","http_method":"PUT","short_description":"Update a config group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"config_group","full_name":"config_group","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"config_group[name]","description":"","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/config_groups/destroy","name":"destroy","apis":[{"api_url":"/api/config_groups/:id","http_method":"DELETE","short_description":"Delete a config group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null},"dashboard":{"doc_url":"../apidoc/v2/dashboard","api_url":"/api","name":"Dashboard","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/dashboard/index","name":"index","apis":[{"api_url":"/api/dashboard","http_method":"GET","short_description":"Get dashboard details","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null},"domains":{"doc_url":"../apidoc/v2/domains","api_url":"/api","name":"Domains","short_description":null,"full_description":"\n\u003cp\u003eForeman considers a domain and a DNS zone as the same thing. That is, if you are planning to manage a site where all the machines are or the form \u003ci\u003ehostname\u003c/i\u003e.\u003cb\u003esomewhere.com\u003c/b\u003e then the domain is \u003cb\u003esomewhere.com\u003c/b\u003e. This allows Foreman to associate a puppet variable with a domain/site and automatically append this variable to all external node requests made by machines at that site.\u003c/p\u003e\n","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/domains/index","name":"index","apis":[{"api_url":"/api/domains","http_method":"GET","short_description":"List of domains","deprecated":null},{"api_url":"/api/subnets/:subnet_id/domains","http_method":"GET","short_description":"List of domains per subnet","deprecated":null},{"api_url":"/api/locations/:location_id/domains","http_method":"GET","short_description":"List of domains per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/domains","http_method":"GET","short_description":"List of domains per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003cp\u003esort results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003cp\u003epaginate results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003enumber of entries per request\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/domains/show","name":"show","apis":[{"api_url":"/api/domains/:id","http_method":"GET","short_description":"Show a domain","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eNumerical ID or domain name\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/domains/create","name":"create","apis":[{"api_url":"/api/domains","http_method":"POST","short_description":"Create a domain","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eThe \u003cb\u003efullname\u003c/b\u003e field is used for human readability in reports and other pages that refer to domains, and also available as an external node parameter\u003c/p\u003e\n","errors":[],"params":[{"name":"domain","full_name":"domain","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"domain[name]","description":"\n\u003cp\u003eThe full DNS domain name\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"fullname","full_name":"domain[fullname]","description":"\n\u003cp\u003eDescription of the domain\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"dns_id","full_name":"domain[dns_id]","description":"\n\u003cp\u003eDNS proxy to use within this domain\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"domain_parameters_attributes","full_name":"domain[domain_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters (name, value)\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"location_ids","full_name":"domain[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"organization_ids","full_name":"domain[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/domains/update","name":"update","apis":[{"api_url":"/api/domains/:id","http_method":"PUT","short_description":"Update a domain","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"domain","full_name":"domain","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"domain[name]","description":"\n\u003cp\u003eThe full DNS domain name\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"fullname","full_name":"domain[fullname]","description":"\n\u003cp\u003eDescription of the domain\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"dns_id","full_name":"domain[dns_id]","description":"\n\u003cp\u003eDNS proxy to use within this domain\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"domain_parameters_attributes","full_name":"domain[domain_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters (name, value)\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"location_ids","full_name":"domain[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"organization_ids","full_name":"domain[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/domains/destroy","name":"destroy","apis":[{"api_url":"/api/domains/:id","http_method":"DELETE","short_description":"Delete a domain","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[]},"environments":{"doc_url":"../apidoc/v2/environments","api_url":"/api","name":"Environments","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/environments/import_puppetclasses","name":"import_puppetclasses","apis":[{"api_url":"/api/smart_proxies/:id/import_puppetclasses","http_method":"POST","short_description":"Import puppet classes from puppet proxy.","deprecated":null},{"api_url":"/api/smart_proxies/:smart_proxy_id/environments/:id/import_puppetclasses","http_method":"POST","short_description":"Import puppet classes from puppet proxy for an environment","deprecated":null},{"api_url":"/api/environments/:environment_id/smart_proxies/:id/import_puppetclasses","http_method":"POST","short_description":"Import puppet classes from puppet proxy for an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"smart_proxy_id","full_name":"smart_proxy_id","description":"","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"environment_id","full_name":"environment_id","description":"","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"dryrun","full_name":"dryrun","description":"","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"except","full_name":"except","description":"\n\u003cp\u003eOptional comma-delimited string containing either ‘new’, ‘updated’, or ‘obsolete’ that is used to limit the imported Puppet classes\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/environments/index","name":"index","apis":[{"api_url":"/api/environments","http_method":"GET","short_description":"List all environments","deprecated":null},{"api_url":"/api/puppetclasses/:puppetclass_id/environments","http_method":"GET","short_description":"List environments of Puppet class","deprecated":null},{"api_url":"/api/locations/:location_id/environments","http_method":"GET","short_description":"List environments per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/environments","http_method":"GET","short_description":"List environments per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"puppetclass_id","full_name":"puppetclass_id","description":"\n\u003cp\u003eID of Puppet class\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003cp\u003esort results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003cp\u003epaginate results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003enumber of entries per request\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/environments/show","name":"show","apis":[{"api_url":"/api/environments/:id","http_method":"GET","short_description":"Show an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/environments/create","name":"create","apis":[{"api_url":"/api/environments","http_method":"POST","short_description":"Create an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"environment","full_name":"environment","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"environment[name]","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"location_ids","full_name":"environment[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"organization_ids","full_name":"environment[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/environments/update","name":"update","apis":[{"api_url":"/api/environments/:id","http_method":"PUT","short_description":"Update an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"environment","full_name":"environment","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"environment[name]","description":"","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"location_ids","full_name":"environment[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"organization_ids","full_name":"environment[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/environments/destroy","name":"destroy","apis":[{"api_url":"/api/environments/:id","http_method":"DELETE","short_description":"Delete an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null},"external_usergroups":{"doc_url":"../apidoc/v2/external_usergroups","api_url":"/api","name":"External usergroups","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/external_usergroups/index","name":"index","apis":[{"api_url":"/api/usergroups/:usergroup_id/external_usergroups","http_method":"GET","short_description":"List all external user groups for user group","deprecated":null},{"api_url":"/api/auth_source_ldaps/:auth_source_ldap_id/external_usergroups","http_method":"GET","short_description":"List all external user groups for LDAP authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"usergroup_id","full_name":"usergroup_id","description":"\n\u003cp\u003eID or name of user group\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/external_usergroups/show","name":"show","apis":[{"api_url":"/api/usergroups/:usergroup_id/external_usergroups/:id","http_method":"GET","short_description":"Show an external user group for user group","deprecated":null},{"api_url":"/api/auth_source_ldaps/:auth_source_ldap_id/external_usergroups/:id","http_method":"GET","short_description":"Show an external user group for LDAP authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"usergroup_id","full_name":"usergroup_id","description":"\n\u003cp\u003eID or name of user group\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID or name of external user group\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/external_usergroups/create","name":"create","apis":[{"api_url":"/api/usergroups/:usergroup_id/external_usergroups","http_method":"POST","short_description":"Create an external user group linked to a user group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"usergroup_id","full_name":"usergroup_id","description":"\n\u003cp\u003eID or name of user group\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"external_usergroup","full_name":"external_usergroup","description":"\n\u003cp\u003eExternal user group information\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"external_usergroup[name]","description":"\n\u003cp\u003eExternal user group name\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"auth_source_id","full_name":"external_usergroup[auth_source_id]","description":"\n\u003cp\u003eID of linked authentication source\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"Fixnum","expected_type":"numeric","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/external_usergroups/update","name":"update","apis":[{"api_url":"/api/usergroups/:usergroup_id/external_usergroups/:id","http_method":"PUT","short_description":"Update external user group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"usergroup_id","full_name":"usergroup_id","description":"\n\u003cp\u003eID or name of user group\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID or name of external user group\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"external_usergroup","full_name":"external_usergroup","description":"\n\u003cp\u003eExternal user group information\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"external_usergroup[name]","description":"\n\u003cp\u003eExternal user group name\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"auth_source_id","full_name":"external_usergroup[auth_source_id]","description":"\n\u003cp\u003eID of linked authentication source\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Fixnum","expected_type":"numeric","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/external_usergroups/refresh","name":"refresh","apis":[{"api_url":"/api/usergroups/:usergroup_id/external_usergroups/:id/refresh","http_method":"PUT","short_description":"Refresh external user group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"usergroup_id","full_name":"usergroup_id","description":"\n\u003cp\u003eID or name of user group\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID or name of external user group\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/external_usergroups/destroy","name":"destroy","apis":[{"api_url":"/api/usergroups/:usergroup_id/external_usergroups/:id","http_method":"DELETE","short_description":"Delete an external user group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"usergroup_id","full_name":"usergroup_id","description":"\n\u003cp\u003eID or name of user group\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID or name external user group\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null},"fact_values":{"doc_url":"../apidoc/v2/fact_values","api_url":"/api","name":"Fact values","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/fact_values/index","name":"index","apis":[{"api_url":"/api/fact_values","http_method":"GET","short_description":"List all fact values","deprecated":null},{"api_url":"/api/hosts/:host_id/facts","http_method":"GET","short_description":"List all fact values of a given host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003cp\u003esort results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003cp\u003epaginate results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003enumber of entries per request\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null},"filters":{"doc_url":"../apidoc/v2/filters","api_url":"/api","name":"Filters","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/filters/index","name":"index","apis":[{"api_url":"/api/filters","http_method":"GET","short_description":"List all filters","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003cp\u003esort results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003cp\u003epaginate results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003enumber of entries per request\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/filters/show","name":"show","apis":[{"api_url":"/api/filters/:id","http_method":"GET","short_description":"Show a filter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/filters/create","name":"create","apis":[{"api_url":"/api/filters","http_method":"POST","short_description":"Create a filter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"filter","full_name":"filter","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"role_id","full_name":"filter[role_id]","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"search","full_name":"filter[search]","description":"","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"permission_ids","full_name":"filter[permission_ids]","description":"","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"organization_ids","full_name":"filter[organization_ids]","description":"","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"location_ids","full_name":"filter[location_ids]","description":"","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/filters/update","name":"update","apis":[{"api_url":"/api/filters/:id","http_method":"PUT","short_description":"Update a filter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"filter","full_name":"filter","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"role_id","full_name":"filter[role_id]","description":"","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"search","full_name":"filter[search]","description":"","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"permission_ids","full_name":"filter[permission_ids]","description":"","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"organization_ids","full_name":"filter[organization_ids]","description":"","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"location_ids","full_name":"filter[location_ids]","description":"","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/filters/destroy","name":"destroy","apis":[{"api_url":"/api/filters/:id","http_method":"DELETE","short_description":"Delete a filter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null},"home":{"doc_url":"../apidoc/v2/home","api_url":"/api","name":"Home","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/home/index","name":"index","apis":[{"api_url":"/api","http_method":"GET","short_description":"Show available API links","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/home/status","name":"status","apis":[{"api_url":"/api/status","http_method":"GET","short_description":"Show status","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null},"hostgroup_classes":{"doc_url":"../apidoc/v2/hostgroup_classes","api_url":"/api","name":"Hostgroup classes","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/hostgroup_classes/index","name":"index","apis":[{"api_url":"/api/hostgroups/:hostgroup_id/puppetclass_ids","http_method":"GET","short_description":"List all Puppet class IDs for host group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hostgroup_classes/create","name":"create","apis":[{"api_url":"/api/hostgroups/:hostgroup_id/puppetclass_ids","http_method":"POST","short_description":"Add a Puppet class to host group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"puppetclass_id","full_name":"puppetclass_id","description":"\n\u003cp\u003eID of Puppet class\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hostgroup_classes/destroy","name":"destroy","apis":[{"api_url":"/api/hostgroups/:hostgroup_id/puppetclass_ids/:id","http_method":"DELETE","short_description":"Remove a Puppet class from host group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of Puppet class\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null},"images":{"doc_url":"../apidoc/v2/images","api_url":"/api","name":"Images","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/images/index","name":"index","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/images","http_method":"GET","short_description":"List all images for a compute resource","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/images","http_method":"GET","short_description":"List all images for operating system","deprecated":null},{"api_url":"/api/architectures/:architecture_id/images","http_method":"GET","short_description":"List all images for architecture","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"compute_resource_id","full_name":"compute_resource_id","description":"\n\u003cp\u003eID of compute resource\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"architecture_id","full_name":"architecture_id","description":"\n\u003cp\u003eID of architecture\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003cp\u003esort results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003cp\u003epaginate results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003enumber of entries per request\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/images/show","name":"show","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/images/:id","http_method":"GET","short_description":"Show an image","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/images/:id","http_method":"GET","short_description":"Show an image","deprecated":null},{"api_url":"/api/architectures/:architecture_id/images/:id","http_method":"GET","short_description":"Show an image","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"\n\u003cp\u003eID of compute resource\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"architecture_id","full_name":"architecture_id","description":"\n\u003cp\u003eID of architecture\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/images/create","name":"create","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/images","http_method":"POST","short_description":"Create an image","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"compute_resource_id","full_name":"compute_resource_id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"image","full_name":"image","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"image[name]","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"username","full_name":"image[username]","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"uuid","full_name":"image[uuid]","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"compute_resource_id","full_name":"image[compute_resource_id]","description":"\n\u003cp\u003eID of compute resource\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"architecture_id","full_name":"image[architecture_id]","description":"\n\u003cp\u003eID of architecture\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"operatingsystem_id","full_name":"image[operatingsystem_id]","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/images/update","name":"update","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/images/:id","http_method":"PUT","short_description":"Update an image","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"compute_resource_id","full_name":"compute_resource_id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"image","full_name":"image","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"image[name]","description":"","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"username","full_name":"image[username]","description":"","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"uuid","full_name":"image[uuid]","description":"","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"compute_resource_id","full_name":"image[compute_resource_id]","description":"\n\u003cp\u003eID of compute resource\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"architecture_id","full_name":"image[architecture_id]","description":"\n\u003cp\u003eID of architecture\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"operatingsystem_id","full_name":"image[operatingsystem_id]","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/images/destroy","name":"destroy","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/images/:id","http_method":"DELETE","short_description":"Delete an image","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"compute_resource_id","full_name":"compute_resource_id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null},"locations":{"doc_url":"../apidoc/v2/locations","api_url":"/api","name":"Locations","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/locations/index","name":"index","apis":[{"api_url":"/api/locations","http_method":"GET","short_description":"List all locations","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003cp\u003esort results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003cp\u003epaginate results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003enumber of entries per request\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/locations/show","name":"show","apis":[{"api_url":"/api/locations/:id","http_method":"GET","short_description":"Show a location","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/locations/create","name":"create","apis":[{"api_url":"/api/locations","http_method":"POST","short_description":"Create a location","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location","full_name":"location","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"location[name]","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"description","full_name":"location[description]","description":"","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"user_ids","full_name":"location[user_ids]","description":"\n\u003cp\u003eUser IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"smart_proxy_ids","full_name":"location[smart_proxy_ids]","description":"\n\u003cp\u003eSmart proxy IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"compute_resource_ids","full_name":"location[compute_resource_ids]","description":"\n\u003cp\u003eCompute resource IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"media_ids","full_name":"location[media_ids]","description":"\n\u003cp\u003eMedia IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"config_template_ids","full_name":"location[config_template_ids]","description":"\n\u003cp\u003eProvisioning template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"ptable_ids","full_name":"location[ptable_ids]","description":"\n\u003cp\u003ePartition template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"provisioning_template_ids","full_name":"location[provisioning_template_ids]","description":"\n\u003cp\u003eProvisioning template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"domain_ids","full_name":"location[domain_ids]","description":"\n\u003cp\u003eDomain IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"realm_ids","full_name":"location[realm_ids]","description":"\n\u003cp\u003eRealm IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"hostgroup_ids","full_name":"location[hostgroup_ids]","description":"\n\u003cp\u003eHost group IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"environment_ids","full_name":"location[environment_ids]","description":"\n\u003cp\u003eEnvironment IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"subnet_ids","full_name":"location[subnet_ids]","description":"\n\u003cp\u003eSubnet IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/locations/update","name":"update","apis":[{"api_url":"/api/locations/:id","http_method":"PUT","short_description":"Update a location","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location","full_name":"location","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"location[name]","description":"","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"description","full_name":"location[description]","description":"","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"user_ids","full_name":"location[user_ids]","description":"\n\u003cp\u003eUser IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"smart_proxy_ids","full_name":"location[smart_proxy_ids]","description":"\n\u003cp\u003eSmart proxy IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"compute_resource_ids","full_name":"location[compute_resource_ids]","description":"\n\u003cp\u003eCompute resource IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"media_ids","full_name":"location[media_ids]","description":"\n\u003cp\u003eMedia IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"config_template_ids","full_name":"location[config_template_ids]","description":"\n\u003cp\u003eProvisioning template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"ptable_ids","full_name":"location[ptable_ids]","description":"\n\u003cp\u003ePartition template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"provisioning_template_ids","full_name":"location[provisioning_template_ids]","description":"\n\u003cp\u003eProvisioning template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"domain_ids","full_name":"location[domain_ids]","description":"\n\u003cp\u003eDomain IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"realm_ids","full_name":"location[realm_ids]","description":"\n\u003cp\u003eRealm IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"hostgroup_ids","full_name":"location[hostgroup_ids]","description":"\n\u003cp\u003eHost group IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"environment_ids","full_name":"location[environment_ids]","description":"\n\u003cp\u003eEnvironment IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"subnet_ids","full_name":"location[subnet_ids]","description":"\n\u003cp\u003eSubnet IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/locations/destroy","name":"destroy","apis":[{"api_url":"/api/locations/:id","http_method":"DELETE","short_description":"Delete a location","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null},"mail_notifications":{"doc_url":"../apidoc/v2/mail_notifications","api_url":"/api","name":"Mail notifications","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/mail_notifications/index","name":"index","apis":[{"api_url":"/api/mail_notifications","http_method":"GET","short_description":"List of email notifications","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003cp\u003esort results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003cp\u003epaginate results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003enumber of entries per request\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/mail_notifications/show","name":"show","apis":[{"api_url":"/api/mail_notifications/:id","http_method":"GET","short_description":"Show an email notification","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eNumerical ID or email notification name\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null},"media":{"doc_url":"../apidoc/v2/media","api_url":"/api","name":"Media","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/media/index","name":"index","apis":[{"api_url":"/api/media","http_method":"GET","short_description":"List all installation media","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/media","http_method":"GET","short_description":"List all media for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/media","http_method":"GET","short_description":"List all media per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/media","http_method":"GET","short_description":"List all media per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003cp\u003esort results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003cp\u003epaginate results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003enumber of entries per request\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/media/show","name":"show","apis":[{"api_url":"/api/media/:id","http_method":"GET","short_description":"Show a medium","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/media/create","name":"create","apis":[{"api_url":"/api/media","http_method":"POST","short_description":"Create a medium","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"medium","full_name":"medium","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"medium[name]","description":"\n\u003cp\u003eName of media\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"path","full_name":"medium[path]","description":"\n\u003cp\u003eThe path to the medium, can be a URL or a valid NFS server (exclusive of the architecture).\u003c/p\u003e\n\n\u003cp\u003efor example http://mirror.centos.org/centos/$version/os/$arch where $arch will be substituted for the host’s actual OS architecture and $version, $major and $minor will be substituted for the version of the operating system.\u003c/p\u003e\n\n\u003cp\u003eSolaris and Debian media may also use $release.\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"os_family","full_name":"medium[os_family]","description":"\n\u003cp\u003eOperating system family, available values: AIX, Altlinux, Archlinux, Coreos, Debian, Freebsd, Gentoo, Junos, NXOS, Redhat, Solaris, Suse, Windows\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"operatingsystem_ids","full_name":"medium[operatingsystem_ids]","description":"","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"location_ids","full_name":"medium[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"organization_ids","full_name":"medium[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/media/update","name":"update","apis":[{"api_url":"/api/media/:id","http_method":"PUT","short_description":"Update a medium","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"medium","full_name":"medium","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"medium[name]","description":"\n\u003cp\u003eName of media\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"path","full_name":"medium[path]","description":"\n\u003cp\u003eThe path to the medium, can be a URL or a valid NFS server (exclusive of the architecture).\u003c/p\u003e\n\n\u003cp\u003efor example http://mirror.centos.org/centos/$version/os/$arch where $arch will be substituted for the host’s actual OS architecture and $version, $major and $minor will be substituted for the version of the operating system.\u003c/p\u003e\n\n\u003cp\u003eSolaris and Debian media may also use $release.\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"os_family","full_name":"medium[os_family]","description":"\n\u003cp\u003eOperating system family, available values: AIX, Altlinux, Archlinux, Coreos, Debian, Freebsd, Gentoo, Junos, NXOS, Redhat, Solaris, Suse, Windows\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"operatingsystem_ids","full_name":"medium[operatingsystem_ids]","description":"","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"location_ids","full_name":"medium[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"organization_ids","full_name":"medium[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/media/destroy","name":"destroy","apis":[{"api_url":"/api/media/:id","http_method":"DELETE","short_description":"Delete a medium","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null},"organizations":{"doc_url":"../apidoc/v2/organizations","api_url":"/api","name":"Organizations","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/organizations/index","name":"index","apis":[{"api_url":"/katello/api/organizations","http_method":"GET","short_description":"List all organizations","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘name DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"full_results","full_name":"full_results","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"sort","full_name":"sort","description":"\n\u003cp\u003eHash version of ‘order’ param\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"by","full_name":"sort[by]","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"sort[order]","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/organizations/show","name":"show","apis":[{"api_url":"/katello/api/organizations/:id","http_method":"GET","short_description":"Show organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eorganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/organizations/create","name":"create","apis":[{"api_url":"/katello/api/organizations","http_method":"POST","short_description":"Create organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n\u003cp\u003ename\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"label","full_name":"label","description":"\n\u003cp\u003eunique label\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"description","full_name":"description","description":"\n\u003cp\u003edescription\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"organization","full_name":"organization","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"organization[name]","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"description","full_name":"organization[description]","description":"","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"user_ids","full_name":"organization[user_ids]","description":"\n\u003cp\u003eUser IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"smart_proxy_ids","full_name":"organization[smart_proxy_ids]","description":"\n\u003cp\u003eSmart proxy IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"compute_resource_ids","full_name":"organization[compute_resource_ids]","description":"\n\u003cp\u003eCompute resource IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"media_ids","full_name":"organization[media_ids]","description":"\n\u003cp\u003eMedia IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"config_template_ids","full_name":"organization[config_template_ids]","description":"\n\u003cp\u003eProvisioning template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"ptable_ids","full_name":"organization[ptable_ids]","description":"\n\u003cp\u003ePartition template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"provisioning_template_ids","full_name":"organization[provisioning_template_ids]","description":"\n\u003cp\u003eProvisioning template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"domain_ids","full_name":"organization[domain_ids]","description":"\n\u003cp\u003eDomain IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"realm_ids","full_name":"organization[realm_ids]","description":"\n\u003cp\u003eRealm IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"hostgroup_ids","full_name":"organization[hostgroup_ids]","description":"\n\u003cp\u003eHost group IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"environment_ids","full_name":"organization[environment_ids]","description":"\n\u003cp\u003eEnvironment IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"subnet_ids","full_name":"organization[subnet_ids]","description":"\n\u003cp\u003eSubnet IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"label","full_name":"organization[label]","description":"","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/organizations/update","name":"update","apis":[{"api_url":"/katello/api/organizations/:id","http_method":"PUT","short_description":"Update organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eorganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"redhat_repository_url","full_name":"redhat_repository_url","description":"\n\u003cp\u003eRed Hat CDN URL\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"organization","full_name":"organization","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"organization[name]","description":"","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"description","full_name":"organization[description]","description":"","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"user_ids","full_name":"organization[user_ids]","description":"\n\u003cp\u003eUser IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"smart_proxy_ids","full_name":"organization[smart_proxy_ids]","description":"\n\u003cp\u003eSmart proxy IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"compute_resource_ids","full_name":"organization[compute_resource_ids]","description":"\n\u003cp\u003eCompute resource IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"media_ids","full_name":"organization[media_ids]","description":"\n\u003cp\u003eMedia IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"config_template_ids","full_name":"organization[config_template_ids]","description":"\n\u003cp\u003eProvisioning template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"ptable_ids","full_name":"organization[ptable_ids]","description":"\n\u003cp\u003ePartition template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"provisioning_template_ids","full_name":"organization[provisioning_template_ids]","description":"\n\u003cp\u003eProvisioning template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"domain_ids","full_name":"organization[domain_ids]","description":"\n\u003cp\u003eDomain IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"realm_ids","full_name":"organization[realm_ids]","description":"\n\u003cp\u003eRealm IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"hostgroup_ids","full_name":"organization[hostgroup_ids]","description":"\n\u003cp\u003eHost group IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"environment_ids","full_name":"organization[environment_ids]","description":"\n\u003cp\u003eEnvironment IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"subnet_ids","full_name":"organization[subnet_ids]","description":"\n\u003cp\u003eSubnet IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/organizations/destroy","name":"destroy","apis":[{"api_url":"/katello/api/organizations/:id","http_method":"DELETE","short_description":"Delete an organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/organizations/repo_discover","name":"repo_discover","apis":[{"api_url":"/katello/api/organizations/:id/repo_discover","http_method":"PUT","short_description":"Discover Repositories","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"url","full_name":"url","description":"\n\u003cp\u003ebase url to perform repo discovery on\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/organizations/cancel_repo_discover","name":"cancel_repo_discover","apis":[{"api_url":"/katello/api/organizations/:label/cancel_repo_discover","http_method":"PUT","short_description":"Cancel repository discovery","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"label","full_name":"label","description":"\n\u003cp\u003eOrganization label\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"url","full_name":"url","description":"\n\u003cp\u003ebase url to perform repo discovery on\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/organizations/download_debug_certificate","name":"download_debug_certificate","apis":[{"api_url":"/katello/api/organizations/:label/download_debug_certificate","http_method":"GET","short_description":"Download a debug certificate","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"label","full_name":"label","description":"\n\u003cp\u003eOrganization label\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/organizations/autoattach_subscriptions","name":"autoattach_subscriptions","apis":[{"api_url":"/katello/api/organizations/:id/autoattach_subscriptions","http_method":"POST","short_description":"Auto-attach available subscriptions to all systems within an organization. Asynchronous operation.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/organizations/redhat_provider","name":"redhat_provider","apis":[{"api_url":"/katello/api/organizations/:id/redhat_provider","http_method":"GET","short_description":"List all :resource_id","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[]},"os_default_templates":{"doc_url":"../apidoc/v2/os_default_templates","api_url":"/api","name":"Os default templates","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/os_default_templates/index","name":"index","apis":[{"api_url":"/api/operatingsystems/:operatingsystem_id/os_default_templates","http_method":"GET","short_description":"List default templates combinations for an operating system","deprecated":null},{"api_url":"/api/config_templates/:config_template_id/os_default_templates","http_method":"GET","short_description":"List operating systems where this template is set as a default","deprecated":null},{"api_url":"/api/provisioning_templates/:provisioning_template_id/os_default_templates","http_method":"GET","short_description":"List operating systems where this template is set as a default","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"config_template_id","full_name":"config_template_id","description":"\n\u003cp\u003eID of provisioning template\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"provisioning_template_id","full_name":"provisioning_template_id","description":"\n\u003cp\u003eID of provisioning template\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003cp\u003epaginate results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003enumber of entries per request\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/os_default_templates/show","name":"show","apis":[{"api_url":"/api/operatingsystems/:operatingsystem_id/os_default_templates/:id","http_method":"GET","short_description":"Show a default template combination for an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/os_default_templates/create","name":"create","apis":[{"api_url":"/api/operatingsystems/:operatingsystem_id/os_default_templates","http_method":"POST","short_description":"Create a default template combination for an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"os_default_template","full_name":"os_default_template","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"template_kind_id","full_name":"os_default_template[template_kind_id]","description":"","required":false,"allow_nil":true,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"config_template_id","full_name":"os_default_template[config_template_id]","description":"\n\u003cp\u003eID of provisioning template\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"provisioning_template_id","full_name":"os_default_template[provisioning_template_id]","description":"\n\u003cp\u003eID of provisioning template\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"number.","expected_type":"string","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/os_default_templates/update","name":"update","apis":[{"api_url":"/api/operatingsystems/:operatingsystem_id/os_default_templates/:id","http_method":"PUT","short_description":"Update a default template combination for an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"os_default_template","full_name":"os_default_template","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"template_kind_id","full_name":"os_default_template[template_kind_id]","description":"","required":false,"allow_nil":true,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"config_template_id","full_name":"os_default_template[config_template_id]","description":"\n\u003cp\u003eID of provisioning template\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"provisioning_template_id","full_name":"os_default_template[provisioning_template_id]","description":"\n\u003cp\u003eID of provisioning template\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"number.","expected_type":"string","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/os_default_templates/destroy","name":"destroy","apis":[{"api_url":"/api/operatingsystems/:operatingsystem_id/os_default_templates/:id","http_method":"DELETE","short_description":"Delete a default template combination for an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null},"override_values":{"doc_url":"../apidoc/v2/override_values","api_url":"/api","name":"Override values","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/override_values/index","name":"index","apis":[{"api_url":"/api/smart_variables/:smart_variable_id/override_values","http_method":"GET","short_description":"List of override values for a specific smart variable","deprecated":null},{"api_url":"/api/smart_class_parameters/:smart_class_parameter_id/override_values","http_method":"GET","short_description":"List of override values for a specific smart class parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"smart_variable_id","full_name":"smart_variable_id","description":"","required":false,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"smart_class_parameter_id","full_name":"smart_class_parameter_id","description":"","required":false,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003cp\u003epaginate results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003enumber of entries per request\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/override_values/show","name":"show","apis":[{"api_url":"/api/smart_variables/:smart_variable_id/override_values/:id","http_method":"GET","short_description":"Show an override value for a specific smart variable","deprecated":null},{"api_url":"/api/smart_class_parameters/:smart_class_parameter_id/override_values/:id","http_method":"GET","short_description":"Show an override value for a specific smart class parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"smart_variable_id","full_name":"smart_variable_id","description":"","required":false,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"smart_class_parameter_id","full_name":"smart_class_parameter_id","description":"","required":false,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/override_values/create","name":"create","apis":[{"api_url":"/api/smart_variables/:smart_variable_id/override_values","http_method":"POST","short_description":"Create an override value for a specific smart variable","deprecated":null},{"api_url":"/api/smart_class_parameters/:smart_class_parameter_id/override_values","http_method":"POST","short_description":"Create an override value for a specific smart class parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"smart_variable_id","full_name":"smart_variable_id","description":"","required":false,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"smart_class_parameter_id","full_name":"smart_class_parameter_id","description":"","required":false,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"override_value","full_name":"override_value","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"match","full_name":"override_value[match]","description":"\n\u003cp\u003eOverride match\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"value","full_name":"override_value[value]","description":"\n\u003cp\u003eOverride value\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"use_puppet_default","full_name":"override_value[use_puppet_default]","description":"","required":false,"allow_nil":true,"validator":"boolean","expected_type":"string","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/override_values/update","name":"update","apis":[{"api_url":"/api/smart_variables/:smart_variable_id/override_values/:id","http_method":"PUT","short_description":"Update an override value for a specific smart variable","deprecated":null},{"api_url":"/api/smart_class_parameters/:smart_class_parameter_id/override_values/:id","http_method":"PUT","short_description":"Update an override value for a specific smart class parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"smart_variable_id","full_name":"smart_variable_id","description":"","required":false,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"smart_class_parameter_id","full_name":"smart_class_parameter_id","description":"","required":false,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"override_value","full_name":"override_value","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"match","full_name":"override_value[match]","description":"\n\u003cp\u003eOverride match\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"value","full_name":"override_value[value]","description":"\n\u003cp\u003eOverride value\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"use_puppet_default","full_name":"override_value[use_puppet_default]","description":"","required":false,"allow_nil":true,"validator":"boolean","expected_type":"string","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/override_values/destroy","name":"destroy","apis":[{"api_url":"/api/smart_variables/:smart_variable_id/override_values/:id","http_method":"DELETE","short_description":"Delete an override value for a specific smart variable","deprecated":null},{"api_url":"/api/smart_class_parameters/:smart_class_parameter_id/override_values/:id","http_method":"DELETE","short_description":"Delete an override value for a specific smart class parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"smart_variable_id","full_name":"smart_variable_id","description":"","required":false,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"smart_class_parameter_id","full_name":"smart_class_parameter_id","description":"","required":false,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null},"permissions":{"doc_url":"../apidoc/v2/permissions","api_url":"/api","name":"Permissions","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/permissions/index","name":"index","apis":[{"api_url":"/api/permissions","http_method":"GET","short_description":"List all permissions","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003cp\u003esort results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003cp\u003epaginate results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003enumber of entries per request\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"resource_type","full_name":"resource_type","description":"","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"name","full_name":"name","description":"","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/permissions/show","name":"show","apis":[{"api_url":"/api/permissions/:id","http_method":"GET","short_description":"Show a permission","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/permissions/resource_types","name":"resource_types","apis":[{"api_url":"/api/permissions/resource_types","http_method":"GET","short_description":"List available resource types.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null},"plugins":{"doc_url":"../apidoc/v2/plugins","api_url":"/api","name":"Plugins","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/plugins/index","name":"index","apis":[{"api_url":"/api/plugins","http_method":"GET","short_description":"List installed plugins","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null},"ptables":{"doc_url":"../apidoc/v2/ptables","api_url":"/api","name":"Ptables","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/ptables/index","name":"index","apis":[{"api_url":"/api/ptables","http_method":"GET","short_description":"List all partition tables","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/ptables","http_method":"GET","short_description":"List all partition tables for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/ptables","http_method":"GET","short_description":"List all partition tables per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/ptables","http_method":"GET","short_description":"List all partition tables per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003cp\u003esort results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003cp\u003epaginate results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003enumber of entries per request\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ptables/show","name":"show","apis":[{"api_url":"/api/ptables/:id","http_method":"GET","short_description":"Show a partition table","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ptables/create","name":"create","apis":[{"api_url":"/api/ptables","http_method":"POST","short_description":"Create a partition table","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ptable","full_name":"ptable","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"ptable[name]","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"layout","full_name":"ptable[layout]","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"snippet","full_name":"ptable[snippet]","description":"","required":false,"allow_nil":true,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"audit_comment","full_name":"ptable[audit_comment]","description":"","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"locked","full_name":"ptable[locked]","description":"\n\u003cp\u003eWhether or not the template is locked for editing\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"os_family","full_name":"ptable[os_family]","description":"","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"operatingsystem_ids","full_name":"ptable[operatingsystem_ids]","description":"\n\u003cp\u003eArray of operating system IDs to associate with the partition table\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"host_ids","full_name":"ptable[host_ids]","description":"\n\u003cp\u003eArray of host IDs to associate with the partition table\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"hostgroup_ids","full_name":"ptable[hostgroup_ids]","description":"\n\u003cp\u003eArray of host group IDs to associate with the partition table\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"location_ids","full_name":"ptable[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"organization_ids","full_name":"ptable[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ptables/revision","name":"revision","apis":[{"api_url":"/api/ptables/revision","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"version","full_name":"version","description":"\n\u003cp\u003etemplate version\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ptables/update","name":"update","apis":[{"api_url":"/api/ptables/:id","http_method":"PUT","short_description":"Update a partition table","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"ptable","full_name":"ptable","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"ptable[name]","description":"","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"layout","full_name":"ptable[layout]","description":"","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"snippet","full_name":"ptable[snippet]","description":"","required":false,"allow_nil":true,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"audit_comment","full_name":"ptable[audit_comment]","description":"","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"locked","full_name":"ptable[locked]","description":"\n\u003cp\u003eWhether or not the template is locked for editing\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"os_family","full_name":"ptable[os_family]","description":"","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"operatingsystem_ids","full_name":"ptable[operatingsystem_ids]","description":"\n\u003cp\u003eArray of operating system IDs to associate with the partition table\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"host_ids","full_name":"ptable[host_ids]","description":"\n\u003cp\u003eArray of host IDs to associate with the partition table\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"hostgroup_ids","full_name":"ptable[hostgroup_ids]","description":"\n\u003cp\u003eArray of host group IDs to associate with the partition table\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"location_ids","full_name":"ptable[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"organization_ids","full_name":"ptable[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ptables/destroy","name":"destroy","apis":[{"api_url":"/api/ptables/:id","http_method":"DELETE","short_description":"Delete a partition table","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ptables/clone","name":"clone","apis":[{"api_url":"/api/ptables/:id/clone","http_method":"POST","short_description":"Clone a template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"ptable","full_name":"ptable","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"ptable[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null},"puppetclasses":{"doc_url":"../apidoc/v2/puppetclasses","api_url":"/api","name":"Puppetclasses","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/puppetclasses/index","name":"index","apis":[{"api_url":"/api/puppetclasses","http_method":"GET","short_description":"List all Puppet classes","deprecated":null},{"api_url":"/api/hosts/:host_id/puppetclasses","http_method":"GET","short_description":"List all Puppet classes for a host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/puppetclasses","http_method":"GET","short_description":"List all Puppet classes for a host group","deprecated":null},{"api_url":"/api/environments/:environment_id/puppetclasses","http_method":"GET","short_description":"List all Puppet classes for an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eID of environment\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003cp\u003esort results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003cp\u003epaginate results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003enumber of entries per request\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/puppetclasses/show","name":"show","apis":[{"api_url":"/api/puppetclasses/:id","http_method":"GET","short_description":"Show a Puppet class","deprecated":null},{"api_url":"/api/hosts/:host_id/puppetclasses/:id","http_method":"GET","short_description":"Show a Puppet class for host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/puppetclasses/:id","http_method":"GET","short_description":"Show a Puppet class for a host group","deprecated":null},{"api_url":"/api/environments/:environment_id/puppetclasses/:id","http_method":"GET","short_description":"Show a Puppet class for an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eID of environment\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of Puppet class\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/puppetclasses/create","name":"create","apis":[{"api_url":"/api/puppetclasses","http_method":"POST","short_description":"Create a Puppet class","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"puppetclass","full_name":"puppetclass","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"puppetclass[name]","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/puppetclasses/update","name":"update","apis":[{"api_url":"/api/puppetclasses/:id","http_method":"PUT","short_description":"Update a Puppet class","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"puppetclass","full_name":"puppetclass","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"puppetclass[name]","description":"","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/puppetclasses/destroy","name":"destroy","apis":[{"api_url":"/api/puppetclasses/:id","http_method":"DELETE","short_description":"Delete a Puppet class","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null},"realms":{"doc_url":"../apidoc/v2/realms","api_url":"/api","name":"Realms","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/realms/index","name":"index","apis":[{"api_url":"/api/realms","http_method":"GET","short_description":"List of realms","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003cp\u003esort results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003cp\u003epaginate results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003enumber of entries per request\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/realms/show","name":"show","apis":[{"api_url":"/api/realms/:id","http_method":"GET","short_description":"Show a realm","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eNumerical ID or realm name\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/realms/create","name":"create","apis":[{"api_url":"/api/realms","http_method":"POST","short_description":"Create a realm","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eThe \u003cb\u003ename\u003c/b\u003e field is used for the name of the realm.\u003c/p\u003e\n","errors":[],"params":[{"name":"realm","full_name":"realm","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"realm[name]","description":"\n\u003cp\u003eThe realm name, e.g. EXAMPLE.COM\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"realm_proxy_id","full_name":"realm[realm_proxy_id]","description":"\n\u003cp\u003eProxy to use for this realm\u003c/p\u003e\n","required":true,"allow_nil":true,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"realm_type","full_name":"realm[realm_type]","description":"\n\u003cp\u003eRealm type, e.g. FreeIPA or Active Directory\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"location_ids","full_name":"realm[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"organization_ids","full_name":"realm[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/realms/update","name":"update","apis":[{"api_url":"/api/realms/:id","http_method":"PUT","short_description":"Update a realm","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"realm","full_name":"realm","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"realm[name]","description":"\n\u003cp\u003eThe realm name, e.g. EXAMPLE.COM\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"realm_proxy_id","full_name":"realm[realm_proxy_id]","description":"\n\u003cp\u003eProxy to use for this realm\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"realm_type","full_name":"realm[realm_type]","description":"\n\u003cp\u003eRealm type, e.g. FreeIPA or Active Directory\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"location_ids","full_name":"realm[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"organization_ids","full_name":"realm[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/realms/destroy","name":"destroy","apis":[{"api_url":"/api/realms/:id","http_method":"DELETE","short_description":"Delete a realm","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null},"roles":{"doc_url":"../apidoc/v2/roles","api_url":"/api","name":"Roles","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/roles/index","name":"index","apis":[{"api_url":"/api/roles","http_method":"GET","short_description":"List all roles","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003cp\u003esort results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003cp\u003epaginate results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003enumber of entries per request\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/roles/show","name":"show","apis":[{"api_url":"/api/roles/:id","http_method":"GET","short_description":"Show a role","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/roles/create","name":"create","apis":[{"api_url":"/api/roles","http_method":"POST","short_description":"Create a role","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"role","full_name":"role","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"role[name]","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/roles/update","name":"update","apis":[{"api_url":"/api/roles/:id","http_method":"PUT","short_description":"Update a role","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"role","full_name":"role","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"role[name]","description":"","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/roles/destroy","name":"destroy","apis":[{"api_url":"/api/roles/:id","http_method":"DELETE","short_description":"Delete a role","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null},"settings":{"doc_url":"../apidoc/v2/settings","api_url":"/api","name":"Settings","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/settings/index","name":"index","apis":[{"api_url":"/api/settings","http_method":"GET","short_description":"List all settings","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003cp\u003esort results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003cp\u003epaginate results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003enumber of entries per request\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/settings/show","name":"show","apis":[{"api_url":"/api/settings/:id","http_method":"GET","short_description":"Show a setting","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/settings/update","name":"update","apis":[{"api_url":"/api/settings/:id","http_method":"PUT","short_description":"Update a setting","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"setting","full_name":"setting","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"value","full_name":"setting[value]","description":"","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null},"smart_class_parameters":{"doc_url":"../apidoc/v2/smart_class_parameters","api_url":"/api","name":"Smart class parameters","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/smart_class_parameters/index","name":"index","apis":[{"api_url":"/api/smart_class_parameters","http_method":"GET","short_description":"List all smart class parameters","deprecated":null},{"api_url":"/api/hosts/:host_id/smart_class_parameters","http_method":"GET","short_description":"List of smart class parameters for a specific host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/smart_class_parameters","http_method":"GET","short_description":"List of smart class parameters for a specific host group","deprecated":null},{"api_url":"/api/puppetclasses/:puppetclass_id/smart_class_parameters","http_method":"GET","short_description":"List of smart class parameters for a specific Puppet class","deprecated":null},{"api_url":"/api/environments/:environment_id/smart_class_parameters","http_method":"GET","short_description":"List of smart class parameters for a specific environment","deprecated":null},{"api_url":"/api/environments/:environment_id/puppetclasses/:puppetclass_id/smart_class_parameters","http_method":"GET","short_description":"List of smart class parameters for a specific environment/Puppet class combination","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"","required":false,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"","required":false,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"puppetclass_id","full_name":"puppetclass_id","description":"","required":false,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"environment_id","full_name":"environment_id","description":"","required":false,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003cp\u003esort results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003cp\u003epaginate results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003enumber of entries per request\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/smart_class_parameters/show","name":"show","apis":[{"api_url":"/api/smart_class_parameters/:id","http_method":"GET","short_description":"Show a smart class parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/smart_class_parameters/update","name":"update","apis":[{"api_url":"/api/smart_class_parameters/:id","http_method":"PUT","short_description":"Update a smart class parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"smart_class_parameter","full_name":"smart_class_parameter","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"override","full_name":"smart_class_parameter[override]","description":"\n\u003cp\u003eWhether the smart class parameter value is managed by Foreman\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"description","full_name":"smart_class_parameter[description]","description":"\n\u003cp\u003eDescription of smart class\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"default_value","full_name":"smart_class_parameter[default_value]","description":"\n\u003cp\u003eValue to use when there is no match\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"hidden_value","full_name":"smart_class_parameter[hidden_value]","description":"\n\u003cp\u003eWhen enabled the parameter is hidden in the UI\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"use_puppet_default","full_name":"smart_class_parameter[use_puppet_default]","description":"\n\u003cp\u003eDo not send this parameter via the ENC. Puppet will use the value defined in the Puppet manifest for this parameter\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"path","full_name":"smart_class_parameter[path]","description":"\n\u003cp\u003eThe order in which values are resolved\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"validator_type","full_name":"smart_class_parameter[validator_type]","description":"\n\u003cp\u003eTypes of validation values\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Must be one of: regexp, list.","expected_type":"string","metadata":null,"show":true},{"name":"validator_rule","full_name":"smart_class_parameter[validator_rule]","description":"\n\u003cp\u003eUsed to enforce certain values for the parameter values\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"override_value_order","full_name":"smart_class_parameter[override_value_order]","description":"\n\u003cp\u003eThe order in which values are resolved\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"parameter_type","full_name":"smart_class_parameter[parameter_type]","description":"\n\u003cp\u003eTypes of variable values\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Must be one of: string, boolean, integer, real, array, hash, yaml, json.","expected_type":"string","metadata":null,"show":true},{"name":"required","full_name":"smart_class_parameter[required]","description":"\n\u003cp\u003eIf true, will raise an error if there is no default value and no matcher provide a value\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"merge_overrides","full_name":"smart_class_parameter[merge_overrides]","description":"\n\u003cp\u003eMerge all matching values (only array/hash type)\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"merge_default","full_name":"smart_class_parameter[merge_default]","description":"\n\u003cp\u003eInclude default value when merging all matching values\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"avoid_duplicates","full_name":"smart_class_parameter[avoid_duplicates]","description":"\n\u003cp\u003eRemove duplicate values (only array type)\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null},"smart_variables":{"doc_url":"../apidoc/v2/smart_variables","api_url":"/api","name":"Smart variables","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/smart_variables/index","name":"index","apis":[{"api_url":"/api/smart_variables","http_method":"GET","short_description":"List all smart variables","deprecated":null},{"api_url":"/api/hosts/:host_id/smart_variables","http_method":"GET","short_description":"List of smart variables for a specific host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/smart_variables","http_method":"GET","short_description":"List of smart variables for a specific host group","deprecated":null},{"api_url":"/api/puppetclasses/:puppetclass_id/smart_variables","http_method":"GET","short_description":"List of smart variables for a specific Puppet class","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"","required":false,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"","required":false,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"puppetclass_id","full_name":"puppetclass_id","description":"","required":false,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003cp\u003esort results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003cp\u003epaginate results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003enumber of entries per request\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/smart_variables/show","name":"show","apis":[{"api_url":"/api/smart_variables/:id","http_method":"GET","short_description":"Show a smart variable","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/smart_variables/create","name":"create","apis":[{"api_url":"/api/smart_variables","http_method":"POST","short_description":"Create a smart variable","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"smart_variable","full_name":"smart_variable","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"variable","full_name":"smart_variable[variable]","description":"\n\u003cp\u003eName of variable\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"puppetclass_id","full_name":"smart_variable[puppetclass_id]","description":"\n\u003cp\u003ePuppet class ID\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"default_value","full_name":"smart_variable[default_value]","description":"\n\u003cp\u003eDefault value of variable\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"hidden_value","full_name":"smart_variable[hidden_value]","description":"\n\u003cp\u003eWhen enabled the parameter is hidden in the UI\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"override_value_order","full_name":"smart_variable[override_value_order]","description":"\n\u003cp\u003eThe order in which values are resolved\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"description","full_name":"smart_variable[description]","description":"\n\u003cp\u003eDescription of variable\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"validator_type","full_name":"smart_variable[validator_type]","description":"\n\u003cp\u003eTypes of validation values\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be one of: regexp, list.","expected_type":"string","metadata":null,"show":true},{"name":"validator_rule","full_name":"smart_variable[validator_rule]","description":"\n\u003cp\u003eUsed to enforce certain values for the parameter values\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"variable_type","full_name":"smart_variable[variable_type]","description":"\n\u003cp\u003eTypes of variable values\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be one of: string, boolean, integer, real, array, hash, yaml, json.","expected_type":"string","metadata":null,"show":true},{"name":"merge_overrides","full_name":"smart_variable[merge_overrides]","description":"\n\u003cp\u003eMerge all matching values (only array/hash type)\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"merge_default","full_name":"smart_variable[merge_default]","description":"\n\u003cp\u003eInclude default value when merging all matching values\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"avoid_duplicates","full_name":"smart_variable[avoid_duplicates]","description":"\n\u003cp\u003eRemove duplicate values (only array type)\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"boolean","expected_type":"string","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/smart_variables/update","name":"update","apis":[{"api_url":"/api/smart_variables/:id","http_method":"PUT","short_description":"Update a smart variable","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"smart_variable","full_name":"smart_variable","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"variable","full_name":"smart_variable[variable]","description":"\n\u003cp\u003eName of variable\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"puppetclass_id","full_name":"smart_variable[puppetclass_id]","description":"\n\u003cp\u003ePuppet class ID\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"default_value","full_name":"smart_variable[default_value]","description":"\n\u003cp\u003eDefault value of variable\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"hidden_value","full_name":"smart_variable[hidden_value]","description":"\n\u003cp\u003eWhen enabled the parameter is hidden in the UI\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"override_value_order","full_name":"smart_variable[override_value_order]","description":"\n\u003cp\u003eThe order in which values are resolved\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"description","full_name":"smart_variable[description]","description":"\n\u003cp\u003eDescription of variable\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"validator_type","full_name":"smart_variable[validator_type]","description":"\n\u003cp\u003eTypes of validation values\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be one of: regexp, list.","expected_type":"string","metadata":null,"show":true},{"name":"validator_rule","full_name":"smart_variable[validator_rule]","description":"\n\u003cp\u003eUsed to enforce certain values for the parameter values\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"variable_type","full_name":"smart_variable[variable_type]","description":"\n\u003cp\u003eTypes of variable values\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be one of: string, boolean, integer, real, array, hash, yaml, json.","expected_type":"string","metadata":null,"show":true},{"name":"merge_overrides","full_name":"smart_variable[merge_overrides]","description":"\n\u003cp\u003eMerge all matching values (only array/hash type)\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"merge_default","full_name":"smart_variable[merge_default]","description":"\n\u003cp\u003eInclude default value when merging all matching values\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"avoid_duplicates","full_name":"smart_variable[avoid_duplicates]","description":"\n\u003cp\u003eRemove duplicate values (only array type)\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"boolean","expected_type":"string","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/smart_variables/destroy","name":"destroy","apis":[{"api_url":"/api/smart_variables/:id","http_method":"DELETE","short_description":"Delete a smart variable","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null},"statistics":{"doc_url":"../apidoc/v2/statistics","api_url":"/api","name":"Statistics","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/statistics/index","name":"index","apis":[{"api_url":"/api/statistics","http_method":"GET","short_description":"Get statistics","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null},"subnets":{"doc_url":"../apidoc/v2/subnets","api_url":"/api","name":"Subnets","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/subnets/index","name":"index","apis":[{"api_url":"/api/subnets","http_method":"GET","short_description":"List of subnets","deprecated":null},{"api_url":"/api/domains/:domain_id/subnets","http_method":"GET","short_description":"List of subnets for a domain","deprecated":null},{"api_url":"/api/locations/:location_id/subnets","http_method":"GET","short_description":"List of subnets per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/subnets","http_method":"GET","short_description":"List of subnets per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003cp\u003esort results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003cp\u003epaginate results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003enumber of entries per request\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/subnets/show","name":"show","apis":[{"api_url":"/api/subnets/:id","http_method":"GET","short_description":"Show a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/subnets/create","name":"create","apis":[{"api_url":"/api/subnets","http_method":"POST","short_description":"Create a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"subnet","full_name":"subnet","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"subnet[name]","description":"\n\u003cp\u003eSubnet name\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"network","full_name":"subnet[network]","description":"\n\u003cp\u003eSubnet network\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"mask","full_name":"subnet[mask]","description":"\n\u003cp\u003eNetmask for this subnet\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"gateway","full_name":"subnet[gateway]","description":"\n\u003cp\u003ePrimary DNS for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"dns_primary","full_name":"subnet[dns_primary]","description":"\n\u003cp\u003ePrimary DNS for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"dns_secondary","full_name":"subnet[dns_secondary]","description":"\n\u003cp\u003eSecondary DNS for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"ipam","full_name":"subnet[ipam]","description":"\n\u003cp\u003eIP Address auto suggestion mode for this subnet, valid values are “DHCP”, “Internal DB”, “None”\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"from","full_name":"subnet[from]","description":"\n\u003cp\u003eStarting IP Address for IP auto suggestion\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"to","full_name":"subnet[to]","description":"\n\u003cp\u003eEnding IP Address for IP auto suggestion\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"vlanid","full_name":"subnet[vlanid]","description":"\n\u003cp\u003eVLAN ID for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"domain_ids","full_name":"subnet[domain_ids]","description":"\n\u003cp\u003eDomains in which this subnet is part\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"dhcp_id","full_name":"subnet[dhcp_id]","description":"\n\u003cp\u003eDHCP Proxy to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"tftp_id","full_name":"subnet[tftp_id]","description":"\n\u003cp\u003eTFTP Proxy to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"dns_id","full_name":"subnet[dns_id]","description":"\n\u003cp\u003eDNS Proxy to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"boot_mode","full_name":"subnet[boot_mode]","description":"\n\u003cp\u003eDefault boot mode for interfaces assigned to this subnet, valid values are “Static”, “DHCP”\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"location_ids","full_name":"subnet[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"organization_ids","full_name":"subnet[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/subnets/update","name":"update","apis":[{"api_url":"/api/subnets/:id","http_method":"PUT","short_description":"Update a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eSubnet numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"subnet","full_name":"subnet","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"subnet[name]","description":"\n\u003cp\u003eSubnet name\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"network","full_name":"subnet[network]","description":"\n\u003cp\u003eSubnet network\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"mask","full_name":"subnet[mask]","description":"\n\u003cp\u003eNetmask for this subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"gateway","full_name":"subnet[gateway]","description":"\n\u003cp\u003ePrimary DNS for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"dns_primary","full_name":"subnet[dns_primary]","description":"\n\u003cp\u003ePrimary DNS for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"dns_secondary","full_name":"subnet[dns_secondary]","description":"\n\u003cp\u003eSecondary DNS for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"ipam","full_name":"subnet[ipam]","description":"\n\u003cp\u003eIP Address auto suggestion mode for this subnet, valid values are “DHCP”, “Internal DB”, “None”\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"from","full_name":"subnet[from]","description":"\n\u003cp\u003eStarting IP Address for IP auto suggestion\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"to","full_name":"subnet[to]","description":"\n\u003cp\u003eEnding IP Address for IP auto suggestion\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"vlanid","full_name":"subnet[vlanid]","description":"\n\u003cp\u003eVLAN ID for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"domain_ids","full_name":"subnet[domain_ids]","description":"\n\u003cp\u003eDomains in which this subnet is part\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"dhcp_id","full_name":"subnet[dhcp_id]","description":"\n\u003cp\u003eDHCP Proxy to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"tftp_id","full_name":"subnet[tftp_id]","description":"\n\u003cp\u003eTFTP Proxy to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"dns_id","full_name":"subnet[dns_id]","description":"\n\u003cp\u003eDNS Proxy to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"boot_mode","full_name":"subnet[boot_mode]","description":"\n\u003cp\u003eDefault boot mode for interfaces assigned to this subnet, valid values are “Static”, “DHCP”\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"location_ids","full_name":"subnet[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"organization_ids","full_name":"subnet[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/subnets/destroy","name":"destroy","apis":[{"api_url":"/api/subnets/:id","http_method":"DELETE","short_description":"Delete a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eSubnet numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null},"tasks":{"doc_url":"../apidoc/v2/tasks","api_url":"/api","name":"Tasks","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/tasks/index","name":"index","apis":[{"api_url":"/api/orchestration/:id/tasks","http_method":"GET","short_description":"List all tasks for a given orchestration event","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null},"template_combinations":{"doc_url":"../apidoc/v2/template_combinations","api_url":"/api","name":"Template combinations","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/template_combinations/index","name":"index","apis":[{"api_url":"/api/config_templates/:config_template_id/template_combinations","http_method":"GET","short_description":"List template combination","deprecated":true},{"api_url":"/api/provisioning_templates/:provisioning_template_id/template_combinations","http_method":"GET","short_description":"List template combination","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/template_combinations","http_method":"GET","short_description":"List template combination","deprecated":null},{"api_url":"/api/environments/:environment_id/template_combinations","http_method":"GET","short_description":"List template combination","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"config_template_id","full_name":"config_template_id","description":"\n\u003cp\u003eID of config template\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"provisioning_template_id","full_name":"provisioning_template_id","description":"\n\u003cp\u003eID of config template\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eID of environment\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/template_combinations/create","name":"create","apis":[{"api_url":"/api/config_templates/:config_template_id/template_combinations","http_method":"POST","short_description":"Add a template combination","deprecated":true},{"api_url":"/api/provisioning_templates/:provisioning_template_id/template_combinations","http_method":"POST","short_description":"Add a template combination","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/template_combinations","http_method":"POST","short_description":"Add a template combination","deprecated":null},{"api_url":"/api/environments/:environment_id/template_combinations","http_method":"POST","short_description":"Add a template combination","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"config_template_id","full_name":"config_template_id","description":"\n\u003cp\u003eID of config template\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"provisioning_template_id","full_name":"provisioning_template_id","description":"\n\u003cp\u003eID of config template\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eID of environment\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"template_combination","full_name":"template_combination","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"environment_id","full_name":"template_combination[environment_id]","description":"\n\u003cp\u003eenvironment id\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"hostgroup_id","full_name":"template_combination[hostgroup_id]","description":"\n\u003cp\u003ehost group id\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"number.","expected_type":"string","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/template_combinations/show","name":"show","apis":[{"api_url":"/api/template_combinations/:id","http_method":"GET","short_description":"Show template combination","deprecated":null},{"api_url":"/api/config_templates/:config_template_id/template_combinations/:id","http_method":"GET","short_description":"Show template combination","deprecated":true},{"api_url":"/api/provisioning_templates/:provisioning_template_id/template_combinations/:id","http_method":"GET","short_description":"Show template combination","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/template_combinations/:id","http_method":"GET","short_description":"Show template combination","deprecated":null},{"api_url":"/api/environments/:environment_id/template_combinations/:id","http_method":"GET","short_description":"Show template combination","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"config_template_id","full_name":"config_template_id","description":"\n\u003cp\u003eID of config template\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"provisioning_template_id","full_name":"provisioning_template_id","description":"\n\u003cp\u003eID of config template\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eID of environment\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/template_combinations/update","name":"update","apis":[{"api_url":"/api/provisioning_templates/:provisioning_template_id/template_combinations/:id","http_method":"PUT","short_description":"Update template combination","deprecated":null},{"api_url":"/api/config_templates/:config_template_id/template_combinations/:id","http_method":"PUT","short_description":"Update template combination","deprecated":true},{"api_url":"/api/hostgroups/:hostgroup_id/template_combinations/:id","http_method":"PUT","short_description":"Update template combination","deprecated":null},{"api_url":"/api/environments/:environment_id/template_combinations/:id","http_method":"PUT","short_description":"Update template combination","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"config_template_id","full_name":"config_template_id","description":"\n\u003cp\u003eID of config template\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"provisioning_template_id","full_name":"provisioning_template_id","description":"\n\u003cp\u003eID of config template\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eID of environment\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"template_combination","full_name":"template_combination","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"environment_id","full_name":"template_combination[environment_id]","description":"\n\u003cp\u003eenvironment id\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"hostgroup_id","full_name":"template_combination[hostgroup_id]","description":"\n\u003cp\u003ehost group id\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"number.","expected_type":"string","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/template_combinations/destroy","name":"destroy","apis":[{"api_url":"/api/template_combinations/:id","http_method":"DELETE","short_description":"Delete a template combination","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null},"template_kinds":{"doc_url":"../apidoc/v2/template_kinds","api_url":"/api","name":"Template kinds","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/template_kinds/index","name":"index","apis":[{"api_url":"/api/template_kinds","http_method":"GET","short_description":"List all template kinds","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003cp\u003esort results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003cp\u003epaginate results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003enumber of entries per request\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null},"usergroups":{"doc_url":"../apidoc/v2/usergroups","api_url":"/api","name":"Usergroups","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/usergroups/index","name":"index","apis":[{"api_url":"/api/usergroups","http_method":"GET","short_description":"List all user groups","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003cp\u003esort results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003cp\u003epaginate results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003enumber of entries per request\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/usergroups/show","name":"show","apis":[{"api_url":"/api/usergroups/:id","http_method":"GET","short_description":"Show a user group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/usergroups/create","name":"create","apis":[{"api_url":"/api/usergroups","http_method":"POST","short_description":"Create a user group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"usergroup","full_name":"usergroup","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"usergroup[name]","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"user_ids","full_name":"usergroup[user_ids]","description":"","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"usergroup_ids","full_name":"usergroup[usergroup_ids]","description":"","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"role_ids","full_name":"usergroup[role_ids]","description":"","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/usergroups/update","name":"update","apis":[{"api_url":"/api/usergroups/:id","http_method":"PUT","short_description":"Update a user group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"usergroup","full_name":"usergroup","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"usergroup[name]","description":"","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"user_ids","full_name":"usergroup[user_ids]","description":"","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"usergroup_ids","full_name":"usergroup[usergroup_ids]","description":"","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"role_ids","full_name":"usergroup[role_ids]","description":"","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/usergroups/destroy","name":"destroy","apis":[{"api_url":"/api/usergroups/:id","http_method":"DELETE","short_description":"Delete a user group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null},"users":{"doc_url":"../apidoc/v2/users","api_url":"/api","name":"Users","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/users/index","name":"index","apis":[{"api_url":"/api/users","http_method":"GET","short_description":"List all users","deprecated":null},{"api_url":"/api/auth_source_ldaps/:auth_source_ldap_id/users","http_method":"GET","short_description":"List all users for LDAP authentication source","deprecated":null},{"api_url":"/api/usergroups/:usergroup_id/users","http_method":"GET","short_description":"List all users for user group","deprecated":null},{"api_url":"/api/roles/:role_id/users","http_method":"GET","short_description":"List all users for role","deprecated":null},{"api_url":"/api/locations/:location_id/users","http_method":"GET","short_description":"List all users for location","deprecated":null},{"api_url":"/api/organizations/:organization_id/users","http_method":"GET","short_description":"List all users for organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"auth_source_ldap_id","full_name":"auth_source_ldap_id","description":"\n\u003cp\u003eID of LDAP authentication source\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"usergroup_id","full_name":"usergroup_id","description":"\n\u003cp\u003eID of user group\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"role_id","full_name":"role_id","description":"\n\u003cp\u003eID of role\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003cp\u003esort results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003cp\u003epaginate results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003enumber of entries per request\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/users/show","name":"show","apis":[{"api_url":"/api/users/:id","http_method":"GET","short_description":"Show a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/users/create","name":"create","apis":[{"api_url":"/api/users","http_method":"POST","short_description":"Create a user","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eAdds role ‘Anonymous’ to the user by default\u003c/p\u003e\n","errors":[],"params":[{"name":"user","full_name":"user","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"login","full_name":"user[login]","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"firstname","full_name":"user[firstname]","description":"","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"lastname","full_name":"user[lastname]","description":"","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"mail","full_name":"user[mail]","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"admin","full_name":"user[admin]","description":"\n\u003cp\u003eis an admin account\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"password","full_name":"user[password]","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"default_location_id","full_name":"user[default_location_id]","description":"","required":false,"allow_nil":true,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"default_organization_id","full_name":"user[default_organization_id]","description":"","required":false,"allow_nil":true,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"auth_source_id","full_name":"user[auth_source_id]","description":"","required":true,"allow_nil":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"timezone","full_name":"user[timezone]","description":"\n\u003cp\u003eUser’s timezone\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be one of: UTC, International Date Line West, Midway Island, American Samoa, Hawaii, Alaska, Pacific Time (US \u0026 Canada), Tijuana, Mountain Time (US \u0026 Canada), Arizona, Chihuahua, Mazatlan, Central Time (US \u0026 Canada), Saskatchewan, Guadalajara, Mexico City, Monterrey, Central America, Eastern Time (US \u0026 Canada), Indiana (East), Bogota, Lima, Quito, Atlantic Time (Canada), Caracas, La Paz, Santiago, Newfoundland, Brasilia, Buenos Aires, Montevideo, Georgetown, Greenland, Mid-Atlantic, Azores, Cape Verde Is., Dublin, Edinburgh, Lisbon, London, Casablanca, Monrovia, Belgrade, Bratislava, Budapest, Ljubljana, Prague, Sarajevo, Skopje, Warsaw, Zagreb, Brussels, Copenhagen, Madrid, Paris, Amsterdam, Berlin, Bern, Rome, Stockholm, Vienna, West Central Africa, Bucharest, Cairo, Helsinki, Kyiv, Riga, Sofia, Tallinn, Vilnius, Athens, Istanbul, Minsk, Jerusalem, Harare, Pretoria, Moscow, St. Petersburg, Volgograd, Kuwait, Riyadh, Nairobi, Baghdad, Tehran, Abu Dhabi, Muscat, Baku, Tbilisi, Yerevan, Kabul, Ekaterinburg, Islamabad, Karachi, Tashkent, Chennai, Kolkata, Mumbai, New Delhi, Kathmandu, Astana, Dhaka, Sri Jayawardenepura, Almaty, Novosibirsk, Rangoon, Bangkok, Hanoi, Jakarta, Krasnoyarsk, Beijing, Chongqing, Hong Kong, Urumqi, Kuala Lumpur, Singapore, Taipei, Perth, Irkutsk, Ulaanbaatar, Seoul, Osaka, Sapporo, Tokyo, Yakutsk, Darwin, Adelaide, Canberra, Melbourne, Sydney, Brisbane, Hobart, Vladivostok, Guam, Port Moresby, Magadan, Solomon Is., New Caledonia, Fiji, Kamchatka, Marshall Is., Auckland, Wellington, Nuku'alofa, Tokelau Is., Chatham Is., Samoa.","expected_type":"string","metadata":null,"show":true},{"name":"locale","full_name":"user[locale]","description":"\n\u003cp\u003eUser’s preferred locale\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be one of: de, en, en_GB, es, fr, ja, ca, gl, it, ko, pt_BR, ru, sv_SE, zh_CN, zh_TW.","expected_type":"string","metadata":null,"show":true},{"name":"location_ids","full_name":"user[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"organization_ids","full_name":"user[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/users/update","name":"update","apis":[{"api_url":"/api/users/:id","http_method":"PUT","short_description":"Update a user","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eAdds role ‘Anonymous’ to the user if it is not already present. Only another admin can change the admin account attribute.\u003c/p\u003e\n","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"user","full_name":"user","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"login","full_name":"user[login]","description":"","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"firstname","full_name":"user[firstname]","description":"","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"lastname","full_name":"user[lastname]","description":"","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"mail","full_name":"user[mail]","description":"","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"admin","full_name":"user[admin]","description":"\n\u003cp\u003eis an admin account\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"password","full_name":"user[password]","description":"","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"default_location_id","full_name":"user[default_location_id]","description":"","required":false,"allow_nil":true,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"default_organization_id","full_name":"user[default_organization_id]","description":"","required":false,"allow_nil":true,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"auth_source_id","full_name":"user[auth_source_id]","description":"","required":false,"allow_nil":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"timezone","full_name":"user[timezone]","description":"\n\u003cp\u003eUser’s timezone\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be one of: UTC, International Date Line West, Midway Island, American Samoa, Hawaii, Alaska, Pacific Time (US \u0026 Canada), Tijuana, Mountain Time (US \u0026 Canada), Arizona, Chihuahua, Mazatlan, Central Time (US \u0026 Canada), Saskatchewan, Guadalajara, Mexico City, Monterrey, Central America, Eastern Time (US \u0026 Canada), Indiana (East), Bogota, Lima, Quito, Atlantic Time (Canada), Caracas, La Paz, Santiago, Newfoundland, Brasilia, Buenos Aires, Montevideo, Georgetown, Greenland, Mid-Atlantic, Azores, Cape Verde Is., Dublin, Edinburgh, Lisbon, London, Casablanca, Monrovia, Belgrade, Bratislava, Budapest, Ljubljana, Prague, Sarajevo, Skopje, Warsaw, Zagreb, Brussels, Copenhagen, Madrid, Paris, Amsterdam, Berlin, Bern, Rome, Stockholm, Vienna, West Central Africa, Bucharest, Cairo, Helsinki, Kyiv, Riga, Sofia, Tallinn, Vilnius, Athens, Istanbul, Minsk, Jerusalem, Harare, Pretoria, Moscow, St. Petersburg, Volgograd, Kuwait, Riyadh, Nairobi, Baghdad, Tehran, Abu Dhabi, Muscat, Baku, Tbilisi, Yerevan, Kabul, Ekaterinburg, Islamabad, Karachi, Tashkent, Chennai, Kolkata, Mumbai, New Delhi, Kathmandu, Astana, Dhaka, Sri Jayawardenepura, Almaty, Novosibirsk, Rangoon, Bangkok, Hanoi, Jakarta, Krasnoyarsk, Beijing, Chongqing, Hong Kong, Urumqi, Kuala Lumpur, Singapore, Taipei, Perth, Irkutsk, Ulaanbaatar, Seoul, Osaka, Sapporo, Tokyo, Yakutsk, Darwin, Adelaide, Canberra, Melbourne, Sydney, Brisbane, Hobart, Vladivostok, Guam, Port Moresby, Magadan, Solomon Is., New Caledonia, Fiji, Kamchatka, Marshall Is., Auckland, Wellington, Nuku'alofa, Tokelau Is., Chatham Is., Samoa.","expected_type":"string","metadata":null,"show":true},{"name":"locale","full_name":"user[locale]","description":"\n\u003cp\u003eUser’s preferred locale\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be one of: de, en, en_GB, es, fr, ja, ca, gl, it, ko, pt_BR, ru, sv_SE, zh_CN, zh_TW.","expected_type":"string","metadata":null,"show":true},{"name":"location_ids","full_name":"user[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"organization_ids","full_name":"user[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/users/destroy","name":"destroy","apis":[{"api_url":"/api/users/:id","http_method":"DELETE","short_description":"Delete a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null},"config_reports":{"doc_url":"../apidoc/v2/config_reports","api_url":"/api","name":"Config reports","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/config_reports/index","name":"index","apis":[{"api_url":"/api/config_reports","http_method":"GET","short_description":"List all reports","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003cp\u003esort results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003cp\u003epaginate results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003enumber of entries per request\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/config_reports/show","name":"show","apis":[{"api_url":"/api/config_reports/:id","http_method":"GET","short_description":"Show a report","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/config_reports/create","name":"create","apis":[{"api_url":"/api/config_reports","http_method":"POST","short_description":"Create a report","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"config_report","full_name":"config_report","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"host","full_name":"config_report[host]","description":"\n\u003cp\u003eHostname or certname\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"reported_at","full_name":"config_report[reported_at]","description":"\n\u003cp\u003eUTC time of report\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"status","full_name":"config_report[status]","description":"\n\u003cp\u003eHash of status type totals\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true},{"name":"metrics","full_name":"config_report[metrics]","description":"\n\u003cp\u003eHash of report metrics, can be just {}\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true},{"name":"logs","full_name":"config_report[logs]","description":"\n\u003cp\u003eOptional array of log hashes\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/config_reports/destroy","name":"destroy","apis":[{"api_url":"/api/config_reports/:id","http_method":"DELETE","short_description":"Delete a report","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/config_reports/last","name":"last","apis":[{"api_url":"/api/hosts/:host_id/config_reports/last","http_method":"GET","short_description":"Show the last report for a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null},"host_classes":{"doc_url":"../apidoc/v2/host_classes","api_url":"/api","name":"Host classes","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/host_classes/index","name":"index","apis":[{"api_url":"/api/hosts/:host_id/puppetclass_ids","http_method":"GET","short_description":"List all Puppet class IDs for host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_classes/create","name":"create","apis":[{"api_url":"/api/hosts/:host_id/puppetclass_ids","http_method":"POST","short_description":"Add a Puppet class to host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"puppetclass_id","full_name":"puppetclass_id","description":"\n\u003cp\u003eID of Puppet class\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_classes/destroy","name":"destroy","apis":[{"api_url":"/api/hosts/:host_id/puppetclass_ids/:id","http_method":"DELETE","short_description":"Remove a Puppet class from host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of Puppet class\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null},"models":{"doc_url":"../apidoc/v2/models","api_url":"/api","name":"Models","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/models/index","name":"index","apis":[{"api_url":"/api/models","http_method":"GET","short_description":"List all hardware models","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003cp\u003esort results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003cp\u003epaginate results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003enumber of entries per request\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/models/show","name":"show","apis":[{"api_url":"/api/models/:id","http_method":"GET","short_description":"Show a hardware model","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/models/create","name":"create","apis":[{"api_url":"/api/models","http_method":"POST","short_description":"Create a hardware model","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"model","full_name":"model","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"model[name]","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"info","full_name":"model[info]","description":"","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"vendor_class","full_name":"model[vendor_class]","description":"","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"hardware_model","full_name":"model[hardware_model]","description":"","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/models/update","name":"update","apis":[{"api_url":"/api/models/:id","http_method":"PUT","short_description":"Update a hardware model","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"model","full_name":"model","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"model[name]","description":"","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"info","full_name":"model[info]","description":"","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"vendor_class","full_name":"model[vendor_class]","description":"","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"hardware_model","full_name":"model[hardware_model]","description":"","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/models/destroy","name":"destroy","apis":[{"api_url":"/api/models/:id","http_method":"DELETE","short_description":"Delete a hardware model","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null},"parameters":{"doc_url":"../apidoc/v2/parameters","api_url":"/api","name":"Parameters","short_description":null,"full_description":"\n\u003cp\u003eThese API calls are related to \u003cb\u003enested parameters for a host, domain, host group, operating system\u003c/b\u003e. If you are looking for \u003ca href='common_parameters.html'\u003eglobal parameters\u003c/a\u003e, go to \u003ca href='common_parameters.html'\u003ethis link\u003c/a\u003e.\u003c/p\u003e\n","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/parameters/index","name":"index","apis":[{"api_url":"/api/hosts/:host_id/parameters","http_method":"GET","short_description":"List all parameters for a host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/parameters","http_method":"GET","short_description":"List all parameters for a host group","deprecated":null},{"api_url":"/api/domains/:domain_id/parameters","http_method":"GET","short_description":"List all parameters for a domain","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters","http_method":"GET","short_description":"List all parameters for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/parameters","http_method":"GET","short_description":"List all parameters for a location","deprecated":null},{"api_url":"/api/organizations/:organization_id/parameters","http_method":"GET","short_description":"List all parameters for an organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of location\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of organization\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003cp\u003esort results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003cp\u003epaginate results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003enumber of entries per request\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/parameters/show","name":"show","apis":[{"api_url":"/api/hosts/:host_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for a host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for a host group","deprecated":null},{"api_url":"/api/domains/:domain_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for a domain","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for a location","deprecated":null},{"api_url":"/api/organizations/:organization_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for an organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of location\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of organization\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of parameter\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/parameters/create","name":"create","apis":[{"api_url":"/api/hosts/:host_id/parameters","http_method":"POST","short_description":"Create a nested parameter for a host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/parameters","http_method":"POST","short_description":"Create a nested parameter for a host group","deprecated":null},{"api_url":"/api/domains/:domain_id/parameters","http_method":"POST","short_description":"Create a nested parameter for a domain","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters","http_method":"POST","short_description":"Create a nested parameter for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/parameters","http_method":"POST","short_description":"Create a nested parameter for a location","deprecated":null},{"api_url":"/api/organizations/:organization_id/parameters","http_method":"POST","short_description":"Create a nested parameter for an organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of location\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of organization\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"parameter","full_name":"parameter","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"parameter[name]","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"value","full_name":"parameter[value]","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/parameters/update","name":"update","apis":[{"api_url":"/api/hosts/:host_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for a host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for a host group","deprecated":null},{"api_url":"/api/domains/:domain_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for a domain","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for a location","deprecated":null},{"api_url":"/api/organizations/:organization_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for an organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of location\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of organization\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of parameter\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"parameter","full_name":"parameter","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"parameter[name]","description":"","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"value","full_name":"parameter[value]","description":"","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/parameters/destroy","name":"destroy","apis":[{"api_url":"/api/hosts/:host_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for a host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for a host group","deprecated":null},{"api_url":"/api/domains/:domain_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for a domain","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for a location","deprecated":null},{"api_url":"/api/organizations/:organization_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for an organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of location\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of organization\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of parameter\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/parameters/reset","name":"reset","apis":[{"api_url":"/api/hosts/:host_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameters for a host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameters for a host group","deprecated":null},{"api_url":"/api/domains/:domain_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameters for a domain","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameters for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameter for a location","deprecated":null},{"api_url":"/api/organizations/:organization_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameter for an organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of location\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of organization\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[]},"reports":{"doc_url":"../apidoc/v2/reports","api_url":"/api","name":"Reports","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/reports/index","name":"index","apis":[{"api_url":"/api/reports","http_method":"GET","short_description":"List all reports","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003cp\u003esort results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003cp\u003epaginate results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003enumber of entries per request\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/reports/show","name":"show","apis":[{"api_url":"/api/reports/:id","http_method":"GET","short_description":"Show a report","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/reports/create","name":"create","apis":[{"api_url":"/api/reports","http_method":"POST","short_description":"Create a report","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"report","full_name":"report","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"host","full_name":"report[host]","description":"\n\u003cp\u003eHostname or certname\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"reported_at","full_name":"report[reported_at]","description":"\n\u003cp\u003eUTC time of report\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"status","full_name":"report[status]","description":"\n\u003cp\u003eHash of status type totals\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true},{"name":"metrics","full_name":"report[metrics]","description":"\n\u003cp\u003eHash of report metrics, can be just {}\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true},{"name":"logs","full_name":"report[logs]","description":"\n\u003cp\u003eOptional array of log hashes\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/reports/destroy","name":"destroy","apis":[{"api_url":"/api/reports/:id","http_method":"DELETE","short_description":"Delete a report","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/reports/last","name":"last","apis":[{"api_url":"/api/hosts/:host_id/reports/last","http_method":"GET","short_description":"Show the last report for a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null},"provisioning_templates":{"doc_url":"../apidoc/v2/provisioning_templates","api_url":"/api","name":"Provisioning templates","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/provisioning_templates/index","name":"index","apis":[{"api_url":"/api/provisioning_templates","http_method":"GET","short_description":"List provisioning templates","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/provisioning_templates","http_method":"GET","short_description":"List provisioning templates per operating system","deprecated":null},{"api_url":"/api/locations/:location_id/provisioning_templates","http_method":"GET","short_description":"List provisioning templates per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/provisioning_templates","http_method":"GET","short_description":"List provisioning templates per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003cp\u003esort results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003cp\u003epaginate results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003enumber of entries per request\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/show","name":"show","apis":[{"api_url":"/api/provisioning_templates/:id","http_method":"GET","short_description":"Show provisioning template details","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/create","name":"create","apis":[{"api_url":"/api/provisioning_templates","http_method":"POST","short_description":"Create a provisioning template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"provisioning_template","full_name":"provisioning_template","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"provisioning_template[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"template","full_name":"provisioning_template[template]","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"snippet","full_name":"provisioning_template[snippet]","description":"","required":false,"allow_nil":true,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"audit_comment","full_name":"provisioning_template[audit_comment]","description":"","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"template_kind_id","full_name":"provisioning_template[template_kind_id]","description":"\n\u003cp\u003enot relevant for snippet\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"template_combinations_attributes","full_name":"provisioning_template[template_combinations_attributes]","description":"\n\u003cp\u003eArray of template combinations (hostgroup_id, environment_id)\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"operatingsystem_ids","full_name":"provisioning_template[operatingsystem_ids]","description":"\n\u003cp\u003eArray of operating system IDs to associate with the template\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"locked","full_name":"provisioning_template[locked]","description":"\n\u003cp\u003eWhether or not the template is locked for editing\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"location_ids","full_name":"provisioning_template[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"organization_ids","full_name":"provisioning_template[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/update","name":"update","apis":[{"api_url":"/api/provisioning_templates/:id","http_method":"PUT","short_description":"Update a provisioning template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"provisioning_template","full_name":"provisioning_template","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"provisioning_template[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"template","full_name":"provisioning_template[template]","description":"","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"snippet","full_name":"provisioning_template[snippet]","description":"","required":false,"allow_nil":true,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"audit_comment","full_name":"provisioning_template[audit_comment]","description":"","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"template_kind_id","full_name":"provisioning_template[template_kind_id]","description":"\n\u003cp\u003enot relevant for snippet\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"template_combinations_attributes","full_name":"provisioning_template[template_combinations_attributes]","description":"\n\u003cp\u003eArray of template combinations (hostgroup_id, environment_id)\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"operatingsystem_ids","full_name":"provisioning_template[operatingsystem_ids]","description":"\n\u003cp\u003eArray of operating system IDs to associate with the template\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"locked","full_name":"provisioning_template[locked]","description":"\n\u003cp\u003eWhether or not the template is locked for editing\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"location_ids","full_name":"provisioning_template[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"organization_ids","full_name":"provisioning_template[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/revision","name":"revision","apis":[{"api_url":"/api/provisioning_templates/revision","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"version","full_name":"version","description":"\n\u003cp\u003etemplate version\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/destroy","name":"destroy","apis":[{"api_url":"/api/provisioning_templates/:id","http_method":"DELETE","short_description":"Delete a provisioning template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/build_pxe_default","name":"build_pxe_default","apis":[{"api_url":"/api/provisioning_templates/build_pxe_default","http_method":"POST","short_description":"Update the default PXE menu on all configured TFTP servers","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/clone","name":"clone","apis":[{"api_url":"/api/provisioning_templates/:id/clone","http_method":"POST","short_description":"Clone a provision template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"provisioning_template","full_name":"provisioning_template","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"provisioning_template[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null},"operatingsystems":{"doc_url":"../apidoc/v2/operatingsystems","api_url":"/api","name":"Operating systems","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/operatingsystems/index","name":"index","apis":[{"api_url":"/api/operatingsystems","http_method":"GET","short_description":"List all operating systems","deprecated":null},{"api_url":"/api/architectures/:architecture_id/operatingsystems","http_method":"GET","short_description":"List all operating systems for nested architecture","deprecated":null},{"api_url":"/api/media/:medium_id/operatingsystems","http_method":"GET","short_description":"List all operating systems for nested medium","deprecated":null},{"api_url":"/api/ptables/:ptable_id/operatingsystems","http_method":"GET","short_description":"List all operating systems for nested partition table","deprecated":null},{"api_url":"/api/config_templates/:config_template_id/operatingsystems","http_method":"GET","short_description":"List all operating systems for nested provisioning template","deprecated":null},{"api_url":"/api/provisioning_templates/:provisioning_template_id/operatingsystems","http_method":"GET","short_description":"List all operating systems for nested provisioning template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"architecture_id","full_name":"architecture_id","description":"\n\u003cp\u003eID of architecture\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"medium_id","full_name":"medium_id","description":"\n\u003cp\u003eID of medium\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"ptable_id","full_name":"ptable_id","description":"\n\u003cp\u003eID of partition table\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"config_template_id","full_name":"config_template_id","description":"\n\u003cp\u003eID of template\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"provisioning_template_id","full_name":"provisioning_template_id","description":"\n\u003cp\u003eID of template\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003cp\u003esort results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003cp\u003epaginate results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003enumber of entries per request\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/operatingsystems/show","name":"show","apis":[{"api_url":"/api/operatingsystems/:id","http_method":"GET","short_description":"Show an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/operatingsystems/create","name":"create","apis":[{"api_url":"/api/operatingsystems","http_method":"POST","short_description":"Create an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"operatingsystem","full_name":"operatingsystem","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"operatingsystem[name]","description":"","required":true,"allow_nil":false,"validator":"Must match regular expression /\\A(\\S+)\\Z/.","expected_type":"string","metadata":null,"show":true},{"name":"major","full_name":"operatingsystem[major]","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"minor","full_name":"operatingsystem[minor]","description":"","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"description","full_name":"operatingsystem[description]","description":"","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"family","full_name":"operatingsystem[family]","description":"","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"release_name","full_name":"operatingsystem[release_name]","description":"","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"os_parameters_attributes","full_name":"operatingsystem[os_parameters_attributes]","description":"\n\u003cp\u003eOS’ parameters (array or indexed hash)\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"name","full_name":"operatingsystem[os_parameters_attributes][name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"value","full_name":"operatingsystem[os_parameters_attributes][value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}]},{"name":"password_hash","full_name":"operatingsystem[password_hash]","description":"\n\u003cp\u003eRoot password hash function to use, one of MD5, SHA256, SHA512, Base64\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"architecture_ids","full_name":"operatingsystem[architecture_ids]","description":"\n\u003cp\u003eIDs of associated architectures\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"config_template_ids","full_name":"operatingsystem[config_template_ids]","description":"\n\u003cp\u003eIDs of associated provisioning templates\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"provisioning_template_ids","full_name":"operatingsystem[provisioning_template_ids]","description":"\n\u003cp\u003eIDs of associated provisioning templates\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"medium_ids","full_name":"operatingsystem[medium_ids]","description":"\n\u003cp\u003eIDs of associated media\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"ptable_ids","full_name":"operatingsystem[ptable_ids]","description":"\n\u003cp\u003eIDs of associated partition tables\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/operatingsystems/update","name":"update","apis":[{"api_url":"/api/operatingsystems/:id","http_method":"PUT","short_description":"Update an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"operatingsystem","full_name":"operatingsystem","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"operatingsystem[name]","description":"","required":false,"allow_nil":false,"validator":"Must match regular expression /\\A(\\S+)\\Z/.","expected_type":"string","metadata":null,"show":true},{"name":"major","full_name":"operatingsystem[major]","description":"","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"minor","full_name":"operatingsystem[minor]","description":"","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"description","full_name":"operatingsystem[description]","description":"","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"family","full_name":"operatingsystem[family]","description":"","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"release_name","full_name":"operatingsystem[release_name]","description":"","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"os_parameters_attributes","full_name":"operatingsystem[os_parameters_attributes]","description":"\n\u003cp\u003eOS’ parameters (array or indexed hash)\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"name","full_name":"operatingsystem[os_parameters_attributes][name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"value","full_name":"operatingsystem[os_parameters_attributes][value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}]},{"name":"password_hash","full_name":"operatingsystem[password_hash]","description":"\n\u003cp\u003eRoot password hash function to use, one of MD5, SHA256, SHA512, Base64\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"architecture_ids","full_name":"operatingsystem[architecture_ids]","description":"\n\u003cp\u003eIDs of associated architectures\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"config_template_ids","full_name":"operatingsystem[config_template_ids]","description":"\n\u003cp\u003eIDs of associated provisioning templates\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"provisioning_template_ids","full_name":"operatingsystem[provisioning_template_ids]","description":"\n\u003cp\u003eIDs of associated provisioning templates\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"medium_ids","full_name":"operatingsystem[medium_ids]","description":"\n\u003cp\u003eIDs of associated media\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"ptable_ids","full_name":"operatingsystem[ptable_ids]","description":"\n\u003cp\u003eIDs of associated partition tables\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/operatingsystems/destroy","name":"destroy","apis":[{"api_url":"/api/operatingsystems/:id","http_method":"DELETE","short_description":"Delete an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/operatingsystems/bootfiles","name":"bootfiles","apis":[{"api_url":"/api/operatingsystems/:id/bootfiles","http_method":"GET","short_description":"List boot files for an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"medium","full_name":"medium","description":"","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"architecture","full_name":"architecture","description":"","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[]},"recurring_logics":{"doc_url":"../apidoc/v2/recurring_logics","api_url":"/api","name":"Recurring logics","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/recurring_logics/index","name":"index","apis":[{"api_url":"/foreman_tasks/api/recurring_logics","http_method":"GET","short_description":"List recurring logics","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/recurring_logics/show","name":"show","apis":[{"api_url":"/foreman_tasks/api/recurring_logics/:id","http_method":"GET","short_description":"Show recurring logic details","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the recurring logic\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/recurring_logics/cancel","name":"cancel","apis":[{"api_url":"/foreman_tasks/api/recurring_logics/:id/cancel","http_method":"POST","short_description":"Cancel recurring logic","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the recurring logic\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[]},"foreman_tasks":{"doc_url":"../apidoc/v2/foreman_tasks","api_url":"/api","name":"Foreman tasks","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/foreman_tasks/summary","name":"summary","apis":[{"api_url":"/foreman_tasks/api/tasks/summary","http_method":"GET","short_description":"Show task summary","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/foreman_tasks/show","name":"show","apis":[{"api_url":"/foreman_tasks/api/tasks/:id","http_method":"GET","short_description":"Show task details","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eUUID of the task\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/foreman_tasks/bulk_search","name":"bulk_search","apis":[{"api_url":"/foreman_tasks/api/tasks/bulk_search","http_method":"POST","short_description":"List dynflow tasks for uuids","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eFor every search it returns the list of tasks that satisfty the condition. The reason for supporting multiple searches is the UI that might be ending needing periodic updates on task status for various searches at the same time. This way, it is possible to get all the task statuses with one request.\u003c/p\u003e\n","errors":[],"params":[{"name":"searches","full_name":"searches","description":"\n\u003cp\u003eList of uuids to fetch info about\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"search_id","full_name":"searches[search_id]","description":"\n\u003cp\u003eArbitraty value for client to identify the the request parts with results. It’s passed in the results to be able to pair the requests and responses properly.\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"type","full_name":"searches[type]","description":"","required":false,"allow_nil":false,"validator":"Must be one of: user, resource, task.","expected_type":"string","metadata":null,"show":true},{"name":"task_id","full_name":"searches[task_id]","description":"\n\u003cp\u003eIn case :type = ‘task’, find the task by the uuid\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"user_id","full_name":"searches[user_id]","description":"\n\u003cp\u003eIn case :type = ‘user’, find tasks for the user\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"resource_type","full_name":"searches[resource_type]","description":"\n\u003cp\u003eIn case :type = ‘resource’, what resource type we’re searching the tasks for\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"resource_type","full_name":"searches[resource_type]","description":"\n\u003cp\u003eIn case :type = ‘resource’, what resource id we’re searching the tasks for\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"action_types","full_name":"searches[action_types]","description":"\n\u003cp\u003eReturn just tasks of given action type, e.g. [Actions::Katello::Repository::Synchronize]\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Must be one of: String.","expected_type":"string","metadata":null,"show":true},{"name":"active_only","full_name":"searches[active_only]","description":"","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"searches[page]","description":"","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"searches[per_page]","description":"","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/foreman_tasks/bulk_resume","name":"bulk_resume","apis":[{"api_url":"/foreman_tasks/api/tasks/bulk_resume","http_method":"POST","short_description":"Resume all paused error tasks","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"\n\u003cp\u003eResume tasks matching search string\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"task_ids","full_name":"task_ids","description":"\n\u003cp\u003eResume specific tasks by id\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/foreman_tasks/index","name":"index","apis":[{"api_url":"/foreman_tasks/api/tasks","http_method":"GET","short_description":"List tasks","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘name DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"sort","full_name":"sort","description":"\n\u003cp\u003eHash version of ‘order’ param\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"by","full_name":"sort[by]","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"sort[order]","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/foreman_tasks/callback","name":"callback","apis":[{"api_url":"/foreman_tasks/api/tasks/callback","http_method":"POST","short_description":"Send data to the task from external executor (such as smart_proxy_dynflow)","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"callback","full_name":"callback","description":"","required":false,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"task_id","full_name":"callback[task_id]","description":"\n\u003cp\u003eUUID of the task\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"step_id","full_name":"callback[step_id]","description":"\n\u003cp\u003eThe id of the step inside the execution plan to send the event to\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}]},{"name":"data","full_name":"data","description":"\n\u003cp\u003eData to be sent to the action\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[]},"containers":{"doc_url":"../apidoc/v2/containers","api_url":"/api","name":"Containers","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/containers/index","name":"index","apis":[{"api_url":"/docker/api/v2/containers","http_method":"GET","short_description":"List all containers","deprecated":null},{"api_url":"/docker/api/v2/compute_resources/:compute_resource_id/containers","http_method":"GET","short_description":"List all containers in a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"compute_resource_id","full_name":"compute_resource_id","description":"","required":false,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003cp\u003esort results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003cp\u003epaginate results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003enumber of entries per request\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/containers/show","name":"show","apis":[{"api_url":"/docker/api/v2/containers/:id","http_method":"GET","short_description":"Show a container","deprecated":null},{"api_url":"/docker/api/v2/compute_resources/:compute_resource_id/containers/:id","http_method":"GET","short_description":"Show container in a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"","required":false,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/containers/create","name":"create","apis":[{"api_url":"/docker/api/v2/containers","http_method":"POST","short_description":"Create a container","deprecated":null},{"api_url":"/docker/api/v2/compute_resources/:compute_resource_id/containers","http_method":"POST","short_description":"Create container in a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"container","full_name":"container","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"container[name]","description":"","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"location_ids","full_name":"container[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"organization_ids","full_name":"container[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"compute_resource_id","full_name":"container[compute_resource_id]","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"registry_id","full_name":"container[registry_id]","description":"\n\u003cp\u003eRegistry this container will have to use to get the image\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"repository_name","full_name":"container[repository_name]","description":"\n\u003cp\u003eName of the repository to use to create the container. e.g: centos\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"tag","full_name":"container[tag]","description":"\n\u003cp\u003eTag to use to create the container. e.g: latest\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"tty","full_name":"container[tty]","description":"","required":false,"allow_nil":true,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"entrypoint","full_name":"container[entrypoint]","description":"","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"command","full_name":"container[command]","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"memory","full_name":"container[memory]","description":"","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"cpu_shares","full_name":"container[cpu_shares]","description":"","required":false,"allow_nil":true,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"cpu_set","full_name":"container[cpu_set]","description":"","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"environment_variables","full_name":"container[environment_variables]","description":"","required":false,"allow_nil":true,"validator":"Hash","expected_type":"hash","metadata":null,"show":true},{"name":"attach_stdout","full_name":"container[attach_stdout]","description":"","required":false,"allow_nil":true,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"attach_stdin","full_name":"container[attach_stdin]","description":"","required":false,"allow_nil":true,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"attach_stderr","full_name":"container[attach_stderr]","description":"","required":false,"allow_nil":true,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"capsule_id","full_name":"container[capsule_id]","description":"\n\u003cp\u003eThe capsule this container will have to use to get the image. Relevant for images retrieved from katello registry.\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/containers/destroy","name":"destroy","apis":[{"api_url":"/docker/api/v2/containers/:id","http_method":"DELETE","short_description":"Delete a container","deprecated":null},{"api_url":"/docker/api/v2/compute_resources/:compute_resource_id/containers/:id","http_method":"DELETE","short_description":"Delete container in a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"","required":false,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/containers/logs","name":"logs","apis":[{"api_url":"/docker/api/v2/containers/:id/logs","http_method":"GET","short_description":"Show container logs","deprecated":null},{"api_url":"/docker/api/v2/compute_resources/:compute_resource_id/containers/:id/logs","http_method":"GET","short_description":"Show logs from a container in a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"","required":false,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"stdout","full_name":"stdout","description":"","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"stderr","full_name":"stderr","description":"","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"tail","full_name":"tail","description":"\n\u003cp\u003eNumber of lines to tail. Default: 100\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Fixnum","expected_type":"numeric","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/containers/power","name":"power","apis":[{"api_url":"/docker/api/v2/containers/:id/power","http_method":"PUT","short_description":"Run power operation on a container","deprecated":null},{"api_url":"/docker/api/v2/compute_resources/:compute_resource_id/containers/:id/power","http_method":"PUT","short_description":"Run power operation on a container in a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"","required":false,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"power_action","full_name":"power_action","description":"\n\u003cp\u003epower action, valid actions are (start), (stop), (status)\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[]},"registries":{"doc_url":"../apidoc/v2/registries","api_url":"/api","name":"Registries","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/registries/index","name":"index","apis":[{"api_url":"/docker/api/v2/registries","http_method":"GET","short_description":"List all docker registries","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003cp\u003esort results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003cp\u003epaginate results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003enumber of entries per request\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/registries/show","name":"show","apis":[{"api_url":"/docker/api/v2/registries/:id","http_method":"GET","short_description":"Show a docker registry","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/registries/create","name":"create","apis":[{"api_url":"/docker/api/v2/registries","http_method":"POST","short_description":"Create a docker registry","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"registry","full_name":"registry","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"registry[name]","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"url","full_name":"registry[url]","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"description","full_name":"registry[description]","description":"","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"username","full_name":"registry[username]","description":"","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"password","full_name":"registry[password]","description":"","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/registries/update","name":"update","apis":[{"api_url":"/docker/api/v2/registries/:id","http_method":"PUT","short_description":"Update a docker registry","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"registry","full_name":"registry","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"registry[name]","description":"","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"url","full_name":"registry[url]","description":"","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"description","full_name":"registry[description]","description":"","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"username","full_name":"registry[username]","description":"","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"password","full_name":"registry[password]","description":"","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/registries/destroy","name":"destroy","apis":[{"api_url":"/docker/api/v2/registries/:id","http_method":"DELETE","short_description":"Delete a docker registry","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[]},"activation_keys":{"doc_url":"../apidoc/v2/activation_keys","api_url":"/api","name":"Activation keys","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/activation_keys/index","name":"index","apis":[{"api_url":"/katello/api/activation_keys","http_method":"GET","short_description":"List activation keys","deprecated":null},{"api_url":"/katello/api/environments/:environment_id/activation_keys","http_method":"GET","short_description":null,"deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/activation_keys","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"name","full_name":"name","description":"\n\u003cp\u003eactivation key name to filter by\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘name DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"full_results","full_name":"full_results","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"sort","full_name":"sort","description":"\n\u003cp\u003eHash version of ‘order’ param\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"by","full_name":"sort[by]","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"sort[order]","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/activation_keys/create","name":"create","apis":[{"api_url":"/katello/api/activation_keys","http_method":"POST","short_description":"Create an activation key","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"name","full_name":"name","description":"\n\u003cp\u003ename\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"description","full_name":"description","description":"\n\u003cp\u003edescription\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"environment","full_name":"environment","description":"\n\u003cp\u003eenvironment\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment id\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view id\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"max_content_hosts","full_name":"max_content_hosts","description":"\n\u003cp\u003emaximum number of registered content hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"unlimited_content_hosts","full_name":"unlimited_content_hosts","description":"\n\u003cp\u003ecan the activation key have unlimited content hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/activation_keys/update","name":"update","apis":[{"api_url":"/katello/api/activation_keys/:id","http_method":"PUT","short_description":"Update an activation key","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"name","full_name":"name","description":"\n\u003cp\u003ename\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"description","full_name":"description","description":"\n\u003cp\u003edescription\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment id\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view id\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"max_content_hosts","full_name":"max_content_hosts","description":"\n\u003cp\u003emaximum number of registered content hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"unlimited_content_hosts","full_name":"unlimited_content_hosts","description":"\n\u003cp\u003ecan the activation key have unlimited content hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"release_version","full_name":"release_version","description":"\n\u003cp\u003econtent release version\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"service_level","full_name":"service_level","description":"\n\u003cp\u003eservice level\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"auto_attach","full_name":"auto_attach","description":"\n\u003cp\u003eauto attach subscriptions upon registration\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/activation_keys/destroy","name":"destroy","apis":[{"api_url":"/katello/api/activation_keys/:id","http_method":"DELETE","short_description":"Destroy an activation key","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/activation_keys/show","name":"show","apis":[{"api_url":"/katello/api/activation_keys/:id","http_method":"GET","short_description":"Show an activation key","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/activation_keys/copy","name":"copy","apis":[{"api_url":"/katello/api/activation_keys/:id/copy","http_method":"POST","short_description":"Copy an activation key","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"new_name","full_name":"new_name","description":"\n\u003cp\u003eName of new activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/activation_keys/available_host_collections","name":"available_host_collections","apis":[{"api_url":"/katello/api/activation_keys/:id/host_collections/available","http_method":"GET","short_description":"List host collections the system does not belong to","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘name DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"full_results","full_name":"full_results","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"sort","full_name":"sort","description":"\n\u003cp\u003eHash version of ‘order’ param\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"by","full_name":"sort[by]","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"sort[order]","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}]},{"name":"name","full_name":"name","description":"\n\u003cp\u003ehost collection name to filter by\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/activation_keys/available_releases","name":"available_releases","apis":[{"api_url":"/katello/api/activation_keys/:id/releases","http_method":"GET","short_description":"Show release versions available for an activation key","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/activation_keys/product_content","name":"product_content","apis":[{"api_url":"/katello/api/activation_keys/:id/product_content","http_method":"GET","short_description":"Show content available for an activation key","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/activation_keys/add_host_collections","name":"add_host_collections","apis":[{"api_url":"/katello/api/activation_keys/:id/host_collections","http_method":"POST","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"host_collection_ids","full_name":"host_collection_ids","description":"\n\u003cp\u003eList of host collection IDs to associate with activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/activation_keys/remove_host_collections","name":"remove_host_collections","apis":[{"api_url":"/katello/api/activation_keys/:id/host_collections","http_method":"PUT","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"host_collection_ids","full_name":"host_collection_ids","description":"\n\u003cp\u003eList of host collection IDs to disassociate from the activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/activation_keys/add_subscriptions","name":"add_subscriptions","apis":[{"api_url":"/katello/api/activation_keys/:id/add_subscriptions","http_method":"PUT","short_description":"Attach a subscription","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"subscription_id","full_name":"subscription_id","description":"\n\u003cp\u003eSubscription identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"quantity","full_name":"quantity","description":"\n\u003cp\u003eQuantity of this subscription to add\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"subscriptions","full_name":"subscriptions","description":"\n\u003cp\u003eArray of subscriptions to add\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"id","full_name":"subscriptions[id]","description":"\n\u003cp\u003eSubscription Pool uuid\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"quantity","full_name":"subscriptions[quantity]","description":"\n\u003cp\u003eQuantity of this subscriptions to add\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/activation_keys/remove_subscriptions","name":"remove_subscriptions","apis":[{"api_url":"/katello/api/activation_keys/:id/remove_subscriptions","http_method":"PUT","short_description":"Unattach a subscription","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"subscription_id","full_name":"subscription_id","description":"\n\u003cp\u003eSubscription ID\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"subscriptions","full_name":"subscriptions","description":"\n\u003cp\u003eArray of subscriptions to add\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"id","full_name":"subscriptions[id]","description":"\n\u003cp\u003eSubscription Pool uuid\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/activation_keys/content_override","name":"content_override","apis":[{"api_url":"/katello/api/activation_keys/:id/content_override","http_method":"PUT","short_description":"Override content for activation_key","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"content_override","full_name":"content_override","description":"\n\u003cp\u003eContent override parameters\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"content_label","full_name":"content_override[content_label]","description":"\n\u003cp\u003eLabel of the content\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"value","full_name":"content_override[value]","description":"\n\u003cp\u003eOverride to 0/1, or ‘default’\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"Must be one of: 0, 1, default.","expected_type":"string","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/activation_keys/subscriptions","name":"subscriptions","apis":[{"api_url":"/katello/api/activation_keys/:id/subscriptions","http_method":"GET","short_description":"List an activation key's subscriptions","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"activation_key_id","full_name":"activation_key_id","description":"\n\u003cp\u003eActivation key ID\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null},"capsules":{"doc_url":"../apidoc/v2/capsules","api_url":"/api","name":"Capsules","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/capsules/index","name":"index","apis":[{"api_url":"/katello/api/capsules","http_method":"GET","short_description":"List all capsules","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘name DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"full_results","full_name":"full_results","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"sort","full_name":"sort","description":"\n\u003cp\u003eHash version of ‘order’ param\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"by","full_name":"sort[by]","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"sort[order]","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/capsules/show","name":"show","apis":[{"api_url":"/katello/api/capsules/:id","http_method":"GET","short_description":"Show the capsule details","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the capsule\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[]},"content_uploads":{"doc_url":"../apidoc/v2/content_uploads","api_url":"/api","name":"Content uploads","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/content_uploads/create","name":"create","apis":[{"api_url":"/katello/api/repositories/:repository_id/content_uploads","http_method":"POST","short_description":"Create an upload request","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository id\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_uploads/update","name":"update","apis":[{"api_url":"/katello/api/repositories/:repository_id/content_uploads/:id","http_method":"PUT","short_description":"Upload a chunk of the file's content","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eRepository id\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"id","full_name":"id","description":"\n\u003cp\u003eUpload request id\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"offset","full_name":"offset","description":"\n\u003cp\u003eThe offset in the file where the content starts\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"content","full_name":"content","description":"\n\u003cp\u003eThe actual file contents\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"File","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_uploads/destroy","name":"destroy","apis":[{"api_url":"/katello/api/repositories/:repository_id/content_uploads/:id","http_method":"DELETE","short_description":"Delete an upload request","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eRepository id\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"id","full_name":"id","description":"\n\u003cp\u003eUpload request id\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null},"content_view_histories":{"doc_url":"../apidoc/v2/content_view_histories","api_url":"/api","name":"Content view histories","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/content_view_histories/index","name":"index","apis":[{"api_url":"/katello/api/content_views/:id/history","http_method":"GET","short_description":"Show a content view's history","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003econtent view numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null},"content_view_puppet_modules":{"doc_url":"../apidoc/v2/content_view_puppet_modules","api_url":"/api","name":"Content view puppet modules","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/content_view_puppet_modules/index","name":"index","apis":[{"api_url":"/katello/api/content_views/:content_view_id/content_view_puppet_modules","http_method":"GET","short_description":"List content view puppet modules","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"name","full_name":"name","description":"\n\u003cp\u003ename of the puppet module\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"author","full_name":"author","description":"\n\u003cp\u003eauthor of the puppet module\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"uuid","full_name":"uuid","description":"\n\u003cp\u003ethe uuid of the puppet module to associate\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘name DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"full_results","full_name":"full_results","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"sort","full_name":"sort","description":"\n\u003cp\u003eHash version of ‘order’ param\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"by","full_name":"sort[by]","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"sort[order]","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_puppet_modules/create","name":"create","apis":[{"api_url":"/katello/api/content_views/:content_view_id/content_view_puppet_modules","http_method":"POST","short_description":"Add a puppet module to the content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"name","full_name":"name","description":"\n\u003cp\u003ename of the puppet module\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"author","full_name":"author","description":"\n\u003cp\u003eauthor of the puppet module\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"id","full_name":"id","description":"\n\u003cp\u003ethe id of the puppet module to associate\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"uuid","full_name":"uuid","description":"\n\u003cp\u003ethe uuid of the puppet module to associate\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_puppet_modules/show","name":"show","apis":[{"api_url":"/katello/api/content_views/:content_view_id/content_view_puppet_modules/:id","http_method":"GET","short_description":"Show a content view puppet module","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"id","full_name":"id","description":"\n\u003cp\u003epuppet module ID\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_puppet_modules/update","name":"update","apis":[{"api_url":"/katello/api/content_views/:content_view_id/content_view_puppet_modules/:id","http_method":"PUT","short_description":"Update a puppet module associated with the content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"id","full_name":"id","description":"\n\u003cp\u003epuppet module ID\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"name","full_name":"name","description":"\n\u003cp\u003ename of the puppet module\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"author","full_name":"author","description":"\n\u003cp\u003eauthor of the puppet module\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"uuid","full_name":"uuid","description":"\n\u003cp\u003ethe uuid of the puppet module to associate\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_puppet_modules/destroy","name":"destroy","apis":[{"api_url":"/katello/api/content_views/:content_view_id/content_view_puppet_modules/:id","http_method":"DELETE","short_description":"Remove a puppet module from the content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"id","full_name":"id","description":"\n\u003cp\u003epuppet module ID\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null},"content_views":{"doc_url":"../apidoc/v2/content_views","api_url":"/api","name":"Content views","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/content_views/index","name":"index","apis":[{"api_url":"/katello/api/organizations/:organization_id/content_views","http_method":"GET","short_description":"List content views","deprecated":null},{"api_url":"/katello/api/content_views","http_method":"GET","short_description":"List content views","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"nondefault","full_name":"nondefault","description":"\n\u003cp\u003eFilter out default content views\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"noncomposite","full_name":"noncomposite","description":"\n\u003cp\u003eFilter out composite content views\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"without","full_name":"without","description":"\n\u003cp\u003eDo not include this array of content views\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"name","full_name":"name","description":"\n\u003cp\u003eName of the content view\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘name DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"full_results","full_name":"full_results","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"sort","full_name":"sort","description":"\n\u003cp\u003eHash version of ‘order’ param\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"by","full_name":"sort[by]","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"sort[order]","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_views/create","name":"create","apis":[{"api_url":"/katello/api/organizations/:organization_id/content_views","http_method":"POST","short_description":"Create a content view","deprecated":null},{"api_url":"/katello/api/content_views","http_method":"POST","short_description":"Create a content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"name","full_name":"name","description":"\n\u003cp\u003eName of the content view\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"label","full_name":"label","description":"\n\u003cp\u003eContent view label\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"composite","full_name":"composite","description":"\n\u003cp\u003eComposite content view\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription for the content view\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"repository_ids","full_name":"repository_ids","description":"\n\u003cp\u003eList of repository ids\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"component_ids","full_name":"component_ids","description":"\n\u003cp\u003eList of component content view version ids for composite views\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_views/update","name":"update","apis":[{"api_url":"/katello/api/content_views/:id","http_method":"PUT","short_description":"Update a content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent view identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"name","full_name":"name","description":"\n\u003cp\u003eNew name for the content view\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription for the content view\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"repository_ids","full_name":"repository_ids","description":"\n\u003cp\u003eList of repository ids\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"component_ids","full_name":"component_ids","description":"\n\u003cp\u003eList of component content view version ids for composite views\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_views/publish","name":"publish","apis":[{"api_url":"/katello/api/content_views/:id/publish","http_method":"POST","short_description":"Publish a content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent view identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription for the new published content view version\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_views/show","name":"show","apis":[{"api_url":"/katello/api/content_views/:id","http_method":"GET","short_description":"Show a content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003econtent view numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_views/available_puppet_modules","name":"available_puppet_modules","apis":[{"api_url":"/katello/api/content_views/:id/available_puppet_modules","http_method":"GET","short_description":"Get puppet modules that are available to be added to the content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003econtent view numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"name","full_name":"name","description":"\n\u003cp\u003emodule name to restrict modules for\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_views/available_puppet_module_names","name":"available_puppet_module_names","apis":[{"api_url":"/katello/api/content_views/:id/available_puppet_module_names","http_method":"GET","short_description":"Get puppet modules names that are available to be added to the content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003econtent view numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_views/remove_from_environment","name":"remove_from_environment","apis":[{"api_url":"/katello/api/content_views/:id/environments/:environment_id","http_method":"DELETE","short_description":"Remove a content view from an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003econtent view numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_views/remove","name":"remove","apis":[{"api_url":"/katello/api/content_views/:id/remove","http_method":"PUT","short_description":"Remove versions and/or environments from a content view and reassign systems and keys","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003econtent view numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"environment_ids","full_name":"environment_ids","description":"\n\u003cp\u003eenvironment numeric identifiers to be removed\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view version identifiers to be deleted\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"system_content_view_id","full_name":"system_content_view_id","description":"\n\u003cp\u003econtent view to reassign orphaned systems to\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"system_environment_id","full_name":"system_environment_id","description":"\n\u003cp\u003eenvironment to reassign orphaned systems to\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"key_content_view_id","full_name":"key_content_view_id","description":"\n\u003cp\u003econtent view to reassign orphaned activation keys to\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"key_environment_id","full_name":"key_environment_id","description":"\n\u003cp\u003eenvironment to reassign orphaned activation keys to\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_views/destroy","name":"destroy","apis":[{"api_url":"/katello/api/content_views/:id","http_method":"DELETE","short_description":"Delete a content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003econtent view numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_views/copy","name":"copy","apis":[{"api_url":"/katello/api/content_views/:id/copy","http_method":"POST","short_description":"Make copy of a content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent view numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"name","full_name":"name","description":"\n\u003cp\u003eNew content view name\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[]},"docker_tags":{"doc_url":"../apidoc/v2/docker_tags","api_url":"/api","name":"Docker tags","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/docker_tags/index","name":"index","apis":[{"api_url":"/katello/api/docker_tags","http_method":"GET","short_description":"List docker_tags","deprecated":null},{"api_url":"/katello/api/content_views/:content_view_id/filters/:filter_id/docker_tags","http_method":"GET","short_description":"List docker_tags","deprecated":null},{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/docker_tags","http_method":"GET","short_description":"List docker_tags","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/docker_tags","http_method":"GET","short_description":"List docker_tags","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003econtent view version identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003econtent view filter identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eids to filter content by\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘name DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"full_results","full_name":"full_results","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"sort","full_name":"sort","description":"\n\u003cp\u003eHash version of ‘order’ param\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"by","full_name":"sort[by]","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"sort[order]","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/docker_tags/show","name":"show","apis":[{"api_url":"/katello/api/docker_tags/:id","http_method":"GET","short_description":"Show a docker tag","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/docker_tags/:id","http_method":"GET","short_description":"Show a docker tag","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"id","full_name":"id","description":"\n\u003cp\u003ea docker tag identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/docker_tags/compare","name":"compare","apis":[{"api_url":"/katello/api/compare","http_method":"GET","short_description":"List docker_tags","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view versions to compare\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eLibrary repository id to restrict comparisons to\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null},"package_groups":{"doc_url":"../apidoc/v2/package_groups","api_url":"/api","name":"Package groups","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/package_groups/index","name":"index","apis":[{"api_url":"/katello/api/package_groups","http_method":"GET","short_description":"List package_groups","deprecated":null},{"api_url":"/katello/api/content_views/:content_view_id/filters/:filter_id/package_groups","http_method":"GET","short_description":"List package_groups","deprecated":null},{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/package_groups","http_method":"GET","short_description":"List package_groups","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/package_groups","http_method":"GET","short_description":"List package_groups","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003econtent view version identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003econtent view filter identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eids to filter content by\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘name DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"full_results","full_name":"full_results","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"sort","full_name":"sort","description":"\n\u003cp\u003eHash version of ‘order’ param\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"by","full_name":"sort[by]","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"sort[order]","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/package_groups/show","name":"show","apis":[{"api_url":"/katello/api/package_groups/:id","http_method":"GET","short_description":"Show a package group","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/package_groups/:id","http_method":"GET","short_description":"Show a package group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"id","full_name":"id","description":"\n\u003cp\u003ea package group identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/package_groups/compare","name":"compare","apis":[{"api_url":"/katello/api/compare","http_method":"GET","short_description":"List package_groups","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view versions to compare\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eLibrary repository id to restrict comparisons to\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null},"packages":{"doc_url":"../apidoc/v2/packages","api_url":"/api","name":"Packages","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/packages/index","name":"index","apis":[{"api_url":"/katello/api/packages","http_method":"GET","short_description":"List packages","deprecated":null},{"api_url":"/katello/api/content_views/:content_view_id/filters/:filter_id/packages","http_method":"GET","short_description":"List packages","deprecated":null},{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/packages","http_method":"GET","short_description":"List packages","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/packages","http_method":"GET","short_description":"List packages","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003econtent view version identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003econtent view filter identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eids to filter content by\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘name DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"full_results","full_name":"full_results","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"sort","full_name":"sort","description":"\n\u003cp\u003eHash version of ‘order’ param\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"by","full_name":"sort[by]","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"sort[order]","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/packages/show","name":"show","apis":[{"api_url":"/katello/api/packages/:id","http_method":"GET","short_description":"Show a package","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/packages/:id","http_method":"GET","short_description":"Show a package","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"id","full_name":"id","description":"\n\u003cp\u003ea package identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/packages/compare","name":"compare","apis":[{"api_url":"/katello/api/compare","http_method":"GET","short_description":"List packages","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view versions to compare\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eLibrary repository id to restrict comparisons to\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null},"products_bulk_actions":{"doc_url":"../apidoc/v2/products_bulk_actions","api_url":"/api","name":"Products bulk actions","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/products_bulk_actions/destroy_products","name":"destroy_products","apis":[{"api_url":"/katello/api/products/bulk/destroy","http_method":"PUT","short_description":"Destroy one or more products","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eList of product ids\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/products_bulk_actions/sync_products","name":"sync_products","apis":[{"api_url":"/katello/api/products/bulk/sync","http_method":"PUT","short_description":"Sync one or more products","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eList of product ids\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/products_bulk_actions/update_sync_plans","name":"update_sync_plans","apis":[{"api_url":"/katello/api/products/bulk/sync_plan","http_method":"PUT","short_description":"Sync one or more products","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eList of product ids\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"plan_id","full_name":"plan_id","description":"\n\u003cp\u003eSync plan identifier to attach\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null},"puppet_modules":{"doc_url":"../apidoc/v2/puppet_modules","api_url":"/api","name":"Puppet modules","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/puppet_modules/index","name":"index","apis":[{"api_url":"/katello/api/puppet_modules","http_method":"GET","short_description":"List puppet_modules","deprecated":null},{"api_url":"/katello/api/content_views/:content_view_id/filters/:filter_id/puppet_modules","http_method":"GET","short_description":"List puppet_modules","deprecated":null},{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/puppet_modules","http_method":"GET","short_description":"List puppet_modules","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/puppet_modules","http_method":"GET","short_description":"List puppet_modules","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003econtent view version identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003econtent view filter identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eids to filter content by\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘name DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"full_results","full_name":"full_results","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"sort","full_name":"sort","description":"\n\u003cp\u003eHash version of ‘order’ param\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"by","full_name":"sort[by]","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"sort[order]","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/puppet_modules/show","name":"show","apis":[{"api_url":"/katello/api/puppet_modules/:id","http_method":"GET","short_description":"Show a puppet module","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/puppet_modules/:id","http_method":"GET","short_description":"Show a puppet module","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"id","full_name":"id","description":"\n\u003cp\u003ea puppet module identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/puppet_modules/compare","name":"compare","apis":[{"api_url":"/katello/api/compare","http_method":"GET","short_description":"List puppet_modules","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view versions to compare\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eLibrary repository id to restrict comparisons to\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null},"repositories_bulk_actions":{"doc_url":"../apidoc/v2/repositories_bulk_actions","api_url":"/api","name":"Repositories bulk actions","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/repositories_bulk_actions/destroy_repositories","name":"destroy_repositories","apis":[{"api_url":"/katello/api/repositories/bulk/destroy","http_method":"PUT","short_description":"Destroy one or more repositories","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eList of repository ids\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repositories_bulk_actions/sync_repositories","name":"sync_repositories","apis":[{"api_url":"/katello/api/repositories/bulk/sync","http_method":"POST","short_description":"Synchronize repository","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eList of repository ids\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null},"host_collections":{"doc_url":"../apidoc/v2/host_collections","api_url":"/api","name":"Host collections","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/host_collections/show","name":"show","apis":[{"api_url":"/katello/api/host_collections/:id","http_method":"GET","short_description":"Show a host collection","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the host collection\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_collections/index","name":"index","apis":[{"api_url":"/katello/api/host_collections","http_method":"GET","short_description":"List host collections","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/host_collections","http_method":"GET","short_description":"List host collections within an organization","deprecated":null},{"api_url":"/katello/api/activation_keys/:activation_key_id/host_collections","http_method":"GET","short_description":"List host collections in an activation key","deprecated":null},{"api_url":"/katello/api/hosts/:host_id/host_collections","http_method":"GET","short_description":"List host collections containing a content host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘name DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"full_results","full_name":"full_results","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"sort","full_name":"sort","description":"\n\u003cp\u003eHash version of ‘order’ param\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"by","full_name":"sort[by]","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"sort[order]","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"name","full_name":"name","description":"\n\u003cp\u003ehost collection name to filter by\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"activation_key_id","full_name":"activation_key_id","description":"\n\u003cp\u003eactivation key identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eFilter products by host id\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"available_for","full_name":"available_for","description":"\n\u003cp\u003eInterpret specified object to return only Host Collections that can be associated with specified object. The value ‘host’ is supported.\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_collections/create","name":"create","apis":[{"api_url":"/katello/api/host_collections","http_method":"POST","short_description":"Create a host collection","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/host_collections","http_method":"POST","short_description":"Create a host collection","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"name","full_name":"name","description":"\n\u003cp\u003eHost Collection name\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"description","full_name":"description","description":"","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"host_ids","full_name":"host_ids","description":"\n\u003cp\u003eList of host ids to replace the hosts in host collection\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"max_hosts","full_name":"max_hosts","description":"\n\u003cp\u003eMaximum number of hosts in the host collection\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"unlimited_hosts","full_name":"unlimited_hosts","description":"\n\u003cp\u003eWhether or not the host collection may have unlimited hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_collections/update","name":"update","apis":[{"api_url":"/katello/api/host_collections/:id","http_method":"PUT","short_description":"Update a host collection","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the host collection\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"name","full_name":"name","description":"\n\u003cp\u003eHost Collection name\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"description","full_name":"description","description":"","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"host_ids","full_name":"host_ids","description":"\n\u003cp\u003eList of host ids to replace the hosts in host collection\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"max_hosts","full_name":"max_hosts","description":"\n\u003cp\u003eMaximum number of hosts in the host collection\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"unlimited_hosts","full_name":"unlimited_hosts","description":"\n\u003cp\u003eWhether or not the host collection may have unlimited hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_collections/add_hosts","name":"add_hosts","apis":[{"api_url":"/katello/api/host_collections/:id/add_hosts","http_method":"PUT","short_description":"Add host to the host collection","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the host collection\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"host_ids","full_name":"host_ids","description":"\n\u003cp\u003eArray of host ids\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_collections/remove_hosts","name":"remove_hosts","apis":[{"api_url":"/katello/api/host_collections/:id/remove_hosts","http_method":"PUT","short_description":"Remove hosts from the host collection","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the host collection\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"host_ids","full_name":"host_ids","description":"\n\u003cp\u003eArray of host ids\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_collections/destroy","name":"destroy","apis":[{"api_url":"/katello/api/host_collections/:id","http_method":"DELETE","short_description":"Destroy a host collection","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the host collection\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_collections/copy","name":"copy","apis":[{"api_url":"/katello/api/host_collections/:id/copy","http_method":"POST","short_description":"Make copy of a host collection","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the host collection\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"name","full_name":"name","description":"\n\u003cp\u003eNew host collection name\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null},"hosts_bulk_actions":{"doc_url":"../apidoc/v2/hosts_bulk_actions","api_url":"/api","name":"Hosts bulk actions","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/hosts_bulk_actions/bulk_add_host_collections","name":"bulk_add_host_collections","apis":[{"api_url":"/katello/api/hosts/bulk/add_host_collections","http_method":"PUT","short_description":"Add one or more host collections to one or more hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for systems to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of system ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of system ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]},{"name":"host_collection_ids","full_name":"host_collection_ids","description":"\n\u003cp\u003eList of host collection ids\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/bulk_remove_host_collections","name":"bulk_remove_host_collections","apis":[{"api_url":"/katello/api/hosts/bulk/remove_host_collections","http_method":"PUT","short_description":"Remove one or more host collections from one or more hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for systems to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of system ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of system ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]},{"name":"host_collection_ids","full_name":"host_collection_ids","description":"\n\u003cp\u003eList of host collection ids\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/installable_errata","name":"installable_errata","apis":[{"api_url":"/katello/api/hosts/bulk/applicable_errata","http_method":"POST","short_description":"Fetch applicable errata for a system.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for systems to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of system ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of system ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/install_content","name":"install_content","apis":[{"api_url":"/katello/api/hosts/bulk/install_content","http_method":"PUT","short_description":"Install content on one or more hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for systems to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of system ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of system ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]},{"name":"content_type","full_name":"content_type","description":"\n\u003cp\u003eThe type of content. The following types are supported: ‘package’, ‘package_group’ and ‘errata’.\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"content","full_name":"content","description":"\n\u003cp\u003eList of content (e.g. package names, package group names or errata ids)\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/update_content","name":"update_content","apis":[{"api_url":"/katello/api/hosts/bulk/update_content","http_method":"PUT","short_description":"Update content on one or more hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for systems to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of system ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of system ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]},{"name":"content_type","full_name":"content_type","description":"\n\u003cp\u003eThe type of content. The following types are supported: ‘package’ and ‘package_group.\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"content","full_name":"content","description":"\n\u003cp\u003eList of content (e.g. package or package group names)\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/remove_content","name":"remove_content","apis":[{"api_url":"/katello/api/hosts/bulk/remove_content","http_method":"PUT","short_description":"Remove content on one or more hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for systems to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of system ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of system ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]},{"name":"content_type","full_name":"content_type","description":"\n\u003cp\u003eThe type of content. The following types are supported: ‘package’ and ‘package_group.\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"content","full_name":"content","description":"\n\u003cp\u003eList of content (e.g. package or package group names)\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/destroy_hosts","name":"destroy_hosts","apis":[{"api_url":"/katello/api/hosts/bulk/destroy","http_method":"PUT","short_description":"Destroy one or more hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for systems to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of system ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of system ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/environment_content_view","name":"environment_content_view","apis":[{"api_url":"/katello/api/hosts/bulk/environment_content_view","http_method":"PUT","short_description":"Assign the environment and content view to one or more systems","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for systems to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of system ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of system ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]},{"name":"environment_id","full_name":"environment_id","description":"","required":false,"allow_nil":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"content_view_id","full_name":"content_view_id","description":"","required":false,"allow_nil":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/available_incremental_updates","name":"available_incremental_updates","apis":[{"api_url":"/katello/api/hosts/bulk/available_incremental_updates","http_method":"POST","short_description":"Given a set of hosts and errata, lists the content view versions and environments that need updating.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for systems to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of system ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of system ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]},{"name":"errata_ids","full_name":"errata_ids","description":"\n\u003cp\u003eList of Errata ids\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null},"uebercerts":{"doc_url":"../apidoc/v2/uebercerts","api_url":"/api","name":"Uebercerts","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/uebercerts/show","name":"show","apis":[{"api_url":"/katello/api/organizations/:organization_id/uebercert","http_method":"GET","short_description":"Show an ueber certificate for an organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"regenerate","full_name":"regenerate","description":"\n\u003cp\u003eWhen set to ‘True’ certificate will be re-issued\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[]},"gpg_keys":{"doc_url":"../apidoc/v2/gpg_keys","api_url":"/api","name":"Gpg keys","short_description":null,"full_description":"\n\u003ch1 id=\"description\"\u003eDescription\u003c/h1\u003e\n\n\u003cp\u003eDocuments the calls for the list, read, create, update and delete operations for GPG keys\u003c/p\u003e\n","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/gpg_keys/index","name":"index","apis":[{"api_url":"/katello/api/gpg_keys","http_method":"GET","short_description":"List gpg keys","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"name","full_name":"name","description":"\n\u003cp\u003ename of the GPG key\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘name DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"full_results","full_name":"full_results","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"sort","full_name":"sort","description":"\n\u003cp\u003eHash version of ‘order’ param\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"by","full_name":"sort[by]","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"sort[order]","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/gpg_keys/create","name":"create","apis":[{"api_url":"/katello/api/gpg_keys","http_method":"POST","short_description":"Create a gpg key","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"name","full_name":"name","description":"\n\u003cp\u003eidentifier of the gpg key\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"content","full_name":"content","description":"\n\u003cp\u003epublic key block in DER encoding\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/gpg_keys/show","name":"show","apis":[{"api_url":"/katello/api/gpg_keys/:id","http_method":"GET","short_description":"Show a gpg key","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003egpg key numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/gpg_keys/update","name":"update","apis":[{"api_url":"/katello/api/gpg_keys/:id","http_method":"PUT","short_description":"Update a repository","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003egpg key numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"name","full_name":"name","description":"\n\u003cp\u003eidentifier of the gpg key\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"content","full_name":"content","description":"\n\u003cp\u003epublic key block in DER encoding\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/gpg_keys/destroy","name":"destroy","apis":[{"api_url":"/katello/api/gpg_keys/:id","http_method":"DELETE","short_description":"Destroy a gpg key","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003egpg key numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/gpg_keys/content","name":"content","apis":[{"api_url":"/katello/api/gpg_keys/:id/content","http_method":"POST","short_description":"Upload gpg key contents","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003egpg key numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"content","full_name":"content","description":"\n\u003cp\u003efile contents\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"File","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[]},"ping":{"doc_url":"../apidoc/v2/ping","api_url":"/api","name":"Ping","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/ping/index","name":"index","apis":[{"api_url":"/katello/api/ping","http_method":"GET","short_description":"Shows status of system and it's subcomponents","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eThis service is only available for authenticated users\u003c/p\u003e\n","errors":[],"params":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ping/server_status","name":"server_status","apis":[{"api_url":"/katello/api/status","http_method":"GET","short_description":"Shows version information","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eThis service is available for unauthenticated users\u003c/p\u003e\n","errors":[],"params":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[]},"products":{"doc_url":"../apidoc/v2/products","api_url":"/api","name":"Products","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/products/index","name":"index","apis":[{"api_url":"/katello/api/products","http_method":"GET","short_description":"List products","deprecated":null},{"api_url":"/katello/api/subscriptions/:subscription_id/products","http_method":"GET","short_description":"List of subscription products in a subscription","deprecated":null},{"api_url":"/katello/api/activation_keys/:activation_key_id/products","http_method":"GET","short_description":"List of subscription products in an activation key","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/products","http_method":"GET","short_description":"List of products in an organization","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/sync_plans/:sync_plan_id/available_products","http_method":"GET","short_description":"List of available Products for sync plan","deprecated":true},{"api_url":"/katello/api/sync_plans/:sync_plan_id/products","http_method":"GET","short_description":"List of Products for sync plan","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/sync_plans/:sync_plan_id/products","http_method":"GET","short_description":"List of Products for sync plan","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eFilter products by organization\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"subscription_id","full_name":"subscription_id","description":"\n\u003cp\u003eFilter products by subscription\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"name","full_name":"name","description":"\n\u003cp\u003eFilter products by name\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"enabled","full_name":"enabled","description":"\n\u003cp\u003eFilter products by enabled or disabled\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"custom","full_name":"custom","description":"\n\u003cp\u003eFilter products by custom\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"include_available_content","full_name":"include_available_content","description":"\n\u003cp\u003eWhether to include available content attribute in results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"sync_plan_id","full_name":"sync_plan_id","description":"\n\u003cp\u003eFilter products by sync plan id\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"available_for","full_name":"available_for","description":"\n\u003cp\u003eInterpret specified object to return only Products that can be associated with specified object. Only ‘sync_plan’ is supported.\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘name DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"full_results","full_name":"full_results","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"sort","full_name":"sort","description":"\n\u003cp\u003eHash version of ‘order’ param\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"by","full_name":"sort[by]","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"sort[order]","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/products/create","name":"create","apis":[{"api_url":"/katello/api/products","http_method":"POST","short_description":"Create a product","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"description","full_name":"description","description":"\n\u003cp\u003eProduct description\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"gpg_key_id","full_name":"gpg_key_id","description":"\n\u003cp\u003eIdentifier of the GPG key\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"sync_plan_id","full_name":"sync_plan_id","description":"\n\u003cp\u003ePlan numeric identifier\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"name","full_name":"name","description":"\n\u003cp\u003eProduct name\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"label","full_name":"label","description":"","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/products/show","name":"show","apis":[{"api_url":"/katello/api/products/:id","http_method":"GET","short_description":"Show a product","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eproduct numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/products/update","name":"update","apis":[{"api_url":"/katello/api/products/:id","http_method":"PUT","short_description":"Updates a product","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eproduct numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"description","full_name":"description","description":"\n\u003cp\u003eProduct description\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"gpg_key_id","full_name":"gpg_key_id","description":"\n\u003cp\u003eIdentifier of the GPG key\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"sync_plan_id","full_name":"sync_plan_id","description":"\n\u003cp\u003ePlan numeric identifier\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"name","full_name":"name","description":"\n\u003cp\u003eProduct name\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/products/destroy","name":"destroy","apis":[{"api_url":"/katello/api/products/:id","http_method":"DELETE","short_description":"Destroy a product","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eproduct numeric identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/products/sync","name":"sync","apis":[{"api_url":"/katello/api/products/:id/sync","http_method":"POST","short_description":"Sync all repositories for a product","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eproduct ID\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[]},"sync":{"doc_url":"../apidoc/v2/sync","api_url":"/api","name":"Sync","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/sync/index","name":"index","apis":[{"api_url":"/katello/api/organizations/:organization_id/products/:product_id/sync","http_method":"GET","short_description":"Get status of repo synchronisation for given product","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/sync","http_method":"GET","short_description":"Get status of synchronisation for given repository","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null},"docker_manifests":{"doc_url":"../apidoc/v2/docker_manifests","api_url":"/api","name":"Docker manifests","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/docker_manifests/index","name":"index","apis":[{"api_url":"/katello/api/docker_manifests","http_method":"GET","short_description":"List docker_manifests","deprecated":null},{"api_url":"/katello/api/content_views/:content_view_id/filters/:filter_id/docker_manifests","http_method":"GET","short_description":"List docker_manifests","deprecated":null},{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/docker_manifests","http_method":"GET","short_description":"List docker_manifests","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/docker_manifests","http_method":"GET","short_description":"List docker_manifests","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003econtent view version identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003econtent view filter identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eids to filter content by\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘name DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"full_results","full_name":"full_results","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"sort","full_name":"sort","description":"\n\u003cp\u003eHash version of ‘order’ param\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"by","full_name":"sort[by]","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"sort[order]","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/docker_manifests/show","name":"show","apis":[{"api_url":"/katello/api/docker_manifests/:id","http_method":"GET","short_description":"Show a docker manifest","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/docker_manifests/:id","http_method":"GET","short_description":"Show a docker manifest","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"id","full_name":"id","description":"\n\u003cp\u003ea docker manifest identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/docker_manifests/compare","name":"compare","apis":[{"api_url":"/katello/api/compare","http_method":"GET","short_description":"List docker_manifests","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view versions to compare\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eLibrary repository id to restrict comparisons to\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null},"errata":{"doc_url":"../apidoc/v2/errata","api_url":"/api","name":"Errata","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/errata/index","name":"index","apis":[{"api_url":"/katello/api/errata","http_method":"GET","short_description":"List errata","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003econtent view version identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003econtent view filter identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"cve","full_name":"cve","description":"\n\u003cp\u003eCVE identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"errata_restrict_applicable","full_name":"errata_restrict_applicable","description":"\n\u003cp\u003eshow only errata with one or more applicable hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"errata_restrict_installable","full_name":"errata_restrict_installable","description":"\n\u003cp\u003eshow only errata with one or more installable hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘name DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"full_results","full_name":"full_results","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"sort","full_name":"sort","description":"\n\u003cp\u003eHash version of ‘order’ param\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"by","full_name":"sort[by]","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"sort[order]","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/errata/show","name":"show","apis":[{"api_url":"/katello/api/errata/:id","http_method":"GET","short_description":"Show an erratum","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/errata/:id","http_method":"GET","short_description":"Show an erratum","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"id","full_name":"id","description":"\n\u003cp\u003ean erratum identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/errata/compare","name":"compare","apis":[{"api_url":"/katello/api/compare","http_method":"GET","short_description":"List errata","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view versions to compare\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eLibrary repository id to restrict comparisons to\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null},"systems":{"doc_url":"../apidoc/v2/systems","api_url":"/api","name":"Systems","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/systems/index","name":"index","apis":[{"api_url":"/katello/api/systems","http_method":"GET","short_description":"List content hosts","deprecated":true},{"api_url":"/katello/api/systems/post_index","http_method":"POST","short_description":"List content hosts when you have a query string parameter that will cause a 414.","deprecated":true},{"api_url":"/katello/api/organizations/:organization_id/systems","http_method":"GET","short_description":"List content hosts in an organization","deprecated":true},{"api_url":"/katello/api/environments/:environment_id/systems","http_method":"GET","short_description":"List content hosts in environment","deprecated":true},{"api_url":"/katello/api/host_collections/:host_collection_id/systems","http_method":"GET","short_description":"List content hosts in a host collection","deprecated":true}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n\u003cp\u003eFilter content host by name\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"pool_id","full_name":"pool_id","description":"\n\u003cp\u003eFilter content host by subscribed pool\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"uuid","full_name":"uuid","description":"\n\u003cp\u003eFilter content host by uuid\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSpecify the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eFilter by environment\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"host_collection_id","full_name":"host_collection_id","description":"\n\u003cp\u003eFilter by host collection\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003eFilter by content view\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"erratum_id","full_name":"erratum_id","description":"\n\u003cp\u003eFilter by systems that need an Erratum by uuid\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"errata_ids","full_name":"errata_ids","description":"\n\u003cp\u003eFilter by systems that need any one of multiple Errata by uuid\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"erratum_restrict_installable","full_name":"erratum_restrict_installable","description":"\n\u003cp\u003eReturn only systems where the Erratum specified by erratum_id or errata_ids is available to systems (default False)\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"erratum_restrict_non_installable","full_name":"erratum_restrict_non_installable","description":"\n\u003cp\u003eReturn only systems where the Erratum specified by erratum_id or errata_ids is unavailable to systems (default False)\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"available_for","full_name":"available_for","description":"\n\u003cp\u003eReturn content hosts that are able to be attached to a specified object such as ‘host_collection’\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘name DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"full_results","full_name":"full_results","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"sort","full_name":"sort","description":"\n\u003cp\u003eHash version of ‘order’ param\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"by","full_name":"sort[by]","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"sort[order]","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/systems/create","name":"create","apis":[{"api_url":"/katello/api/systems","http_method":"POST","short_description":"Register a content host","deprecated":true},{"api_url":"/katello/api/environments/:environment_id/systems","http_method":"POST","short_description":"Register a content host in environment","deprecated":true},{"api_url":"/katello/api/host_collections/:host_collection_id/systems","http_method":"POST","short_description":"Register a content host in environment","deprecated":true}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n\u003cp\u003eName of the content host\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription of the content host\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"location","full_name":"location","description":"\n\u003cp\u003ePhysical location of the content host\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"facts","full_name":"facts","description":"\n\u003cp\u003eKey-value hash of content host-specific facts\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"fact","full_name":"facts[fact]","description":"\n\u003cp\u003eAny number of facts about this content host\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true}]},{"name":"type","full_name":"type","description":"\n\u003cp\u003eType of the content host, it should always be ‘system’\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"guest_ids","full_name":"guest_ids","description":"\n\u003cp\u003eIDs of the virtual guests running on this content host\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"installed_products","full_name":"installed_products","description":"\n\u003cp\u003eList of products installed on the content host\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"release_ver","full_name":"release_ver","description":"\n\u003cp\u003eRelease version of the content host\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"service_level","full_name":"service_level","description":"\n\u003cp\u003eA service level for auto-healing process, e.g. SELF-SUPPORT\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"last_checkin","full_name":"last_checkin","description":"\n\u003cp\u003eLast check-in time of this content host\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSpecify the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eSpecify the environment\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003eSpecify the content view\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"host_collection_ids","full_name":"host_collection_ids","description":"\n\u003cp\u003eSpecify the host collections as an array\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/systems/update","name":"update","apis":[{"api_url":"/katello/api/systems/:id","http_method":"PUT","short_description":"Update content host information","deprecated":true}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eUUID of the content host\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"name","full_name":"name","description":"\n\u003cp\u003eName of the content host\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription of the content host\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"location","full_name":"location","description":"\n\u003cp\u003ePhysical location of the content host\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"facts","full_name":"facts","description":"\n\u003cp\u003eKey-value hash of content host-specific facts\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"fact","full_name":"facts[fact]","description":"\n\u003cp\u003eAny number of facts about this content host\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true}]},{"name":"type","full_name":"type","description":"\n\u003cp\u003eType of the content host, it should always be ‘system’\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"guest_ids","full_name":"guest_ids","description":"\n\u003cp\u003eIDs of the virtual guests running on this content host\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"installed_products","full_name":"installed_products","description":"\n\u003cp\u003eList of products installed on the content host\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"release_ver","full_name":"release_ver","description":"\n\u003cp\u003eRelease version of the content host\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"service_level","full_name":"service_level","description":"\n\u003cp\u003eA service level for auto-healing process, e.g. SELF-SUPPORT\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"last_checkin","full_name":"last_checkin","description":"\n\u003cp\u003eLast check-in time of this content host\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eSpecify the environment\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003eSpecify the content view\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"host_collection_ids","full_name":"host_collection_ids","description":"\n\u003cp\u003eSpecify the host collections as an array\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/systems/show","name":"show","apis":[{"api_url":"/katello/api/systems/:id","http_method":"GET","short_description":"Show a content host","deprecated":true}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eUUID of the content host\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/systems/destroy","name":"destroy","apis":[{"api_url":"/katello/api/systems/:id","http_method":"DELETE","short_description":"Unregister a content host","deprecated":true}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eUUID of the content host\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/systems/report","name":"report","apis":[{"api_url":"/katello/api/environments/:environment_id/systems/report","http_method":"GET","short_description":"Get content host reports for the environment","deprecated":true},{"api_url":"/katello/api/organizations/:organization_id/systems/report","http_method":"GET","short_description":"Get content host reports for the organization","deprecated":true}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/systems/releases","name":"releases","apis":[{"api_url":"/katello/api/systems/:id/releases","http_method":"GET","short_description":"Show releases available for the content host","deprecated":true}],"formats":null,"full_description":"\n\u003cp\u003eA hint for choosing the right value for the releaseVer param\u003c/p\u003e\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eUUID of the content host\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/systems/content_override","name":"content_override","apis":[{"api_url":"/katello/api/systems/:id/content_override","http_method":"PUT","short_description":"Set content overrides for the content host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eUUID of the content host\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"content_override","full_name":"content_override","description":"\n\u003cp\u003eContent override parameters\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"content_label","full_name":"content_override[content_label]","description":"\n\u003cp\u003eLabel of the content\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"value","full_name":"content_override[value]","description":"\n\u003cp\u003eOverride to 0/1, or ‘default’\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"Must be one of: 0, 1, default.","expected_type":"string","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/systems/product_content","name":"product_content","apis":[{"api_url":"/katello/api/systems/:id/product_content","http_method":"GET","short_description":"Get content overrides for the content host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eUUID of the content host\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null},"host_packages":{"doc_url":"../apidoc/v2/host_packages","api_url":"/api","name":"Host packages","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/host_packages/index","name":"index","apis":[{"api_url":"/api/hosts/:host_id/packages","http_method":"GET","short_description":"List packages installed on the host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_packages/install","name":"install","apis":[{"api_url":"/api/hosts/:host_id/packages/install","http_method":"PUT","short_description":"Install packages remotely","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"packages","full_name":"packages","description":"\n\u003cp\u003eList of package names\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"groups","full_name":"groups","description":"\n\u003cp\u003eList of package group names\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_packages/upgrade","name":"upgrade","apis":[{"api_url":"/api/hosts/:host_id/packages/upgrade","http_method":"PUT","short_description":"Update packages remotely","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"packages","full_name":"packages","description":"\n\u003cp\u003elist of packages names\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_packages/upgrade_all","name":"upgrade_all","apis":[{"api_url":"/api/hosts/:host_id/packages/upgrade_all","http_method":"PUT","short_description":"Update packages remotely","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_packages/remove","name":"remove","apis":[{"api_url":"/api/hosts/:host_id/packages/remove","http_method":"PUT","short_description":"Uninstall packages remotely","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"packages","full_name":"packages","description":"\n\u003cp\u003eList of package names\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"groups","full_name":"groups","description":"\n\u003cp\u003eList of package group names\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[]},"subscriptions":{"doc_url":"../apidoc/v2/subscriptions","api_url":"/api","name":"Subscriptions","short_description":null,"full_description":"\n\u003cp\u003eSubscriptions management.\u003c/p\u003e\n","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/subscriptions/index","name":"index","apis":[{"api_url":"/katello/api/organizations/:organization_id/subscriptions","http_method":"GET","short_description":"List organization subscriptions","deprecated":null},{"api_url":"/katello/api/subscriptions","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘name DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"full_results","full_name":"full_results","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"sort","full_name":"sort","description":"\n\u003cp\u003eHash version of ‘order’ param\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"by","full_name":"sort[by]","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"sort[order]","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eid of a host\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"activation_key_id","full_name":"activation_key_id","description":"\n\u003cp\u003eActivation key ID\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"available_for","full_name":"available_for","description":"\n\u003cp\u003eObject to show subscriptions available for, either ‘host’ or ‘activation_key’\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"match_host","full_name":"match_host","description":"\n\u003cp\u003eIgnore subscriptions that are unavailable to the specified host\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"match_installed","full_name":"match_installed","description":"\n\u003cp\u003eReturn subscriptions that match installed products of the specified host\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"no_overlap","full_name":"no_overlap","description":"\n\u003cp\u003eReturn subscriptions which do not overlap with a currently-attached subscription\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/subscriptions/show","name":"show","apis":[{"api_url":"/katello/api/organizations/:organization_id/subscriptions/:id","http_method":"GET","short_description":"Show a subscription","deprecated":null},{"api_url":"/katello/api/subscriptions/:id","http_method":"GET","short_description":"Show a subscription","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"id","full_name":"id","description":"\n\u003cp\u003eSubscription identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/subscriptions/create","name":"create","apis":[{"api_url":"/katello/api/activation_keys/:activation_key_id/subscriptions","http_method":"POST","short_description":"Add a subscription to an activation key","deprecated":true}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eSubscription Pool uuid\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"activation_key_id","full_name":"activation_key_id","description":"\n\u003cp\u003eID of the activation key\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"quantity","full_name":"quantity","description":"\n\u003cp\u003eQuantity of this subscriptions to add\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"subscriptions","full_name":"subscriptions","description":"\n\u003cp\u003eArray of subscriptions to add\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"id","full_name":"subscriptions[id]","description":"\n\u003cp\u003eSubscription Pool uuid\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"quantity","full_name":"subscriptions[quantity]","description":"\n\u003cp\u003eQuantity of this subscriptions to add\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/subscriptions/destroy","name":"destroy","apis":[{"api_url":"/katello/api/activation_keys/:activation_key_id/subscriptions/:id","http_method":"DELETE","short_description":"Unattach a subscription","deprecated":true}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eSubscription ID\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"activation_key_id","full_name":"activation_key_id","description":"\n\u003cp\u003eactivation key ID\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/subscriptions/upload","name":"upload","apis":[{"api_url":"/katello/api/organizations/:organization_id/subscriptions/upload","http_method":"POST","short_description":"Upload a subscription manifest","deprecated":null},{"api_url":"/katello/api/subscriptions/upload","http_method":"POST","short_description":"Upload a subscription manifest","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization id\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"content","full_name":"content","description":"\n\u003cp\u003eSubscription manifest file\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"File","expected_type":"string","metadata":null,"show":true},{"name":"repository_url","full_name":"repository_url","description":"\n\u003cp\u003erepository url\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/subscriptions/refresh_manifest","name":"refresh_manifest","apis":[{"api_url":"/katello/api/organizations/:organization_id/subscriptions/refresh_manifest","http_method":"PUT","short_description":"Refresh previously imported manifest for Red Hat provider","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization id\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/subscriptions/delete_manifest","name":"delete_manifest","apis":[{"api_url":"/katello/api/organizations/:organization_id/subscriptions/delete_manifest","http_method":"POST","short_description":"Delete manifest from Red Hat provider","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization id\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/subscriptions/manifest_history","name":"manifest_history","apis":[{"api_url":"/katello/api/organizations/:organization_id/subscriptions/manifest_history","http_method":"GET","short_description":"obtain manifest history for subscriptions","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[]},"host_errata":{"doc_url":"../apidoc/v2/host_errata","api_url":"/api","name":"Host errata","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/host_errata/index","name":"index","apis":[{"api_url":"/api/hosts/:host_id/errata","http_method":"GET","short_description":"List errata available for the content host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eUUID of the content host\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003eCalculate Applicable Errata based on a particular Content View\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eCalculate Applicable Errata based on a particular Environment\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘name DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"full_results","full_name":"full_results","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"sort","full_name":"sort","description":"\n\u003cp\u003eHash version of ‘order’ param\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"by","full_name":"sort[by]","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"sort[order]","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_errata/apply","name":"apply","apis":[{"api_url":"/api/hosts/:host_id/errata/apply","http_method":"PUT","short_description":"Schedule errata for installation","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eHost ID\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"errata_ids","full_name":"errata_ids","description":"\n\u003cp\u003eList of Errata ids to install\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_errata/show","name":"show","apis":[{"api_url":"/api/hosts/:host_id/errata/:id","http_method":"GET","short_description":"Retrieve a single errata for a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eHost ID\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"id","full_name":"id","description":"\n\u003cp\u003eErrata id of the erratum (RHSA-2012:108)\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[]},"content_view_filter_rules":{"doc_url":"../apidoc/v2/content_view_filter_rules","api_url":"/api","name":"Content view filter rules","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/content_view_filter_rules/index","name":"index","apis":[{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/rules","http_method":"GET","short_description":"List filter rules","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003efilter identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_filter_rules/create","name":"create","apis":[{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/rules","http_method":"POST","short_description":"Create a filter rule. The parameters included should be based upon the filter type.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003efilter identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"name","full_name":"name","description":"\n\u003cp\u003epackage or package group: name\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"version","full_name":"version","description":"\n\u003cp\u003epackage: version\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"min_version","full_name":"min_version","description":"\n\u003cp\u003epackage: minimum version\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"max_version","full_name":"max_version","description":"\n\u003cp\u003epackage: maximum version\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"errata_id","full_name":"errata_id","description":"\n\u003cp\u003eerratum: id\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"errata_ids","full_name":"errata_ids","description":"\n\u003cp\u003eerratum: IDs or a select all object\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"start_date","full_name":"start_date","description":"\n\u003cp\u003eerratum: start date (YYYY-MM-DD)\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"end_date","full_name":"end_date","description":"\n\u003cp\u003eerratum: end date (YYYY-MM-DD)\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"types","full_name":"types","description":"\n\u003cp\u003eerratum: types (enhancement, bugfix, security)\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"date_type","full_name":"date_type","description":"\n\u003cp\u003eerratum: search using the ‘Issued On’ or ‘Updated On’ column of the errata. Values are ‘issued’/‘updated’\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_filter_rules/show","name":"show","apis":[{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/rules/:id","http_method":"GET","short_description":"Show filter rule info","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003efilter identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"id","full_name":"id","description":"\n\u003cp\u003erule identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_filter_rules/update","name":"update","apis":[{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/rules/:id","http_method":"PUT","short_description":"Update a filter rule. The parameters included should be based upon the filter type.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003efilter identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"id","full_name":"id","description":"\n\u003cp\u003erule identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"name","full_name":"name","description":"\n\u003cp\u003epackage or package group: name\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"version","full_name":"version","description":"\n\u003cp\u003epackage: version\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"min_version","full_name":"min_version","description":"\n\u003cp\u003epackage: minimum version\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"max_version","full_name":"max_version","description":"\n\u003cp\u003epackage: maximum version\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"errata_id","full_name":"errata_id","description":"\n\u003cp\u003eerratum: id\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"start_date","full_name":"start_date","description":"\n\u003cp\u003eerratum: start date (YYYY-MM-DD)\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"end_date","full_name":"end_date","description":"\n\u003cp\u003eerratum: end date (YYYY-MM-DD)\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"types","full_name":"types","description":"\n\u003cp\u003eerratum: types (enhancement, bugfix, security)\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_filter_rules/destroy","name":"destroy","apis":[{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/rules/:id","http_method":"DELETE","short_description":"Delete a filter rule","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003efilter identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"id","full_name":"id","description":"\n\u003cp\u003erule identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null},"content_view_filters":{"doc_url":"../apidoc/v2/content_view_filters","api_url":"/api","name":"Content view filters","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/content_view_filters/index","name":"index","apis":[{"api_url":"/katello/api/content_views/:content_view_id/filters","http_method":"get","short_description":"list filters","deprecated":null},{"api_url":"/katello/api/content_view_filters","http_method":"get","short_description":"list filters","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘name DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"full_results","full_name":"full_results","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"sort","full_name":"sort","description":"\n\u003cp\u003eHash version of ‘order’ param\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"by","full_name":"sort[by]","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"sort[order]","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}]},{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"name","full_name":"name","description":"\n\u003cp\u003efilter content view filters by name\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_filters/create","name":"create","apis":[{"api_url":"/katello/api/content_views/:content_view_id/filters","http_method":"post","short_description":"create a filter for a content view","deprecated":null},{"api_url":"/katello/api/content_view_filters","http_method":"post","short_description":"create a filter for a content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"name","full_name":"name","description":"\n\u003cp\u003ename of the filter\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"type","full_name":"type","description":"\n\u003cp\u003etype of filter (e.g. rpm, package_group, erratum)\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"original_packages","full_name":"original_packages","description":"\n\u003cp\u003eadd all packages without errata to the included/excluded list. (package filter only)\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"inclusion","full_name":"inclusion","description":"\n\u003cp\u003especifies if content should be included or excluded, default: inclusion=false\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"repository_ids","full_name":"repository_ids","description":"\n\u003cp\u003elist of repository ids\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"description","full_name":"description","description":"\n\u003cp\u003edescription of the filter\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_filters/show","name":"show","apis":[{"api_url":"/katello/api/content_views/:content_view_id/filters/:id","http_method":"get","short_description":"show filter info","deprecated":null},{"api_url":"/katello/api/content_view_filters/:id","http_method":"get","short_description":"show filter info","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"id","full_name":"id","description":"\n\u003cp\u003efilter identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_filters/update","name":"update","apis":[{"api_url":"/katello/api/content_views/:content_view_id/filters/:id","http_method":"put","short_description":"update a filter","deprecated":null},{"api_url":"/katello/api/content_view_filters/:id","http_method":"put","short_description":"update a filter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"id","full_name":"id","description":"\n\u003cp\u003efilter identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"name","full_name":"name","description":"\n\u003cp\u003enew name for the filter\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"original_packages","full_name":"original_packages","description":"\n\u003cp\u003eadd all packages without errata to the included/excluded list. (package filter only)\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"inclusion","full_name":"inclusion","description":"\n\u003cp\u003especifies if content should be included or excluded, default: inclusion=false\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"repository_ids","full_name":"repository_ids","description":"\n\u003cp\u003elist of repository ids\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_filters/destroy","name":"destroy","apis":[{"api_url":"/katello/api/content_views/:content_view_id/filters/:id","http_method":"delete","short_description":"delete a filter","deprecated":null},{"api_url":"/katello/api/content_view_filters/:id","http_method":"delete","short_description":"delete a filter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"id","full_name":"id","description":"\n\u003cp\u003efilter identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null},"lifecycle_environments":{"doc_url":"../apidoc/v2/lifecycle_environments","api_url":"/api","name":"Lifecycle environments","short_description":null,"full_description":"\n\u003ch1 id=\"description\"\u003eDescription\u003c/h1\u003e\n\n\u003cp\u003eAn environment is a basic organization structure that groups systems, products, repositories, etc. Every system belongs to one environment and it’s isolated inside so that it can see only content that is in its environment.\u003c/p\u003e\n\n\u003ch2 id=\"chains\"\u003eChains\u003c/h2\u003e\n\n\u003cp\u003eEnvironments are ordered into chains and their content (propducts, repositories, tempaltes, packages) can be moved to an environment only from its prior environment. You can have for example chain like:\u003c/p\u003e\n\n\u003cpre\u003e\u003ccode\u003eLibrary -\u0026gt; Development -\u0026gt; Testing -\u0026gt; Production\u003c/code\u003e\u003c/pre\u003e\n\n\u003cp\u003eEach change in an environment is done through a changeset in an action called promotion.\u003c/p\u003e\n\n\u003ch2 id=\"library\"\u003eLibrary\u003c/h2\u003e\n\n\u003cp\u003eLibrary is a special environment that has no ascendant: All the content starts in this environment. More chains can start from the library environment but no further branching of a chain is enabled.\u003c/p\u003e\n","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/lifecycle_environments/index","name":"index","apis":[{"api_url":"/katello/api/environments","http_method":"GET","short_description":"List environments in an organization","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/environments","http_method":"GET","short_description":"List environments in an organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"library","full_name":"library","description":"\n\u003cp\u003eset true if you want to see only library environments\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Must be one of: true, false.","expected_type":"string","metadata":null,"show":true},{"name":"name","full_name":"name","description":"\n\u003cp\u003efilter only environments containing this name\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/lifecycle_environments/show","name":"show","apis":[{"api_url":"/katello/api/environments/:id","http_method":"GET","short_description":"Show an environment","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/environments/:environment_id","http_method":"GET","short_description":"Show an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the environment\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/lifecycle_environments/create","name":"create","apis":[{"api_url":"/katello/api/environments","http_method":"POST","short_description":"Create an environment","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/environments","http_method":"POST","short_description":"Create an environment in an organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003ename of organization\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"name","full_name":"name","description":"\n\u003cp\u003ename of the environment\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"label","full_name":"label","description":"\n\u003cp\u003elabel of the environment\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"description","full_name":"description","description":"\n\u003cp\u003edescription of the environment\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"prior","full_name":"prior","description":"\n\u003cp\u003eID of an environment that is prior to the new environment in the chain. It has to be either the ID of Library or the ID of an environment at the end of a chain. This param exists for backwards compatibility purposes. Please use prior_id.\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"prior_id","full_name":"prior_id","description":"\n\u003cp\u003eID of an environment that is prior to the new environment in the chain. It has to be either the ID of Library or the ID of an environment at the end of a chain.\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/lifecycle_environments/update","name":"update","apis":[{"api_url":"/katello/api/environments/:id","http_method":"PUT","short_description":"Update an environment","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/environments/:id","http_method":"PUT","short_description":"Update an environment in an organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the environment\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003ename of the organization\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"new_name","full_name":"new_name","description":"\n\u003cp\u003enew name to be given to the environment\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"description","full_name":"description","description":"\n\u003cp\u003edescription of the environment\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/lifecycle_environments/destroy","name":"destroy","apis":[{"api_url":"/katello/api/environments/:id","http_method":"DELETE","short_description":"Destroy an environment","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/environments/:id","http_method":"DELETE","short_description":"Destroy an environment in an organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the environment\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/lifecycle_environments/paths","name":"paths","apis":[{"api_url":"/katello/api/organizations/:organization_id/environments/paths","http_method":"GET","short_description":"List environment paths","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"permission_type","full_name":"permission_type","description":"\n\u003cp\u003eThe associated permission type. One of (readable | promotable) Default: readable\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/lifecycle_environments/repositories","name":"repositories","apis":[{"api_url":"/katello/api/organizations/:organization_id/environments/:id/repositories","http_method":"GET","short_description":"List repositories available in the environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eenvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[]},"capsule_content":{"doc_url":"../apidoc/v2/capsule_content","api_url":"/api","name":"Capsule content","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/capsule_content/lifecycle_environments","name":"lifecycle_environments","apis":[{"api_url":"/katello/api/capsules/:id/content/lifecycle_environments","http_method":"GET","short_description":"List the lifecycle environments attached to the capsule","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the capsule\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eId of the organization to limit environments on\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/capsule_content/available_lifecycle_environments","name":"available_lifecycle_environments","apis":[{"api_url":"/katello/api/capsules/:id/content/available_lifecycle_environments","http_method":"GET","short_description":"List the lifecycle environments not attached to the capsule","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the capsule\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eId of the organization to limit environments on\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/capsule_content/add_lifecycle_environment","name":"add_lifecycle_environment","apis":[{"api_url":"/katello/api/capsules/:id/content/lifecycle_environments","http_method":"POST","short_description":"Add lifecycle environments to the capsule","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the capsule\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eId of the lifecycle environment\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/capsule_content/remove_lifecycle_environment","name":"remove_lifecycle_environment","apis":[{"api_url":"/katello/api/capsules/:id/content/lifecycle_environments/:environment_id","http_method":"DELETE","short_description":"Remove lifecycle environments from the capsule","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the capsule\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eId of the lifecycle environment\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/capsule_content/sync","name":"sync","apis":[{"api_url":"/katello/api/capsules/:id/content/sync","http_method":"POST","short_description":"Synchronize the content to the capsule","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the capsule\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eId of the environment to limit the synchronization on\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/capsule_content/sync_status","name":"sync_status","apis":[{"api_url":"/katello/api/capsules/:id/content/sync","http_method":"GET","short_description":"Get current capsule synchronization status","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the capsule\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eId of the organization to get the status for\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/capsule_content/cancel_sync","name":"cancel_sync","apis":[{"api_url":"/katello/api/capsules/:id/content/sync","http_method":"DELETE","short_description":"Cancel running capsule synchronization.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the capsule\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[]},"content_view_versions":{"doc_url":"../apidoc/v2/content_view_versions","api_url":"/api","name":"Content view versions","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/content_view_versions/index","name":"index","apis":[{"api_url":"/katello/api/content_view_versions","http_method":"GET","short_description":"List content view versions","deprecated":null},{"api_url":"/katello/api/content_views/:content_view_id/content_view_versions","http_method":"GET","short_description":"List content view versions","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003eContent view identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eFilter versions by environment\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"puppet_module_id","full_name":"puppet_module_id","description":"\n\u003cp\u003eFilter versions by puppet module\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"version","full_name":"version","description":"\n\u003cp\u003eFilter versions by version number\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"composite_version_id","full_name":"composite_version_id","description":"\n\u003cp\u003eFilter versions that are components in the specified composite version\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘name DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"full_results","full_name":"full_results","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"sort","full_name":"sort","description":"\n\u003cp\u003eHash version of ‘order’ param\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"by","full_name":"sort[by]","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"sort[order]","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_versions/show","name":"show","apis":[{"api_url":"/katello/api/content_view_versions/:id","http_method":"GET","short_description":"Show content view version","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent view version identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_versions/promote","name":"promote","apis":[{"api_url":"/katello/api/content_view_versions/:id/promote","http_method":"POST","short_description":"Promote a content view version","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent view version identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"force","full_name":"force","description":"\n\u003cp\u003eforce content view promotion and bypass lifecycle environment restriction\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"environment_id","full_name":"environment_id","description":"","required":false,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_versions/export","name":"export","apis":[{"api_url":"/katello/api/content_view_versions/:id/export","http_method":"POST","short_description":"Export a content view version","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent view version identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"export_to_iso","full_name":"export_to_iso","description":"\n\u003cp\u003eExport to ISO format\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"iso_mb_size","full_name":"iso_mb_size","description":"\n\u003cp\u003emaximum size of each ISO in MB\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"since","full_name":"since","description":"\n\u003cp\u003eOptional date of last export (ex: 2010-01-01T12:00:00Z)\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Date","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_versions/destroy","name":"destroy","apis":[{"api_url":"/katello/api/content_view_versions/:id","http_method":"DELETE","short_description":"Remove content view version","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent view version identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_versions/incremental_update","name":"incremental_update","apis":[{"api_url":"/katello/api/content_view_versions/incremental_update","http_method":"POST","short_description":"Perform an Incremental Update on one or more Content View Versions","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_environments","full_name":"content_view_version_environments","description":"","required":false,"allow_nil":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"content_view_version_id","full_name":"content_view_version_environments[content_view_version_id]","description":"\n\u003cp\u003eContent View Version Ids to perform an incremental update on. May contain composites as well as one or more components to update.\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"environment_ids","full_name":"content_view_version_environments[environment_ids]","description":"\n\u003cp\u003eThe list of environments to promote the specified Content View Version to (replacing the older version).\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]},{"name":"description","full_name":"description","description":"\n\u003cp\u003eThe description for the new generated Content View Versions\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"resolve_dependencies","full_name":"resolve_dependencies","description":"\n\u003cp\u003eIf true, when adding the specified errata or packages, any needed dependencies will be copied as well.\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"propagate_all_composites","full_name":"propagate_all_composites","description":"\n\u003cp\u003eIf true, will publish a new composite version using any specified content_view_version_id that has been promoted to a lifecycle environment.\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"add_content","full_name":"add_content","description":"","required":false,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"errata_ids","full_name":"add_content[errata_ids]","description":"\n\u003cp\u003eErrata uuids to copy into the new versions.\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"package_ids","full_name":"add_content[package_ids]","description":"\n\u003cp\u003ePackage uuids to copy into the new versions.\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"puppet_module_ids","full_name":"add_content[puppet_module_ids]","description":"\n\u003cp\u003ePuppet Modules to copy into the new versions.\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]},{"name":"update_systems","full_name":"update_systems","description":"\n\u003cp\u003eAfter generating the incremental update, apply the changes to the specified systems. Only Errata are supported currently.\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"included","full_name":"update_systems[included]","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"search","full_name":"update_systems[included][search]","description":"\n\u003cp\u003eSearch string for systems to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"ids","full_name":"update_systems[included][ids]","description":"\n\u003cp\u003eList of system ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]},{"name":"excluded","full_name":"update_systems[excluded]","description":"","required":false,"allow_nil":true,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"ids","full_name":"update_systems[excluded][ids]","description":"\n\u003cp\u003eList of system ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}]},{"name":"update_all_systems","full_name":"update_systems[update_all_systems]","description":"\n\u003cp\u003eUpdate all editable and applicable systems, not just ones using the selected Content View Versions and Environments\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null},"host_subscriptions":{"doc_url":"../apidoc/v2/host_subscriptions","api_url":"/api","name":"Host subscriptions","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/host_subscriptions/index","name":"index","apis":[{"api_url":"/api/hosts/:host_id/subscriptions","http_method":"GET","short_description":"List a host's subscriptions","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eId of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_subscriptions/auto_attach","name":"auto_attach","apis":[{"api_url":"/api/hosts/:host_id/subscriptions/auto_attach","http_method":"PUT","short_description":"Trigger an auto-attach of subscriptions","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eId of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_subscriptions/events","name":"events","apis":[{"api_url":"/api/hosts/:host_id/subscriptions/events","http_method":"GET","short_description":"List subscription events for the host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eId of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_subscriptions/remove_subscriptions","name":"remove_subscriptions","apis":[{"api_url":"/api/hosts/:host_id/subscriptions/remove_subscriptions","http_method":"PUT","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eId of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"subscriptions","full_name":"subscriptions","description":"\n\u003cp\u003eArray of subscriptions to remove\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"id","full_name":"subscriptions[id]","description":"\n\u003cp\u003eSubscription Pool id\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"quantity","full_name":"subscriptions[quantity]","description":"\n\u003cp\u003eIf specified, remove the first instance of a subscription with matching id and quantity\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_subscriptions/add_subscriptions","name":"add_subscriptions","apis":[{"api_url":"/api/hosts/:host_id/subscriptions/add_subscriptions","http_method":"PUT","short_description":"Add a subscription to a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eId of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"subscriptions","full_name":"subscriptions","description":"\n\u003cp\u003eArray of subscriptions to add\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"id","full_name":"subscriptions[id]","description":"\n\u003cp\u003eSubscription Pool id\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"quantity","full_name":"subscriptions[quantity]","description":"\n\u003cp\u003eQuantity of this subscriptions to add\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[]},"sync_plans":{"doc_url":"../apidoc/v2/sync_plans","api_url":"/api","name":"Sync plans","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/sync_plans/index","name":"index","apis":[{"api_url":"/katello/api/sync_plans","http_method":"GET","short_description":"List sync plans","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/sync_plans","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eFilter sync plans by organization name or label\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"name","full_name":"name","description":"\n\u003cp\u003efilter by name\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"sync_date","full_name":"sync_date","description":"\n\u003cp\u003efilter by sync date\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"interval","full_name":"interval","description":"\n\u003cp\u003efilter by interval\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Must be one of: hourly, daily, weekly.","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/sync_plans/show","name":"show","apis":[{"api_url":"/katello/api/organizations/:organization_id/sync_plans/:id","http_method":"GET","short_description":"Show a sync plan","deprecated":null},{"api_url":"/katello/api/sync_plans/:id","http_method":"GET","short_description":"Show a sync plan","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eFilter sync plans by organization name or label\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"id","full_name":"id","description":"\n\u003cp\u003esync plan numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/sync_plans/create","name":"create","apis":[{"api_url":"/katello/api/organizations/:organization_id/sync_plans","http_method":"POST","short_description":"Create a sync plan","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eFilter sync plans by organization name or label\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"name","full_name":"name","description":"\n\u003cp\u003esync plan name\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"interval","full_name":"interval","description":"\n\u003cp\u003ehow often synchronization should run\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"Must be one of: hourly, daily, weekly.","expected_type":"string","metadata":null,"show":true},{"name":"sync_date","full_name":"sync_date","description":"\n\u003cp\u003estart datetime of synchronization\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"description","full_name":"description","description":"\n\u003cp\u003esync plan description\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"enabled","full_name":"enabled","description":"\n\u003cp\u003eenables or disables synchronization\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"boolean","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/sync_plans/update","name":"update","apis":[{"api_url":"/katello/api/organizations/:organization_id/sync_plans/:id","http_method":"PUT","short_description":"Update a sync plan","deprecated":null},{"api_url":"/katello/api/sync_plans/:id","http_method":"PUT","short_description":"Update a sync plan","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eFilter sync plans by organization name or label\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"id","full_name":"id","description":"\n\u003cp\u003esync plan numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"name","full_name":"name","description":"\n\u003cp\u003esync plan name\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"interval","full_name":"interval","description":"\n\u003cp\u003ehow often synchronization should run\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Must be one of: hourly, daily, weekly.","expected_type":"string","metadata":null,"show":true},{"name":"sync_date","full_name":"sync_date","description":"\n\u003cp\u003estart datetime of synchronization\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"description","full_name":"description","description":"\n\u003cp\u003esync plan description\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"enabled","full_name":"enabled","description":"\n\u003cp\u003eenables or disables synchronization\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/sync_plans/destroy","name":"destroy","apis":[{"api_url":"/katello/api/organizations/:organization_id/sync_plans/:id","http_method":"DELETE","short_description":"Destroy a sync plan","deprecated":null},{"api_url":"/katello/api/sync_plans/:id","http_method":"DELETE","short_description":"Destroy a sync plan","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eFilter sync plans by organization name or label\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"id","full_name":"id","description":"\n\u003cp\u003esync plan numeric identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/sync_plans/add_products","name":"add_products","apis":[{"api_url":"/katello/api/organizations/:organization_id/sync_plans/:id/add_products","http_method":"PUT","short_description":"Add products to sync plan","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the sync plan\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"product_ids","full_name":"product_ids","description":"\n\u003cp\u003eList of product ids to add to the sync plan\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/sync_plans/remove_products","name":"remove_products","apis":[{"api_url":"/katello/api/organizations/:organization_id/sync_plans/:id/remove_products","http_method":"PUT","short_description":"Remove products from sync plan","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the sync plan\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"product_ids","full_name":"product_ids","description":"\n\u003cp\u003eList of product ids to remove from the sync plan\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/sync_plans/sync","name":"sync","apis":[{"api_url":"/katello/api/sync_plans/:id/sync","http_method":"PUT","short_description":"Initiate a sync of the products attached to the sync plan","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/sync_plans/:id/sync","http_method":"PUT","short_description":"Initiate a sync of the products attached to the sync plan","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the sync plan\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null},"repositories":{"doc_url":"../apidoc/v2/repositories","api_url":"/api","name":"Repositories","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/repositories/index","name":"index","apis":[{"api_url":"/katello/api/repositories","http_method":"GET","short_description":"List of enabled repositories","deprecated":null},{"api_url":"/katello/api/content_views/:id/repositories","http_method":"GET","short_description":"List of repositories for a content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of an organization to show repositories in\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"product_id","full_name":"product_id","description":"\n\u003cp\u003eID of a product to show repositories of\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eID of an environment to show repositories in\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003eID of a content view to show repositories in\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003eID of a content view version to show repositories in\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"erratum_id","full_name":"erratum_id","description":"\n\u003cp\u003eId of an erratum to find repositories that contain the erratum\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"rpm_id","full_name":"rpm_id","description":"\n\u003cp\u003eId of a package to find repositories that contain the rpm\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"library","full_name":"library","description":"\n\u003cp\u003eshow repositories in Library and the default content view\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"content_type","full_name":"content_type","description":"\n\u003cp\u003elimit to only repositories of this time\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"name","full_name":"name","description":"\n\u003cp\u003ename of the repository\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"available_for","full_name":"available_for","description":"\n\u003cp\u003einterpret specified object to return only Repositories that can be associated with specified object. Only ‘content_view’ is supported.\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘name DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"full_results","full_name":"full_results","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"sort","full_name":"sort","description":"\n\u003cp\u003eHash version of ‘order’ param\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"by","full_name":"sort[by]","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"order","full_name":"sort[order]","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repositories/create","name":"create","apis":[{"api_url":"/katello/api/repositories","http_method":"POST","short_description":"Create a custom repository","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"label","full_name":"label","description":"","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"product_id","full_name":"product_id","description":"\n\u003cp\u003eProduct the repository belongs to\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"url","full_name":"url","description":"\n\u003cp\u003erepository source url\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"gpg_key_id","full_name":"gpg_key_id","description":"\n\u003cp\u003eid of the gpg key that will be assigned to the new repository\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"unprotected","full_name":"unprotected","description":"\n\u003cp\u003etrue if this repository can be published via HTTP\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"content_type","full_name":"content_type","description":"\n\u003cp\u003etype of repo (either ‘yum’, ‘puppet’ or ‘docker’)\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"checksum_type","full_name":"checksum_type","description":"\n\u003cp\u003echecksum of the repository, currently ‘sha1’ \u0026amp; ‘sha256’ are supported.‘\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"docker_upstream_name","full_name":"docker_upstream_name","description":"\n\u003cp\u003ename of the upstream docker repository\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"download_policy","full_name":"download_policy","description":"\n\u003cp\u003edownload policy for yum repos (either ‘immediate’, ‘on_demand’, or ‘background’)\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Must be one of: immediate, on_demand, background.","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repositories/repository_types","name":"repository_types","apis":[{"api_url":"/katello/api/repositories/repository_types","http_method":"GET","short_description":"Show the available repository types","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"creatable","full_name":"creatable","description":"\n\u003cp\u003eWhen set to ‘True’ repository types that are creatable will be returned\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repositories/show","name":"show","apis":[{"api_url":"/katello/api/repositories/:id","http_method":"GET","short_description":"Show a custom repository","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003erepository ID\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repositories/sync","name":"sync","apis":[{"api_url":"/katello/api/repositories/:id/sync","http_method":"POST","short_description":"Sync a repository","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003erepository ID\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"source_url","full_name":"source_url","description":"\n\u003cp\u003etemporarily override feed URL for sync\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"incremental","full_name":"incremental","description":"\n\u003cp\u003eperform an incremental import\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repositories/export","name":"export","apis":[{"api_url":"/katello/api/repositories/:id/export","http_method":"POST","short_description":"Export a repository","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eRepository identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"export_to_iso","full_name":"export_to_iso","description":"\n\u003cp\u003eExport to ISO format\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"iso_mb_size","full_name":"iso_mb_size","description":"\n\u003cp\u003emaximum size of each ISO in MB\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"since","full_name":"since","description":"\n\u003cp\u003eOptional date of last export (ex: 2010-01-01T12:00:00Z)\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Date","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repositories/update","name":"update","apis":[{"api_url":"/katello/api/repositories/:id","http_method":"PUT","short_description":"Update a custom repository","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n\u003cp\u003eNew name for the repository\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"id","full_name":"id","description":"\n\u003cp\u003erepository ID\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"gpg_key_id","full_name":"gpg_key_id","description":"\n\u003cp\u003eID of a gpg key that will be assigned to this repository\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"unprotected","full_name":"unprotected","description":"\n\u003cp\u003etrue if this repository can be published via HTTP\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string","metadata":null,"show":true},{"name":"checksum_type","full_name":"checksum_type","description":"\n\u003cp\u003echecksum of the repository, currently ‘sha1’ \u0026amp; ‘sha256’ are supported.‘\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"url","full_name":"url","description":"\n\u003cp\u003ethe feed url of the original repository\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"docker_upstream_name","full_name":"docker_upstream_name","description":"\n\u003cp\u003ename of the upstream docker repository\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"download_policy","full_name":"download_policy","description":"\n\u003cp\u003edownload policy for yum repos (either ‘immediate’, ‘on_demand’, or ‘background’)\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"Must be one of: immediate, on_demand, background.","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repositories/destroy","name":"destroy","apis":[{"api_url":"/katello/api/repositories/:id","http_method":"DELETE","short_description":"Destroy a custom repository","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repositories/sync_complete","name":"sync_complete","apis":[{"api_url":"/katello/api/repositories/sync_complete","http_method":"POST","short_description":null,"deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eURL for post sync notification from pulp\u003c/p\u003e\n","errors":[],"params":[{"name":"token","full_name":"token","description":"\n\u003cp\u003eshared secret token\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"payload","full_name":"payload","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"repo_id","full_name":"payload[repo_id]","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}]},{"name":"call_report","full_name":"call_report","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"task_id","full_name":"call_report[task_id]","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repositories/remove_content","name":"remove_content","apis":[{"api_url":"/katello/api/repositories/:id/remove_packages","http_method":"PUT","short_description":null,"deprecated":null},{"api_url":"/katello/api/repositories/:id/remove_docker_manifests","http_method":"PUT","short_description":null,"deprecated":null},{"api_url":"/katello/api/repositories/:id/remove_puppet_modules","http_method":"PUT","short_description":null,"deprecated":null},{"api_url":"/katello/api/repositories/:id/remove_content","http_method":"PUT","short_description":null,"deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eRemove content from a repository\u003c/p\u003e\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003erepository ID\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"uuids","full_name":"uuids","description":"\n\u003cp\u003eArray of content uuids to remove\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true},{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eArray of content ids to remove\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repositories/upload_content","name":"upload_content","apis":[{"api_url":"/katello/api/repositories/:id/upload_content","http_method":"POST","short_description":"Upload content into the repository","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003erepository ID\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"content","full_name":"content","description":"\n\u003cp\u003eContent files to upload. Can be a single file or array of files.\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"File","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repositories/import_uploads","name":"import_uploads","apis":[{"api_url":"/katello/api/repositories/:id/import_uploads","http_method":"PUT","short_description":"Import uploads into a repository","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eRepository id\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true},{"name":"upload_ids","full_name":"upload_ids","description":"\n\u003cp\u003eArray of upload ids to import\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repositories/gpg_key_content","name":"gpg_key_content","apis":[{"api_url":"/katello/api/repositories/:id/gpg_key_content","http_method":"GET","short_description":"Return the content of a repo gpg key, used directly by yum","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null},"repository_sets":{"doc_url":"../apidoc/v2/repository_sets","api_url":"/api","name":"Repository sets","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/repository_sets/index","name":"index","apis":[{"api_url":"/katello/api/products/:product_id/repository_sets","http_method":"GET","short_description":"List repository sets for a product.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"product_id","full_name":"product_id","description":"\n\u003cp\u003eID of a product to list repository sets from\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"name","full_name":"name","description":"\n\u003cp\u003eRepository set name to search on\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repository_sets/show","name":"show","apis":[{"api_url":"/katello/api/products/:product_id/repository_sets/:id","http_method":"GET","short_description":"Get info about a repository set","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the repository set\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"product_id","full_name":"product_id","description":"\n\u003cp\u003eID of a product to list repository sets from\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repository_sets/available_repositories","name":"available_repositories","apis":[{"api_url":"/katello/api/products/:product_id/repository_sets/:id/available_repositories","http_method":"GET","short_description":"Get list or available repositories for the repository set","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the repository set\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"product_id","full_name":"product_id","description":"\n\u003cp\u003eID of a product to list repository sets from\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repository_sets/enable","name":"enable","apis":[{"api_url":"/katello/api/products/:product_id/repository_sets/:id/enable","http_method":"PUT","short_description":"Enable a repository from the set","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the repository set to enable\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"product_id","full_name":"product_id","description":"\n\u003cp\u003eID of the product containing the repository set\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"basearch","full_name":"basearch","description":"\n\u003cp\u003eBasearch to enable\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"releasever","full_name":"releasever","description":"\n\u003cp\u003eReleasever to enable\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repository_sets/disable","name":"disable","apis":[{"api_url":"/katello/api/products/:product_id/repository_sets/:id/disable","http_method":"PUT","short_description":"Disable a repository form the set","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the repository set to enable\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"product_id","full_name":"product_id","description":"\n\u003cp\u003eID of the product containing the repository set\u003c/p\u003e\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string","metadata":null,"show":true},{"name":"basearch","full_name":"basearch","description":"\n\u003cp\u003eBasearch to disable\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"releasever","full_name":"releasever","description":"\n\u003cp\u003eReleasever to disable\u003c/p\u003e\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[]}},"link_extension":".en.html"}}

data/test/functional/capsule/content/cancel_synchronization_test.rb

@@ -0,0 +1,42 @@
+require File.join(File.dirname(__FILE__), '../../test_helper')
+require File.join(File.dirname(__FILE__), './capsule_content_helpers')
+
+describe 'capsule content cancel-synchronization' do
+  include CapsuleContentHelpers
+
+  before do
+    @cmd = ['capsule', 'content', 'cancel-synchronization']
+  end
+
+  MESSAGE = "There's no running synchronization for this capsule."
+
+  it "triggers the cancel" do
+    expected_result = success_result("#{MESSAGE}\n")
+    params = ['--id=3']
+
+    ex = api_expects(:capsule_content, :cancel_sync, 'Cancel sync') do |par|
+      par['id'] == '3'
+    end
+    ex.returns("message" => MESSAGE)
+
+    result = run_cmd(@cmd + params)
+    assert_cmd(expected_result, result)
+  end
+
+  it "resolves id from name" do
+    params = ['--name=capsule1']
+
+    ex = api_expects(:capsule_content, :cancel_sync, 'Cancel sync') do |par|
+      par['id'] == '3'
+    end
+    ex.returns("message" => MESSAGE)
+    expect_capsule_search('capsule1', '3')
+
+    run_cmd(@cmd + params)
+  end
+
+  it "is mounted under proxy too" do
+    result = run_cmd(['proxy', 'content', 'cancel-synchronization', '-h'])
+    assert_exit_code_equal(HammerCLI::EX_OK, result.exit_code)
+  end
+end