katello_api 0.0.4 → 0.0.5

data/lib/katello_api/documentation.json

@@ -1 +1 @@
-{"docs":{"name":"Foreman","info":"\n<p>Foreman v2 is currently in development and is not the default version. You may use v2 by either passing ‘version=2’ in the Accept Header or entering api/v2/ in the URL.</p>\n","copyright":"","doc_url":"/apidoc/v2","api_url":"/api","resources":{"repository_sets":{"doc_url":"/apidoc/v2/repository_sets","api_url":"/api","name":"Repository sets","short_description":null,"full_description":"","version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/repository_sets/enable","name":"enable","apis":[{"api_url":"/api/organizations/:organization_id/product/:product_id/repository_sets/:id/enable","http_method":"POST","short_description":"Enable a repository set for a product."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n<p>id of an organization the repository will be contained in</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"product_id","full_name":"product_id","description":"\n<p>id of a product the repository will be contained in</p>\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"id","full_name":"id","description":"\n<p>id or name of the repository set to enable</p>\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/repository_sets/disable","name":"disable","apis":[{"api_url":"/api/organizations/:organization_id/product/:product_id/repository_sets/:id/disable","http_method":"POST","short_description":"Enable a repository set for a product."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n<p>id of an organization the repository will be contained in</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"product_id","full_name":"product_id","description":"\n<p>id of a product the repository will be contained in</p>\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"id","full_name":"id","description":"\n<p>id of the repository set to disable</p>\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/repository_sets/index","name":"index","apis":[{"api_url":"/api/product/:product_id/repository_sets","http_method":"GET","short_description":"List repository sets for a product."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"product_id","full_name":"product_id","description":"\n<p>id of a product to list repository sets for</p>\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string"}],"examples":[],"see":[]}]},"puppet_modules":{"doc_url":"/apidoc/v2/puppet_modules","api_url":"/api","name":"Puppet modules","short_description":null,"full_description":null,"version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/puppet_modules/index","name":"index","apis":[{"api_url":"/api/repositories/:repository_id/puppet_modules","http_method":"GET","short_description":"List puppet modules"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n<p>repository numeric identifier</p>\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/puppet_modules/search","name":"search","apis":[{"api_url":"/api/repositories/:repository_id/puppet_modules/search","http_method":"GET","short_description":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n<p>repository numeric identifier</p>\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"search","full_name":"search","description":"\n<p>search expression</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/puppet_modules/show","name":"show","apis":[{"api_url":"/api/repositories/:repository_id/puppet_modules/:id","http_method":"GET","short_description":"Show a puppet module"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n<p>repository numeric identifier</p>\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"id","full_name":"id","description":"\n<p>puppet module id</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]}]},"filters":{"doc_url":"/apidoc/v2/filters","api_url":"/api","name":"Filters","short_description":null,"full_description":null,"version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/filters/index","name":"index","apis":[{"api_url":"/api/content_view_definitions/:content_view_definition_id/filters","http_method":"GET","short_description":"List filters"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_definition_id","full_name":"content_view_definition_id","description":"\n<p>id of the content view definition</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/filters/create","name":"create","apis":[{"api_url":"/api/content_view_definitions/:content_view_definition_id/filters","http_method":"POST","short_description":"Create a filter for a content view definition"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_definition_id","full_name":"content_view_definition_id","description":"\n<p>id of the content view definition</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"filter","full_name":"filter","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"name","full_name":"filter[name]","description":"\n<p>name of the filter</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"}]}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/filters/show","name":"show","apis":[{"api_url":"/api/content_view_definitions/:content_view_definition_id/filters/:id","http_method":"GET","short_description":"Show filter info"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_definition_id","full_name":"content_view_definition_id","description":"\n<p>id of the content view definition</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"id","full_name":"id","description":"\n<p>name of the filter</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/filters/destroy","name":"destroy","apis":[{"api_url":"/api/content_view_definitions/:content_view_definition_id/filters/:id","http_method":"DELETE","short_description":"Delete a filter"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_definition_id","full_name":"content_view_definition_id","description":"\n<p>id of the content view definition</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"id","full_name":"id","description":"\n<p>name of the filter</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/filters/list_products","name":"list_products","apis":[{"api_url":"/api/content_view_definitions/:content_view_definition_id/filters/:id/products","http_method":"GET","short_description":"List all the products for a content view definition filter"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_definition_id","full_name":"content_view_definition_id","description":"\n<p>id of the content view definition</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"id","full_name":"id","description":"\n<p>name of the filter</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/filters/update_products","name":"update_products","apis":[{"api_url":"/api/content_view_definitions/:content_view_definition_id/filters/:id/products","http_method":"PUT","short_description":"Update products for a content view definition filter"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_definition_id","full_name":"content_view_definition_id","description":"\n<p>content view definition identifier</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"id","full_name":"id","description":"\n<p>name of the filter</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"products","full_name":"products","description":"\n<p>Updated list of product ids</p>\n","required":true,"allow_nil":false,"validator":"Array","expected_type":"array"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/filters/list_repositories","name":"list_repositories","apis":[{"api_url":"/api/content_view_definitions/:content_view_definition_id/filters/:id/repositories","http_method":"GET","short_description":"List all the repositories for a content view definition filter"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_definition_id","full_name":"content_view_definition_id","description":"\n<p>id of the content view definition</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"id","full_name":"id","description":"\n<p>name of the filter</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/filters/update_repositories","name":"update_repositories","apis":[{"api_url":"/api/content_view_definitions/:content_view_definition_id/filters/:id/repositories","http_method":"PUT","short_description":"Update repositories for a content view definition filter"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_definition_id","full_name":"content_view_definition_id","description":"\n<p>id of the content view definition</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"id","full_name":"id","description":"\n<p>name of the filter</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"repos","full_name":"repos","description":"\n<p>Updated list of repo ids</p>\n","required":true,"allow_nil":false,"validator":"Array","expected_type":"array"}],"examples":[],"see":[]}]},"products":{"doc_url":"/apidoc/v2/products","api_url":"/api","name":"Products","short_description":null,"full_description":null,"version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/products/index","name":"index","apis":[{"api_url":"/api/environments/:environment_id/products","http_method":"GET","short_description":"List products in an environment"},{"api_url":"/api/organizations/:organization_id/products","http_method":"GET","short_description":"List all products in an organization"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n<p>organization identifier</p>\n","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"name","full_name":"name","description":"\n<p>product identifier</p>\n","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"include_marketing","full_name":"include_marketing","description":"\n<p>include marketing products in results</p>\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/products/create","name":"create","apis":[{"api_url":"/api/products","http_method":"POST","short_description":"Create a product"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"label","full_name":"label","description":"","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"provider_id","full_name":"provider_id","description":"\n<p>Provider the product belongs to</p>\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"description","full_name":"description","description":"\n<p>Product description</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"gpg_key_id","full_name":"gpg_key_id","description":"\n<p>identifier of the gpg key</p>\n","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/products/show","name":"show","apis":[{"api_url":"/api/organizations/:organization_id/products/:id","http_method":"GET","short_description":"Show a product"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n<p>organization identifier</p>\n","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"id","full_name":"id","description":"\n<p>product numeric identifier</p>\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/products/update","name":"update","apis":[{"api_url":"/api/organizations/:organization_id/products/:id","http_method":"PUT","short_description":"Update a product"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n<p>organization identifier</p>\n","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"id","full_name":"id","description":"\n<p>product numeric identifier</p>\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"product","full_name":"product","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"gpg_key_name","full_name":"product[gpg_key_name]","description":"\n<p>identifier of the gpg key</p>\n","required":false,"allow_nil":true,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"description","full_name":"product[description]","description":"\n<p>Product description</p>\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string"},{"name":"recursive","full_name":"product[recursive]","description":"\n<p>set to true to recursive update gpg key</p>\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string"}]}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/products/destroy","name":"destroy","apis":[{"api_url":"/api/organizations/:organization_id/products/:id","http_method":"DELETE","short_description":"Destroy a product"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n<p>organization identifier</p>\n","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"id","full_name":"id","description":"\n<p>product numeric identifier</p>\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/products/repositories","name":"repositories","apis":[{"api_url":"/api/environments/:environment_id/products/:id/repositories","http_method":"GET","short_description":null},{"api_url":"/api/organizations/:organization_id/products/:id/repositories","http_method":"GET","short_description":null},{"api_url":"/api/organizations/:organization_id/products/:id/repositories","http_method":"GET","short_description":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n<p>organization identifier</p>\n","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"environment_id","full_name":"environment_id","description":"\n<p>environment identifier</p>\n","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"id","full_name":"id","description":"\n<p>product numeric identifier</p>\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"include_disabled","full_name":"include_disabled","description":"\n<p>set to True if you want to list disabled repositories</p>\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string"},{"name":"name","full_name":"name","description":"\n<p>repository identifier</p>\n","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"content_view_id","full_name":"content_view_id","description":"\n<p>find repos in content view instead of default content view</p>\n","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/products/set_sync_plan","name":"set_sync_plan","apis":[{"api_url":"/api/organizations/:organization_id/products/:id/sync_plan","http_method":"POST","short_description":"Assign sync plan to product"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n<p>organization identifier</p>\n","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"id","full_name":"id","description":"\n<p>product numeric identifier</p>\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"plan_id","full_name":"plan_id","description":"\n<p>Plan numeric identifier</p>\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/products/remove_sync_plan","name":"remove_sync_plan","apis":[{"api_url":"/api/organizations/:organization_id/products/:id/sync_plan","http_method":"DELETE","short_description":"Delete assignment sync plan and product"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n<p>organization identifier</p>\n","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"id","full_name":"id","description":"\n<p>product numeric identifier</p>\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"plan_id","full_name":"plan_id","description":"\n<p>Plan numeric identifier</p>\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string"}],"examples":[],"see":[]}]},"tasks":{"doc_url":"/apidoc/v2/tasks","api_url":"/api","name":"Tasks","short_description":null,"full_description":null,"version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/tasks/index","name":"index","apis":[{"api_url":"/api/organizations/:organization_id/tasks","http_method":"GET","short_description":"List tasks of given organization"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n<p>organization identifier</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/tasks/show","name":"show","apis":[{"api_url":"/api/tasks/:id","http_method":"GET","short_description":"Show a task info"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>task identifier</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"}],"examples":[],"see":[]}]},"distributors":{"doc_url":"/apidoc/v2/distributors","api_url":"/api","name":"Distributors","short_description":null,"full_description":null,"version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/distributors/create","name":"create","apis":[{"api_url":"/api/environments/:environment_id/distributors","http_method":"POST","short_description":"Register a distributor in environment"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"distributor","full_name":"distributor","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"name","full_name":"distributor[name]","description":"\n<p>Name of the distributor</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"facts","full_name":"distributor[facts]","description":"\n<p>Key-value hash of distributor-specific facts</p>\n","required":false,"allow_nil":true,"validator":"Hash","expected_type":"hash"},{"name":"installedProducts","full_name":"distributor[installedProducts]","description":"\n<p>List of products installed on the distributor</p>\n","required":false,"allow_nil":true,"validator":"Array","expected_type":"array"},{"name":"serviceLevel","full_name":"distributor[serviceLevel]","description":"\n<p>A service level for auto-healing process, e.g. SELF-SUPPORT</p>\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string"},{"name":"releaseVer","full_name":"distributor[releaseVer]","description":"\n<p>Release of the os. The $releasever variable in repo url will be replaced with this value</p>\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string"},{"name":"location","full_name":"distributor[location]","description":"\n<p>Physical of the distributor</p>\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string"},{"name":"capabilities","full_name":"distributor[capabilities]","description":"\n<p>List of subscription capabilities</p>\n","required":false,"allow_nil":true,"validator":"Array","expected_type":"array"},{"name":"type","full_name":"distributor[type]","description":"\n<p>Type of the distributor, it should always be ‘distributor’</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"version","full_name":"distributor[version]","description":"\n<p>Version of the distributor. Defaults to the latest if not given.</p>\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string"}]}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/distributors/update","name":"update","apis":[{"api_url":"/api/distributors/:id","http_method":"PUT","short_description":"Update distributor information"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"distributor","full_name":"distributor","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"name","full_name":"distributor[name]","description":"\n<p>Name of the distributor</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"facts","full_name":"distributor[facts]","description":"\n<p>Key-value hash of distributor-specific facts</p>\n","required":false,"allow_nil":true,"validator":"Hash","expected_type":"hash"},{"name":"installedProducts","full_name":"distributor[installedProducts]","description":"\n<p>List of products installed on the distributor</p>\n","required":false,"allow_nil":true,"validator":"Array","expected_type":"array"},{"name":"serviceLevel","full_name":"distributor[serviceLevel]","description":"\n<p>A service level for auto-healing process, e.g. SELF-SUPPORT</p>\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string"},{"name":"releaseVer","full_name":"distributor[releaseVer]","description":"\n<p>Release of the os. The $releasever variable in repo url will be replaced with this value</p>\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string"},{"name":"location","full_name":"distributor[location]","description":"\n<p>Physical of the distributor</p>\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string"},{"name":"capabilities","full_name":"distributor[capabilities]","description":"\n<p>List of subscription capabilities</p>\n","required":false,"allow_nil":true,"validator":"Array","expected_type":"array"}]},{"name":"capabilities","full_name":"capabilities","description":"\n<p>For backwards capability with Red Hat hosted candlepin - List of subscription capabilities</p>\n","required":false,"allow_nil":false,"validator":"Array","expected_type":"array"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/distributors/index","name":"index","apis":[{"api_url":"/api/environments/:environment_id/distributors","http_method":"GET","short_description":"List distributors in environment"},{"api_url":"/api/organizations/:organization_id/distributors","http_method":"GET","short_description":"List distributors in organization"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>Filter distributors by name</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"pool_id","full_name":"pool_id","description":"\n<p>Filter distributors by subscribed pool</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/distributors/show","name":"show","apis":[{"api_url":"/api/distributors/:id","http_method":"GET","short_description":"Show a distributor"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>UUID of the distributor</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/distributors/export","name":"export","apis":[{"api_url":"/api/distributors/:id/export","http_method":"GET","short_description":"Export distributor's manifest"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>UUID of the distributor</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/distributors/destroy","name":"destroy","apis":[{"api_url":"/api/distributors/:id","http_method":"DELETE","short_description":"Unregister a distributor"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>UUID of the distributor</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/distributors/pools","name":"pools","apis":[{"api_url":"/api/distributors/:id/pools","http_method":"GET","short_description":"List pools a distributor is subscribed to"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>UUID of the distributor</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/distributors/tasks","name":"tasks","apis":[{"api_url":"/api/organizations/:organization_id/distributors/tasks","http_method":"GET","short_description":"List async tasks for the distributor"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"distributor_name","full_name":"distributor_name","description":"\n<p>Name of the distributor</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"distributor_uuid","full_name":"distributor_uuid","description":"\n<p>UUID of the distributor</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/distributors/task_show","name":"task_show","apis":[{"api_url":"/api/distributors/tasks/:id","http_method":"GET","short_description":"Show details of the async task"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>UUID of the task</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/distributors/versions","name":"versions","apis":[{"api_url":"/api/distributor_versions","http_method":"GET","short_description":"Show the list of available distributor versions"}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"see":[]}]},"organizations":{"doc_url":"/apidoc/v2/organizations","api_url":"/api","name":"Organizations","short_description":null,"full_description":null,"version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/organizations/index","name":"index","apis":[{"api_url":"/api/organizations","http_method":"GET","short_description":"List all :resource_id"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"\n<p>Search string</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"page","full_name":"page","description":"\n<p>Page number, starting at 1</p>\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"per_page","full_name":"per_page","description":"\n<p>Number of results per page to return</p>\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"order","full_name":"order","description":"\n<p>Sort field and order, eg. ‘name DESC’</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"sort","full_name":"sort","description":"\n<p>Hash version of ‘order’ param</p>\n","required":false,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"by","full_name":"sort[by]","description":"\n<p>Field to sort the results on</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"order","full_name":"sort[order]","description":"\n<p>How to order the sorted results (e.g. ASC for ascending)</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"}]}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/organizations/show","name":"show","apis":[{"api_url":"/api/organizations/:id","http_method":"GET","short_description":"Show organization"}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/organizations/create","name":"create","apis":[{"api_url":"/api/organizations","http_method":"POST","short_description":"Create organization"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>name</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"label","full_name":"label","description":"\n<p>unique label</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"description","full_name":"description","description":"\n<p>description</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/organizations/update","name":"update","apis":[{"api_url":"/api/organizations/:id","http_method":"PUT","short_description":"Update organization"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"resource","full_name":"resource","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"name","full_name":"resource[name]","description":"","required":false,"allow_nil":false,"validator":"String","expected_type":"string"}]},{"name":"description","full_name":"description","description":"\n<p>description</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/organizations/destroy","name":"destroy","apis":[{"api_url":"/api/organizations/:id","http_method":"DELETE","short_description":"Delete an organization"}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/organizations/repo_discover","name":"repo_discover","apis":[{"api_url":"/api/organizations/:id/repo_discover","http_method":"PUT","short_description":"Discover Repositories"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>organization id, label, or name</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"url","full_name":"url","description":"\n<p>base url to perform repo discovery on</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/organizations/cancel_repo_discover","name":"cancel_repo_discover","apis":[{"api_url":"/api/organizations/:id/cancel_repo_discover","http_method":"PUT","short_description":"Cancel repository discovery"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>organization id, label, or name</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"url","full_name":"url","description":"\n<p>base url to perform repo discovery on</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/organizations/autoattach_subscriptions","name":"autoattach_subscriptions","apis":[{"api_url":"/api/organizations/:id/autoattach_subscriptions","http_method":"POST","short_description":"Auto-attach available subscriptions to all systems within an organization. Asynchronous operation."}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"see":[]}]},"environments":{"doc_url":"/apidoc/v2/environments","api_url":"/api","name":"Environments","short_description":null,"full_description":"\n<h1 id=\"description\">Description</h1>\n\n<p>An 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.</p>\n\n<h2 id=\"chains\">Chains</h2>\n\n<p>Environments 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:</p>\n\n<pre><code>Library -&gt; Development -&gt; Testing -&gt; Production</code></pre>\n\n<p>Each change in an environment is done through a changeset in an action called promotion.</p>\n\n<h2 id=\"library\">Library</h2>\n\n<p>Library 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.</p>\n","version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/environments/index","name":"index","apis":[{"api_url":"/api/environments","http_method":"GET","short_description":"List environments in an organization"},{"api_url":"/api/organizations/:organization_id/environments","http_method":"GET","short_description":"List environments in an organization"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n<p>organization identifier</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"library","full_name":"library","description":"\n<p>set true if you want to see only library environments</p>\n","required":false,"allow_nil":false,"validator":"Must be one of: true, false.","expected_type":"string"},{"name":"name","full_name":"name","description":"\n<p>filter only environments containing this name</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":["GET /api/environments\n200\n[\n  {\n    \"environment\": {\n      \"name\": \"global_puppetmaster\",\n      \"id\": 153855663,\n      \"updated_at\": \"2012-12-18T15:24:42Z\",\n      \"created_at\": \"2012-12-18T15:24:42Z\"\n    }\n  },\n  {\n    \"environment\": {\n      \"name\": \"production\",\n      \"id\": 334344675,\n      \"updated_at\": \"2012-12-18T15:24:42Z\",\n      \"created_at\": \"2012-12-18T15:24:42Z\"\n    }\n  },\n  {\n    \"environment\": {\n      \"name\": \"testing\",\n      \"id\": 687036937,\n      \"updated_at\": \"2012-12-18T15:24:42Z\",\n      \"created_at\": \"2012-12-18T15:24:42Z\"\n    }\n  }\n]"],"see":[]},{"doc_url":"/apidoc/v2/environments/show","name":"show","apis":[{"api_url":"/api/environments/:id","http_method":"GET","short_description":"Show an environment"},{"api_url":"/api/organizations/:organization_id/environments/:environment_id","http_method":"GET","short_description":"Show an environment"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>ID of the environment</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"name","full_name":"name","description":"\n<p>name of the environment</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"organization_id","full_name":"organization_id","description":"\n<p>ID of the organization</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":["GET /api/environments/production\n200\n{\n  \"environment\": {\n    \"name\": \"production\",\n    \"id\": 334344675,\n    \"updated_at\": \"2012-12-18T15:24:42Z\",\n    \"created_at\": \"2012-12-18T15:24:42Z\"\n  }\n}"],"see":[]},{"doc_url":"/apidoc/v2/environments/create","name":"create","apis":[{"api_url":"/api/environments","http_method":"POST","short_description":"Create an environment"},{"api_url":"/api/organizations/:organization_id/environments","http_method":"POST","short_description":"Create an environment in an organization"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n<p>name of organization</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"name","full_name":"name","description":"\n<p>name of the environment</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"description","full_name":"description","description":"\n<p>description of the environment</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"prior","full_name":"prior","description":"\n<p>Name of an environment that is prior to the new environment in the chain. It has to be either ‘Library’ or an environment at the end of a chain.</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":["POST /api/environments\n{\n  \"environment\": {\n    \"name\": \"Development\"\n  }\n}\n200\n{\n  \"environment\": {\n    \"name\": \"Development\",\n    \"id\": 687036938,\n    \"updated_at\": \"2012-12-18T15:24:46Z\",\n    \"created_at\": \"2012-12-18T15:24:46Z\"\n  }\n}"],"see":[]},{"doc_url":"/apidoc/v2/environments/update","name":"update","apis":[{"api_url":"/api/environments/:id","http_method":"PUT","short_description":"Update an environment"},{"api_url":"/api/organizations/:organization_id/environments/:id","http_method":"PUT","short_description":"Update an environment in an organization"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>ID of the environment</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"organization_id","full_name":"organization_id","description":"\n<p>name of the organization</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"name","full_name":"name","description":"\n<p>name of the environment</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"new_name","full_name":"new_name","description":"\n<p>new name to be given to the environment</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"description","full_name":"description","description":"\n<p>description of the environment</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"prior","full_name":"prior","description":"\n<p>Name of an environment that is prior to the new environment in the chain. It has to be either ‘Library’ or an environment at the end of a chain.</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":["PUT /api/environments/production\n{\n  \"environment\": {}\n}\n200\n{\n  \"environment\": {\n    \"name\": \"production\",\n    \"id\": 334344675\n  }\n}"],"see":[]},{"doc_url":"/apidoc/v2/environments/destroy","name":"destroy","apis":[{"api_url":"/api/environments/:id","http_method":"DELETE","short_description":"Destroy an environment"},{"api_url":"/api/organizations/:organization_id/environments/:id","http_method":"DELETE","short_description":"Destroy an environment in an organization"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>ID of the environment</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"name","full_name":"name","description":"\n<p>name of the environment</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"organization_id","full_name":"organization_id","description":"\n<p>organization identifier</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":["DELETE /api/environments/testing\n200\n{\n  \"environment\": {\n    \"name\": \"testing\",\n    \"id\": 687036937\n  }\n}"],"see":[]},{"doc_url":"/apidoc/v2/environments/paths","name":"paths","apis":[{"api_url":"/api/organization/:organization_id/environments/paths","http_method":"GET","short_description":"List environment paths"}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"see":[]}]},"content_view_definitions":{"doc_url":"/apidoc/v2/content_view_definitions","api_url":"/api","name":"Content view definitions","short_description":null,"full_description":"","version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/content_view_definitions/index","name":"index","apis":[{"api_url":"/api/organizations/:organization_id/content_view_definitions","http_method":"GET","short_description":"List content view definitions"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n<p>organization identifier</p>\n","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"label","full_name":"label","description":"\n<p>content view label</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"name","full_name":"name","description":"\n<p>content view name</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"id","full_name":"id","description":"\n<p>content view id</p>\n","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/content_view_definitions/create","name":"create","apis":[{"api_url":"/api/organizations/:organization_id/content_view_definitions","http_method":"POST","short_description":"Create a content view definition"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n<p>organization identifier</p>\n","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"content_view_definition","full_name":"content_view_definition","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"name","full_name":"content_view_definition[name]","description":"\n<p>Content view definition name</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"description","full_name":"content_view_definition[description]","description":"\n<p>Definition description</p>\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string"},{"name":"label","full_name":"content_view_definition[label]","description":"\n<p>Content view identifier</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"}]}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/content_view_definitions/update","name":"update","apis":[{"api_url":"/api/content_view_definitions/:id","http_method":"PUT","short_description":"Update a definition"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Definition identifier</p>\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"org","full_name":"org","description":"\n<p>Organization name</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"content_view_definition","full_name":"content_view_definition","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"name","full_name":"content_view_definition[name]","description":"\n<p>Content view definition name</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"description","full_name":"content_view_definition[description]","description":"\n<p>Definition description</p>\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string"}]}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/content_view_definitions/show","name":"show","apis":[{"api_url":"/api/content_view_definitions/:id","http_method":"GET","short_description":"Show definition info"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Definition identifier</p>\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/content_view_definitions/publish","name":"publish","apis":[{"api_url":"/api/content_view_definitions/:id/publish","http_method":"POST","short_description":"Publish a content view"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>Name for the new content view</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"label","full_name":"label","description":"\n<p>Label for the new content view</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"description","full_name":"description","description":"\n<p>Description for the new content view</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"id","full_name":"id","description":"\n<p>Definition identifier</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/content_view_definitions/destroy","name":"destroy","apis":[{"api_url":"/api/content_view_definitions/:id","http_method":"DELETE","short_description":"Delete a cv definition"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Definition identifier</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/content_view_definitions/clone","name":"clone","apis":[{"api_url":"/api/content_view_definitions/:id/clone","http_method":"POST","short_description":"Clone a definition"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Definition identifier</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"content_view_definition","full_name":"content_view_definition","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"name","full_name":"content_view_definition[name]","description":"\n<p>Content view definition name</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"description","full_name":"content_view_definition[description]","description":"\n<p>Definition description</p>\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string"},{"name":"label","full_name":"content_view_definition[label]","description":"\n<p>Content view identifier</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"}]}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/content_view_definitions/content_views","name":"content_views","apis":[{"api_url":"/api/content_view_definitions/:id/content_views","http_method":"GET","short_description":"List a definition's content views"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Definition identifier</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/content_view_definitions/update_content_views","name":"update_content_views","apis":[{"api_url":"/api/content_view_definitions/:content_view_definition_id/content_views","http_method":"PUT","short_description":"Update a definition's content views"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_definition_id","full_name":"content_view_definition_id","description":"\n<p>Definition identifier</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"views","full_name":"views","description":"\n<p>Updated list of view ids</p>\n","required":true,"allow_nil":false,"validator":"Array","expected_type":"array"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/content_view_definitions/list_repositories","name":"list_repositories","apis":[{"api_url":"/api/content_view_definitions/:content_view_definition_id/repositories","http_method":"GET","short_description":"List all the repositories for a content view definition"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_definition_id","full_name":"content_view_definition_id","description":"\n<p>Definition id</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/content_view_definitions/update_repositories","name":"update_repositories","apis":[{"api_url":"/api/content_view_definitions/:content_view_definition_id/repositories","http_method":"PUT","short_description":"Update repositories for content view definition"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_definition_id","full_name":"content_view_definition_id","description":"\n<p>content view definition identifier</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"repos","full_name":"repos","description":"\n<p>Updated list of repo ids</p>\n","required":true,"allow_nil":false,"validator":"Array","expected_type":"array"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/content_view_definitions/list_products","name":"list_products","apis":[{"api_url":"/api/content_view_definitions/:content_view_definition_id/products","http_method":"GET","short_description":"Get products for content view definition"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n<p>organization identifier</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"content_view_definition_id","full_name":"content_view_definition_id","description":"\n<p>content view definition identifier</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/content_view_definitions/update_products","name":"update_products","apis":[{"api_url":"/api/content_view_definitions/:content_view_definition_id/products","http_method":"PUT","short_description":"Update products for content view definition"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_definition_id","full_name":"content_view_definition_id","description":"\n<p>content view definition identifier</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"products","full_name":"products","description":"\n<p>Updated list of products</p>\n","required":true,"allow_nil":false,"validator":"Array","expected_type":"array"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/content_view_definitions/list_all_products","name":"list_all_products","apis":[{"api_url":"/api/content_view_definitions/:content_view_definition_id/products/all","http_method":"GET","short_description":"Get a list of products belonging to the content view definition, even if one its repositories have been associated to this definition. Mainly used by filter api  "}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_definition_id","full_name":"content_view_definition_id","description":"\n<p>content view definition identifier</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"}],"examples":[],"see":[]}]},"custom_info":{"doc_url":"/apidoc/v2/custom_info","api_url":"/api","name":"Custom info","short_description":null,"full_description":"","version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/custom_info/create","name":"create","apis":[{"api_url":"/api/custom_info/:informable_type/:informable_id","http_method":"POST","short_description":"Create custom info"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"informable_type","full_name":"informable_type","description":"\n<p>name of the resource</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"informable_id","full_name":"informable_id","description":"\n<p>resource identifier</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"custom_info","full_name":"custom_info","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"keyname","full_name":"custom_info[keyname]","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"value","full_name":"custom_info[value]","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string"}]}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/custom_info/index","name":"index","apis":[{"api_url":"/api/custom_info/:informable_type/:informable_id","http_method":"GET","short_description":"List custom info"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"informable_type","full_name":"informable_type","description":"\n<p>name of the resource</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"informable_id","full_name":"informable_id","description":"\n<p>resource identifier</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/custom_info/show","name":"show","apis":[{"api_url":"/api/custom_info/:informable_type/:informable_id/:keyname","http_method":"GET","short_description":"Show custom info"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"informable_type","full_name":"informable_type","description":"\n<p>name of the resource</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"informable_id","full_name":"informable_id","description":"\n<p>resource identifier</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"keyname","full_name":"keyname","description":"\n<p>Custom info key</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/custom_info/update","name":"update","apis":[{"api_url":"/api/custom_info/:informable_type/:informable_id/:keyname","http_method":"PUT","short_description":"Update custom info"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"informable_type","full_name":"informable_type","description":"\n<p>name of the resource</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"informable_id","full_name":"informable_id","description":"\n<p>resource identifier</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"keyname","full_name":"keyname","description":"\n<p>Custom info key</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"custom_info","full_name":"custom_info","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"value","full_name":"custom_info[value]","description":"","required":false,"allow_nil":false,"validator":"String","expected_type":"string"}]}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/custom_info/destroy","name":"destroy","apis":[{"api_url":"/api/custom_info/:informable_type/:informable_id/:keyname","http_method":"DELETE","short_description":"Delete custom info"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"informable_type","full_name":"informable_type","description":"\n<p>name of the resource</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"informable_id","full_name":"informable_id","description":"\n<p>resource identifier</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"keyname","full_name":"keyname","description":"\n<p>Custom info key</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]}]},"system_packages":{"doc_url":"/apidoc/v2/system_packages","api_url":"/api","name":"System packages","short_description":null,"full_description":"","version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/system_packages/install","name":"install","apis":[{"api_url":"/api/systems/:system_id/packages/install","http_method":"POST","short_description":"Install packages remotely"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"system_id","full_name":"system_id","description":"\n<p>system identifier</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"packages","full_name":"packages","description":"\n<p>List of package names</p>\n","required":false,"allow_nil":false,"validator":"Array","expected_type":"array"},{"name":"groups","full_name":"groups","description":"\n<p>List of package group names</p>\n","required":false,"allow_nil":false,"validator":"Array","expected_type":"array"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/system_packages/upgrade","name":"upgrade","apis":[{"api_url":"/api/systems/:system_id/packages/upgrade","http_method":"PUT","short_description":"Update packages remotely"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"system_id","full_name":"system_id","description":"\n<p>system identifier</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"packages","full_name":"packages","description":"\n<p>list of packages names</p>\n","required":false,"allow_nil":false,"validator":"Array","expected_type":"array"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/system_packages/upgrade_all","name":"upgrade_all","apis":[{"api_url":"/api/systems/:system_id/packages/upgrade_all","http_method":"PUT","short_description":"Update packages remotely"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"system_id","full_name":"system_id","description":"\n<p>system identifier</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/system_packages/remove","name":"remove","apis":[{"api_url":"/api/systems/:system_id/packages/remove","http_method":"POST","short_description":"Uninstall packages remotely"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"system_id","full_name":"system_id","description":"\n<p>system identifier</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"packages","full_name":"packages","description":"\n<p>List of package names</p>\n","required":false,"allow_nil":false,"validator":"Array","expected_type":"array"},{"name":"groups","full_name":"groups","description":"\n<p>List of package group names</p>\n","required":false,"allow_nil":false,"validator":"Array","expected_type":"array"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/system_packages/create","name":"create","apis":[{"api_url":"/api/systems/:system_id/packages","http_method":"POST","short_description":"Install packages remotely"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"system_id","full_name":"system_id","description":"\n<p>system identifier</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"packages","full_name":"packages","description":"\n<p>List of package names</p>\n","required":false,"allow_nil":false,"validator":"Array","expected_type":"array"},{"name":"groups","full_name":"groups","description":"\n<p>List of package group names</p>\n","required":false,"allow_nil":false,"validator":"Array","expected_type":"array"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/system_packages/update","name":"update","apis":[{"api_url":"/api/systems/:system_id/packages","http_method":"PUT","short_description":"Update packages remotely"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"system_id","full_name":"system_id","description":"\n<p>system identifier</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"packages","full_name":"packages","description":"\n<p>list of packages names</p>\n","required":false,"allow_nil":false,"validator":"Array","expected_type":"array"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/system_packages/destroy","name":"destroy","apis":[{"api_url":"/api/systems/:system_id/packages","http_method":"DELETE","short_description":"Uninstall packages remotely"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"system_id","full_name":"system_id","description":"\n<p>system identifier</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"packages","full_name":"packages","description":"\n<p>List of package names</p>\n","required":false,"allow_nil":false,"validator":"Array","expected_type":"array"},{"name":"groups","full_name":"groups","description":"\n<p>List of package group names</p>\n","required":false,"allow_nil":false,"validator":"Array","expected_type":"array"}],"examples":[],"see":[]}]},"content_uploads":{"doc_url":"/apidoc/v2/content_uploads","api_url":"/api","name":"Content uploads","short_description":null,"full_description":null,"version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/content_uploads/create","name":"create","apis":[{"api_url":"/api/repositories/:repo_id/content_uploads","http_method":"POST","short_description":"Create an upload request"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repo_id","full_name":"repo_id","description":"\n<p>repository id</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/content_uploads/upload_bits","name":"upload_bits","apis":[{"api_url":"/api/repositories/:repo_id/content_uploads/:id/upload_bits","http_method":"PUT","short_description":"Upload bits"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repo_id","full_name":"repo_id","description":"\n<p>repository id</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"id","full_name":"id","description":"\n<p>upload request id</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"offset","full_name":"offset","description":"\n<p>the offset at which Pulp will store the file contents</p>\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"content","full_name":"content","description":"\n<p>file contents</p>\n","required":true,"allow_nil":false,"validator":"File","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/content_uploads/destroy","name":"destroy","apis":[{"api_url":"/api/repositories/:repo_id/content_uploads/:id","http_method":"DELETE","short_description":"Delete an upload request"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repo_id","full_name":"repo_id","description":"\n<p>repository id</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"id","full_name":"id","description":"\n<p>upload request id</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/content_uploads/import_into_repo","name":"import_into_repo","apis":[{"api_url":"/api/repositories/:repo_id/content_uploads/import_into_repo","http_method":"POST","short_description":"Import into a repository"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repo_id","full_name":"repo_id","description":"\n<p>repository id</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"uploads","full_name":"uploads","description":"\n<p>array of uploads to import</p>\n","required":true,"allow_nil":false,"validator":"Array","expected_type":"array"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/content_uploads/upload_file","name":"upload_file","apis":[{"api_url":"/api/repositories/:id/content_uploads/file","http_method":"POST","short_description":"Upload content into the repository"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"content","full_name":"content","description":"\n<p>file contents</p>\n","required":true,"allow_nil":false,"validator":"File","expected_type":"string"}],"examples":[],"see":[]}]},"content_views":{"doc_url":"/apidoc/v2/content_views","api_url":"/api","name":"Content views","short_description":null,"full_description":null,"version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/content_views/index","name":"index","apis":[{"api_url":"/api/organizations/:organization_id/content_views","http_method":"GET","short_description":"List content views"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n<p>organization identifier</p>\n","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"environment_id","full_name":"environment_id","description":"\n<p>environment identifier</p>\n","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"label","full_name":"label","description":"\n<p>content view label</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"name","full_name":"name","description":"\n<p>content view name</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"id","full_name":"id","description":"\n<p>content view id</p>\n","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/content_views/show","name":"show","apis":[{"api_url":"/api/content_views/:id","http_method":"GET","short_description":"Show a content view"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>content view id</p>\n","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"environment_id","full_name":"environment_id","description":"\n<p>environment id</p>\n","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/content_views/promote","name":"promote","apis":[{"api_url":"/api/content_views/:id/promote","http_method":"POST","short_description":"Promote a content view to next environment"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>content view id</p>\n","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"environment_id","full_name":"environment_id","description":"\n<p>environment promoting to</p>\n","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/content_views/refresh","name":"refresh","apis":[{"api_url":"/api/content_views/:id/refresh","http_method":"POST","short_description":"Refresh a content view"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>content view id</p>\n","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/content_views/destroy","name":"destroy","apis":[{"api_url":"/api/content_views/:id","http_method":"DELETE","short_description":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>content view id</p>\n","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"}],"examples":[],"see":[]}]},"packages":{"doc_url":"/apidoc/v2/packages","api_url":"/api","name":"Packages","short_description":null,"full_description":null,"version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/packages/index","name":"index","apis":[{"api_url":"/api/repositories/:repository_id/packages","http_method":"GET","short_description":"List packages"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n<p>environment numeric identifier</p>\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/packages/search","name":"search","apis":[{"api_url":"/api/repositories/:repository_id/packages/search","http_method":"GET","short_description":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n<p>environment numeric identifier</p>\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"search","full_name":"search","description":"\n<p>search expression</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/packages/show","name":"show","apis":[{"api_url":"/api/repositories/:repository_id/packages/:id","http_method":"GET","short_description":"Show a package"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n<p>environment numeric identifier</p>\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"id","full_name":"id","description":"\n<p>package id</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]}]},"distributions":{"doc_url":"/apidoc/v2/distributions","api_url":"/api","name":"Distributions","short_description":null,"full_description":null,"version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/distributions/index","name":"index","apis":[{"api_url":"/api/repositories/:repository_id/distributions","http_method":"GET","short_description":"List distributions"}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/distributions/show","name":"show","apis":[{"api_url":"/api/repositories/:repository_id/distributions/:id","http_method":"GET","short_description":"Show a distribution"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n<p>repository numeric id</p>\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string"}],"examples":[],"see":[]}]},"about":{"doc_url":"/apidoc/v2/about","api_url":"/api","name":"About","short_description":null,"full_description":null,"version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/about/index","name":"index","apis":[{"api_url":"/api/about","http_method":"GET","short_description":"Shows status of system and it's subcomponents"}],"formats":null,"full_description":"\n<p>This service is only available for authenticated users</p>\n","errors":[],"params":[],"examples":[],"see":[]}]},"roles":{"doc_url":"/apidoc/v2/roles","api_url":"/api","name":"Roles","short_description":null,"full_description":null,"version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/roles/index","name":"index","apis":[{"api_url":"/api/roles","http_method":"GET","short_description":"List roles"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"","required":false,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/roles/show","name":"show","apis":[{"api_url":"/api/roles/:id","http_method":"GET","short_description":"Show a role"}],"formats":null,"full_description":"","errors":[],"params":[],"examples":["GET /api/roles/1\n200\n{\n  \"role\": {\n    \"name\": \"Manager\",\n    \"id\": 1,\n    \"builtin\": 0,\n    \"permissions\": [\n      \"view_architectures\",\n      \"create_architectures\",\n      \"edit_architectures\",\n      \"destroy_architectures\",\n      \"view_authenticators\",\n      \"create_authenticators\",\n      \"edit_authenticators\",\n      \"destroy_authenticators\",\n      \"view_environments\",\n      \"create_environments\",\n      \"edit_environments\",\n      \"destroy_environments\",\n      \"import_environments\",\n      \"view_external_variables\",\n      \"create_external_variables\",\n      \"edit_external_variables\",\n      \"destroy_external_variables\",\n      \"view_domains\",\n      \"create_domain\",\n      \"edit_domains\",\n      \"destroy_domains\",\n      \"view_globals\",\n      \"create_globals\",\n      \"edit_globals\",\n      \"destroy_globals\",\n      \"view_hostgroups\",\n      \"create_hostgroups\",\n      \"edit_hostgroups\",\n      \"destroy_hostgroups\",\n      \"view_hosts\",\n      \"create_hosts\",\n      \"edit_hosts\",\n      \"destroy_hosts\",\n      \"view_media\",\n      \"create_media\",\n      \"edit_media\",\n      \"destroy_media\",\n      \"view_models\",\n      \"create_models\",\n      \"edit_models\",\n      \"destroy_models\",\n      \"view_operatingsystems\",\n      \"create_operatingsystems\",\n      \"edit_operatingsystems\",\n      \"destroy_operatingsystems\",\n      \"view_ptables\",\n      \"create_ptables\",\n      \"edit_ptables\",\n      \"destroy_ptables\",\n      \"view_puppetclasses\",\n      \"create_puppetclasses\",\n      \"edit_puppetclasses\",\n      \"destroy_puppetclasses\",\n      \"import_puppetclasses\",\n      \"view_usergroups\",\n      \"create_usergroups\",\n      \"edit_usergroups\",\n      \"destroy_usergroups\",\n      \"view_users\",\n      \"create_users\",\n      \"edit_users\",\n      \"destroy_users\",\n      \"access_settings\",\n      \"access_dashboard\",\n      \"view_reports\",\n      \"destroy_reports\",\n      \"view_facts\",\n      \"view_audit_logs\",\n      \"view_statistics\",\n      \"view_locations\",\n      \"edit_locations\",\n      \"create_locations\",\n      \"destroy_locations\",\n      \"view_organizations\",\n      \"edit_organizations\",\n      \"create_organizations\",\n      \"destroy_organizations\"\n    ]\n  }\n}"],"see":[]},{"doc_url":"/apidoc/v2/roles/create","name":"create","apis":[{"api_url":"/api/roles","http_method":"POST","short_description":"Create a role"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"role","full_name":"role","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"name","full_name":"role[name]","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"description","full_name":"role[description]","description":"","required":false,"allow_nil":true,"validator":"String","expected_type":"string"}]}],"examples":["POST /api/roles\n{\n  \"role\": {\n    \"name\": \"staff\"\n  }\n}\n200\n{\n  \"role\": {\n    \"name\": \"staff\",\n    \"id\": 11,\n    \"builtin\": 0,\n    \"permissions\": []\n  }\n}"],"see":[]},{"doc_url":"/apidoc/v2/roles/update","name":"update","apis":[{"api_url":"/api/roles/:id","http_method":"PUT","short_description":"Update a role"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"role","full_name":"role","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"name","full_name":"role[name]","description":"","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"description","full_name":"role[description]","description":"","required":false,"allow_nil":true,"validator":"String","expected_type":"string"}]}],"examples":["PUT /api/roles/1\n{\n  \"role\": {}\n}\n200\n{\n  \"role\": {\n    \"name\": \"Manager\",\n    \"id\": 1,\n    \"builtin\": 0,\n    \"permissions\": [\n      \"view_architectures\",\n      \"create_architectures\",\n      \"edit_architectures\",\n      \"destroy_architectures\",\n      \"view_authenticators\",\n      \"create_authenticators\",\n      \"edit_authenticators\",\n      \"destroy_authenticators\",\n      \"view_environments\",\n      \"create_environments\",\n      \"edit_environments\",\n      \"destroy_environments\",\n      \"import_environments\",\n      \"view_external_variables\",\n      \"create_external_variables\",\n      \"edit_external_variables\",\n      \"destroy_external_variables\",\n      \"view_domains\",\n      \"create_domain\",\n      \"edit_domains\",\n      \"destroy_domains\",\n      \"view_globals\",\n      \"create_globals\",\n      \"edit_globals\",\n      \"destroy_globals\",\n      \"view_hostgroups\",\n      \"create_hostgroups\",\n      \"edit_hostgroups\",\n      \"destroy_hostgroups\",\n      \"view_hosts\",\n      \"create_hosts\",\n      \"edit_hosts\",\n      \"destroy_hosts\",\n      \"view_media\",\n      \"create_media\",\n      \"edit_media\",\n      \"destroy_media\",\n      \"view_models\",\n      \"create_models\",\n      \"edit_models\",\n      \"destroy_models\",\n      \"view_operatingsystems\",\n      \"create_operatingsystems\",\n      \"edit_operatingsystems\",\n      \"destroy_operatingsystems\",\n      \"view_ptables\",\n      \"create_ptables\",\n      \"edit_ptables\",\n      \"destroy_ptables\",\n      \"view_puppetclasses\",\n      \"create_puppetclasses\",\n      \"edit_puppetclasses\",\n      \"destroy_puppetclasses\",\n      \"import_puppetclasses\",\n      \"view_usergroups\",\n      \"create_usergroups\",\n      \"edit_usergroups\",\n      \"destroy_usergroups\",\n      \"view_users\",\n      \"create_users\",\n      \"edit_users\",\n      \"destroy_users\",\n      \"access_settings\",\n      \"access_dashboard\",\n      \"view_reports\",\n      \"destroy_reports\",\n      \"view_facts\",\n      \"view_audit_logs\",\n      \"view_statistics\",\n      \"view_locations\",\n      \"edit_locations\",\n      \"create_locations\",\n      \"destroy_locations\",\n      \"view_organizations\",\n      \"edit_organizations\",\n      \"create_organizations\",\n      \"destroy_organizations\"\n    ]\n  }\n}"],"see":[]},{"doc_url":"/apidoc/v2/roles/destroy","name":"destroy","apis":[{"api_url":"/api/roles/:id","http_method":"DELETE","short_description":"Destroy a role"}],"formats":null,"full_description":"","errors":[],"params":[],"examples":["DELETE /api/roles/1\n200\n{\n  \"role\": {\n    \"name\": \"Manager\",\n    \"id\": 1,\n    \"builtin\": 0,\n    \"permissions\": [\n      \"view_architectures\",\n      \"create_architectures\",\n      \"edit_architectures\",\n      \"destroy_architectures\",\n      \"view_authenticators\",\n      \"create_authenticators\",\n      \"edit_authenticators\",\n      \"destroy_authenticators\",\n      \"view_environments\",\n      \"create_environments\",\n      \"edit_environments\",\n      \"destroy_environments\",\n      \"import_environments\",\n      \"view_external_variables\",\n      \"create_external_variables\",\n      \"edit_external_variables\",\n      \"destroy_external_variables\",\n      \"view_domains\",\n      \"create_domain\",\n      \"edit_domains\",\n      \"destroy_domains\",\n      \"view_globals\",\n      \"create_globals\",\n      \"edit_globals\",\n      \"destroy_globals\",\n      \"view_hostgroups\",\n      \"create_hostgroups\",\n      \"edit_hostgroups\",\n      \"destroy_hostgroups\",\n      \"view_hosts\",\n      \"create_hosts\",\n      \"edit_hosts\",\n      \"destroy_hosts\",\n      \"view_media\",\n      \"create_media\",\n      \"edit_media\",\n      \"destroy_media\",\n      \"view_models\",\n      \"create_models\",\n      \"edit_models\",\n      \"destroy_models\",\n      \"view_operatingsystems\",\n      \"create_operatingsystems\",\n      \"edit_operatingsystems\",\n      \"destroy_operatingsystems\",\n      \"view_ptables\",\n      \"create_ptables\",\n      \"edit_ptables\",\n      \"destroy_ptables\",\n      \"view_puppetclasses\",\n      \"create_puppetclasses\",\n      \"edit_puppetclasses\",\n      \"destroy_puppetclasses\",\n      \"import_puppetclasses\",\n      \"view_usergroups\",\n      \"create_usergroups\",\n      \"edit_usergroups\",\n      \"destroy_usergroups\",\n      \"view_users\",\n      \"create_users\",\n      \"edit_users\",\n      \"destroy_users\",\n      \"access_settings\",\n      \"access_dashboard\",\n      \"view_reports\",\n      \"destroy_reports\",\n      \"view_facts\",\n      \"view_audit_logs\",\n      \"view_statistics\",\n      \"view_locations\",\n      \"edit_locations\",\n      \"create_locations\",\n      \"destroy_locations\",\n      \"view_organizations\",\n      \"edit_organizations\",\n      \"create_organizations\",\n      \"destroy_organizations\"\n    ]\n  }\n}"],"see":[]},{"doc_url":"/apidoc/v2/roles/available_verbs","name":"available_verbs","apis":[{"api_url":"/api/roles/available_verbs","http_method":"GET","short_description":"List all available verbs that can be set to roles"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n<p>With this option specified the listed tags are scoped to the organization.</p>\n","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"}],"examples":[],"see":[]}]},"users":{"doc_url":"/apidoc/v2/users","api_url":"/api","name":"Users","short_description":null,"full_description":"","version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/users/index","name":"index","apis":[{"api_url":"/api/users","http_method":"GET","short_description":"List users"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"email","full_name":"email","description":"\n<p>filter by email</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"disabled","full_name":"disabled","description":"\n<p>filter by disabled flag</p>\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string"},{"name":"login","full_name":"login","description":"\n<p>filter by login</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":["GET /api/users\n200\n[\n  {\n    \"user\": {\n      \"domains_andor\": \"or\",\n      \"filter_on_owner\": null,\n      \"role_id\": null,\n      \"mail\": \"admin@someware.com\",\n      \"id\": 135138680,\n      \"hostgroups_andor\": \"or\",\n      \"updated_at\": \"2012-12-18T15:24:42Z\",\n      \"compute_resources_andor\": \"or\",\n      \"admin\": true,\n      \"last_login_on\": \"2009-10-12T21:50:04Z\",\n      \"lastname\": \"User\",\n      \"created_at\": \"2012-12-18T15:24:42Z\",\n      \"login\": \"admin\",\n      \"firstname\": \"Admin\",\n      \"facts_andor\": \"or\",\n      \"auth_source_id\": 980190962\n    }\n  },\n  {\n    \"user\": {\n      \"domains_andor\": \"or\",\n      \"filter_on_owner\": null,\n      \"role_id\": null,\n      \"mail\": \"apiadmin@someware.com\",\n      \"id\": 886836129,\n      \"hostgroups_andor\": \"or\",\n      \"updated_at\": \"2012-12-18T15:24:42Z\",\n      \"compute_resources_andor\": \"or\",\n      \"admin\": true,\n      \"last_login_on\": \"2009-10-12T21:50:04Z\",\n      \"lastname\": \"User\",\n      \"created_at\": \"2012-12-18T15:24:42Z\",\n      \"login\": \"apiadmin\",\n      \"firstname\": \"apiadmin\",\n      \"facts_andor\": \"or\",\n      \"auth_source_id\": 200482051\n    }\n  },\n  {\n    \"user\": {\n      \"domains_andor\": \"or\",\n      \"filter_on_owner\": null,\n      \"role_id\": null,\n      \"mail\": \"userone@someware.com\",\n      \"id\": 980190962,\n      \"hostgroups_andor\": \"or\",\n      \"updated_at\": \"2012-12-18T15:24:42Z\",\n      \"compute_resources_andor\": \"or\",\n      \"admin\": false,\n      \"last_login_on\": \"2009-10-12T21:50:04Z\",\n      \"lastname\": \"User\",\n      \"created_at\": \"2012-12-18T15:24:42Z\",\n      \"login\": \"one\",\n      \"firstname\": \"One\",\n      \"facts_andor\": \"or\",\n      \"auth_source_id\": 980190962\n    }\n  },\n  {\n    \"user\": {\n      \"domains_andor\": \"or\",\n      \"filter_on_owner\": null,\n      \"role_id\": null,\n      \"mail\": \"testuser@someware.com\",\n      \"id\": 200482051,\n      \"hostgroups_andor\": \"or\",\n      \"updated_at\": \"2012-12-18T15:24:42Z\",\n      \"compute_resources_andor\": \"or\",\n      \"admin\": false,\n      \"last_login_on\": \"2009-10-12T21:50:04Z\",\n      \"lastname\": \"User\",\n      \"created_at\": \"2012-12-18T15:24:42Z\",\n      \"login\": \"test\",\n      \"firstname\": \"test\",\n      \"facts_andor\": \"or\",\n      \"auth_source_id\": 200482051\n    }\n  },\n  {\n    \"user\": {\n      \"domains_andor\": \"or\",\n      \"filter_on_owner\": null,\n      \"role_id\": null,\n      \"mail\": \"usertwo@someware.com\",\n      \"id\": 298486374,\n      \"hostgroups_andor\": \"or\",\n      \"updated_at\": \"2012-12-18T15:24:42Z\",\n      \"compute_resources_andor\": \"or\",\n      \"admin\": false,\n      \"last_login_on\": \"2009-10-12T21:50:04Z\",\n      \"lastname\": \"User\",\n      \"created_at\": \"2012-12-18T15:24:42Z\",\n      \"login\": \"two\",\n      \"firstname\": \"Two\",\n      \"facts_andor\": \"or\",\n      \"auth_source_id\": 980190962\n    }\n  }\n]"],"see":[]},{"doc_url":"/apidoc/v2/users/show","name":"show","apis":[{"api_url":"/api/users/:id","http_method":"GET","short_description":"Show a user"}],"formats":null,"full_description":"","errors":[],"params":[],"examples":["GET /api/users/980190962-one\n200\n{\n  \"user\": {\n    \"domains_andor\": \"or\",\n    \"filter_on_owner\": null,\n    \"roles\": [\n      {\n        \"role\": {\n          \"name\": \"Viewer\",\n          \"id\": 5,\n          \"builtin\": 0,\n          \"permissions\": [\n            \"view_architectures\",\n            \"view_audit_logs\",\n            \"view_authenticators\",\n            \"access_dashboard\",\n            \"view_domains\",\n            \"view_environments\",\n            \"view_external_variables\",\n            \"view_facts\",\n            \"view_globals\",\n            \"view_hostgroups\",\n            \"view_hosts\",\n            \"view_locations\",\n            \"view_media\",\n            \"view_models\",\n            \"view_operatingsystems\",\n            \"view_ptables\",\n            \"view_puppetclasses\",\n            \"view_reports\",\n            \"access_settings\",\n            \"view_statistics\",\n            \"view_organizations\",\n            \"view_usergroups\",\n            \"view_users\"\n          ]\n        }\n      },\n      {\n        \"role\": {\n          \"name\": \"Anonymous\",\n          \"id\": 7,\n          \"builtin\": 2,\n          \"permissions\": [\n            \"view_hosts\"\n          ]\n        }\n      }\n    ],\n    \"role_id\": null,\n    \"auth_source_ldap\": {\n      \"name\": \"ldap\",\n      \"tls\": true,\n      \"attr_login\": \"uid\",\n      \"attr_firstname\": \"givenName\",\n      \"port\": 123,\n      \"attr_lastname\": \"sn\",\n      \"id\": 980190962,\n      \"updated_at\": \"2012-12-18T15:24:43Z\",\n      \"attr_mail\": \"mail\",\n      \"base_dn\": \"dn=x,dn=y\",\n      \"host\": \"ldap\",\n      \"account\": null,\n      \"type\": \"AuthSourceLdap\",\n      \"onthefly_register\": true,\n      \"created_at\": \"2012-12-18T15:24:43Z\"\n    },\n    \"mail\": \"userone@someware.com\",\n    \"id\": 980190962,\n    \"hostgroups_andor\": \"or\",\n    \"updated_at\": \"2012-12-18T15:24:42Z\",\n    \"compute_resources_andor\": \"or\",\n    \"admin\": false,\n    \"last_login_on\": \"2009-10-12T21:50:04Z\",\n    \"lastname\": \"User\",\n    \"created_at\": \"2012-12-18T15:24:42Z\",\n    \"login\": \"one\",\n    \"firstname\": \"One\",\n    \"facts_andor\": \"or\",\n    \"auth_source_id\": 980190962\n  }\n}"],"see":[]},{"doc_url":"/apidoc/v2/users/create","name":"create","apis":[{"api_url":"/api/users","http_method":"POST","short_description":"Create an user"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"user","full_name":"user","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"email","full_name":"user[email]","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"password","full_name":"user[password]","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"default_environment_id","full_name":"user[default_environment_id]","description":"","required":false,"allow_nil":true,"validator":"Integer","expected_type":"numeric"},{"name":"disabled","full_name":"user[disabled]","description":"","required":false,"allow_nil":true,"validator":"boolean","expected_type":"string"},{"name":"login","full_name":"user[login]","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string"}]}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/users/update","name":"update","apis":[{"api_url":"/api/users/:id","http_method":"PUT","short_description":"Update an user"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"user","full_name":"user","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"email","full_name":"user[email]","description":"","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"password","full_name":"user[password]","description":"","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"default_environment_id","full_name":"user[default_environment_id]","description":"","required":false,"allow_nil":true,"validator":"Integer","expected_type":"numeric"},{"name":"disabled","full_name":"user[disabled]","description":"","required":false,"allow_nil":true,"validator":"boolean","expected_type":"string"}]}],"examples":["PUT /api/users/980190963\n{\n  \"user\": {\n    \"password_confirmation\": \"DUMMY\",\n    \"password\": \"dummy\",\n    \"login\": \"johnsmith\"\n  }\n}\n422\n{\n  \"user\": {\n    \"id\": 980190963,\n    \"errors\": {\n      \"password\": [\n        \"doesn't match confirmation\"\n      ]\n    },\n    \"full_messages\": [\n      \"Password doesn't match confirmation\"\n    ]\n  }\n}"],"see":[]},{"doc_url":"/apidoc/v2/users/destroy","name":"destroy","apis":[{"api_url":"/api/users/:id","http_method":"DELETE","short_description":"Destroy an user"}],"formats":null,"full_description":"","errors":[],"params":[],"examples":["DELETE /api/users/980190962\n200\n{\n  \"user\": {\n    \"filter_on_owner\": null,\n    \"domains_andor\": \"or\",\n    \"role_id\": null,\n    \"organizations_andor\": \"or\",\n    \"mail\": \"userone@someware.com\",\n    \"id\": 980190962,\n    \"updated_at\": \"2012-12-18T15:24:42Z\",\n    \"hostgroups_andor\": \"or\",\n    \"compute_resources_andor\": \"or\",\n    \"admin\": false,\n    \"password_hash\": null,\n    \"last_login_on\": \"2009-10-12T21:50:04Z\",\n    \"locations_andor\": \"or\",\n    \"lastname\": \"User\",\n    \"password_salt\": null,\n    \"login\": \"one\",\n    \"created_at\": \"2012-12-18T15:24:42Z\",\n    \"firstname\": \"One\",\n    \"facts_andor\": \"or\",\n    \"auth_source_id\": 980190962\n  }\n}"],"see":[]},{"doc_url":"/apidoc/v2/users/list_roles","name":"list_roles","apis":[{"api_url":"/api/users/:user_id/roles","http_method":"GET","short_description":"List roles assigned to a user"}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/users/sync_ldap_roles","name":"sync_ldap_roles","apis":[{"api_url":"/api/users/sync_ldap_roles","http_method":"GET","short_description":"Synchronises roles for all users with LDAP groups"}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/users/add_role","name":"add_role","apis":[{"api_url":"/api/users/:user_id/roles","http_method":"POST","short_description":"Assign a role to a user"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"role_id","full_name":"role_id","description":"","required":false,"allow_nil":false,"validator":"Integer","expected_type":"numeric"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/users/remove_role","name":"remove_role","apis":[{"api_url":"/api/users/:user_id/roles/:id","http_method":"DELETE","short_description":"Remove user's role"}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"see":[]}]},"uebercerts":{"doc_url":"/apidoc/v2/uebercerts","api_url":"/api","name":"Uebercerts","short_description":null,"full_description":null,"version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/uebercerts/show","name":"show","apis":[{"api_url":"/api/organizations/:organization_id/uebercert","http_method":"GET","short_description":"Show an ueber certificate for an organization"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"regenerate","full_name":"regenerate","description":"\n<p>When set to ‘True’ certificate will be re-issued</p>\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string"}],"examples":[],"see":[]}]},"errata":{"doc_url":"/apidoc/v2/errata","api_url":"/api","name":"Errata","short_description":null,"full_description":"","version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/errata/index","name":"index","apis":[{"api_url":"/api/repositories/:repository_id/errata","http_method":"GET","short_description":"List errata"},{"api_url":"/api/environments/:environment_id/errata","http_method":"GET","short_description":"List errata"}],"formats":null,"full_description":"","errors":[{"code":401,"description":"Unauthorized"},{"code":404,"description":"Not found"}],"params":[{"name":"environment_id","full_name":"environment_id","description":"\n<p>The environment containing the errata.</p>\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"product_id","full_name":"product_id","description":"\n<p>The product which contains errata.</p>\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"repository_id","full_name":"repository_id","description":"\n<p>The repository which contains errata.</p>\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"severity","full_name":"severity","description":"\n<p>Severity of errata. Usually one of: Critical, Important, Moderate, Low. Case insensitive.</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"type","full_name":"type","description":"\n<p>Type of errata. Usually one of: security, bugfix, enhancement. Case insensitive.</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/errata/show","name":"show","apis":[{"api_url":"/api/repositories/:repository_id/errata/:id","http_method":"GET","short_description":"Show an erratum"},{"api_url":"/api/errata/:id","http_method":"GET","short_description":"Show an erratum"}],"formats":null,"full_description":"","errors":[{"code":401,"description":"Unauthorized"},{"code":404,"description":"Not found"}],"params":[],"examples":[],"see":[]}]},"system_errata":{"doc_url":"/apidoc/v2/system_errata","api_url":"/api","name":"System errata","short_description":null,"full_description":null,"version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/system_errata/apply","name":"apply","apis":[{"api_url":"/api/systems/:system_id/errata","http_method":"PUT","short_description":"Schedule errata for installation"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"errata_ids","full_name":"errata_ids","description":"\n<p>List of Errata ids to install</p>\n","required":false,"allow_nil":false,"validator":"Array","expected_type":"array"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/system_errata/show","name":"show","apis":[{"api_url":"/api/systems/:system_id/errata/:id","http_method":"GET","short_description":"Retrieve a single errata for a system"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Errata id of the erratum (RHSA-2012:108)</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]}]},"system_group_errata":{"doc_url":"/apidoc/v2/system_group_errata","api_url":"/api","name":"System group errata","short_description":null,"full_description":"\n<p>methods for handling erratas on system group level</p>\n","version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/system_group_errata/index","name":"index","apis":[{"api_url":"/api/organizations/:organization_id/system_groups/:system_group_id/errata","http_method":"GET","short_description":"Get list of errata associated with the group"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n<p>oranization identifier</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"system_group_id","full_name":"system_group_id","description":"\n<p>system_group identifier</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"type","full_name":"type","description":"\n<p>Filter errata by type</p>\n","required":false,"allow_nil":false,"validator":"Must be one of: bugfix, enhancement, security.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/system_group_errata/create","name":"create","apis":[{"api_url":"/api/organizations/:organization_id/system_groups/:system_group_id/errata","http_method":"POST","short_description":"Install errata remotely"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n<p>oranization identifier</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"system_group_id","full_name":"system_group_id","description":"\n<p>system_group identifier</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"errata_ids","full_name":"errata_ids","description":"\n<p>List of errata ids to install</p>\n","required":true,"allow_nil":false,"validator":"Array","expected_type":"array"}],"examples":[],"see":[]}]},"systems":{"doc_url":"/apidoc/v2/systems","api_url":"/api","name":"Systems","short_description":null,"full_description":null,"version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/systems/index","name":"index","apis":[{"api_url":"/api/systems","http_method":"GET","short_description":"List systems"},{"api_url":"/api/organizations/:organization_id/systems","http_method":"GET","short_description":"List systems in an organization"},{"api_url":"/api/environments/:environment_id/systems","http_method":"GET","short_description":"List systems in environment"},{"api_url":"/api/system_groups/:system_group_id/systems","http_method":"GET","short_description":"List systems in a system group"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>Filter systems by name</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"pool_id","full_name":"pool_id","description":"\n<p>Filter systems by subscribed pool</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"uuid","full_name":"uuid","description":"\n<p>Filter systems by uuid</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"organization_id","full_name":"organization_id","description":"\n<p>Specify the organization</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"environment_id","full_name":"environment_id","description":"\n<p>Filter by environment</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"system_group_id","full_name":"system_group_id","description":"\n<p>Filter by system group</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"search","full_name":"search","description":"\n<p>Search string</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"page","full_name":"page","description":"\n<p>Page number, starting at 1</p>\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"per_page","full_name":"per_page","description":"\n<p>Number of results per page to return</p>\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"order","full_name":"order","description":"\n<p>Sort field and order, eg. ‘name DESC’</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"sort","full_name":"sort","description":"\n<p>Hash version of ‘order’ param</p>\n","required":false,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"by","full_name":"sort[by]","description":"\n<p>Field to sort the results on</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"order","full_name":"sort[order]","description":"\n<p>How to order the sorted results (e.g. ASC for ascending)</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"}]}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/systems/create","name":"create","apis":[{"api_url":"/api/systems","http_method":"POST","short_description":"Register a system"},{"api_url":"/api/environments/:environment_id/systems","http_method":"POST","short_description":"Register a system in environment"},{"api_url":"/api/system_groups/:system_group_id/systems","http_method":"POST","short_description":"Register a system in environment"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>Name of the system</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"description","full_name":"description","description":"\n<p>Description of the system</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"location","full_name":"location","description":"\n<p>Physical location of the system</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"facts","full_name":"facts","description":"\n<p>Key-value hash of system-specific facts</p>\n","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"fact","full_name":"facts[fact]","description":"\n<p>Any number of facts about this system</p>\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string"}]},{"name":"type","full_name":"type","description":"\n<p>Type of the system, it should always be ‘system’</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"guest_ids","full_name":"guest_ids","description":"\n<p>IDs of the guests running on this system</p>\n","required":false,"allow_nil":false,"validator":"Array","expected_type":"array"},{"name":"installed_products","full_name":"installed_products","description":"\n<p>List of products installed on the system</p>\n","required":false,"allow_nil":true,"validator":"Array","expected_type":"array"},{"name":"release_ver","full_name":"release_ver","description":"\n<p>Release version of the system</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"service_level","full_name":"service_level","description":"\n<p>A service level for auto-healing process, e.g. SELF-SUPPORT</p>\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string"},{"name":"last_checkin","full_name":"last_checkin","description":"\n<p>Last check-in time of this system</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"organization_id","full_name":"organization_id","description":"\n<p>Specify the organization</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"environment_id","full_name":"environment_id","description":"\n<p>Specify the environment</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"content_view_id","full_name":"content_view_id","description":"\n<p>Specify the content view</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"system_group_id","full_name":"system_group_id","description":"\n<p>Specify the system group</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/systems/update","name":"update","apis":[{"api_url":"/api/systems/:id","http_method":"PUT","short_description":"Update system information"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>Name of the system</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"description","full_name":"description","description":"\n<p>Description of the system</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"location","full_name":"location","description":"\n<p>Physical location of the system</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"facts","full_name":"facts","description":"\n<p>Key-value hash of system-specific facts</p>\n","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"fact","full_name":"facts[fact]","description":"\n<p>Any number of facts about this system</p>\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string"}]},{"name":"type","full_name":"type","description":"\n<p>Type of the system, it should always be ‘system’</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"guest_ids","full_name":"guest_ids","description":"\n<p>IDs of the guests running on this system</p>\n","required":false,"allow_nil":false,"validator":"Array","expected_type":"array"},{"name":"installed_products","full_name":"installed_products","description":"\n<p>List of products installed on the system</p>\n","required":false,"allow_nil":true,"validator":"Array","expected_type":"array"},{"name":"release_ver","full_name":"release_ver","description":"\n<p>Release version of the system</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"service_level","full_name":"service_level","description":"\n<p>A service level for auto-healing process, e.g. SELF-SUPPORT</p>\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string"},{"name":"last_checkin","full_name":"last_checkin","description":"\n<p>Last check-in time of this system</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"environment_id","full_name":"environment_id","description":"\n<p>Specify the environment</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"content_view_id","full_name":"content_view_id","description":"\n<p>Specify the content view</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/systems/show","name":"show","apis":[{"api_url":"/api/systems/:id","http_method":"GET","short_description":"Show a system"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>UUID of the system</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/systems/available_system_groups","name":"available_system_groups","apis":[{"api_url":"/api/systems/:id/available_system_groups","http_method":"GET","short_description":"List system groups the system does not belong to"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"\n<p>Search string</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"page","full_name":"page","description":"\n<p>Page number, starting at 1</p>\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"per_page","full_name":"per_page","description":"\n<p>Number of results per page to return</p>\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"order","full_name":"order","description":"\n<p>Sort field and order, eg. ‘name DESC’</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"sort","full_name":"sort","description":"\n<p>Hash version of ‘order’ param</p>\n","required":false,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"by","full_name":"sort[by]","description":"\n<p>Field to sort the results on</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"order","full_name":"sort[order]","description":"\n<p>How to order the sorted results (e.g. ASC for ascending)</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"}]},{"name":"name","full_name":"name","description":"\n<p>system group name to filter by</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/systems/destroy","name":"destroy","apis":[{"api_url":"/api/systems/:id","http_method":"DELETE","short_description":"Unregister a system"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>UUID of the system</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/systems/add_system_groups","name":"add_system_groups","apis":[{"api_url":"/api/systems/:id/system_groups","http_method":"POST","short_description":"Replace existing list of system groups"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>UUID of the system</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"system_group_ids","full_name":"system_group_ids","description":"\n<p>List of group ids the system belongs to</p>\n","required":true,"allow_nil":false,"validator":"Array","expected_type":"array"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/systems/remove_system_groups","name":"remove_system_groups","apis":[{"api_url":"/api/systems/:id/system_groups","http_method":"DELETE","short_description":"Remove the list of given system groups"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>UUID of the system</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"system_group_ids","full_name":"system_group_ids","description":"\n<p>List of system groups ids to remove from the system</p>\n","required":true,"allow_nil":false,"validator":"Array","expected_type":"array"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/systems/package_profile","name":"package_profile","apis":[{"api_url":"/api/systems/:id/packages","http_method":"GET","short_description":"List packages installed on the system"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>UUID of the system</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/systems/refresh_subscriptions","name":"refresh_subscriptions","apis":[{"api_url":"/api/systems/:id/refresh_subscriptions","http_method":"PUT","short_description":"Trigger a refresh of subscriptions, auto-attaching if enabled"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>UUID of the system</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/systems/errata","name":"errata","apis":[{"api_url":"/api/systems/:id/errata","http_method":"GET","short_description":"List errata available for the system"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>UUID of the system</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/systems/tasks","name":"tasks","apis":[{"api_url":"/api/systems/:id/tasks","http_method":"GET","short_description":"List async tasks for the system"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>UUID of the system</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/systems/report","name":"report","apis":[{"api_url":"/api/environments/:environment_id/systems/report","http_method":"GET","short_description":"Get system reports for the environment"},{"api_url":"/api/organizations/:organization_id/systems/report","http_method":"GET","short_description":"Get system reports for the organization"}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/systems/pools","name":"pools","apis":[{"api_url":"/api/systems/:id/pools","http_method":"GET","short_description":"List pools a system is subscribed to"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>UUID of the system</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"match_system","full_name":"match_system","description":"\n<p>Match pools to system</p>\n","required":false,"allow_nil":false,"validator":"Must be one of: true, false.","expected_type":"string"},{"name":"match_installed","full_name":"match_installed","description":"\n<p>Match pools to installed</p>\n","required":false,"allow_nil":false,"validator":"Must be one of: true, false.","expected_type":"string"},{"name":"no_overlap","full_name":"no_overlap","description":"\n<p>allow overlap</p>\n","required":false,"allow_nil":false,"validator":"Must be one of: true, false.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/systems/releases","name":"releases","apis":[{"api_url":"/api/systems/:id/releases","http_method":"GET","short_description":"Show releases available for the system"}],"formats":null,"full_description":"\n<p>A hint for choosing the right value for the releaseVer param</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>UUID of the system</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/systems/activate","name":"activate","apis":[{"api_url":"/api/organizations/:organization_id/systems","http_method":"POST","short_description":"Register a system with activation key"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>Name of the system</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"description","full_name":"description","description":"\n<p>Description of the system</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"location","full_name":"location","description":"\n<p>Physical location of the system</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"facts","full_name":"facts","description":"\n<p>Key-value hash of system-specific facts</p>\n","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"fact","full_name":"facts[fact]","description":"\n<p>Any number of facts about this system</p>\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string"}]},{"name":"type","full_name":"type","description":"\n<p>Type of the system, it should always be ‘system’</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"guest_ids","full_name":"guest_ids","description":"\n<p>IDs of the guests running on this system</p>\n","required":false,"allow_nil":false,"validator":"Array","expected_type":"array"},{"name":"installed_products","full_name":"installed_products","description":"\n<p>List of products installed on the system</p>\n","required":false,"allow_nil":true,"validator":"Array","expected_type":"array"},{"name":"release_ver","full_name":"release_ver","description":"\n<p>Release version of the system</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"service_level","full_name":"service_level","description":"\n<p>A service level for auto-healing process, e.g. SELF-SUPPORT</p>\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string"},{"name":"last_checkin","full_name":"last_checkin","description":"\n<p>Last check-in time of this system</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"organization_id","full_name":"organization_id","description":"\n<p>Specify the organization</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"environment_id","full_name":"environment_id","description":"\n<p>Specify the environment</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"content_view_id","full_name":"content_view_id","description":"\n<p>Specify the content view</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"system_group_id","full_name":"system_group_id","description":"\n<p>Specify the system group</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"activation_keys","full_name":"activation_keys","description":"\n<p>comma-separated list of activation-key IDs</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/systems/enabled_repos","name":"enabled_repos","apis":[{"api_url":"/api/systems/:id/enabled_repos","http_method":"PUT","short_description":"Update the information about enabled repositories"}],"formats":null,"full_description":"\n<p>Used by katello-agent to keep the information about enabled repositories up to date. This information is then used for computing the errata available for the system.</p>\n","errors":[],"params":[{"name":"enabled_repos","full_name":"enabled_repos","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"repos","full_name":"enabled_repos[repos]","description":"","required":true,"allow_nil":false,"validator":"Array","expected_type":"array"}]},{"name":"id","full_name":"id","description":"\n<p>UUID of the system</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]}]},"sync":{"doc_url":"/apidoc/v2/sync","api_url":"/api","name":"Sync","short_description":null,"full_description":"","version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/sync/index","name":"index","apis":[{"api_url":"/api/providers/:provider_id/sync","http_method":"GET","short_description":"Get status of repo synchronisation for given provider"},{"api_url":"/api/products/:product_id/sync","http_method":"GET","short_description":"Get status of repo synchronisation for given product"},{"api_url":"/api/repositories/:repository_id/sync","http_method":"GET","short_description":"Get status of synchronisation for given repository"}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/sync/create","name":"create","apis":[{"api_url":"/api/providers/:provider_id/sync","http_method":"POST","short_description":"Synchronize all provider's repositories"},{"api_url":"/api/products/:product_id/sync","http_method":"POST","short_description":"Synchronise all repositories for given product"},{"api_url":"/api/repositories/:repository_id/sync","http_method":"POST","short_description":"Synchronise repository"}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/sync/cancel","name":"cancel","apis":[{"api_url":"/api/providers/:provider_id/sync","http_method":"DELETE","short_description":"Cancel running synchronisation for given provider"},{"api_url":"/api/products/:product_id/sync","http_method":"DELETE","short_description":"Cancel running synchronisations for given product"},{"api_url":"/api/repositories/:repository_id/sync","http_method":"DELETE","short_description":"Cancel running synchronisation"}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"see":[]}]},"systems_bulk_actions":{"doc_url":"/apidoc/v2/systems_bulk_actions","api_url":"/api","name":"Systems bulk actions","short_description":null,"full_description":null,"version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/systems_bulk_actions/bulk_add_system_groups","name":"bulk_add_system_groups","apis":[{"api_url":"/api/systems/bulk/add_system_groups","http_method":"PUT","short_description":"Add one or more system groups to one or more systems"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"include","full_name":"include","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"search","full_name":"include[search]","description":"\n<p>Search string for systems to perform an action on</p>\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string"},{"name":"ids","full_name":"include[ids]","description":"\n<p>List of system ids to perform an action on</p>\n","required":false,"allow_nil":true,"validator":"Array","expected_type":"array"}]},{"name":"exclude","full_name":"exclude","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"ids","full_name":"exclude[ids]","description":"\n<p>List of system ids to exclude and not run an action on</p>\n","required":false,"allow_nil":true,"validator":"Array","expected_type":"array"}]},{"name":"system_group_ids","full_name":"system_group_ids","description":"\n<p>List of system group ids</p>\n","required":true,"allow_nil":false,"validator":"Array","expected_type":"array"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/systems_bulk_actions/bulk_remove_system_groups","name":"bulk_remove_system_groups","apis":[{"api_url":"/api/systems/bulk/remove_system_groups","http_method":"PUT","short_description":"Remove one or more system groups to one or more systems"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"include","full_name":"include","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"search","full_name":"include[search]","description":"\n<p>Search string for systems to perform an action on</p>\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string"},{"name":"ids","full_name":"include[ids]","description":"\n<p>List of system ids to perform an action on</p>\n","required":false,"allow_nil":true,"validator":"Array","expected_type":"array"}]},{"name":"exclude","full_name":"exclude","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"ids","full_name":"exclude[ids]","description":"\n<p>List of system ids to exclude and not run an action on</p>\n","required":false,"allow_nil":true,"validator":"Array","expected_type":"array"}]},{"name":"system_group_ids","full_name":"system_group_ids","description":"\n<p>List of system group ids</p>\n","required":true,"allow_nil":false,"validator":"Array","expected_type":"array"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/systems_bulk_actions/applicable_errata","name":"applicable_errata","apis":[{"api_url":"/api/systems/bulk/applicable_errata","http_method":"POST","short_description":"Fetch applicable errata for a system."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"include","full_name":"include","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"search","full_name":"include[search]","description":"\n<p>Search string for systems to perform an action on</p>\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string"},{"name":"ids","full_name":"include[ids]","description":"\n<p>List of system ids to perform an action on</p>\n","required":false,"allow_nil":true,"validator":"Array","expected_type":"array"}]},{"name":"exclude","full_name":"exclude","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"ids","full_name":"exclude[ids]","description":"\n<p>List of system ids to exclude and not run an action on</p>\n","required":false,"allow_nil":true,"validator":"Array","expected_type":"array"}]}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/systems_bulk_actions/install_content","name":"install_content","apis":[{"api_url":"/api/systems/bulk/install_content","http_method":"PUT","short_description":"Install content on one or more systems"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"include","full_name":"include","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"search","full_name":"include[search]","description":"\n<p>Search string for systems to perform an action on</p>\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string"},{"name":"ids","full_name":"include[ids]","description":"\n<p>List of system ids to perform an action on</p>\n","required":false,"allow_nil":true,"validator":"Array","expected_type":"array"}]},{"name":"exclude","full_name":"exclude","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"ids","full_name":"exclude[ids]","description":"\n<p>List of system ids to exclude and not run an action on</p>\n","required":false,"allow_nil":true,"validator":"Array","expected_type":"array"}]},{"name":"content_type","full_name":"content_type","description":"\n<p>The type of content. The following types are supported: ‘package’, ‘package_group’ and ‘errata’.</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"content","full_name":"content","description":"\n<p>List of content (e.g. package names, package group names or errata ids)</p>\n","required":true,"allow_nil":false,"validator":"Array","expected_type":"array"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/systems_bulk_actions/update_content","name":"update_content","apis":[{"api_url":"/api/systems/bulk/update_content","http_method":"PUT","short_description":"Update content on one or more systems"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"include","full_name":"include","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"search","full_name":"include[search]","description":"\n<p>Search string for systems to perform an action on</p>\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string"},{"name":"ids","full_name":"include[ids]","description":"\n<p>List of system ids to perform an action on</p>\n","required":false,"allow_nil":true,"validator":"Array","expected_type":"array"}]},{"name":"exclude","full_name":"exclude","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"ids","full_name":"exclude[ids]","description":"\n<p>List of system ids to exclude and not run an action on</p>\n","required":false,"allow_nil":true,"validator":"Array","expected_type":"array"}]},{"name":"content_type","full_name":"content_type","description":"\n<p>The type of content. The following types are supported: ‘package’ and ‘package_group.</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"content","full_name":"content","description":"\n<p>List of content (e.g. package or package group names)</p>\n","required":true,"allow_nil":false,"validator":"Array","expected_type":"array"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/systems_bulk_actions/remove_content","name":"remove_content","apis":[{"api_url":"/api/systems/bulk/remove_content","http_method":"PUT","short_description":"Remove content on one or more systems"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"include","full_name":"include","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"search","full_name":"include[search]","description":"\n<p>Search string for systems to perform an action on</p>\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string"},{"name":"ids","full_name":"include[ids]","description":"\n<p>List of system ids to perform an action on</p>\n","required":false,"allow_nil":true,"validator":"Array","expected_type":"array"}]},{"name":"exclude","full_name":"exclude","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"ids","full_name":"exclude[ids]","description":"\n<p>List of system ids to exclude and not run an action on</p>\n","required":false,"allow_nil":true,"validator":"Array","expected_type":"array"}]},{"name":"content_type","full_name":"content_type","description":"\n<p>The type of content. The following types are supported: ‘package’ and ‘package_group.</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"content","full_name":"content","description":"\n<p>List of content (e.g. package or package group names)</p>\n","required":true,"allow_nil":false,"validator":"Array","expected_type":"array"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/systems_bulk_actions/destroy_systems","name":"destroy_systems","apis":[{"api_url":"/api/systems/bulk/destroy","http_method":"PUT","short_description":"Destroy one or more systems"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"include","full_name":"include","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"search","full_name":"include[search]","description":"\n<p>Search string for systems to perform an action on</p>\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string"},{"name":"ids","full_name":"include[ids]","description":"\n<p>List of system ids to perform an action on</p>\n","required":false,"allow_nil":true,"validator":"Array","expected_type":"array"}]},{"name":"exclude","full_name":"exclude","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"ids","full_name":"exclude[ids]","description":"\n<p>List of system ids to exclude and not run an action on</p>\n","required":false,"allow_nil":true,"validator":"Array","expected_type":"array"}]}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/systems_bulk_actions/environment_content_view","name":"environment_content_view","apis":[{"api_url":"/api/systems/bulk/environment_content_view","http_method":"PUT","short_description":"Assign the environment and content view to one or more systems"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"include","full_name":"include","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"search","full_name":"include[search]","description":"\n<p>Search string for systems to perform an action on</p>\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string"},{"name":"ids","full_name":"include[ids]","description":"\n<p>List of system ids to perform an action on</p>\n","required":false,"allow_nil":true,"validator":"Array","expected_type":"array"}]},{"name":"exclude","full_name":"exclude","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"ids","full_name":"exclude[ids]","description":"\n<p>List of system ids to exclude and not run an action on</p>\n","required":false,"allow_nil":true,"validator":"Array","expected_type":"array"}]},{"name":"environment_id","full_name":"environment_id","description":"","required":false,"allow_nil":false,"validator":"Integer","expected_type":"numeric"},{"name":"content_view_id","full_name":"content_view_id","description":"","required":false,"allow_nil":false,"validator":"Integer","expected_type":"numeric"}],"examples":[],"see":[]}]},"changesets_content":{"doc_url":"/apidoc/v2/changesets_content","api_url":"/api","name":"Changesets content","short_description":null,"full_description":null,"version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/changesets_content/add_content_view","name":"add_content_view","apis":[{"api_url":"/api/changesets/:changeset_id/content_views","http_method":"POST","short_description":"Add a content view to a changeset"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"changeset_id","full_name":"changeset_id","description":"\n<p>id of the product to remove</p>\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"content_view","full_name":"content_view","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"id","full_name":"content_view[id]","description":"\n<p>id of the content view to add</p>\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string"}]}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/changesets_content/remove_content_view","name":"remove_content_view","apis":[{"api_url":"/api/changesets/:changeset_id/content_views/:content_view_id","http_method":"DELETE","short_description":"Remove a content_view from a changeset"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"changeset_id","full_name":"changeset_id","description":"","required":false,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"content_view_id","full_name":"content_view_id","description":"\n<p>id of the content view to remove</p>\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string"}],"examples":[],"see":[]}]},"system_groups":{"doc_url":"/apidoc/v2/system_groups","api_url":"/api","name":"System groups","short_description":null,"full_description":"","version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/system_groups/show","name":"show","apis":[{"api_url":"/api/system_groups/:id","http_method":"GET","short_description":"Show a system group"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Id of the system group</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/system_groups/index","name":"index","apis":[{"api_url":"/api/system_groups","http_method":"GET","short_description":"List system groups"},{"api_url":"/api/organizations/:organization_id/system_groups","http_method":"GET","short_description":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"\n<p>Search string</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"page","full_name":"page","description":"\n<p>Page number, starting at 1</p>\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"per_page","full_name":"per_page","description":"\n<p>Number of results per page to return</p>\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"order","full_name":"order","description":"\n<p>Sort field and order, eg. ‘name DESC’</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"sort","full_name":"sort","description":"\n<p>Hash version of ‘order’ param</p>\n","required":false,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"by","full_name":"sort[by]","description":"\n<p>Field to sort the results on</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"order","full_name":"sort[order]","description":"\n<p>How to order the sorted results (e.g. ASC for ascending)</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"}]},{"name":"organization_id","full_name":"organization_id","description":"\n<p>organization identifier</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"name","full_name":"name","description":"\n<p>system group name to filter by</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/system_groups/create","name":"create","apis":[{"api_url":"/api/system_groups","http_method":"POST","short_description":"Create a system group"},{"api_url":"/api/organizations/:organization_id/system_groups","http_method":"POST","short_description":"Create a system group"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n<p>organization identifier</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"name","full_name":"name","description":"\n<p>System group name</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"system_ids","full_name":"system_ids","description":"\n<p>List of system uuids to be in the group</p>\n","required":false,"allow_nil":false,"validator":"Array","expected_type":"array"},{"name":"description","full_name":"description","description":"","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"max_systems","full_name":"max_systems","description":"\n<p>Maximum number of systems in the group</p>\n","required":false,"allow_nil":false,"validator":"Integer","expected_type":"numeric"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/system_groups/update","name":"update","apis":[{"api_url":"/api/system_groups/:id","http_method":"PUT","short_description":"Update a system group"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Id of the system group</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"name","full_name":"name","description":"\n<p>System group name</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"system_ids","full_name":"system_ids","description":"\n<p>List of system uuids to be in the group</p>\n","required":false,"allow_nil":false,"validator":"Array","expected_type":"array"},{"name":"description","full_name":"description","description":"","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"max_systems","full_name":"max_systems","description":"\n<p>Maximum number of systems in the group</p>\n","required":false,"allow_nil":false,"validator":"Integer","expected_type":"numeric"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/system_groups/systems","name":"systems","apis":[{"api_url":"/api/system_groups/:id/systems","http_method":"GET","short_description":"List systems in the group"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Id of the system group</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/system_groups/add_systems","name":"add_systems","apis":[{"api_url":"/api/system_groups/:id/add_systems","http_method":"PUT","short_description":"Add systems to the group"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Id of the system group</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"system_ids","full_name":"system_ids","description":"\n<p>Array of system ids</p>\n","required":false,"allow_nil":false,"validator":"Array","expected_type":"array"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/system_groups/remove_systems","name":"remove_systems","apis":[{"api_url":"/api/system_groups/:id/remove_systems","http_method":"PUT","short_description":"Remove systems from the group"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Id of the system group</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"system_ids","full_name":"system_ids","description":"\n<p>Array of system ids</p>\n","required":false,"allow_nil":false,"validator":"Array","expected_type":"array"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/system_groups/history","name":"history","apis":[{"api_url":"/api/system_groups/:id/history","http_method":"GET","short_description":"History of jobs performed on a system group"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Id of the system group</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/system_groups/history_show","name":"history_show","apis":[{"api_url":"/api/system_groups/:id/history","http_method":"GET","short_description":"History of a job performed on a system group"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Id of the system group</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"job_id","full_name":"job_id","description":"\n<p>Id of a job for filtering</p>\n","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/system_groups/copy","name":"copy","apis":[{"api_url":"/api/system_groups/:id/copy","http_method":"POST","short_description":"Make copy of a system group"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>ID of the system group</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"name","full_name":"name","description":"\n<p>New system group name</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/system_groups/destroy","name":"destroy","apis":[{"api_url":"/api/system_groups/:id","http_method":"DELETE","short_description":"Destroy a system group"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Id of the system group</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/system_groups/destroy_systems","name":"destroy_systems","apis":[{"api_url":"/api/system_groups/:id/destroy_systems","http_method":"DELETE","short_description":"Destroy a system group nad contained systems"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Id of the system group</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"}],"examples":[],"see":[]}]},"gpg_keys":{"doc_url":"/apidoc/v2/gpg_keys","api_url":"/api","name":"Gpg keys","short_description":null,"full_description":null,"version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/gpg_keys/index","name":"index","apis":[{"api_url":"/api/gpg_keys","http_method":"GET","short_description":"List gpg keys"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n<p>organization identifier</p>\n","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"search","full_name":"search","description":"\n<p>Search string</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"page","full_name":"page","description":"\n<p>Page number, starting at 1</p>\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"per_page","full_name":"per_page","description":"\n<p>Number of results per page to return</p>\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"order","full_name":"order","description":"\n<p>Sort field and order, eg. ‘name DESC’</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"sort","full_name":"sort","description":"\n<p>Hash version of ‘order’ param</p>\n","required":false,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"by","full_name":"sort[by]","description":"\n<p>Field to sort the results on</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"order","full_name":"sort[order]","description":"\n<p>How to order the sorted results (e.g. ASC for ascending)</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"}]}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/gpg_keys/create","name":"create","apis":[{"api_url":"/api/gpg_keys","http_method":"POST","short_description":"Create a gpg key"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n<p>organization identifier</p>\n","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"name","full_name":"name","description":"\n<p>identifier of the gpg key</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"content","full_name":"content","description":"\n<p>public key block in DER encoding</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/gpg_keys/show","name":"show","apis":[{"api_url":"/api/gpg_keys/:id","http_method":"GET","short_description":"Show a gpg key"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>gpg key numeric identifier</p>\n","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/gpg_keys/update","name":"update","apis":[{"api_url":"/api/gpg_keys/:id","http_method":"PUT","short_description":"Update a repository"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>gpg key numeric identifier</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"name","full_name":"name","description":"\n<p>identifier of the gpg key</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"content","full_name":"content","description":"\n<p>public key block in DER encoding</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/gpg_keys/destroy","name":"destroy","apis":[{"api_url":"/api/gpg_keys/:id","http_method":"DELETE","short_description":"Destroy a gpg key"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>gpg key numeric identifier</p>\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/gpg_keys/content","name":"content","apis":[{"api_url":"/api/gpg_keys/:id/content","http_method":"POST","short_description":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>gpg key numeric identifier</p>\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"content","full_name":"content","description":"\n<p>file contents</p>\n","required":true,"allow_nil":false,"validator":"File","expected_type":"string"}],"examples":[],"see":[]}]},"sync_plans":{"doc_url":"/apidoc/v2/sync_plans","api_url":"/api","name":"Sync plans","short_description":null,"full_description":"","version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/sync_plans/index","name":"index","apis":[{"api_url":"/api/organizations/:organization_id/sync_plans","http_method":"GET","short_description":"List sync plans"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>filter by name</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"sync_date","full_name":"sync_date","description":"\n<p>filter by sync date</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"interval","full_name":"interval","description":"\n<p>filter by interval</p>\n","required":false,"allow_nil":false,"validator":"Must be one of: none, hourly, daily, weekly.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/sync_plans/show","name":"show","apis":[{"api_url":"/api/sync_plans/:id","http_method":"GET","short_description":"Show a sync plan"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>sync plan numeric identifier</p>\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/sync_plans/create","name":"create","apis":[{"api_url":"/api/organizations/:organization_id/sync_plans","http_method":"POST","short_description":"Create a sync plan"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"sync_plan","full_name":"sync_plan","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"name","full_name":"sync_plan[name]","description":"\n<p>sync plan name</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"interval","full_name":"sync_plan[interval]","description":"\n<p>how often synchronization should run</p>\n","required":false,"allow_nil":true,"validator":"Must be one of: none, hourly, daily, weekly.","expected_type":"string"},{"name":"sync_date","full_name":"sync_plan[sync_date]","description":"\n<p>start datetime of synchronization</p>\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string"},{"name":"description","full_name":"sync_plan[description]","description":"\n<p>sync plan description</p>\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string"}]}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/sync_plans/update","name":"update","apis":[{"api_url":"/api/sync_plans/:id","http_method":"PUT","short_description":"Update a sync plan"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>sync plan numeric identifier</p>\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"sync_plan","full_name":"sync_plan","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"name","full_name":"sync_plan[name]","description":"\n<p>sync plan name</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"interval","full_name":"sync_plan[interval]","description":"\n<p>how often synchronization should run</p>\n","required":false,"allow_nil":true,"validator":"Must be one of: none, hourly, daily, weekly.","expected_type":"string"},{"name":"sync_date","full_name":"sync_plan[sync_date]","description":"\n<p>start datetime of synchronization</p>\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string"},{"name":"description","full_name":"sync_plan[description]","description":"\n<p>sync plan description</p>\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string"}]}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/sync_plans/destroy","name":"destroy","apis":[{"api_url":"/api/sync_plans/:id","http_method":"DELETE","short_description":"Destroy a sync plan"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>sync plan numeric identifier</p>\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string"}],"examples":[],"see":[]}]},"filter_rules":{"doc_url":"/apidoc/v2/filter_rules","api_url":"/api","name":"Filter rules","short_description":null,"full_description":"","version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/filter_rules/create","name":"create","apis":[{"api_url":"/api/content_view_definitions/:content_view_definition_id/filters/:filter_id/rules","http_method":"POST","short_description":"Create a filter rule for a content filter"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_definition_id","full_name":"content_view_definition_id","description":"\n<p>id of the content view definition</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"filter_id","full_name":"filter_id","description":"\n<p>name of the filter</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"rule","full_name":"rule","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"rule","full_name":"rule[rule]","description":"\n<p>A specification of the rule in json format (required).</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"content","full_name":"rule[content]","description":"\n<p>content type of the rule</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"inclusion","full_name":"rule[inclusion]","description":"\n<p>true if its an includes rule, false otherwise. Defauls to true</p>\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string"}]}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/filter_rules/destroy","name":"destroy","apis":[{"api_url":"/api/content_view_definitions/:content_view_definition_id/filters/:filter_id/rules/:id","http_method":"DELETE","short_description":"Delete a filter rule"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_definition_id","full_name":"content_view_definition_id","description":"\n<p>id of the content view definition</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"filter_id","full_name":"filter_id","description":"\n<p>name of the filter</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"id","full_name":"id","description":"\n<p>Id of the filter rule</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]}]},"ping":{"doc_url":"/apidoc/v2/ping","api_url":"/api","name":"Ping","short_description":null,"full_description":null,"version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/ping/index","name":"index","apis":[{"api_url":"/api/ping","http_method":"GET","short_description":"Shows status of system and it's subcomponents"}],"formats":null,"full_description":"\n<p>This service is only available for authenticated users</p>\n","errors":[],"params":[],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/ping/server_status","name":"server_status","apis":[{"api_url":"/api/status","http_method":"GET","short_description":"Shows version information"}],"formats":null,"full_description":"\n<p>This service is available for unauthenticated users</p>\n","errors":[],"params":[],"examples":[],"see":[]}]},"system_group_packages":{"doc_url":"/apidoc/v2/system_group_packages","api_url":"/api","name":"System group packages","short_description":null,"full_description":"\n<p>methods for handling packages on system group level</p>\n","version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/system_group_packages/create","name":"create","apis":[{"api_url":"/api/organizations/:organization_id/system_groups/:system_group_id/packages","http_method":"POST","short_description":"Install packages remotely"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n<p>oranization identifier</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"system_group_id","full_name":"system_group_id","description":"\n<p>system_group identifier</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"packages","full_name":"packages","description":"\n<p>List of package names</p>\n","required":false,"allow_nil":false,"validator":"Array","expected_type":"array"},{"name":"groups","full_name":"groups","description":"\n<p>List of package group names</p>\n","required":false,"allow_nil":false,"validator":"Array","expected_type":"array"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/system_group_packages/update","name":"update","apis":[{"api_url":"/api/organizations/:organization_id/system_groups/:system_group_id/packages","http_method":"PUT","short_description":"Update packages remotely"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n<p>oranization identifier</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"system_group_id","full_name":"system_group_id","description":"\n<p>system_group identifier</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"packages","full_name":"packages","description":"\n<p>List of package names</p>\n","required":false,"allow_nil":false,"validator":"Array","expected_type":"array"},{"name":"groups","full_name":"groups","description":"\n<p>List of package group names</p>\n","required":false,"allow_nil":false,"validator":"Array","expected_type":"array"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/system_group_packages/destroy","name":"destroy","apis":[{"api_url":"/api/organizations/:organization_id/system_groups/:system_group_id/packages","http_method":"DELETE","short_description":"Uninstall packages remotely"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n<p>oranization identifier</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"system_group_id","full_name":"system_group_id","description":"\n<p>system_group identifier</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"packages","full_name":"packages","description":"\n<p>List of package names</p>\n","required":false,"allow_nil":false,"validator":"Array","expected_type":"array"},{"name":"groups","full_name":"groups","description":"\n<p>List of package group names</p>\n","required":false,"allow_nil":false,"validator":"Array","expected_type":"array"}],"examples":[],"see":[]}]},"permissions":{"doc_url":"/apidoc/v2/permissions","api_url":"/api","name":"Permissions","short_description":null,"full_description":"","version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/permissions/index","name":"index","apis":[{"api_url":"/api/roles/:role_id/permissions","http_method":"GET","short_description":"List permissions for a role"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>filter by name</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"description","full_name":"description","description":"\n<p>filter by description</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"all_verbs","full_name":"all_verbs","description":"\n<p>filter by all_verbs flag</p>\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string"},{"name":"all_tags","full_name":"all_tags","description":"\n<p>filter by all_flags flag</p>\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/permissions/show","name":"show","apis":[{"api_url":"/api/roles/:role_id/permissions/:id","http_method":"GET","short_description":"Show a permission"}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/permissions/create","name":"create","apis":[{"api_url":"/api/roles/:role_id/permissions","http_method":"POST","short_description":"Create a roles permission"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"permission","full_name":"permission","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"description","full_name":"permission[description]","description":"","required":false,"allow_nil":true,"validator":"String","expected_type":"string"},{"name":"name","full_name":"permission[name]","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"organization_id","full_name":"permission[organization_id]","description":"","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"tags","full_name":"permission[tags]","description":"\n<p>array of tag ids</p>\n","required":false,"allow_nil":false,"validator":"Array","expected_type":"array"},{"name":"type","full_name":"permission[type]","description":"\n<p>name of a resource or ‘all’</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"verbs","full_name":"permission[verbs]","description":"\n<p>array of permission verbs</p>\n","required":false,"allow_nil":false,"validator":"Array","expected_type":"array"},{"name":"all_tags","full_name":"permission[all_tags]","description":"\n<p>True if the permission should use all tags</p>\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string"},{"name":"all_verbs","full_name":"permission[all_verbs]","description":"\n<p>True if the permission should use all verbs</p>\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string"}]}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/permissions/destroy","name":"destroy","apis":[{"api_url":"/api/roles/:role_id/permissions/:id","http_method":"DELETE","short_description":"Destroy a roles permission"}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"see":[]}]},"repositories":{"doc_url":"/apidoc/v2/repositories","api_url":"/api","name":"Repositories","short_description":null,"full_description":null,"version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/repositories/index","name":"index","apis":[{"api_url":"/api/repositories","http_method":"GET","short_description":"List of repositories"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n<p>id of an organization to show repositories in</p>\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"product_id","full_name":"product_id","description":"\n<p>id of a product to show repositories of</p>\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"environment_id","full_name":"environment_id","description":"\n<p>id of an environment to show repositories in</p>\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"library","full_name":"library","description":"\n<p>show repositories in Library and the default content view</p>\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string"},{"name":"enabled","full_name":"enabled","description":"\n<p>limit to only enabled repositories</p>\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string"},{"name":"search","full_name":"search","description":"\n<p>Search string</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"page","full_name":"page","description":"\n<p>Page number, starting at 1</p>\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"per_page","full_name":"per_page","description":"\n<p>Number of results per page to return</p>\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"order","full_name":"order","description":"\n<p>Sort field and order, eg. ‘name DESC’</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"sort","full_name":"sort","description":"\n<p>Hash version of ‘order’ param</p>\n","required":false,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"by","full_name":"sort[by]","description":"\n<p>Field to sort the results on</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"order","full_name":"sort[order]","description":"\n<p>How to order the sorted results (e.g. ASC for ascending)</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"}]}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/repositories/create","name":"create","apis":[{"api_url":"/api/repositories","http_method":"POST","short_description":"Create a repository"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"label","full_name":"label","description":"","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"product_id","full_name":"product_id","description":"\n<p>Product the repository belongs to</p>\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"url","full_name":"url","description":"\n<p>repository source url</p>\n","required":true,"allow_nil":false,"validator":null,"expected_type":"string"},{"name":"gpg_key_name","full_name":"gpg_key_name","description":"\n<p>name of a gpg key that will be assigned to the new repository</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"enabled","full_name":"enabled","description":"\n<p>flag that enables/disables the repository</p>\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string"},{"name":"content_type","full_name":"content_type","description":"\n<p>type of repo (either ‘yum’ or ‘puppet’, defaults to ‘yum’)</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/repositories/show","name":"show","apis":[{"api_url":"/api/repositories/:id","http_method":"GET","short_description":"Show a repository"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>repository id</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/repositories/update","name":"update","apis":[{"api_url":"/api/repositories/:id","http_method":"PUT","short_description":"Update a repository"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>repository id</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"gpg_key_id","full_name":"gpg_key_id","description":"\n<p>id of a gpg key that will be assigned to this repository</p>\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/repositories/destroy","name":"destroy","apis":[{"api_url":"/api/repositories/:id","http_method":"DELETE","short_description":"Destroy a repository"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/repositories/sync","name":"sync","apis":[{"api_url":"/api/repositories/:id/sync","http_method":"POST","short_description":"Synchronise repository"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>repository id</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"}],"examples":[],"see":[]}]},"role_ldap_groups":{"doc_url":"/apidoc/v2/role_ldap_groups","api_url":"/api","name":"Role ldap groups","short_description":null,"full_description":"","version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/role_ldap_groups/create","name":"create","apis":[{"api_url":"/api/roles/:role_id/ldap_groups","http_method":"POST","short_description":"Add group to list of LDAP groups associated with the role"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ldap_group","full_name":"ldap_group","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"name","full_name":"ldap_group[name]","description":"\n<p>name of the LDAP group</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"}]}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/role_ldap_groups/destroy","name":"destroy","apis":[{"api_url":"/api/roles/:role_id/ldap_groups/:id","http_method":"DELETE","short_description":"Remove group from the list of LDAP groups associated with the role"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"role_id","full_name":"role_id","description":"\n<p>role identifier</p>\n","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"id","full_name":"id","description":"\n<p>ldap group (name)</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/role_ldap_groups/index","name":"index","apis":[{"api_url":"/api/roles/:role_id/ldap_groups","http_method":"GET","short_description":"List LDAP groups associated with the role"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"role_id","full_name":"role_id","description":"\n<p>role identifier</p>\n","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"}],"examples":[],"see":[]}]},"providers":{"doc_url":"/apidoc/v2/providers","api_url":"/api","name":"Providers","short_description":null,"full_description":null,"version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/providers/index","name":"index","apis":[{"api_url":"/api/providers","http_method":"GET","short_description":"List of all providers"},{"api_url":"/api/organizations/:organization_id/providers","http_method":"GET","short_description":"List of all providers for a given organization"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"\n<p>Search string</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"page","full_name":"page","description":"\n<p>Page number, starting at 1</p>\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"per_page","full_name":"per_page","description":"\n<p>Number of results per page to return</p>\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"order","full_name":"order","description":"\n<p>Sort field and order, eg. ‘name DESC’</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"sort","full_name":"sort","description":"\n<p>Hash version of ‘order’ param</p>\n","required":false,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"by","full_name":"sort[by]","description":"\n<p>Field to sort the results on</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"order","full_name":"sort[order]","description":"\n<p>How to order the sorted results (e.g. ASC for ascending)</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"}]},{"name":"organization_id","full_name":"organization_id","description":"\n<p>organization identifier</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"provider_type","full_name":"provider_type","description":"\n<p>Filter providers by type (‘Custom’ or ‘Red Hat’)</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/providers/show","name":"show","apis":[{"api_url":"/api/providers/:id","http_method":"GET","short_description":"Get a provider"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Provider numeric identifier</p>\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/providers/create","name":"create","apis":[{"api_url":"/api/providers","http_method":"POST","short_description":"Create a provider"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n<p>Organization identifier</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"name","full_name":"name","description":"\n<p>name of the provider</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"description","full_name":"description","description":"\n<p>description of the provider</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"provider_type","full_name":"provider_type","description":"\n<p>The type of the provider</p>\n","required":false,"allow_nil":false,"validator":"Must be one of: Red Hat, Custom.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/providers/update","name":"update","apis":[{"api_url":"/api/providers/:id","http_method":"PUT","short_description":"Update the provider"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Provider identifier</p>\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"repository_url","full_name":"repository_url","description":"\n<p>Provider repository url</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/providers/destroy","name":"destroy","apis":[{"api_url":"/api/providers/:id","http_method":"DELETE","short_description":"Destroy a provider"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Provider numeric identifier</p>\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/providers/products","name":"products","apis":[{"api_url":"/api/providers/:id/products","http_method":"GET","short_description":"List of provider's products"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Provider numeric identifier</p>\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"include_marketing","full_name":"include_marketing","description":"\n<p>Include marketing products in results</p>\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/providers/import_manifest","name":"import_manifest","apis":[{"api_url":"/api/providers/:id/import_manifest","http_method":"POST","short_description":"Import manifest for Red Hat provider"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Provider numeric identifier</p>\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"import","full_name":"import","description":"\n<p>Manifest file</p>\n","required":false,"allow_nil":false,"validator":"File","expected_type":"string"},{"name":"force","full_name":"force","description":"\n<p>Force import</p>\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/providers/refresh_manifest","name":"refresh_manifest","apis":[{"api_url":"/api/providers/:id/refresh_manifest","http_method":"POST","short_description":"Refresh previously imported manifest for Red Hat provider"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Provider numeric identifier</p>\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/providers/delete_manifest","name":"delete_manifest","apis":[{"api_url":"/api/providers/:id/delete_manifest","http_method":"POST","short_description":"Delete manifest from Red Hat provider"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Provider numeric identifier</p>\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/providers/refresh_products","name":"refresh_products","apis":[{"api_url":"/api/providers/:id/refresh_products","http_method":"POST","short_description":"Refresh products for Red Hat provider"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Provider numeric identifier</p>\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/providers/import_products","name":"import_products","apis":[{"api_url":"/api/providers/:id/import_products","http_method":"POST","short_description":"Import products"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Provider numeric identifier</p>\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"products","full_name":"products","description":"\n<p>Array of products to import</p>\n","required":true,"allow_nil":false,"validator":"Array","expected_type":"array"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/providers/product_create","name":"product_create","apis":[{"api_url":"/api/providers/:id/product_create","http_method":"POST","short_description":"Create a new product in custom provider"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Provider numeric identifier</p>\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"product","full_name":"product","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"gpg_key_name","full_name":"product[gpg_key_name]","description":"\n<p>identifier of the gpg key</p>\n","required":false,"allow_nil":true,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"description","full_name":"product[description]","description":"\n<p>Product description</p>\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string"},{"name":"name","full_name":"product[name]","description":"\n<p>Product name</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"label","full_name":"product[label]","description":"","required":false,"allow_nil":false,"validator":"String","expected_type":"string"}]}],"examples":[],"see":[]}]},"activation_keys":{"doc_url":"/apidoc/v2/activation_keys","api_url":"/api","name":"Activation keys","short_description":null,"full_description":"","version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/activation_keys/index","name":"index","apis":[{"api_url":"/api/environments/:environment_id/activation_keys","http_method":"GET","short_description":"List activation keys"},{"api_url":"/api/organizations/:organization_id/activation_keys","http_method":"GET","short_description":"List activation keys"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>lists by activation key name</p>\n","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/activation_keys/show","name":"show","apis":[{"api_url":"/api/activation_keys/:id","http_method":"GET","short_description":"Show an activation key"}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/activation_keys/create","name":"create","apis":[{"api_url":"/api/activation_keys","http_method":"POST","short_description":"Create an activation key"},{"api_url":"/api/environments/:environment_id/activation_keys","http_method":"POST","short_description":"Create an activation key"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"activation_key","full_name":"activation_key","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"name","full_name":"activation_key[name]","description":"\n<p>activation key identifier (alphanum characters, space, _ and -)</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"description","full_name":"activation_key[description]","description":"","required":false,"allow_nil":true,"validator":"String","expected_type":"string"},{"name":"content_view_id","full_name":"activation_key[content_view_id]","description":"\n<p>content view id</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"}]}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/activation_keys/update","name":"update","apis":[{"api_url":"/api/activation_keys/:id","http_method":"PUT","short_description":"Update an activation key"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"activation_key","full_name":"activation_key","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"name","full_name":"activation_key[name]","description":"\n<p>activation key identifier (alphanum characters, space, _ and -)</p>\n","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"description","full_name":"activation_key[description]","description":"","required":false,"allow_nil":true,"validator":"String","expected_type":"string"},{"name":"content_view_id","full_name":"activation_key[content_view_id]","description":"\n<p>content view id</p>\n","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"environment_id","full_name":"activation_key[environment_id]","description":"","required":false,"allow_nil":true,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"}]}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/activation_keys/destroy","name":"destroy","apis":[{"api_url":"/api/activation_keys/:id","http_method":"DELETE","short_description":"Destroy an activation key"}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/activation_keys/add_pool","name":"add_pool","apis":[{"api_url":"/api/activation_keys/:id/pools","http_method":"POST","short_description":"Create an entitlement pool within an activation key"}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/activation_keys/remove_pool","name":"remove_pool","apis":[{"api_url":"/api/activation_keys/:id/pools/:poolid","http_method":"DELETE","short_description":"Delete an entitlement pool within an activation key"}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/activation_keys/add_system_groups","name":"add_system_groups","apis":[{"api_url":"/api/activation_keys/:id/system_groups","http_method":"POST","short_description":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/activation_keys/remove_system_groups","name":"remove_system_groups","apis":[{"api_url":"/api/activation_keys/:id/system_groups","http_method":"DELETE","short_description":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"see":[]}]},"changesets":{"doc_url":"/apidoc/v2/changesets","api_url":"/api","name":"Changesets","short_description":null,"full_description":"","version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/changesets/index","name":"index","apis":[{"api_url":"/api/environments/:environment_id/changesets","http_method":"GET","short_description":"List changesets in an environment"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>An optional changeset name to filter upon</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/changesets/show","name":"show","apis":[{"api_url":"/api/changesets/:id","http_method":"GET","short_description":"Show a changeset"}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/changesets/update","name":"update","apis":[{"api_url":"/api/changesets/:id","http_method":"PUT","short_description":"Update a changeset"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"changeset","full_name":"changeset","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"name","full_name":"changeset[name]","description":"\n<p>The name of the changeset</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"description","full_name":"changeset[description]","description":"\n<p>The description of the changeset</p>\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string"}]}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/changesets/create","name":"create","apis":[{"api_url":"/api/environments/:environment_id/changesets","http_method":"POST","short_description":"Create a changeset"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"changeset","full_name":"changeset","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"name","full_name":"changeset[name]","description":"\n<p>The name of the changeset</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"description","full_name":"changeset[description]","description":"\n<p>The description of the changeset</p>\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string"},{"name":"type","full_name":"changeset[type]","description":"","required":true,"allow_nil":false,"validator":"Must be one of: promotion, deletion.","expected_type":"string"}]}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/changesets/apply","name":"apply","apis":[{"api_url":"/api/changesets/:id/apply","http_method":"POST","short_description":"Apply a changeset on an envrionment."}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/changesets/destroy","name":"destroy","apis":[{"api_url":"/api/changesets/:id","http_method":"DELETE","short_description":"Destroy a changeset"}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"see":[]}]},"organization_default_info":{"doc_url":"/apidoc/v2/organization_default_info","api_url":"/api","name":"Organization default info","short_description":null,"full_description":"","version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/organization_default_info/create","name":"create","apis":[{"api_url":"/api/organizations/:organization_id/default_info/:informable_type","http_method":"POST","short_description":"Create default info"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"informable_type","full_name":"informable_type","description":"\n<p>name of the resource</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"informable_id","full_name":"informable_id","description":"\n<p>resource identifier</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"default_info","full_name":"default_info","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"keyname","full_name":"default_info[keyname]","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string"}]}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/organization_default_info/destroy","name":"destroy","apis":[{"api_url":"/api/organizations/:organization_id/default_info/:informable_type/:informable_id/:keyname","http_method":"DELETE","short_description":"Delete default info"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"informable_type","full_name":"informable_type","description":"\n<p>name of the resource</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"informable_id","full_name":"informable_id","description":"\n<p>resource identifier</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"keyname","full_name":"keyname","description":"\n<p>Custom info key</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/organization_default_info/apply_to_all","name":"apply_to_all","apis":[{"api_url":"/api/organizations/:organization_id/default_info/:informable_type/apply","http_method":"POST","short_description":"Apply existing default info on all informable resources"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"informable_type","full_name":"informable_type","description":"\n<p>name of the resource</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"informable_id","full_name":"informable_id","description":"\n<p>resource identifier</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"async","full_name":"async","description":"\n<p>directive to run this asynchronously or not</p>\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string"}],"examples":[],"see":[]}]},"subscriptions":{"doc_url":"/apidoc/v2/subscriptions","api_url":"/api","name":"Subscriptions","short_description":null,"full_description":"\n<p>Systems subscriptions management.</p>\n","version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/subscriptions/index","name":"index","apis":[{"api_url":"/api/systems/:system_id/subscriptions","http_method":"GET","short_description":"List system subscriptions"},{"api_url":"/api/organization/:organization_id/subscriptions","http_method":"GET","short_description":"List organization subscriptions"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"system_id","full_name":"system_id","description":"\n<p>UUID of the system</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"organization_id","full_name":"organization_id","description":"\n<p>Organization id</p>\n","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/subscriptions/show","name":"show","apis":[{"api_url":"/api/organizations/:organization_id/subscriptions/:id","http_method":"GET","short_description":"Show a subscription"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"system_id","full_name":"system_id","description":"\n<p>System uuid</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"organization_id","full_name":"organization_id","description":"\n<p>Organization identifier</p>\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"id","full_name":"id","description":"\n<p>Subscription identifier</p>\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/subscriptions/available","name":"available","apis":[{"api_url":"/api/systems/:system_id/subscriptions/available","http_method":"GET","short_description":"List available subscriptions"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"system_id","full_name":"system_id","description":"\n<p>UUID of the system</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"match_system","full_name":"match_system","description":"\n<p>Return subscriptions that match system</p>\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string"},{"name":"match_installed","full_name":"match_installed","description":"\n<p>Return subscriptions that match installed</p>\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string"},{"name":"no_overlap","full_name":"no_overlap","description":"\n<p>Return subscriptions that don’t overlap</p>\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/subscriptions/create","name":"create","apis":[{"api_url":"/api/systems/:system_id/subscriptions","http_method":"POST","short_description":"Create a subscription"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"system_id","full_name":"system_id","description":"\n<p>UUID of the system</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"subscription","full_name":"subscription","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"pool","full_name":"subscription[pool]","description":"\n<p>Subscription Pool uuid</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"quantity","full_name":"subscription[quantity]","description":"\n<p>Number of subscription to use</p>\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string"}]}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/subscriptions/destroy","name":"destroy","apis":[{"api_url":"/api/systems/:system_id/subscriptions/:id","http_method":"DELETE","short_description":"Delete a subscription"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Entitlement id</p>\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"system_id","full_name":"system_id","description":"\n<p>UUID of the system</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/subscriptions/destroy_all","name":"destroy_all","apis":[{"api_url":"/api/systems/:system_id/subscriptions","http_method":"DELETE","short_description":"Delete all system subscriptions"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"system_id","full_name":"system_id","description":"\n<p>UUID of the system</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/subscriptions/upload","name":"upload","apis":[{"api_url":"/api/organizations/:organization_id/subscriptions/upload","http_method":"POST","short_description":"Upload a subscription manifest"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"system_id","full_name":"system_id","description":"\n<p>System uuid</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"organization_id","full_name":"organization_id","description":"\n<p>Organization id</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"}],"examples":[],"see":[]}]}}}}
+{"docs":{"name":"Foreman","info":"\n<p>Foreman v2 is currently in development and is not the default version. You may use v2 by either passing ‘version=2’ in the Accept Header or entering api/v2/ in the URL.</p>\n","copyright":"","doc_url":"/apidoc/v2","api_url":"/api","resources":{"repository_sets":{"doc_url":"/apidoc/v2/repository_sets","api_url":"/api","name":"Repository sets","short_description":null,"full_description":"","version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/repository_sets/enable","name":"enable","apis":[{"api_url":"/api/organizations/:organization_id/product/:product_id/repository_sets/:id/enable","http_method":"POST","short_description":"Enable a repository set for a product."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n<p>id of an organization the repository will be contained in</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"product_id","full_name":"product_id","description":"\n<p>id of a product the repository will be contained in</p>\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"id","full_name":"id","description":"\n<p>id or name of the repository set to enable</p>\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/repository_sets/disable","name":"disable","apis":[{"api_url":"/api/organizations/:organization_id/product/:product_id/repository_sets/:id/disable","http_method":"POST","short_description":"Enable a repository set for a product."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n<p>id of an organization the repository will be contained in</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"product_id","full_name":"product_id","description":"\n<p>id of a product the repository will be contained in</p>\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"id","full_name":"id","description":"\n<p>id of the repository set to disable</p>\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/repository_sets/index","name":"index","apis":[{"api_url":"/api/product/:product_id/repository_sets","http_method":"GET","short_description":"List repository sets for a product."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"product_id","full_name":"product_id","description":"\n<p>id of a product to list repository sets for</p>\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string"}],"examples":[],"see":[]}]},"puppet_modules":{"doc_url":"/apidoc/v2/puppet_modules","api_url":"/api","name":"Puppet modules","short_description":null,"full_description":null,"version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/puppet_modules/index","name":"index","apis":[{"api_url":"/api/repositories/:repository_id/puppet_modules","http_method":"GET","short_description":"List puppet modules"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n<p>repository numeric identifier</p>\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/puppet_modules/search","name":"search","apis":[{"api_url":"/api/repositories/:repository_id/puppet_modules/search","http_method":"GET","short_description":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n<p>repository numeric identifier</p>\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"search","full_name":"search","description":"\n<p>search expression</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/puppet_modules/show","name":"show","apis":[{"api_url":"/api/repositories/:repository_id/puppet_modules/:id","http_method":"GET","short_description":"Show a puppet module"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n<p>repository numeric identifier</p>\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"id","full_name":"id","description":"\n<p>puppet module id</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]}]},"filters":{"doc_url":"/apidoc/v2/filters","api_url":"/api","name":"Filters","short_description":null,"full_description":null,"version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/filters/index","name":"index","apis":[{"api_url":"/api/content_view_definitions/:content_view_definition_id/filters","http_method":"GET","short_description":"List filters"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_definition_id","full_name":"content_view_definition_id","description":"\n<p>id of the content view definition</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/filters/create","name":"create","apis":[{"api_url":"/api/content_view_definitions/:content_view_definition_id/filters","http_method":"POST","short_description":"Create a filter for a content view definition"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_definition_id","full_name":"content_view_definition_id","description":"\n<p>id of the content view definition</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"filter","full_name":"filter","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"name","full_name":"filter[name]","description":"\n<p>name of the filter</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"}]}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/filters/show","name":"show","apis":[{"api_url":"/api/content_view_definitions/:content_view_definition_id/filters/:id","http_method":"GET","short_description":"Show filter info"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_definition_id","full_name":"content_view_definition_id","description":"\n<p>id of the content view definition</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"id","full_name":"id","description":"\n<p>name of the filter</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/filters/destroy","name":"destroy","apis":[{"api_url":"/api/content_view_definitions/:content_view_definition_id/filters/:id","http_method":"DELETE","short_description":"Delete a filter"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_definition_id","full_name":"content_view_definition_id","description":"\n<p>id of the content view definition</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"id","full_name":"id","description":"\n<p>name of the filter</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/filters/list_products","name":"list_products","apis":[{"api_url":"/api/content_view_definitions/:content_view_definition_id/filters/:id/products","http_method":"GET","short_description":"List all the products for a content view definition filter"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_definition_id","full_name":"content_view_definition_id","description":"\n<p>id of the content view definition</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"id","full_name":"id","description":"\n<p>name of the filter</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/filters/update_products","name":"update_products","apis":[{"api_url":"/api/content_view_definitions/:content_view_definition_id/filters/:id/products","http_method":"PUT","short_description":"Update products for a content view definition filter"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_definition_id","full_name":"content_view_definition_id","description":"\n<p>content view definition identifier</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"id","full_name":"id","description":"\n<p>name of the filter</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"products","full_name":"products","description":"\n<p>Updated list of product ids</p>\n","required":true,"allow_nil":false,"validator":"Array","expected_type":"array"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/filters/list_repositories","name":"list_repositories","apis":[{"api_url":"/api/content_view_definitions/:content_view_definition_id/filters/:id/repositories","http_method":"GET","short_description":"List all the repositories for a content view definition filter"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_definition_id","full_name":"content_view_definition_id","description":"\n<p>id of the content view definition</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"id","full_name":"id","description":"\n<p>name of the filter</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/filters/update_repositories","name":"update_repositories","apis":[{"api_url":"/api/content_view_definitions/:content_view_definition_id/filters/:id/repositories","http_method":"PUT","short_description":"Update repositories for a content view definition filter"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_definition_id","full_name":"content_view_definition_id","description":"\n<p>id of the content view definition</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"id","full_name":"id","description":"\n<p>name of the filter</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"repos","full_name":"repos","description":"\n<p>Updated list of repo ids</p>\n","required":true,"allow_nil":false,"validator":"Array","expected_type":"array"}],"examples":[],"see":[]}]},"products":{"doc_url":"/apidoc/v2/products","api_url":"/api","name":"Products","short_description":null,"full_description":null,"version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/products/index","name":"index","apis":[{"api_url":"/api/environments/:environment_id/products","http_method":"GET","short_description":"List products in an environment"},{"api_url":"/api/organizations/:organization_id/products","http_method":"GET","short_description":"List all products in an organization"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n<p>organization identifier</p>\n","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"name","full_name":"name","description":"\n<p>product identifier</p>\n","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"include_marketing","full_name":"include_marketing","description":"\n<p>include marketing products in results</p>\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/products/create","name":"create","apis":[{"api_url":"/api/products","http_method":"POST","short_description":"Create a product"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"label","full_name":"label","description":"","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"provider_id","full_name":"provider_id","description":"\n<p>Provider the product belongs to</p>\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"description","full_name":"description","description":"\n<p>Product description</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"gpg_key_id","full_name":"gpg_key_id","description":"\n<p>Identifier of the GPG key</p>\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"sync_plan_id","full_name":"sync_plan_id","description":"\n<p>Plan numeric identifier</p>\n","required":false,"allow_nil":true,"validator":"number.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/products/show","name":"show","apis":[{"api_url":"/api/organizations/:organization_id/products/:id","http_method":"GET","short_description":"Show a product"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n<p>organization identifier</p>\n","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"id","full_name":"id","description":"\n<p>product numeric identifier</p>\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/products/update","name":"update","apis":[{"api_url":"/api/organizations/:organization_id/products/:id","http_method":"PUT","short_description":"Update a product"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n<p>organization identifier</p>\n","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"id","full_name":"id","description":"\n<p>product numeric identifier</p>\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"product","full_name":"product","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"gpg_key_name","full_name":"product[gpg_key_name]","description":"\n<p>identifier of the gpg key</p>\n","required":false,"allow_nil":true,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"description","full_name":"product[description]","description":"\n<p>Product description</p>\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string"},{"name":"recursive","full_name":"product[recursive]","description":"\n<p>set to true to recursive update gpg key</p>\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string"}]}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/products/destroy","name":"destroy","apis":[{"api_url":"/api/organizations/:organization_id/products/:id","http_method":"DELETE","short_description":"Destroy a product"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n<p>organization identifier</p>\n","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"id","full_name":"id","description":"\n<p>product numeric identifier</p>\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/products/repositories","name":"repositories","apis":[{"api_url":"/api/environments/:environment_id/products/:id/repositories","http_method":"GET","short_description":null},{"api_url":"/api/organizations/:organization_id/products/:id/repositories","http_method":"GET","short_description":null},{"api_url":"/api/organizations/:organization_id/products/:id/repositories","http_method":"GET","short_description":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n<p>organization identifier</p>\n","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"environment_id","full_name":"environment_id","description":"\n<p>environment identifier</p>\n","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"id","full_name":"id","description":"\n<p>product numeric identifier</p>\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"include_disabled","full_name":"include_disabled","description":"\n<p>set to True if you want to list disabled repositories</p>\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string"},{"name":"name","full_name":"name","description":"\n<p>repository identifier</p>\n","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"content_view_id","full_name":"content_view_id","description":"\n<p>find repos in content view instead of default content view</p>\n","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/products/set_sync_plan","name":"set_sync_plan","apis":[{"api_url":"/api/organizations/:organization_id/products/:id/sync_plan","http_method":"POST","short_description":"Assign sync plan to product"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n<p>organization identifier</p>\n","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"id","full_name":"id","description":"\n<p>product numeric identifier</p>\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"plan_id","full_name":"plan_id","description":"\n<p>Plan numeric identifier</p>\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/products/remove_sync_plan","name":"remove_sync_plan","apis":[{"api_url":"/api/organizations/:organization_id/products/:id/sync_plan","http_method":"DELETE","short_description":"Delete assignment sync plan and product"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n<p>organization identifier</p>\n","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"id","full_name":"id","description":"\n<p>product numeric identifier</p>\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"plan_id","full_name":"plan_id","description":"\n<p>Plan numeric identifier</p>\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string"}],"examples":[],"see":[]}]},"tasks":{"doc_url":"/apidoc/v2/tasks","api_url":"/api","name":"Tasks","short_description":null,"full_description":null,"version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/tasks/index","name":"index","apis":[{"api_url":"/api/organizations/:organization_id/tasks","http_method":"GET","short_description":"List tasks of given organization"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n<p>organization identifier</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/tasks/show","name":"show","apis":[{"api_url":"/api/tasks/:id","http_method":"GET","short_description":"Show a task info"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>task identifier</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"}],"examples":[],"see":[]}]},"distributors":{"doc_url":"/apidoc/v2/distributors","api_url":"/api","name":"Distributors","short_description":null,"full_description":null,"version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/distributors/create","name":"create","apis":[{"api_url":"/api/environments/:environment_id/distributors","http_method":"POST","short_description":"Register a distributor in environment"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"distributor","full_name":"distributor","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"name","full_name":"distributor[name]","description":"\n<p>Name of the distributor</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"facts","full_name":"distributor[facts]","description":"\n<p>Key-value hash of distributor-specific facts</p>\n","required":false,"allow_nil":true,"validator":"Hash","expected_type":"hash"},{"name":"installedProducts","full_name":"distributor[installedProducts]","description":"\n<p>List of products installed on the distributor</p>\n","required":false,"allow_nil":true,"validator":"Array","expected_type":"array"},{"name":"serviceLevel","full_name":"distributor[serviceLevel]","description":"\n<p>A service level for auto-healing process, e.g. SELF-SUPPORT</p>\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string"},{"name":"releaseVer","full_name":"distributor[releaseVer]","description":"\n<p>Release of the os. The $releasever variable in repo url will be replaced with this value</p>\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string"},{"name":"location","full_name":"distributor[location]","description":"\n<p>Physical of the distributor</p>\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string"},{"name":"capabilities","full_name":"distributor[capabilities]","description":"\n<p>List of subscription capabilities</p>\n","required":false,"allow_nil":true,"validator":"Array","expected_type":"array"},{"name":"type","full_name":"distributor[type]","description":"\n<p>Type of the distributor, it should always be ‘distributor’</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"version","full_name":"distributor[version]","description":"\n<p>Version of the distributor. Defaults to the latest if not given.</p>\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string"}]}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/distributors/update","name":"update","apis":[{"api_url":"/api/distributors/:id","http_method":"PUT","short_description":"Update distributor information"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"distributor","full_name":"distributor","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"name","full_name":"distributor[name]","description":"\n<p>Name of the distributor</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"facts","full_name":"distributor[facts]","description":"\n<p>Key-value hash of distributor-specific facts</p>\n","required":false,"allow_nil":true,"validator":"Hash","expected_type":"hash"},{"name":"installedProducts","full_name":"distributor[installedProducts]","description":"\n<p>List of products installed on the distributor</p>\n","required":false,"allow_nil":true,"validator":"Array","expected_type":"array"},{"name":"serviceLevel","full_name":"distributor[serviceLevel]","description":"\n<p>A service level for auto-healing process, e.g. SELF-SUPPORT</p>\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string"},{"name":"releaseVer","full_name":"distributor[releaseVer]","description":"\n<p>Release of the os. The $releasever variable in repo url will be replaced with this value</p>\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string"},{"name":"location","full_name":"distributor[location]","description":"\n<p>Physical of the distributor</p>\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string"},{"name":"capabilities","full_name":"distributor[capabilities]","description":"\n<p>List of subscription capabilities</p>\n","required":false,"allow_nil":true,"validator":"Array","expected_type":"array"}]},{"name":"capabilities","full_name":"capabilities","description":"\n<p>For backwards capability with Red Hat hosted candlepin - List of subscription capabilities</p>\n","required":false,"allow_nil":false,"validator":"Array","expected_type":"array"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/distributors/index","name":"index","apis":[{"api_url":"/api/environments/:environment_id/distributors","http_method":"GET","short_description":"List distributors in environment"},{"api_url":"/api/organizations/:organization_id/distributors","http_method":"GET","short_description":"List distributors in organization"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>Filter distributors by name</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"pool_id","full_name":"pool_id","description":"\n<p>Filter distributors by subscribed pool</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/distributors/show","name":"show","apis":[{"api_url":"/api/distributors/:id","http_method":"GET","short_description":"Show a distributor"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>UUID of the distributor</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/distributors/export","name":"export","apis":[{"api_url":"/api/distributors/:id/export","http_method":"GET","short_description":"Export distributor's manifest"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>UUID of the distributor</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/distributors/destroy","name":"destroy","apis":[{"api_url":"/api/distributors/:id","http_method":"DELETE","short_description":"Unregister a distributor"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>UUID of the distributor</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/distributors/pools","name":"pools","apis":[{"api_url":"/api/distributors/:id/pools","http_method":"GET","short_description":"List pools a distributor is subscribed to"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>UUID of the distributor</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/distributors/tasks","name":"tasks","apis":[{"api_url":"/api/organizations/:organization_id/distributors/tasks","http_method":"GET","short_description":"List async tasks for the distributor"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"distributor_name","full_name":"distributor_name","description":"\n<p>Name of the distributor</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"distributor_uuid","full_name":"distributor_uuid","description":"\n<p>UUID of the distributor</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/distributors/task_show","name":"task_show","apis":[{"api_url":"/api/distributors/tasks/:id","http_method":"GET","short_description":"Show details of the async task"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>UUID of the task</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/distributors/versions","name":"versions","apis":[{"api_url":"/api/distributor_versions","http_method":"GET","short_description":"Show the list of available distributor versions"}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"see":[]}]},"organizations":{"doc_url":"/apidoc/v2/organizations","api_url":"/api","name":"Organizations","short_description":null,"full_description":null,"version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/organizations/index","name":"index","apis":[{"api_url":"/api/organizations","http_method":"GET","short_description":"List all :resource_id"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"\n<p>Search string</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"page","full_name":"page","description":"\n<p>Page number, starting at 1</p>\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"per_page","full_name":"per_page","description":"\n<p>Number of results per page to return</p>\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"order","full_name":"order","description":"\n<p>Sort field and order, eg. ‘name DESC’</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"sort","full_name":"sort","description":"\n<p>Hash version of ‘order’ param</p>\n","required":false,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"by","full_name":"sort[by]","description":"\n<p>Field to sort the results on</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"order","full_name":"sort[order]","description":"\n<p>How to order the sorted results (e.g. ASC for ascending)</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"}]}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/organizations/show","name":"show","apis":[{"api_url":"/api/organizations/:id","http_method":"GET","short_description":"Show organization"}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/organizations/create","name":"create","apis":[{"api_url":"/api/organizations","http_method":"POST","short_description":"Create organization"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>name</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"label","full_name":"label","description":"\n<p>unique label</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"description","full_name":"description","description":"\n<p>description</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/organizations/update","name":"update","apis":[{"api_url":"/api/organizations/:id","http_method":"PUT","short_description":"Update organization"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"resource","full_name":"resource","description":"","required":false,"allow_nil":true,"validator":"Hash","expected_type":"hash","params":[{"name":"name","full_name":"resource[name]","description":"","required":false,"allow_nil":false,"validator":"String","expected_type":"string"}]},{"name":"description","full_name":"description","description":"\n<p>description</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/organizations/destroy","name":"destroy","apis":[{"api_url":"/api/organizations/:id","http_method":"DELETE","short_description":"Delete an organization"}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/organizations/repo_discover","name":"repo_discover","apis":[{"api_url":"/api/organizations/:id/repo_discover","http_method":"PUT","short_description":"Discover Repositories"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>organization id, label, or name</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"url","full_name":"url","description":"\n<p>base url to perform repo discovery on</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/organizations/cancel_repo_discover","name":"cancel_repo_discover","apis":[{"api_url":"/api/organizations/:id/cancel_repo_discover","http_method":"PUT","short_description":"Cancel repository discovery"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>organization id, label, or name</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"url","full_name":"url","description":"\n<p>base url to perform repo discovery on</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/organizations/autoattach_subscriptions","name":"autoattach_subscriptions","apis":[{"api_url":"/api/organizations/:id/autoattach_subscriptions","http_method":"POST","short_description":"Auto-attach available subscriptions to all systems within an organization. Asynchronous operation."}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"see":[]}]},"environments":{"doc_url":"/apidoc/v2/environments","api_url":"/api","name":"Environments","short_description":null,"full_description":"\n<h1 id=\"description\">Description</h1>\n\n<p>An 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.</p>\n\n<h2 id=\"chains\">Chains</h2>\n\n<p>Environments 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:</p>\n\n<pre><code>Library -&gt; Development -&gt; Testing -&gt; Production</code></pre>\n\n<p>Each change in an environment is done through a changeset in an action called promotion.</p>\n\n<h2 id=\"library\">Library</h2>\n\n<p>Library 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.</p>\n","version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/environments/index","name":"index","apis":[{"api_url":"/api/environments","http_method":"GET","short_description":"List environments in an organization"},{"api_url":"/api/organizations/:organization_id/environments","http_method":"GET","short_description":"List environments in an organization"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n<p>organization identifier</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"library","full_name":"library","description":"\n<p>set true if you want to see only library environments</p>\n","required":false,"allow_nil":false,"validator":"Must be one of: true, false.","expected_type":"string"},{"name":"name","full_name":"name","description":"\n<p>filter only environments containing this name</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":["GET /api/environments\n200\n[\n  {\n    \"environment\": {\n      \"name\": \"global_puppetmaster\",\n      \"id\": 153855663,\n      \"updated_at\": \"2012-12-18T15:24:42Z\",\n      \"created_at\": \"2012-12-18T15:24:42Z\"\n    }\n  },\n  {\n    \"environment\": {\n      \"name\": \"production\",\n      \"id\": 334344675,\n      \"updated_at\": \"2012-12-18T15:24:42Z\",\n      \"created_at\": \"2012-12-18T15:24:42Z\"\n    }\n  },\n  {\n    \"environment\": {\n      \"name\": \"testing\",\n      \"id\": 687036937,\n      \"updated_at\": \"2012-12-18T15:24:42Z\",\n      \"created_at\": \"2012-12-18T15:24:42Z\"\n    }\n  }\n]"],"see":[]},{"doc_url":"/apidoc/v2/environments/show","name":"show","apis":[{"api_url":"/api/environments/:id","http_method":"GET","short_description":"Show an environment"},{"api_url":"/api/organizations/:organization_id/environments/:environment_id","http_method":"GET","short_description":"Show an environment"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>ID of the environment</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"name","full_name":"name","description":"\n<p>name of the environment</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"organization_id","full_name":"organization_id","description":"\n<p>ID of the organization</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":["GET /api/environments/production\n200\n{\n  \"environment\": {\n    \"name\": \"production\",\n    \"id\": 334344675,\n    \"updated_at\": \"2012-12-18T15:24:42Z\",\n    \"created_at\": \"2012-12-18T15:24:42Z\"\n  }\n}"],"see":[]},{"doc_url":"/apidoc/v2/environments/create","name":"create","apis":[{"api_url":"/api/environments","http_method":"POST","short_description":"Create an environment"},{"api_url":"/api/organizations/:organization_id/environments","http_method":"POST","short_description":"Create an environment in an organization"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n<p>name of organization</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"name","full_name":"name","description":"\n<p>name of the environment</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"description","full_name":"description","description":"\n<p>description of the environment</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"prior","full_name":"prior","description":"\n<p>Name of an environment that is prior to the new environment in the chain. It has to be either ‘Library’ or an environment at the end of a chain.</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":["POST /api/environments\n{\n  \"environment\": {\n    \"name\": \"Development\"\n  }\n}\n200\n{\n  \"environment\": {\n    \"name\": \"Development\",\n    \"id\": 687036938,\n    \"updated_at\": \"2012-12-18T15:24:46Z\",\n    \"created_at\": \"2012-12-18T15:24:46Z\"\n  }\n}"],"see":[]},{"doc_url":"/apidoc/v2/environments/update","name":"update","apis":[{"api_url":"/api/environments/:id","http_method":"PUT","short_description":"Update an environment"},{"api_url":"/api/organizations/:organization_id/environments/:id","http_method":"PUT","short_description":"Update an environment in an organization"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>ID of the environment</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"organization_id","full_name":"organization_id","description":"\n<p>name of the organization</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"name","full_name":"name","description":"\n<p>name of the environment</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"new_name","full_name":"new_name","description":"\n<p>new name to be given to the environment</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"description","full_name":"description","description":"\n<p>description of the environment</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"prior","full_name":"prior","description":"\n<p>Name of an environment that is prior to the new environment in the chain. It has to be either ‘Library’ or an environment at the end of a chain.</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":["PUT /api/environments/production\n{\n  \"environment\": {}\n}\n200\n{\n  \"environment\": {\n    \"name\": \"production\",\n    \"id\": 334344675\n  }\n}"],"see":[]},{"doc_url":"/apidoc/v2/environments/destroy","name":"destroy","apis":[{"api_url":"/api/environments/:id","http_method":"DELETE","short_description":"Destroy an environment"},{"api_url":"/api/organizations/:organization_id/environments/:id","http_method":"DELETE","short_description":"Destroy an environment in an organization"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>ID of the environment</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"name","full_name":"name","description":"\n<p>name of the environment</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"organization_id","full_name":"organization_id","description":"\n<p>organization identifier</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":["DELETE /api/environments/testing\n200\n{\n  \"environment\": {\n    \"name\": \"testing\",\n    \"id\": 687036937\n  }\n}"],"see":[]},{"doc_url":"/apidoc/v2/environments/paths","name":"paths","apis":[{"api_url":"/api/organization/:organization_id/environments/paths","http_method":"GET","short_description":"List environment paths"}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"see":[]}]},"content_view_definitions":{"doc_url":"/apidoc/v2/content_view_definitions","api_url":"/api","name":"Content view definitions","short_description":null,"full_description":"","version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/content_view_definitions/index","name":"index","apis":[{"api_url":"/api/organizations/:organization_id/content_view_definitions","http_method":"GET","short_description":"List content view definitions"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n<p>organization identifier</p>\n","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"label","full_name":"label","description":"\n<p>content view label</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"name","full_name":"name","description":"\n<p>content view name</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"id","full_name":"id","description":"\n<p>content view id</p>\n","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/content_view_definitions/create","name":"create","apis":[{"api_url":"/api/organizations/:organization_id/content_view_definitions","http_method":"POST","short_description":"Create a content view definition"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n<p>organization identifier</p>\n","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"content_view_definition","full_name":"content_view_definition","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"name","full_name":"content_view_definition[name]","description":"\n<p>Content view definition name</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"description","full_name":"content_view_definition[description]","description":"\n<p>Definition description</p>\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string"},{"name":"label","full_name":"content_view_definition[label]","description":"\n<p>Content view identifier</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"}]}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/content_view_definitions/update","name":"update","apis":[{"api_url":"/api/content_view_definitions/:id","http_method":"PUT","short_description":"Update a definition"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Definition identifier</p>\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"org","full_name":"org","description":"\n<p>Organization name</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"content_view_definition","full_name":"content_view_definition","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"name","full_name":"content_view_definition[name]","description":"\n<p>Content view definition name</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"description","full_name":"content_view_definition[description]","description":"\n<p>Definition description</p>\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string"}]}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/content_view_definitions/show","name":"show","apis":[{"api_url":"/api/content_view_definitions/:id","http_method":"GET","short_description":"Show definition info"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Definition identifier</p>\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/content_view_definitions/publish","name":"publish","apis":[{"api_url":"/api/content_view_definitions/:id/publish","http_method":"POST","short_description":"Publish a content view"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>Name for the new content view</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"label","full_name":"label","description":"\n<p>Label for the new content view</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"description","full_name":"description","description":"\n<p>Description for the new content view</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"id","full_name":"id","description":"\n<p>Definition identifier</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/content_view_definitions/destroy","name":"destroy","apis":[{"api_url":"/api/content_view_definitions/:id","http_method":"DELETE","short_description":"Delete a cv definition"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Definition identifier</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/content_view_definitions/clone","name":"clone","apis":[{"api_url":"/api/content_view_definitions/:id/clone","http_method":"POST","short_description":"Clone a definition"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Definition identifier</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"content_view_definition","full_name":"content_view_definition","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"name","full_name":"content_view_definition[name]","description":"\n<p>Content view definition name</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"description","full_name":"content_view_definition[description]","description":"\n<p>Definition description</p>\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string"},{"name":"label","full_name":"content_view_definition[label]","description":"\n<p>Content view identifier</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"}]}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/content_view_definitions/content_views","name":"content_views","apis":[{"api_url":"/api/content_view_definitions/:id/content_views","http_method":"GET","short_description":"List a definition's content views"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Definition identifier</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/content_view_definitions/update_content_views","name":"update_content_views","apis":[{"api_url":"/api/content_view_definitions/:content_view_definition_id/content_views","http_method":"PUT","short_description":"Update a definition's content views"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_definition_id","full_name":"content_view_definition_id","description":"\n<p>Definition identifier</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"views","full_name":"views","description":"\n<p>Updated list of view ids</p>\n","required":true,"allow_nil":false,"validator":"Array","expected_type":"array"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/content_view_definitions/list_repositories","name":"list_repositories","apis":[{"api_url":"/api/content_view_definitions/:content_view_definition_id/repositories","http_method":"GET","short_description":"List all the repositories for a content view definition"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_definition_id","full_name":"content_view_definition_id","description":"\n<p>Definition id</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/content_view_definitions/update_repositories","name":"update_repositories","apis":[{"api_url":"/api/content_view_definitions/:content_view_definition_id/repositories","http_method":"PUT","short_description":"Update repositories for content view definition"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_definition_id","full_name":"content_view_definition_id","description":"\n<p>content view definition identifier</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"repos","full_name":"repos","description":"\n<p>Updated list of repo ids</p>\n","required":true,"allow_nil":false,"validator":"Array","expected_type":"array"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/content_view_definitions/list_products","name":"list_products","apis":[{"api_url":"/api/content_view_definitions/:content_view_definition_id/products","http_method":"GET","short_description":"Get products for content view definition"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n<p>organization identifier</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"content_view_definition_id","full_name":"content_view_definition_id","description":"\n<p>content view definition identifier</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/content_view_definitions/update_products","name":"update_products","apis":[{"api_url":"/api/content_view_definitions/:content_view_definition_id/products","http_method":"PUT","short_description":"Update products for content view definition"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_definition_id","full_name":"content_view_definition_id","description":"\n<p>content view definition identifier</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"products","full_name":"products","description":"\n<p>Updated list of products</p>\n","required":true,"allow_nil":false,"validator":"Array","expected_type":"array"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/content_view_definitions/list_all_products","name":"list_all_products","apis":[{"api_url":"/api/content_view_definitions/:content_view_definition_id/products/all","http_method":"GET","short_description":"Get a list of products belonging to the content view definition, even if one its repositories have been associated to this definition. Mainly used by filter api  "}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_definition_id","full_name":"content_view_definition_id","description":"\n<p>content view definition identifier</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"}],"examples":[],"see":[]}]},"custom_info":{"doc_url":"/apidoc/v2/custom_info","api_url":"/api","name":"Custom info","short_description":null,"full_description":"","version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/custom_info/create","name":"create","apis":[{"api_url":"/api/custom_info/:informable_type/:informable_id","http_method":"POST","short_description":"Create custom info"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"informable_type","full_name":"informable_type","description":"\n<p>name of the resource</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"informable_id","full_name":"informable_id","description":"\n<p>resource identifier</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"custom_info","full_name":"custom_info","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"keyname","full_name":"custom_info[keyname]","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"value","full_name":"custom_info[value]","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string"}]}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/custom_info/index","name":"index","apis":[{"api_url":"/api/custom_info/:informable_type/:informable_id","http_method":"GET","short_description":"List custom info"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"informable_type","full_name":"informable_type","description":"\n<p>name of the resource</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"informable_id","full_name":"informable_id","description":"\n<p>resource identifier</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/custom_info/show","name":"show","apis":[{"api_url":"/api/custom_info/:informable_type/:informable_id/:keyname","http_method":"GET","short_description":"Show custom info"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"informable_type","full_name":"informable_type","description":"\n<p>name of the resource</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"informable_id","full_name":"informable_id","description":"\n<p>resource identifier</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"keyname","full_name":"keyname","description":"\n<p>Custom info key</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/custom_info/update","name":"update","apis":[{"api_url":"/api/custom_info/:informable_type/:informable_id/:keyname","http_method":"PUT","short_description":"Update custom info"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"informable_type","full_name":"informable_type","description":"\n<p>name of the resource</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"informable_id","full_name":"informable_id","description":"\n<p>resource identifier</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"keyname","full_name":"keyname","description":"\n<p>Custom info key</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"custom_info","full_name":"custom_info","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"value","full_name":"custom_info[value]","description":"","required":false,"allow_nil":false,"validator":"String","expected_type":"string"}]}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/custom_info/destroy","name":"destroy","apis":[{"api_url":"/api/custom_info/:informable_type/:informable_id/:keyname","http_method":"DELETE","short_description":"Delete custom info"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"informable_type","full_name":"informable_type","description":"\n<p>name of the resource</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"informable_id","full_name":"informable_id","description":"\n<p>resource identifier</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"keyname","full_name":"keyname","description":"\n<p>Custom info key</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]}]},"system_packages":{"doc_url":"/apidoc/v2/system_packages","api_url":"/api","name":"System packages","short_description":null,"full_description":"","version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/system_packages/install","name":"install","apis":[{"api_url":"/api/systems/:system_id/packages/install","http_method":"POST","short_description":"Install packages remotely"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"system_id","full_name":"system_id","description":"\n<p>system identifier</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"packages","full_name":"packages","description":"\n<p>List of package names</p>\n","required":false,"allow_nil":false,"validator":"Array","expected_type":"array"},{"name":"groups","full_name":"groups","description":"\n<p>List of package group names</p>\n","required":false,"allow_nil":false,"validator":"Array","expected_type":"array"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/system_packages/upgrade","name":"upgrade","apis":[{"api_url":"/api/systems/:system_id/packages/upgrade","http_method":"PUT","short_description":"Update packages remotely"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"system_id","full_name":"system_id","description":"\n<p>system identifier</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"packages","full_name":"packages","description":"\n<p>list of packages names</p>\n","required":false,"allow_nil":false,"validator":"Array","expected_type":"array"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/system_packages/upgrade_all","name":"upgrade_all","apis":[{"api_url":"/api/systems/:system_id/packages/upgrade_all","http_method":"PUT","short_description":"Update packages remotely"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"system_id","full_name":"system_id","description":"\n<p>system identifier</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/system_packages/remove","name":"remove","apis":[{"api_url":"/api/systems/:system_id/packages/remove","http_method":"POST","short_description":"Uninstall packages remotely"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"system_id","full_name":"system_id","description":"\n<p>system identifier</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"packages","full_name":"packages","description":"\n<p>List of package names</p>\n","required":false,"allow_nil":false,"validator":"Array","expected_type":"array"},{"name":"groups","full_name":"groups","description":"\n<p>List of package group names</p>\n","required":false,"allow_nil":false,"validator":"Array","expected_type":"array"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/system_packages/create","name":"create","apis":[{"api_url":"/api/systems/:system_id/packages","http_method":"POST","short_description":"Install packages remotely"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"system_id","full_name":"system_id","description":"\n<p>system identifier</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"packages","full_name":"packages","description":"\n<p>List of package names</p>\n","required":false,"allow_nil":false,"validator":"Array","expected_type":"array"},{"name":"groups","full_name":"groups","description":"\n<p>List of package group names</p>\n","required":false,"allow_nil":false,"validator":"Array","expected_type":"array"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/system_packages/update","name":"update","apis":[{"api_url":"/api/systems/:system_id/packages","http_method":"PUT","short_description":"Update packages remotely"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"system_id","full_name":"system_id","description":"\n<p>system identifier</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"packages","full_name":"packages","description":"\n<p>list of packages names</p>\n","required":false,"allow_nil":false,"validator":"Array","expected_type":"array"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/system_packages/destroy","name":"destroy","apis":[{"api_url":"/api/systems/:system_id/packages","http_method":"DELETE","short_description":"Uninstall packages remotely"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"system_id","full_name":"system_id","description":"\n<p>system identifier</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"packages","full_name":"packages","description":"\n<p>List of package names</p>\n","required":false,"allow_nil":false,"validator":"Array","expected_type":"array"},{"name":"groups","full_name":"groups","description":"\n<p>List of package group names</p>\n","required":false,"allow_nil":false,"validator":"Array","expected_type":"array"}],"examples":[],"see":[]}]},"content_uploads":{"doc_url":"/apidoc/v2/content_uploads","api_url":"/api","name":"Content uploads","short_description":null,"full_description":null,"version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/content_uploads/create","name":"create","apis":[{"api_url":"/api/repositories/:repo_id/content_uploads","http_method":"POST","short_description":"Create an upload request"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repo_id","full_name":"repo_id","description":"\n<p>repository id</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/content_uploads/upload_bits","name":"upload_bits","apis":[{"api_url":"/api/repositories/:repo_id/content_uploads/:id/upload_bits","http_method":"PUT","short_description":"Upload bits"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repo_id","full_name":"repo_id","description":"\n<p>repository id</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"id","full_name":"id","description":"\n<p>upload request id</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"offset","full_name":"offset","description":"\n<p>the offset at which Pulp will store the file contents</p>\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"content","full_name":"content","description":"\n<p>file contents</p>\n","required":true,"allow_nil":false,"validator":"File","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/content_uploads/destroy","name":"destroy","apis":[{"api_url":"/api/repositories/:repo_id/content_uploads/:id","http_method":"DELETE","short_description":"Delete an upload request"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repo_id","full_name":"repo_id","description":"\n<p>repository id</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"id","full_name":"id","description":"\n<p>upload request id</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/content_uploads/import_into_repo","name":"import_into_repo","apis":[{"api_url":"/api/repositories/:repo_id/content_uploads/import_into_repo","http_method":"POST","short_description":"Import into a repository"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repo_id","full_name":"repo_id","description":"\n<p>repository id</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"uploads","full_name":"uploads","description":"\n<p>array of uploads to import</p>\n","required":true,"allow_nil":false,"validator":"Array","expected_type":"array"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/content_uploads/upload_file","name":"upload_file","apis":[{"api_url":"/api/repositories/:id/content_uploads/file","http_method":"POST","short_description":"Upload content into the repository"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"content","full_name":"content","description":"\n<p>file contents</p>\n","required":true,"allow_nil":false,"validator":"File","expected_type":"string"}],"examples":[],"see":[]}]},"content_views":{"doc_url":"/apidoc/v2/content_views","api_url":"/api","name":"Content views","short_description":null,"full_description":null,"version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/content_views/index","name":"index","apis":[{"api_url":"/api/organizations/:organization_id/content_views","http_method":"GET","short_description":"List content views"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n<p>organization identifier</p>\n","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"environment_id","full_name":"environment_id","description":"\n<p>environment identifier</p>\n","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"label","full_name":"label","description":"\n<p>content view label</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"name","full_name":"name","description":"\n<p>content view name</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"id","full_name":"id","description":"\n<p>content view id</p>\n","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/content_views/show","name":"show","apis":[{"api_url":"/api/content_views/:id","http_method":"GET","short_description":"Show a content view"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>content view id</p>\n","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"environment_id","full_name":"environment_id","description":"\n<p>environment id</p>\n","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/content_views/promote","name":"promote","apis":[{"api_url":"/api/content_views/:id/promote","http_method":"POST","short_description":"Promote a content view to next environment"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>content view id</p>\n","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"environment_id","full_name":"environment_id","description":"\n<p>environment promoting to</p>\n","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/content_views/refresh","name":"refresh","apis":[{"api_url":"/api/content_views/:id/refresh","http_method":"POST","short_description":"Refresh a content view"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>content view id</p>\n","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/content_views/destroy","name":"destroy","apis":[{"api_url":"/api/content_views/:id","http_method":"DELETE","short_description":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>content view id</p>\n","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"}],"examples":[],"see":[]}]},"packages":{"doc_url":"/apidoc/v2/packages","api_url":"/api","name":"Packages","short_description":null,"full_description":null,"version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/packages/index","name":"index","apis":[{"api_url":"/api/repositories/:repository_id/packages","http_method":"GET","short_description":"List packages"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n<p>environment numeric identifier</p>\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/packages/search","name":"search","apis":[{"api_url":"/api/repositories/:repository_id/packages/search","http_method":"GET","short_description":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n<p>environment numeric identifier</p>\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"search","full_name":"search","description":"\n<p>search expression</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/packages/show","name":"show","apis":[{"api_url":"/api/repositories/:repository_id/packages/:id","http_method":"GET","short_description":"Show a package"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n<p>environment numeric identifier</p>\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"id","full_name":"id","description":"\n<p>package id</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]}]},"distributions":{"doc_url":"/apidoc/v2/distributions","api_url":"/api","name":"Distributions","short_description":null,"full_description":null,"version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/distributions/index","name":"index","apis":[{"api_url":"/api/repositories/:repository_id/distributions","http_method":"GET","short_description":"List distributions"}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/distributions/show","name":"show","apis":[{"api_url":"/api/repositories/:repository_id/distributions/:id","http_method":"GET","short_description":"Show a distribution"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n<p>repository numeric id</p>\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string"}],"examples":[],"see":[]}]},"about":{"doc_url":"/apidoc/v2/about","api_url":"/api","name":"About","short_description":null,"full_description":null,"version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/about/index","name":"index","apis":[{"api_url":"/api/about","http_method":"GET","short_description":"Shows status of system and it's subcomponents"}],"formats":null,"full_description":"\n<p>This service is only available for authenticated users</p>\n","errors":[],"params":[],"examples":[],"see":[]}]},"roles":{"doc_url":"/apidoc/v2/roles","api_url":"/api","name":"Roles","short_description":null,"full_description":null,"version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/roles/index","name":"index","apis":[{"api_url":"/api/roles","http_method":"GET","short_description":"List roles"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"","required":false,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/roles/show","name":"show","apis":[{"api_url":"/api/roles/:id","http_method":"GET","short_description":"Show a role"}],"formats":null,"full_description":"","errors":[],"params":[],"examples":["GET /api/roles/1\n200\n{\n  \"role\": {\n    \"name\": \"Manager\",\n    \"id\": 1,\n    \"builtin\": 0,\n    \"permissions\": [\n      \"view_architectures\",\n      \"create_architectures\",\n      \"edit_architectures\",\n      \"destroy_architectures\",\n      \"view_authenticators\",\n      \"create_authenticators\",\n      \"edit_authenticators\",\n      \"destroy_authenticators\",\n      \"view_environments\",\n      \"create_environments\",\n      \"edit_environments\",\n      \"destroy_environments\",\n      \"import_environments\",\n      \"view_external_variables\",\n      \"create_external_variables\",\n      \"edit_external_variables\",\n      \"destroy_external_variables\",\n      \"view_domains\",\n      \"create_domain\",\n      \"edit_domains\",\n      \"destroy_domains\",\n      \"view_globals\",\n      \"create_globals\",\n      \"edit_globals\",\n      \"destroy_globals\",\n      \"view_hostgroups\",\n      \"create_hostgroups\",\n      \"edit_hostgroups\",\n      \"destroy_hostgroups\",\n      \"view_hosts\",\n      \"create_hosts\",\n      \"edit_hosts\",\n      \"destroy_hosts\",\n      \"view_media\",\n      \"create_media\",\n      \"edit_media\",\n      \"destroy_media\",\n      \"view_models\",\n      \"create_models\",\n      \"edit_models\",\n      \"destroy_models\",\n      \"view_operatingsystems\",\n      \"create_operatingsystems\",\n      \"edit_operatingsystems\",\n      \"destroy_operatingsystems\",\n      \"view_ptables\",\n      \"create_ptables\",\n      \"edit_ptables\",\n      \"destroy_ptables\",\n      \"view_puppetclasses\",\n      \"create_puppetclasses\",\n      \"edit_puppetclasses\",\n      \"destroy_puppetclasses\",\n      \"import_puppetclasses\",\n      \"view_usergroups\",\n      \"create_usergroups\",\n      \"edit_usergroups\",\n      \"destroy_usergroups\",\n      \"view_users\",\n      \"create_users\",\n      \"edit_users\",\n      \"destroy_users\",\n      \"access_settings\",\n      \"access_dashboard\",\n      \"view_reports\",\n      \"destroy_reports\",\n      \"view_facts\",\n      \"view_audit_logs\",\n      \"view_statistics\",\n      \"view_locations\",\n      \"edit_locations\",\n      \"create_locations\",\n      \"destroy_locations\",\n      \"view_organizations\",\n      \"edit_organizations\",\n      \"create_organizations\",\n      \"destroy_organizations\"\n    ]\n  }\n}"],"see":[]},{"doc_url":"/apidoc/v2/roles/create","name":"create","apis":[{"api_url":"/api/roles","http_method":"POST","short_description":"Create a role"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"role","full_name":"role","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"name","full_name":"role[name]","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"description","full_name":"role[description]","description":"","required":false,"allow_nil":true,"validator":"String","expected_type":"string"}]}],"examples":["POST /api/roles\n{\n  \"role\": {\n    \"name\": \"staff\"\n  }\n}\n200\n{\n  \"role\": {\n    \"name\": \"staff\",\n    \"id\": 11,\n    \"builtin\": 0,\n    \"permissions\": []\n  }\n}"],"see":[]},{"doc_url":"/apidoc/v2/roles/update","name":"update","apis":[{"api_url":"/api/roles/:id","http_method":"PUT","short_description":"Update a role"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"role","full_name":"role","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"name","full_name":"role[name]","description":"","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"description","full_name":"role[description]","description":"","required":false,"allow_nil":true,"validator":"String","expected_type":"string"}]}],"examples":["PUT /api/roles/1\n{\n  \"role\": {}\n}\n200\n{\n  \"role\": {\n    \"name\": \"Manager\",\n    \"id\": 1,\n    \"builtin\": 0,\n    \"permissions\": [\n      \"view_architectures\",\n      \"create_architectures\",\n      \"edit_architectures\",\n      \"destroy_architectures\",\n      \"view_authenticators\",\n      \"create_authenticators\",\n      \"edit_authenticators\",\n      \"destroy_authenticators\",\n      \"view_environments\",\n      \"create_environments\",\n      \"edit_environments\",\n      \"destroy_environments\",\n      \"import_environments\",\n      \"view_external_variables\",\n      \"create_external_variables\",\n      \"edit_external_variables\",\n      \"destroy_external_variables\",\n      \"view_domains\",\n      \"create_domain\",\n      \"edit_domains\",\n      \"destroy_domains\",\n      \"view_globals\",\n      \"create_globals\",\n      \"edit_globals\",\n      \"destroy_globals\",\n      \"view_hostgroups\",\n      \"create_hostgroups\",\n      \"edit_hostgroups\",\n      \"destroy_hostgroups\",\n      \"view_hosts\",\n      \"create_hosts\",\n      \"edit_hosts\",\n      \"destroy_hosts\",\n      \"view_media\",\n      \"create_media\",\n      \"edit_media\",\n      \"destroy_media\",\n      \"view_models\",\n      \"create_models\",\n      \"edit_models\",\n      \"destroy_models\",\n      \"view_operatingsystems\",\n      \"create_operatingsystems\",\n      \"edit_operatingsystems\",\n      \"destroy_operatingsystems\",\n      \"view_ptables\",\n      \"create_ptables\",\n      \"edit_ptables\",\n      \"destroy_ptables\",\n      \"view_puppetclasses\",\n      \"create_puppetclasses\",\n      \"edit_puppetclasses\",\n      \"destroy_puppetclasses\",\n      \"import_puppetclasses\",\n      \"view_usergroups\",\n      \"create_usergroups\",\n      \"edit_usergroups\",\n      \"destroy_usergroups\",\n      \"view_users\",\n      \"create_users\",\n      \"edit_users\",\n      \"destroy_users\",\n      \"access_settings\",\n      \"access_dashboard\",\n      \"view_reports\",\n      \"destroy_reports\",\n      \"view_facts\",\n      \"view_audit_logs\",\n      \"view_statistics\",\n      \"view_locations\",\n      \"edit_locations\",\n      \"create_locations\",\n      \"destroy_locations\",\n      \"view_organizations\",\n      \"edit_organizations\",\n      \"create_organizations\",\n      \"destroy_organizations\"\n    ]\n  }\n}"],"see":[]},{"doc_url":"/apidoc/v2/roles/destroy","name":"destroy","apis":[{"api_url":"/api/roles/:id","http_method":"DELETE","short_description":"Destroy a role"}],"formats":null,"full_description":"","errors":[],"params":[],"examples":["DELETE /api/roles/1\n200\n{\n  \"role\": {\n    \"name\": \"Manager\",\n    \"id\": 1,\n    \"builtin\": 0,\n    \"permissions\": [\n      \"view_architectures\",\n      \"create_architectures\",\n      \"edit_architectures\",\n      \"destroy_architectures\",\n      \"view_authenticators\",\n      \"create_authenticators\",\n      \"edit_authenticators\",\n      \"destroy_authenticators\",\n      \"view_environments\",\n      \"create_environments\",\n      \"edit_environments\",\n      \"destroy_environments\",\n      \"import_environments\",\n      \"view_external_variables\",\n      \"create_external_variables\",\n      \"edit_external_variables\",\n      \"destroy_external_variables\",\n      \"view_domains\",\n      \"create_domain\",\n      \"edit_domains\",\n      \"destroy_domains\",\n      \"view_globals\",\n      \"create_globals\",\n      \"edit_globals\",\n      \"destroy_globals\",\n      \"view_hostgroups\",\n      \"create_hostgroups\",\n      \"edit_hostgroups\",\n      \"destroy_hostgroups\",\n      \"view_hosts\",\n      \"create_hosts\",\n      \"edit_hosts\",\n      \"destroy_hosts\",\n      \"view_media\",\n      \"create_media\",\n      \"edit_media\",\n      \"destroy_media\",\n      \"view_models\",\n      \"create_models\",\n      \"edit_models\",\n      \"destroy_models\",\n      \"view_operatingsystems\",\n      \"create_operatingsystems\",\n      \"edit_operatingsystems\",\n      \"destroy_operatingsystems\",\n      \"view_ptables\",\n      \"create_ptables\",\n      \"edit_ptables\",\n      \"destroy_ptables\",\n      \"view_puppetclasses\",\n      \"create_puppetclasses\",\n      \"edit_puppetclasses\",\n      \"destroy_puppetclasses\",\n      \"import_puppetclasses\",\n      \"view_usergroups\",\n      \"create_usergroups\",\n      \"edit_usergroups\",\n      \"destroy_usergroups\",\n      \"view_users\",\n      \"create_users\",\n      \"edit_users\",\n      \"destroy_users\",\n      \"access_settings\",\n      \"access_dashboard\",\n      \"view_reports\",\n      \"destroy_reports\",\n      \"view_facts\",\n      \"view_audit_logs\",\n      \"view_statistics\",\n      \"view_locations\",\n      \"edit_locations\",\n      \"create_locations\",\n      \"destroy_locations\",\n      \"view_organizations\",\n      \"edit_organizations\",\n      \"create_organizations\",\n      \"destroy_organizations\"\n    ]\n  }\n}"],"see":[]},{"doc_url":"/apidoc/v2/roles/available_verbs","name":"available_verbs","apis":[{"api_url":"/api/roles/available_verbs","http_method":"GET","short_description":"List all available verbs that can be set to roles"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n<p>With this option specified the listed tags are scoped to the organization.</p>\n","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"}],"examples":[],"see":[]}]},"users":{"doc_url":"/apidoc/v2/users","api_url":"/api","name":"Users","short_description":null,"full_description":"","version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/users/index","name":"index","apis":[{"api_url":"/api/users","http_method":"GET","short_description":"List users"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"email","full_name":"email","description":"\n<p>filter by email</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"disabled","full_name":"disabled","description":"\n<p>filter by disabled flag</p>\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string"},{"name":"login","full_name":"login","description":"\n<p>filter by login</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":["GET /api/users\n200\n[\n  {\n    \"user\": {\n      \"domains_andor\": \"or\",\n      \"filter_on_owner\": null,\n      \"role_id\": null,\n      \"mail\": \"admin@someware.com\",\n      \"id\": 135138680,\n      \"hostgroups_andor\": \"or\",\n      \"updated_at\": \"2012-12-18T15:24:42Z\",\n      \"compute_resources_andor\": \"or\",\n      \"admin\": true,\n      \"last_login_on\": \"2009-10-12T21:50:04Z\",\n      \"lastname\": \"User\",\n      \"created_at\": \"2012-12-18T15:24:42Z\",\n      \"login\": \"admin\",\n      \"firstname\": \"Admin\",\n      \"facts_andor\": \"or\",\n      \"auth_source_id\": 980190962\n    }\n  },\n  {\n    \"user\": {\n      \"domains_andor\": \"or\",\n      \"filter_on_owner\": null,\n      \"role_id\": null,\n      \"mail\": \"apiadmin@someware.com\",\n      \"id\": 886836129,\n      \"hostgroups_andor\": \"or\",\n      \"updated_at\": \"2012-12-18T15:24:42Z\",\n      \"compute_resources_andor\": \"or\",\n      \"admin\": true,\n      \"last_login_on\": \"2009-10-12T21:50:04Z\",\n      \"lastname\": \"User\",\n      \"created_at\": \"2012-12-18T15:24:42Z\",\n      \"login\": \"apiadmin\",\n      \"firstname\": \"apiadmin\",\n      \"facts_andor\": \"or\",\n      \"auth_source_id\": 200482051\n    }\n  },\n  {\n    \"user\": {\n      \"domains_andor\": \"or\",\n      \"filter_on_owner\": null,\n      \"role_id\": null,\n      \"mail\": \"userone@someware.com\",\n      \"id\": 980190962,\n      \"hostgroups_andor\": \"or\",\n      \"updated_at\": \"2012-12-18T15:24:42Z\",\n      \"compute_resources_andor\": \"or\",\n      \"admin\": false,\n      \"last_login_on\": \"2009-10-12T21:50:04Z\",\n      \"lastname\": \"User\",\n      \"created_at\": \"2012-12-18T15:24:42Z\",\n      \"login\": \"one\",\n      \"firstname\": \"One\",\n      \"facts_andor\": \"or\",\n      \"auth_source_id\": 980190962\n    }\n  },\n  {\n    \"user\": {\n      \"domains_andor\": \"or\",\n      \"filter_on_owner\": null,\n      \"role_id\": null,\n      \"mail\": \"testuser@someware.com\",\n      \"id\": 200482051,\n      \"hostgroups_andor\": \"or\",\n      \"updated_at\": \"2012-12-18T15:24:42Z\",\n      \"compute_resources_andor\": \"or\",\n      \"admin\": false,\n      \"last_login_on\": \"2009-10-12T21:50:04Z\",\n      \"lastname\": \"User\",\n      \"created_at\": \"2012-12-18T15:24:42Z\",\n      \"login\": \"test\",\n      \"firstname\": \"test\",\n      \"facts_andor\": \"or\",\n      \"auth_source_id\": 200482051\n    }\n  },\n  {\n    \"user\": {\n      \"domains_andor\": \"or\",\n      \"filter_on_owner\": null,\n      \"role_id\": null,\n      \"mail\": \"usertwo@someware.com\",\n      \"id\": 298486374,\n      \"hostgroups_andor\": \"or\",\n      \"updated_at\": \"2012-12-18T15:24:42Z\",\n      \"compute_resources_andor\": \"or\",\n      \"admin\": false,\n      \"last_login_on\": \"2009-10-12T21:50:04Z\",\n      \"lastname\": \"User\",\n      \"created_at\": \"2012-12-18T15:24:42Z\",\n      \"login\": \"two\",\n      \"firstname\": \"Two\",\n      \"facts_andor\": \"or\",\n      \"auth_source_id\": 980190962\n    }\n  }\n]"],"see":[]},{"doc_url":"/apidoc/v2/users/show","name":"show","apis":[{"api_url":"/api/users/:id","http_method":"GET","short_description":"Show a user"}],"formats":null,"full_description":"","errors":[],"params":[],"examples":["GET /api/users/980190962-one\n200\n{\n  \"user\": {\n    \"domains_andor\": \"or\",\n    \"filter_on_owner\": null,\n    \"roles\": [\n      {\n        \"role\": {\n          \"name\": \"Viewer\",\n          \"id\": 5,\n          \"builtin\": 0,\n          \"permissions\": [\n            \"view_architectures\",\n            \"view_audit_logs\",\n            \"view_authenticators\",\n            \"access_dashboard\",\n            \"view_domains\",\n            \"view_environments\",\n            \"view_external_variables\",\n            \"view_facts\",\n            \"view_globals\",\n            \"view_hostgroups\",\n            \"view_hosts\",\n            \"view_locations\",\n            \"view_media\",\n            \"view_models\",\n            \"view_operatingsystems\",\n            \"view_ptables\",\n            \"view_puppetclasses\",\n            \"view_reports\",\n            \"access_settings\",\n            \"view_statistics\",\n            \"view_organizations\",\n            \"view_usergroups\",\n            \"view_users\"\n          ]\n        }\n      },\n      {\n        \"role\": {\n          \"name\": \"Anonymous\",\n          \"id\": 7,\n          \"builtin\": 2,\n          \"permissions\": [\n            \"view_hosts\"\n          ]\n        }\n      }\n    ],\n    \"role_id\": null,\n    \"auth_source_ldap\": {\n      \"name\": \"ldap\",\n      \"tls\": true,\n      \"attr_login\": \"uid\",\n      \"attr_firstname\": \"givenName\",\n      \"port\": 123,\n      \"attr_lastname\": \"sn\",\n      \"id\": 980190962,\n      \"updated_at\": \"2012-12-18T15:24:43Z\",\n      \"attr_mail\": \"mail\",\n      \"base_dn\": \"dn=x,dn=y\",\n      \"host\": \"ldap\",\n      \"account\": null,\n      \"type\": \"AuthSourceLdap\",\n      \"onthefly_register\": true,\n      \"created_at\": \"2012-12-18T15:24:43Z\"\n    },\n    \"mail\": \"userone@someware.com\",\n    \"id\": 980190962,\n    \"hostgroups_andor\": \"or\",\n    \"updated_at\": \"2012-12-18T15:24:42Z\",\n    \"compute_resources_andor\": \"or\",\n    \"admin\": false,\n    \"last_login_on\": \"2009-10-12T21:50:04Z\",\n    \"lastname\": \"User\",\n    \"created_at\": \"2012-12-18T15:24:42Z\",\n    \"login\": \"one\",\n    \"firstname\": \"One\",\n    \"facts_andor\": \"or\",\n    \"auth_source_id\": 980190962\n  }\n}"],"see":[]},{"doc_url":"/apidoc/v2/users/create","name":"create","apis":[{"api_url":"/api/users","http_method":"POST","short_description":"Create an user"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"user","full_name":"user","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"email","full_name":"user[email]","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"password","full_name":"user[password]","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"default_environment_id","full_name":"user[default_environment_id]","description":"","required":false,"allow_nil":true,"validator":"Integer","expected_type":"numeric"},{"name":"disabled","full_name":"user[disabled]","description":"","required":false,"allow_nil":true,"validator":"boolean","expected_type":"string"},{"name":"login","full_name":"user[login]","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string"}]}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/users/update","name":"update","apis":[{"api_url":"/api/users/:id","http_method":"PUT","short_description":"Update an user"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"user","full_name":"user","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"email","full_name":"user[email]","description":"","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"password","full_name":"user[password]","description":"","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"default_environment_id","full_name":"user[default_environment_id]","description":"","required":false,"allow_nil":true,"validator":"Integer","expected_type":"numeric"},{"name":"disabled","full_name":"user[disabled]","description":"","required":false,"allow_nil":true,"validator":"boolean","expected_type":"string"}]}],"examples":["PUT /api/users/980190963\n{\n  \"user\": {\n    \"password_confirmation\": \"DUMMY\",\n    \"password\": \"dummy\",\n    \"login\": \"johnsmith\"\n  }\n}\n422\n{\n  \"user\": {\n    \"id\": 980190963,\n    \"errors\": {\n      \"password\": [\n        \"doesn't match confirmation\"\n      ]\n    },\n    \"full_messages\": [\n      \"Password doesn't match confirmation\"\n    ]\n  }\n}"],"see":[]},{"doc_url":"/apidoc/v2/users/destroy","name":"destroy","apis":[{"api_url":"/api/users/:id","http_method":"DELETE","short_description":"Destroy an user"}],"formats":null,"full_description":"","errors":[],"params":[],"examples":["DELETE /api/users/980190962\n200\n{\n  \"user\": {\n    \"filter_on_owner\": null,\n    \"domains_andor\": \"or\",\n    \"role_id\": null,\n    \"organizations_andor\": \"or\",\n    \"mail\": \"userone@someware.com\",\n    \"id\": 980190962,\n    \"updated_at\": \"2012-12-18T15:24:42Z\",\n    \"hostgroups_andor\": \"or\",\n    \"compute_resources_andor\": \"or\",\n    \"admin\": false,\n    \"password_hash\": null,\n    \"last_login_on\": \"2009-10-12T21:50:04Z\",\n    \"locations_andor\": \"or\",\n    \"lastname\": \"User\",\n    \"password_salt\": null,\n    \"login\": \"one\",\n    \"created_at\": \"2012-12-18T15:24:42Z\",\n    \"firstname\": \"One\",\n    \"facts_andor\": \"or\",\n    \"auth_source_id\": 980190962\n  }\n}"],"see":[]},{"doc_url":"/apidoc/v2/users/list_roles","name":"list_roles","apis":[{"api_url":"/api/users/:user_id/roles","http_method":"GET","short_description":"List roles assigned to a user"}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/users/sync_ldap_roles","name":"sync_ldap_roles","apis":[{"api_url":"/api/users/sync_ldap_roles","http_method":"GET","short_description":"Synchronises roles for all users with LDAP groups"}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/users/add_role","name":"add_role","apis":[{"api_url":"/api/users/:user_id/roles","http_method":"POST","short_description":"Assign a role to a user"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"role_id","full_name":"role_id","description":"","required":false,"allow_nil":false,"validator":"Integer","expected_type":"numeric"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/users/remove_role","name":"remove_role","apis":[{"api_url":"/api/users/:user_id/roles/:id","http_method":"DELETE","short_description":"Remove user's role"}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"see":[]}]},"uebercerts":{"doc_url":"/apidoc/v2/uebercerts","api_url":"/api","name":"Uebercerts","short_description":null,"full_description":null,"version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/uebercerts/show","name":"show","apis":[{"api_url":"/api/organizations/:organization_id/uebercert","http_method":"GET","short_description":"Show an ueber certificate for an organization"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"regenerate","full_name":"regenerate","description":"\n<p>When set to ‘True’ certificate will be re-issued</p>\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string"}],"examples":[],"see":[]}]},"errata":{"doc_url":"/apidoc/v2/errata","api_url":"/api","name":"Errata","short_description":null,"full_description":"","version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/errata/index","name":"index","apis":[{"api_url":"/api/repositories/:repository_id/errata","http_method":"GET","short_description":"List errata"},{"api_url":"/api/environments/:environment_id/errata","http_method":"GET","short_description":"List errata"}],"formats":null,"full_description":"","errors":[{"code":401,"description":"Unauthorized"},{"code":404,"description":"Not found"}],"params":[{"name":"environment_id","full_name":"environment_id","description":"\n<p>The environment containing the errata.</p>\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"product_id","full_name":"product_id","description":"\n<p>The product which contains errata.</p>\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"repository_id","full_name":"repository_id","description":"\n<p>The repository which contains errata.</p>\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"severity","full_name":"severity","description":"\n<p>Severity of errata. Usually one of: Critical, Important, Moderate, Low. Case insensitive.</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"type","full_name":"type","description":"\n<p>Type of errata. Usually one of: security, bugfix, enhancement. Case insensitive.</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/errata/show","name":"show","apis":[{"api_url":"/api/repositories/:repository_id/errata/:id","http_method":"GET","short_description":"Show an erratum"},{"api_url":"/api/errata/:id","http_method":"GET","short_description":"Show an erratum"}],"formats":null,"full_description":"","errors":[{"code":401,"description":"Unauthorized"},{"code":404,"description":"Not found"}],"params":[],"examples":[],"see":[]}]},"system_errata":{"doc_url":"/apidoc/v2/system_errata","api_url":"/api","name":"System errata","short_description":null,"full_description":null,"version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/system_errata/apply","name":"apply","apis":[{"api_url":"/api/systems/:system_id/errata","http_method":"PUT","short_description":"Schedule errata for installation"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"errata_ids","full_name":"errata_ids","description":"\n<p>List of Errata ids to install</p>\n","required":false,"allow_nil":false,"validator":"Array","expected_type":"array"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/system_errata/show","name":"show","apis":[{"api_url":"/api/systems/:system_id/errata/:id","http_method":"GET","short_description":"Retrieve a single errata for a system"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Errata id of the erratum (RHSA-2012:108)</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]}]},"system_group_errata":{"doc_url":"/apidoc/v2/system_group_errata","api_url":"/api","name":"System group errata","short_description":null,"full_description":"\n<p>methods for handling erratas on system group level</p>\n","version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/system_group_errata/index","name":"index","apis":[{"api_url":"/api/organizations/:organization_id/system_groups/:system_group_id/errata","http_method":"GET","short_description":"Get list of errata associated with the group"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n<p>oranization identifier</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"system_group_id","full_name":"system_group_id","description":"\n<p>system_group identifier</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"type","full_name":"type","description":"\n<p>Filter errata by type</p>\n","required":false,"allow_nil":false,"validator":"Must be one of: bugfix, enhancement, security.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/system_group_errata/create","name":"create","apis":[{"api_url":"/api/organizations/:organization_id/system_groups/:system_group_id/errata","http_method":"POST","short_description":"Install errata remotely"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n<p>oranization identifier</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"system_group_id","full_name":"system_group_id","description":"\n<p>system_group identifier</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"errata_ids","full_name":"errata_ids","description":"\n<p>List of errata ids to install</p>\n","required":true,"allow_nil":false,"validator":"Array","expected_type":"array"}],"examples":[],"see":[]}]},"systems":{"doc_url":"/apidoc/v2/systems","api_url":"/api","name":"Systems","short_description":null,"full_description":null,"version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/systems/index","name":"index","apis":[{"api_url":"/api/systems","http_method":"GET","short_description":"List systems"},{"api_url":"/api/organizations/:organization_id/systems","http_method":"GET","short_description":"List systems in an organization"},{"api_url":"/api/environments/:environment_id/systems","http_method":"GET","short_description":"List systems in environment"},{"api_url":"/api/system_groups/:system_group_id/systems","http_method":"GET","short_description":"List systems in a system group"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>Filter systems by name</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"pool_id","full_name":"pool_id","description":"\n<p>Filter systems by subscribed pool</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"uuid","full_name":"uuid","description":"\n<p>Filter systems by uuid</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"organization_id","full_name":"organization_id","description":"\n<p>Specify the organization</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"environment_id","full_name":"environment_id","description":"\n<p>Filter by environment</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"system_group_id","full_name":"system_group_id","description":"\n<p>Filter by system group</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"search","full_name":"search","description":"\n<p>Search string</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"page","full_name":"page","description":"\n<p>Page number, starting at 1</p>\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"per_page","full_name":"per_page","description":"\n<p>Number of results per page to return</p>\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"order","full_name":"order","description":"\n<p>Sort field and order, eg. ‘name DESC’</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"sort","full_name":"sort","description":"\n<p>Hash version of ‘order’ param</p>\n","required":false,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"by","full_name":"sort[by]","description":"\n<p>Field to sort the results on</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"order","full_name":"sort[order]","description":"\n<p>How to order the sorted results (e.g. ASC for ascending)</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"}]}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/systems/create","name":"create","apis":[{"api_url":"/api/systems","http_method":"POST","short_description":"Register a system"},{"api_url":"/api/environments/:environment_id/systems","http_method":"POST","short_description":"Register a system in environment"},{"api_url":"/api/system_groups/:system_group_id/systems","http_method":"POST","short_description":"Register a system in environment"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>Name of the system</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"description","full_name":"description","description":"\n<p>Description of the system</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"location","full_name":"location","description":"\n<p>Physical location of the system</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"facts","full_name":"facts","description":"\n<p>Key-value hash of system-specific facts</p>\n","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"fact","full_name":"facts[fact]","description":"\n<p>Any number of facts about this system</p>\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string"}]},{"name":"type","full_name":"type","description":"\n<p>Type of the system, it should always be ‘system’</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"guest_ids","full_name":"guest_ids","description":"\n<p>IDs of the guests running on this system</p>\n","required":false,"allow_nil":false,"validator":"Array","expected_type":"array"},{"name":"installed_products","full_name":"installed_products","description":"\n<p>List of products installed on the system</p>\n","required":false,"allow_nil":true,"validator":"Array","expected_type":"array"},{"name":"release_ver","full_name":"release_ver","description":"\n<p>Release version of the system</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"service_level","full_name":"service_level","description":"\n<p>A service level for auto-healing process, e.g. SELF-SUPPORT</p>\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string"},{"name":"last_checkin","full_name":"last_checkin","description":"\n<p>Last check-in time of this system</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"organization_id","full_name":"organization_id","description":"\n<p>Specify the organization</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"environment_id","full_name":"environment_id","description":"\n<p>Specify the environment</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"content_view_id","full_name":"content_view_id","description":"\n<p>Specify the content view</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"system_group_id","full_name":"system_group_id","description":"\n<p>Specify the system group</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/systems/update","name":"update","apis":[{"api_url":"/api/systems/:id","http_method":"PUT","short_description":"Update system information"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>Name of the system</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"description","full_name":"description","description":"\n<p>Description of the system</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"location","full_name":"location","description":"\n<p>Physical location of the system</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"facts","full_name":"facts","description":"\n<p>Key-value hash of system-specific facts</p>\n","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"fact","full_name":"facts[fact]","description":"\n<p>Any number of facts about this system</p>\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string"}]},{"name":"type","full_name":"type","description":"\n<p>Type of the system, it should always be ‘system’</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"guest_ids","full_name":"guest_ids","description":"\n<p>IDs of the guests running on this system</p>\n","required":false,"allow_nil":false,"validator":"Array","expected_type":"array"},{"name":"installed_products","full_name":"installed_products","description":"\n<p>List of products installed on the system</p>\n","required":false,"allow_nil":true,"validator":"Array","expected_type":"array"},{"name":"release_ver","full_name":"release_ver","description":"\n<p>Release version of the system</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"service_level","full_name":"service_level","description":"\n<p>A service level for auto-healing process, e.g. SELF-SUPPORT</p>\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string"},{"name":"last_checkin","full_name":"last_checkin","description":"\n<p>Last check-in time of this system</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"environment_id","full_name":"environment_id","description":"\n<p>Specify the environment</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"content_view_id","full_name":"content_view_id","description":"\n<p>Specify the content view</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/systems/show","name":"show","apis":[{"api_url":"/api/systems/:id","http_method":"GET","short_description":"Show a system"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>UUID of the system</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/systems/available_system_groups","name":"available_system_groups","apis":[{"api_url":"/api/systems/:id/available_system_groups","http_method":"GET","short_description":"List system groups the system does not belong to"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"\n<p>Search string</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"page","full_name":"page","description":"\n<p>Page number, starting at 1</p>\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"per_page","full_name":"per_page","description":"\n<p>Number of results per page to return</p>\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"order","full_name":"order","description":"\n<p>Sort field and order, eg. ‘name DESC’</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"sort","full_name":"sort","description":"\n<p>Hash version of ‘order’ param</p>\n","required":false,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"by","full_name":"sort[by]","description":"\n<p>Field to sort the results on</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"order","full_name":"sort[order]","description":"\n<p>How to order the sorted results (e.g. ASC for ascending)</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"}]},{"name":"name","full_name":"name","description":"\n<p>system group name to filter by</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/systems/destroy","name":"destroy","apis":[{"api_url":"/api/systems/:id","http_method":"DELETE","short_description":"Unregister a system"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>UUID of the system</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/systems/add_system_groups","name":"add_system_groups","apis":[{"api_url":"/api/systems/:id/system_groups","http_method":"POST","short_description":"Replace existing list of system groups"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>UUID of the system</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"system_group_ids","full_name":"system_group_ids","description":"\n<p>List of group ids the system belongs to</p>\n","required":true,"allow_nil":false,"validator":"Array","expected_type":"array"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/systems/remove_system_groups","name":"remove_system_groups","apis":[{"api_url":"/api/systems/:id/system_groups","http_method":"DELETE","short_description":"Remove the list of given system groups"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>UUID of the system</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"system_group_ids","full_name":"system_group_ids","description":"\n<p>List of system groups ids to remove from the system</p>\n","required":true,"allow_nil":false,"validator":"Array","expected_type":"array"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/systems/package_profile","name":"package_profile","apis":[{"api_url":"/api/systems/:id/packages","http_method":"GET","short_description":"List packages installed on the system"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>UUID of the system</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/systems/refresh_subscriptions","name":"refresh_subscriptions","apis":[{"api_url":"/api/systems/:id/refresh_subscriptions","http_method":"PUT","short_description":"Trigger a refresh of subscriptions, auto-attaching if enabled"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>UUID of the system</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/systems/errata","name":"errata","apis":[{"api_url":"/api/systems/:id/errata","http_method":"GET","short_description":"List errata available for the system"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>UUID of the system</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/systems/tasks","name":"tasks","apis":[{"api_url":"/api/systems/:id/tasks","http_method":"GET","short_description":"List async tasks for the system"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>UUID of the system</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/systems/report","name":"report","apis":[{"api_url":"/api/environments/:environment_id/systems/report","http_method":"GET","short_description":"Get system reports for the environment"},{"api_url":"/api/organizations/:organization_id/systems/report","http_method":"GET","short_description":"Get system reports for the organization"}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/systems/pools","name":"pools","apis":[{"api_url":"/api/systems/:id/pools","http_method":"GET","short_description":"List pools a system is subscribed to"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>UUID of the system</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"match_system","full_name":"match_system","description":"\n<p>Match pools to system</p>\n","required":false,"allow_nil":false,"validator":"Must be one of: true, false.","expected_type":"string"},{"name":"match_installed","full_name":"match_installed","description":"\n<p>Match pools to installed</p>\n","required":false,"allow_nil":false,"validator":"Must be one of: true, false.","expected_type":"string"},{"name":"no_overlap","full_name":"no_overlap","description":"\n<p>allow overlap</p>\n","required":false,"allow_nil":false,"validator":"Must be one of: true, false.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/systems/releases","name":"releases","apis":[{"api_url":"/api/systems/:id/releases","http_method":"GET","short_description":"Show releases available for the system"}],"formats":null,"full_description":"\n<p>A hint for choosing the right value for the releaseVer param</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>UUID of the system</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/systems/activate","name":"activate","apis":[{"api_url":"/api/organizations/:organization_id/systems","http_method":"POST","short_description":"Register a system with activation key"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>Name of the system</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"description","full_name":"description","description":"\n<p>Description of the system</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"location","full_name":"location","description":"\n<p>Physical location of the system</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"facts","full_name":"facts","description":"\n<p>Key-value hash of system-specific facts</p>\n","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"fact","full_name":"facts[fact]","description":"\n<p>Any number of facts about this system</p>\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string"}]},{"name":"type","full_name":"type","description":"\n<p>Type of the system, it should always be ‘system’</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"guest_ids","full_name":"guest_ids","description":"\n<p>IDs of the guests running on this system</p>\n","required":false,"allow_nil":false,"validator":"Array","expected_type":"array"},{"name":"installed_products","full_name":"installed_products","description":"\n<p>List of products installed on the system</p>\n","required":false,"allow_nil":true,"validator":"Array","expected_type":"array"},{"name":"release_ver","full_name":"release_ver","description":"\n<p>Release version of the system</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"service_level","full_name":"service_level","description":"\n<p>A service level for auto-healing process, e.g. SELF-SUPPORT</p>\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string"},{"name":"last_checkin","full_name":"last_checkin","description":"\n<p>Last check-in time of this system</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"organization_id","full_name":"organization_id","description":"\n<p>Specify the organization</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"environment_id","full_name":"environment_id","description":"\n<p>Specify the environment</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"content_view_id","full_name":"content_view_id","description":"\n<p>Specify the content view</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"system_group_id","full_name":"system_group_id","description":"\n<p>Specify the system group</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"activation_keys","full_name":"activation_keys","description":"\n<p>comma-separated list of activation-key IDs</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/systems/enabled_repos","name":"enabled_repos","apis":[{"api_url":"/api/systems/:id/enabled_repos","http_method":"PUT","short_description":"Update the information about enabled repositories"}],"formats":null,"full_description":"\n<p>Used by katello-agent to keep the information about enabled repositories up to date. This information is then used for computing the errata available for the system.</p>\n","errors":[],"params":[{"name":"enabled_repos","full_name":"enabled_repos","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"repos","full_name":"enabled_repos[repos]","description":"","required":true,"allow_nil":false,"validator":"Array","expected_type":"array"}]},{"name":"id","full_name":"id","description":"\n<p>UUID of the system</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]}]},"sync":{"doc_url":"/apidoc/v2/sync","api_url":"/api","name":"Sync","short_description":null,"full_description":"","version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/sync/index","name":"index","apis":[{"api_url":"/api/providers/:provider_id/sync","http_method":"GET","short_description":"Get status of repo synchronisation for given provider"},{"api_url":"/api/products/:product_id/sync","http_method":"GET","short_description":"Get status of repo synchronisation for given product"},{"api_url":"/api/repositories/:repository_id/sync","http_method":"GET","short_description":"Get status of synchronisation for given repository"}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/sync/create","name":"create","apis":[{"api_url":"/api/providers/:provider_id/sync","http_method":"POST","short_description":"Synchronize all provider's repositories"},{"api_url":"/api/products/:product_id/sync","http_method":"POST","short_description":"Synchronise all repositories for given product"},{"api_url":"/api/repositories/:repository_id/sync","http_method":"POST","short_description":"Synchronise repository"}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/sync/cancel","name":"cancel","apis":[{"api_url":"/api/providers/:provider_id/sync","http_method":"DELETE","short_description":"Cancel running synchronisation for given provider"},{"api_url":"/api/products/:product_id/sync","http_method":"DELETE","short_description":"Cancel running synchronisations for given product"},{"api_url":"/api/repositories/:repository_id/sync","http_method":"DELETE","short_description":"Cancel running synchronisation"}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"see":[]}]},"systems_bulk_actions":{"doc_url":"/apidoc/v2/systems_bulk_actions","api_url":"/api","name":"Systems bulk actions","short_description":null,"full_description":null,"version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/systems_bulk_actions/bulk_add_system_groups","name":"bulk_add_system_groups","apis":[{"api_url":"/api/systems/bulk/add_system_groups","http_method":"PUT","short_description":"Add one or more system groups to one or more systems"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"include","full_name":"include","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"search","full_name":"include[search]","description":"\n<p>Search string for systems to perform an action on</p>\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string"},{"name":"ids","full_name":"include[ids]","description":"\n<p>List of system ids to perform an action on</p>\n","required":false,"allow_nil":true,"validator":"Array","expected_type":"array"}]},{"name":"exclude","full_name":"exclude","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"ids","full_name":"exclude[ids]","description":"\n<p>List of system ids to exclude and not run an action on</p>\n","required":false,"allow_nil":true,"validator":"Array","expected_type":"array"}]},{"name":"system_group_ids","full_name":"system_group_ids","description":"\n<p>List of system group ids</p>\n","required":true,"allow_nil":false,"validator":"Array","expected_type":"array"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/systems_bulk_actions/bulk_remove_system_groups","name":"bulk_remove_system_groups","apis":[{"api_url":"/api/systems/bulk/remove_system_groups","http_method":"PUT","short_description":"Remove one or more system groups to one or more systems"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"include","full_name":"include","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"search","full_name":"include[search]","description":"\n<p>Search string for systems to perform an action on</p>\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string"},{"name":"ids","full_name":"include[ids]","description":"\n<p>List of system ids to perform an action on</p>\n","required":false,"allow_nil":true,"validator":"Array","expected_type":"array"}]},{"name":"exclude","full_name":"exclude","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"ids","full_name":"exclude[ids]","description":"\n<p>List of system ids to exclude and not run an action on</p>\n","required":false,"allow_nil":true,"validator":"Array","expected_type":"array"}]},{"name":"system_group_ids","full_name":"system_group_ids","description":"\n<p>List of system group ids</p>\n","required":true,"allow_nil":false,"validator":"Array","expected_type":"array"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/systems_bulk_actions/applicable_errata","name":"applicable_errata","apis":[{"api_url":"/api/systems/bulk/applicable_errata","http_method":"POST","short_description":"Fetch applicable errata for a system."}],"formats":null,"full_description":"","errors":[],"params":[{"name":"include","full_name":"include","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"search","full_name":"include[search]","description":"\n<p>Search string for systems to perform an action on</p>\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string"},{"name":"ids","full_name":"include[ids]","description":"\n<p>List of system ids to perform an action on</p>\n","required":false,"allow_nil":true,"validator":"Array","expected_type":"array"}]},{"name":"exclude","full_name":"exclude","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"ids","full_name":"exclude[ids]","description":"\n<p>List of system ids to exclude and not run an action on</p>\n","required":false,"allow_nil":true,"validator":"Array","expected_type":"array"}]}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/systems_bulk_actions/install_content","name":"install_content","apis":[{"api_url":"/api/systems/bulk/install_content","http_method":"PUT","short_description":"Install content on one or more systems"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"include","full_name":"include","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"search","full_name":"include[search]","description":"\n<p>Search string for systems to perform an action on</p>\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string"},{"name":"ids","full_name":"include[ids]","description":"\n<p>List of system ids to perform an action on</p>\n","required":false,"allow_nil":true,"validator":"Array","expected_type":"array"}]},{"name":"exclude","full_name":"exclude","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"ids","full_name":"exclude[ids]","description":"\n<p>List of system ids to exclude and not run an action on</p>\n","required":false,"allow_nil":true,"validator":"Array","expected_type":"array"}]},{"name":"content_type","full_name":"content_type","description":"\n<p>The type of content. The following types are supported: ‘package’, ‘package_group’ and ‘errata’.</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"content","full_name":"content","description":"\n<p>List of content (e.g. package names, package group names or errata ids)</p>\n","required":true,"allow_nil":false,"validator":"Array","expected_type":"array"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/systems_bulk_actions/update_content","name":"update_content","apis":[{"api_url":"/api/systems/bulk/update_content","http_method":"PUT","short_description":"Update content on one or more systems"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"include","full_name":"include","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"search","full_name":"include[search]","description":"\n<p>Search string for systems to perform an action on</p>\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string"},{"name":"ids","full_name":"include[ids]","description":"\n<p>List of system ids to perform an action on</p>\n","required":false,"allow_nil":true,"validator":"Array","expected_type":"array"}]},{"name":"exclude","full_name":"exclude","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"ids","full_name":"exclude[ids]","description":"\n<p>List of system ids to exclude and not run an action on</p>\n","required":false,"allow_nil":true,"validator":"Array","expected_type":"array"}]},{"name":"content_type","full_name":"content_type","description":"\n<p>The type of content. The following types are supported: ‘package’ and ‘package_group.</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"content","full_name":"content","description":"\n<p>List of content (e.g. package or package group names)</p>\n","required":true,"allow_nil":false,"validator":"Array","expected_type":"array"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/systems_bulk_actions/remove_content","name":"remove_content","apis":[{"api_url":"/api/systems/bulk/remove_content","http_method":"PUT","short_description":"Remove content on one or more systems"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"include","full_name":"include","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"search","full_name":"include[search]","description":"\n<p>Search string for systems to perform an action on</p>\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string"},{"name":"ids","full_name":"include[ids]","description":"\n<p>List of system ids to perform an action on</p>\n","required":false,"allow_nil":true,"validator":"Array","expected_type":"array"}]},{"name":"exclude","full_name":"exclude","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"ids","full_name":"exclude[ids]","description":"\n<p>List of system ids to exclude and not run an action on</p>\n","required":false,"allow_nil":true,"validator":"Array","expected_type":"array"}]},{"name":"content_type","full_name":"content_type","description":"\n<p>The type of content. The following types are supported: ‘package’ and ‘package_group.</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"content","full_name":"content","description":"\n<p>List of content (e.g. package or package group names)</p>\n","required":true,"allow_nil":false,"validator":"Array","expected_type":"array"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/systems_bulk_actions/destroy_systems","name":"destroy_systems","apis":[{"api_url":"/api/systems/bulk/destroy","http_method":"PUT","short_description":"Destroy one or more systems"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"include","full_name":"include","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"search","full_name":"include[search]","description":"\n<p>Search string for systems to perform an action on</p>\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string"},{"name":"ids","full_name":"include[ids]","description":"\n<p>List of system ids to perform an action on</p>\n","required":false,"allow_nil":true,"validator":"Array","expected_type":"array"}]},{"name":"exclude","full_name":"exclude","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"ids","full_name":"exclude[ids]","description":"\n<p>List of system ids to exclude and not run an action on</p>\n","required":false,"allow_nil":true,"validator":"Array","expected_type":"array"}]}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/systems_bulk_actions/environment_content_view","name":"environment_content_view","apis":[{"api_url":"/api/systems/bulk/environment_content_view","http_method":"PUT","short_description":"Assign the environment and content view to one or more systems"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"include","full_name":"include","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"search","full_name":"include[search]","description":"\n<p>Search string for systems to perform an action on</p>\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string"},{"name":"ids","full_name":"include[ids]","description":"\n<p>List of system ids to perform an action on</p>\n","required":false,"allow_nil":true,"validator":"Array","expected_type":"array"}]},{"name":"exclude","full_name":"exclude","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"ids","full_name":"exclude[ids]","description":"\n<p>List of system ids to exclude and not run an action on</p>\n","required":false,"allow_nil":true,"validator":"Array","expected_type":"array"}]},{"name":"environment_id","full_name":"environment_id","description":"","required":false,"allow_nil":false,"validator":"Integer","expected_type":"numeric"},{"name":"content_view_id","full_name":"content_view_id","description":"","required":false,"allow_nil":false,"validator":"Integer","expected_type":"numeric"}],"examples":[],"see":[]}]},"changesets_content":{"doc_url":"/apidoc/v2/changesets_content","api_url":"/api","name":"Changesets content","short_description":null,"full_description":null,"version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/changesets_content/add_content_view","name":"add_content_view","apis":[{"api_url":"/api/changesets/:changeset_id/content_views","http_method":"POST","short_description":"Add a content view to a changeset"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"changeset_id","full_name":"changeset_id","description":"\n<p>id of the product to remove</p>\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"content_view","full_name":"content_view","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"id","full_name":"content_view[id]","description":"\n<p>id of the content view to add</p>\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string"}]}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/changesets_content/remove_content_view","name":"remove_content_view","apis":[{"api_url":"/api/changesets/:changeset_id/content_views/:content_view_id","http_method":"DELETE","short_description":"Remove a content_view from a changeset"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"changeset_id","full_name":"changeset_id","description":"","required":false,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"content_view_id","full_name":"content_view_id","description":"\n<p>id of the content view to remove</p>\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string"}],"examples":[],"see":[]}]},"system_groups":{"doc_url":"/apidoc/v2/system_groups","api_url":"/api","name":"System groups","short_description":null,"full_description":null,"version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/system_groups/show","name":"show","apis":[{"api_url":"/api/system_groups/:id","http_method":"GET","short_description":"Show a system group"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Id of the system group</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/system_groups/index","name":"index","apis":[{"api_url":"/api/system_groups","http_method":"GET","short_description":"List system groups"},{"api_url":"/api/organizations/:organization_id/system_groups","http_method":"GET","short_description":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"\n<p>Search string</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"page","full_name":"page","description":"\n<p>Page number, starting at 1</p>\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"per_page","full_name":"per_page","description":"\n<p>Number of results per page to return</p>\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"order","full_name":"order","description":"\n<p>Sort field and order, eg. ‘name DESC’</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"sort","full_name":"sort","description":"\n<p>Hash version of ‘order’ param</p>\n","required":false,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"by","full_name":"sort[by]","description":"\n<p>Field to sort the results on</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"order","full_name":"sort[order]","description":"\n<p>How to order the sorted results (e.g. ASC for ascending)</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"}]},{"name":"organization_id","full_name":"organization_id","description":"\n<p>organization identifier</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"name","full_name":"name","description":"\n<p>system group name to filter by</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/system_groups/create","name":"create","apis":[{"api_url":"/api/system_groups","http_method":"POST","short_description":"Create a system group"},{"api_url":"/api/organizations/:organization_id/system_groups","http_method":"POST","short_description":"Create a system group"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n<p>organization identifier</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"name","full_name":"name","description":"\n<p>System group name</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"system_ids","full_name":"system_ids","description":"\n<p>List of system uuids to be in the group</p>\n","required":false,"allow_nil":false,"validator":"Array","expected_type":"array"},{"name":"description","full_name":"description","description":"","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"max_systems","full_name":"max_systems","description":"\n<p>Maximum number of systems in the group</p>\n","required":false,"allow_nil":false,"validator":"Integer","expected_type":"numeric"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/system_groups/update","name":"update","apis":[{"api_url":"/api/system_groups/:id","http_method":"PUT","short_description":"Update a system group"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Id of the system group</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"name","full_name":"name","description":"\n<p>System group name</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"system_ids","full_name":"system_ids","description":"\n<p>List of system uuids to be in the group</p>\n","required":false,"allow_nil":false,"validator":"Array","expected_type":"array"},{"name":"description","full_name":"description","description":"","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"max_systems","full_name":"max_systems","description":"\n<p>Maximum number of systems in the group</p>\n","required":false,"allow_nil":false,"validator":"Integer","expected_type":"numeric"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/system_groups/systems","name":"systems","apis":[{"api_url":"/api/system_groups/:id/systems","http_method":"GET","short_description":"List systems in the group"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Id of the system group</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/system_groups/add_systems","name":"add_systems","apis":[{"api_url":"/api/system_groups/:id/add_systems","http_method":"PUT","short_description":"Add systems to the group"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Id of the system group</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"system_ids","full_name":"system_ids","description":"\n<p>Array of system ids</p>\n","required":false,"allow_nil":false,"validator":"Array","expected_type":"array"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/system_groups/remove_systems","name":"remove_systems","apis":[{"api_url":"/api/system_groups/:id/remove_systems","http_method":"PUT","short_description":"Remove systems from the group"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Id of the system group</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"system_ids","full_name":"system_ids","description":"\n<p>Array of system ids</p>\n","required":false,"allow_nil":false,"validator":"Array","expected_type":"array"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/system_groups/history","name":"history","apis":[{"api_url":"/api/system_groups/:id/history","http_method":"GET","short_description":"History of jobs performed on a system group"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Id of the system group</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/system_groups/history_show","name":"history_show","apis":[{"api_url":"/api/system_groups/:id/history","http_method":"GET","short_description":"History of a job performed on a system group"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Id of the system group</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"job_id","full_name":"job_id","description":"\n<p>Id of a job for filtering</p>\n","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/system_groups/copy","name":"copy","apis":[{"api_url":"/api/system_groups/:id/copy","http_method":"POST","short_description":"Make copy of a system group"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>ID of the system group</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"name","full_name":"name","description":"\n<p>New system group name</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/system_groups/destroy","name":"destroy","apis":[{"api_url":"/api/system_groups/:id","http_method":"DELETE","short_description":"Destroy a system group"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Id of the system group</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/system_groups/destroy_systems","name":"destroy_systems","apis":[{"api_url":"/api/system_groups/:id/destroy_systems","http_method":"DELETE","short_description":"Destroy a system group nad contained systems"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Id of the system group</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"}],"examples":[],"see":[]}]},"gpg_keys":{"doc_url":"/apidoc/v2/gpg_keys","api_url":"/api","name":"Gpg keys","short_description":null,"full_description":null,"version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/gpg_keys/index","name":"index","apis":[{"api_url":"/api/gpg_keys","http_method":"GET","short_description":"List gpg keys"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n<p>organization identifier</p>\n","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"search","full_name":"search","description":"\n<p>Search string</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"page","full_name":"page","description":"\n<p>Page number, starting at 1</p>\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"per_page","full_name":"per_page","description":"\n<p>Number of results per page to return</p>\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"order","full_name":"order","description":"\n<p>Sort field and order, eg. ‘name DESC’</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"sort","full_name":"sort","description":"\n<p>Hash version of ‘order’ param</p>\n","required":false,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"by","full_name":"sort[by]","description":"\n<p>Field to sort the results on</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"order","full_name":"sort[order]","description":"\n<p>How to order the sorted results (e.g. ASC for ascending)</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"}]}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/gpg_keys/create","name":"create","apis":[{"api_url":"/api/gpg_keys","http_method":"POST","short_description":"Create a gpg key"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n<p>organization identifier</p>\n","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"name","full_name":"name","description":"\n<p>identifier of the gpg key</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"content","full_name":"content","description":"\n<p>public key block in DER encoding</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/gpg_keys/show","name":"show","apis":[{"api_url":"/api/gpg_keys/:id","http_method":"GET","short_description":"Show a gpg key"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>gpg key numeric identifier</p>\n","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/gpg_keys/update","name":"update","apis":[{"api_url":"/api/gpg_keys/:id","http_method":"PUT","short_description":"Update a repository"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>gpg key numeric identifier</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"name","full_name":"name","description":"\n<p>identifier of the gpg key</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"content","full_name":"content","description":"\n<p>public key block in DER encoding</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/gpg_keys/destroy","name":"destroy","apis":[{"api_url":"/api/gpg_keys/:id","http_method":"DELETE","short_description":"Destroy a gpg key"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>gpg key numeric identifier</p>\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/gpg_keys/content","name":"content","apis":[{"api_url":"/api/gpg_keys/:id/content","http_method":"POST","short_description":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>gpg key numeric identifier</p>\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"content","full_name":"content","description":"\n<p>file contents</p>\n","required":true,"allow_nil":false,"validator":"File","expected_type":"string"}],"examples":[],"see":[]}]},"sync_plans":{"doc_url":"/apidoc/v2/sync_plans","api_url":"/api","name":"Sync plans","short_description":null,"full_description":"","version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/sync_plans/index","name":"index","apis":[{"api_url":"/api/organizations/:organization_id/sync_plans","http_method":"GET","short_description":"List sync plans"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>filter by name</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"sync_date","full_name":"sync_date","description":"\n<p>filter by sync date</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"interval","full_name":"interval","description":"\n<p>filter by interval</p>\n","required":false,"allow_nil":false,"validator":"Must be one of: none, hourly, daily, weekly.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/sync_plans/show","name":"show","apis":[{"api_url":"/api/sync_plans/:id","http_method":"GET","short_description":"Show a sync plan"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>sync plan numeric identifier</p>\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/sync_plans/create","name":"create","apis":[{"api_url":"/api/organizations/:organization_id/sync_plans","http_method":"POST","short_description":"Create a sync plan"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"sync_plan","full_name":"sync_plan","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"name","full_name":"sync_plan[name]","description":"\n<p>sync plan name</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"interval","full_name":"sync_plan[interval]","description":"\n<p>how often synchronization should run</p>\n","required":false,"allow_nil":true,"validator":"Must be one of: none, hourly, daily, weekly.","expected_type":"string"},{"name":"sync_date","full_name":"sync_plan[sync_date]","description":"\n<p>start datetime of synchronization</p>\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string"},{"name":"description","full_name":"sync_plan[description]","description":"\n<p>sync plan description</p>\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string"}]}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/sync_plans/update","name":"update","apis":[{"api_url":"/api/sync_plans/:id","http_method":"PUT","short_description":"Update a sync plan"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>sync plan numeric identifier</p>\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"sync_plan","full_name":"sync_plan","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"name","full_name":"sync_plan[name]","description":"\n<p>sync plan name</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"interval","full_name":"sync_plan[interval]","description":"\n<p>how often synchronization should run</p>\n","required":false,"allow_nil":true,"validator":"Must be one of: none, hourly, daily, weekly.","expected_type":"string"},{"name":"sync_date","full_name":"sync_plan[sync_date]","description":"\n<p>start datetime of synchronization</p>\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string"},{"name":"description","full_name":"sync_plan[description]","description":"\n<p>sync plan description</p>\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string"}]}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/sync_plans/destroy","name":"destroy","apis":[{"api_url":"/api/sync_plans/:id","http_method":"DELETE","short_description":"Destroy a sync plan"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>sync plan numeric identifier</p>\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string"}],"examples":[],"see":[]}]},"filter_rules":{"doc_url":"/apidoc/v2/filter_rules","api_url":"/api","name":"Filter rules","short_description":null,"full_description":"","version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/filter_rules/create","name":"create","apis":[{"api_url":"/api/content_view_definitions/:content_view_definition_id/filters/:filter_id/rules","http_method":"POST","short_description":"Create a filter rule for a content filter"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_definition_id","full_name":"content_view_definition_id","description":"\n<p>id of the content view definition</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"filter_id","full_name":"filter_id","description":"\n<p>name of the filter</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"rule","full_name":"rule","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"rule","full_name":"rule[rule]","description":"\n<p>A specification of the rule in json format (required).</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"content","full_name":"rule[content]","description":"\n<p>content type of the rule</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"inclusion","full_name":"rule[inclusion]","description":"\n<p>true if its an includes rule, false otherwise. Defauls to true</p>\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string"}]}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/filter_rules/destroy","name":"destroy","apis":[{"api_url":"/api/content_view_definitions/:content_view_definition_id/filters/:filter_id/rules/:id","http_method":"DELETE","short_description":"Delete a filter rule"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_definition_id","full_name":"content_view_definition_id","description":"\n<p>id of the content view definition</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"filter_id","full_name":"filter_id","description":"\n<p>name of the filter</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"id","full_name":"id","description":"\n<p>Id of the filter rule</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]}]},"ping":{"doc_url":"/apidoc/v2/ping","api_url":"/api","name":"Ping","short_description":null,"full_description":null,"version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/ping/index","name":"index","apis":[{"api_url":"/api/ping","http_method":"GET","short_description":"Shows status of system and it's subcomponents"}],"formats":null,"full_description":"\n<p>This service is only available for authenticated users</p>\n","errors":[],"params":[],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/ping/server_status","name":"server_status","apis":[{"api_url":"/api/status","http_method":"GET","short_description":"Shows version information"}],"formats":null,"full_description":"\n<p>This service is available for unauthenticated users</p>\n","errors":[],"params":[],"examples":[],"see":[]}]},"system_group_packages":{"doc_url":"/apidoc/v2/system_group_packages","api_url":"/api","name":"System group packages","short_description":null,"full_description":"\n<p>methods for handling packages on system group level</p>\n","version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/system_group_packages/create","name":"create","apis":[{"api_url":"/api/organizations/:organization_id/system_groups/:system_group_id/packages","http_method":"POST","short_description":"Install packages remotely"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n<p>oranization identifier</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"system_group_id","full_name":"system_group_id","description":"\n<p>system_group identifier</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"packages","full_name":"packages","description":"\n<p>List of package names</p>\n","required":false,"allow_nil":false,"validator":"Array","expected_type":"array"},{"name":"groups","full_name":"groups","description":"\n<p>List of package group names</p>\n","required":false,"allow_nil":false,"validator":"Array","expected_type":"array"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/system_group_packages/update","name":"update","apis":[{"api_url":"/api/organizations/:organization_id/system_groups/:system_group_id/packages","http_method":"PUT","short_description":"Update packages remotely"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n<p>oranization identifier</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"system_group_id","full_name":"system_group_id","description":"\n<p>system_group identifier</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"packages","full_name":"packages","description":"\n<p>List of package names</p>\n","required":false,"allow_nil":false,"validator":"Array","expected_type":"array"},{"name":"groups","full_name":"groups","description":"\n<p>List of package group names</p>\n","required":false,"allow_nil":false,"validator":"Array","expected_type":"array"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/system_group_packages/destroy","name":"destroy","apis":[{"api_url":"/api/organizations/:organization_id/system_groups/:system_group_id/packages","http_method":"DELETE","short_description":"Uninstall packages remotely"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n<p>oranization identifier</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"system_group_id","full_name":"system_group_id","description":"\n<p>system_group identifier</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"packages","full_name":"packages","description":"\n<p>List of package names</p>\n","required":false,"allow_nil":false,"validator":"Array","expected_type":"array"},{"name":"groups","full_name":"groups","description":"\n<p>List of package group names</p>\n","required":false,"allow_nil":false,"validator":"Array","expected_type":"array"}],"examples":[],"see":[]}]},"permissions":{"doc_url":"/apidoc/v2/permissions","api_url":"/api","name":"Permissions","short_description":null,"full_description":"","version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/permissions/index","name":"index","apis":[{"api_url":"/api/roles/:role_id/permissions","http_method":"GET","short_description":"List permissions for a role"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>filter by name</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"description","full_name":"description","description":"\n<p>filter by description</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"all_verbs","full_name":"all_verbs","description":"\n<p>filter by all_verbs flag</p>\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string"},{"name":"all_tags","full_name":"all_tags","description":"\n<p>filter by all_flags flag</p>\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/permissions/show","name":"show","apis":[{"api_url":"/api/roles/:role_id/permissions/:id","http_method":"GET","short_description":"Show a permission"}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/permissions/create","name":"create","apis":[{"api_url":"/api/roles/:role_id/permissions","http_method":"POST","short_description":"Create a roles permission"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"permission","full_name":"permission","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"description","full_name":"permission[description]","description":"","required":false,"allow_nil":true,"validator":"String","expected_type":"string"},{"name":"name","full_name":"permission[name]","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"organization_id","full_name":"permission[organization_id]","description":"","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"tags","full_name":"permission[tags]","description":"\n<p>array of tag ids</p>\n","required":false,"allow_nil":false,"validator":"Array","expected_type":"array"},{"name":"type","full_name":"permission[type]","description":"\n<p>name of a resource or ‘all’</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"verbs","full_name":"permission[verbs]","description":"\n<p>array of permission verbs</p>\n","required":false,"allow_nil":false,"validator":"Array","expected_type":"array"},{"name":"all_tags","full_name":"permission[all_tags]","description":"\n<p>True if the permission should use all tags</p>\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string"},{"name":"all_verbs","full_name":"permission[all_verbs]","description":"\n<p>True if the permission should use all verbs</p>\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string"}]}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/permissions/destroy","name":"destroy","apis":[{"api_url":"/api/roles/:role_id/permissions/:id","http_method":"DELETE","short_description":"Destroy a roles permission"}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"see":[]}]},"repositories":{"doc_url":"/apidoc/v2/repositories","api_url":"/api","name":"Repositories","short_description":null,"full_description":null,"version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/repositories/index","name":"index","apis":[{"api_url":"/api/repositories","http_method":"GET","short_description":"List of repositories"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n<p>id of an organization to show repositories in</p>\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"product_id","full_name":"product_id","description":"\n<p>id of a product to show repositories of</p>\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"environment_id","full_name":"environment_id","description":"\n<p>id of an environment to show repositories in</p>\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"library","full_name":"library","description":"\n<p>show repositories in Library and the default content view</p>\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string"},{"name":"enabled","full_name":"enabled","description":"\n<p>limit to only enabled repositories</p>\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string"},{"name":"search","full_name":"search","description":"\n<p>Search string</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"page","full_name":"page","description":"\n<p>Page number, starting at 1</p>\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"per_page","full_name":"per_page","description":"\n<p>Number of results per page to return</p>\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"order","full_name":"order","description":"\n<p>Sort field and order, eg. ‘name DESC’</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"sort","full_name":"sort","description":"\n<p>Hash version of ‘order’ param</p>\n","required":false,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"by","full_name":"sort[by]","description":"\n<p>Field to sort the results on</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"order","full_name":"sort[order]","description":"\n<p>How to order the sorted results (e.g. ASC for ascending)</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"}]}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/repositories/create","name":"create","apis":[{"api_url":"/api/repositories","http_method":"POST","short_description":"Create a repository"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"label","full_name":"label","description":"","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"product_id","full_name":"product_id","description":"\n<p>Product the repository belongs to</p>\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"url","full_name":"url","description":"\n<p>repository source url</p>\n","required":true,"allow_nil":false,"validator":null,"expected_type":"string"},{"name":"gpg_key_name","full_name":"gpg_key_name","description":"\n<p>name of a gpg key that will be assigned to the new repository</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"enabled","full_name":"enabled","description":"\n<p>flag that enables/disables the repository</p>\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string"},{"name":"content_type","full_name":"content_type","description":"\n<p>type of repo (either ‘yum’ or ‘puppet’, defaults to ‘yum’)</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/repositories/show","name":"show","apis":[{"api_url":"/api/repositories/:id","http_method":"GET","short_description":"Show a repository"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>repository id</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/repositories/update","name":"update","apis":[{"api_url":"/api/repositories/:id","http_method":"PUT","short_description":"Update a repository"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>repository id</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"gpg_key_id","full_name":"gpg_key_id","description":"\n<p>id of a gpg key that will be assigned to this repository</p>\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/repositories/destroy","name":"destroy","apis":[{"api_url":"/api/repositories/:id","http_method":"DELETE","short_description":"Destroy a repository"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/repositories/sync","name":"sync","apis":[{"api_url":"/api/repositories/:id/sync","http_method":"POST","short_description":"Synchronise repository"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>repository id</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"}],"examples":[],"see":[]}]},"role_ldap_groups":{"doc_url":"/apidoc/v2/role_ldap_groups","api_url":"/api","name":"Role ldap groups","short_description":null,"full_description":"","version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/role_ldap_groups/create","name":"create","apis":[{"api_url":"/api/roles/:role_id/ldap_groups","http_method":"POST","short_description":"Add group to list of LDAP groups associated with the role"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ldap_group","full_name":"ldap_group","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"name","full_name":"ldap_group[name]","description":"\n<p>name of the LDAP group</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"}]}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/role_ldap_groups/destroy","name":"destroy","apis":[{"api_url":"/api/roles/:role_id/ldap_groups/:id","http_method":"DELETE","short_description":"Remove group from the list of LDAP groups associated with the role"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"role_id","full_name":"role_id","description":"\n<p>role identifier</p>\n","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"id","full_name":"id","description":"\n<p>ldap group (name)</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/role_ldap_groups/index","name":"index","apis":[{"api_url":"/api/roles/:role_id/ldap_groups","http_method":"GET","short_description":"List LDAP groups associated with the role"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"role_id","full_name":"role_id","description":"\n<p>role identifier</p>\n","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"}],"examples":[],"see":[]}]},"providers":{"doc_url":"/apidoc/v2/providers","api_url":"/api","name":"Providers","short_description":null,"full_description":null,"version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/providers/index","name":"index","apis":[{"api_url":"/api/providers","http_method":"GET","short_description":"List of all providers"},{"api_url":"/api/organizations/:organization_id/providers","http_method":"GET","short_description":"List of all providers for a given organization"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"\n<p>Search string</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"page","full_name":"page","description":"\n<p>Page number, starting at 1</p>\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"per_page","full_name":"per_page","description":"\n<p>Number of results per page to return</p>\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"order","full_name":"order","description":"\n<p>Sort field and order, eg. ‘name DESC’</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"sort","full_name":"sort","description":"\n<p>Hash version of ‘order’ param</p>\n","required":false,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"by","full_name":"sort[by]","description":"\n<p>Field to sort the results on</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"order","full_name":"sort[order]","description":"\n<p>How to order the sorted results (e.g. ASC for ascending)</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"}]},{"name":"organization_id","full_name":"organization_id","description":"\n<p>organization identifier</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"provider_type","full_name":"provider_type","description":"\n<p>Filter providers by type (‘Custom’ or ‘Red Hat’)</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/providers/show","name":"show","apis":[{"api_url":"/api/providers/:id","http_method":"GET","short_description":"Show a provider"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>ID of provider</p>\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/providers/create","name":"create","apis":[{"api_url":"/api/providers","http_method":"POST","short_description":"Create a provider"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n<p>Organization identifier</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"name","full_name":"name","description":"\n<p>name of the provider</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"description","full_name":"description","description":"\n<p>description of the provider</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"provider_type","full_name":"provider_type","description":"\n<p>The type of the provider</p>\n","required":false,"allow_nil":false,"validator":"Must be one of: Red Hat, Custom.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/providers/update","name":"update","apis":[{"api_url":"/api/providers/:id","http_method":"PUT","short_description":"Update a provider"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Provider numeric identifier</p>\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"name","full_name":"name","description":"\n<p>name of the provider</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"description","full_name":"description","description":"\n<p>description of the provider</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"provider_type","full_name":"provider_type","description":"\n<p>The type of the provider</p>\n","required":false,"allow_nil":false,"validator":"Must be one of: Red Hat, Custom.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/providers/destroy","name":"destroy","apis":[{"api_url":"/api/providers/:id","http_method":"DELETE","short_description":"Destroy a provider"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Provider numeric identifier</p>\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/providers/products","name":"products","apis":[{"api_url":"/api/providers/:id/products","http_method":"GET","short_description":"List of provider's products"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Provider numeric identifier</p>\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"include_marketing","full_name":"include_marketing","description":"\n<p>Include marketing products in results</p>\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/providers/import_manifest","name":"import_manifest","apis":[{"api_url":"/api/providers/:id/import_manifest","http_method":"POST","short_description":"Import manifest for Red Hat provider"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Provider numeric identifier</p>\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"import","full_name":"import","description":"\n<p>Manifest file</p>\n","required":false,"allow_nil":false,"validator":"File","expected_type":"string"},{"name":"force","full_name":"force","description":"\n<p>Force import</p>\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/providers/refresh_manifest","name":"refresh_manifest","apis":[{"api_url":"/api/providers/:id/refresh_manifest","http_method":"PUT","short_description":"Refresh previously imported manifest for Red Hat provider"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Provider numeric identifier</p>\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/providers/delete_manifest","name":"delete_manifest","apis":[{"api_url":"/api/providers/:id/delete_manifest","http_method":"POST","short_description":"Delete manifest from Red Hat provider"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Provider numeric identifier</p>\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/providers/refresh_products","name":"refresh_products","apis":[{"api_url":"/api/providers/:id/refresh_products","http_method":"PUT","short_description":"Refresh products for Red Hat provider"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Provider numeric identifier</p>\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/providers/import_products","name":"import_products","apis":[{"api_url":"/api/providers/:id/import_products","http_method":"POST","short_description":"Import products"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Provider numeric identifier</p>\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"products","full_name":"products","description":"\n<p>Array of products to import</p>\n","required":true,"allow_nil":false,"validator":"Array","expected_type":"array"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/providers/product_create","name":"product_create","apis":[{"api_url":"/api/providers/:id/product_create","http_method":"POST","short_description":"Create a new product in custom provider"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Provider numeric identifier</p>\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"product","full_name":"product","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"gpg_key_name","full_name":"product[gpg_key_name]","description":"\n<p>identifier of the gpg key</p>\n","required":false,"allow_nil":true,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"description","full_name":"product[description]","description":"\n<p>Product description</p>\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string"},{"name":"name","full_name":"product[name]","description":"\n<p>Product name</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"label","full_name":"product[label]","description":"","required":false,"allow_nil":false,"validator":"String","expected_type":"string"}]}],"examples":[],"see":[]}]},"activation_keys":{"doc_url":"/apidoc/v2/activation_keys","api_url":"/api","name":"Activation keys","short_description":null,"full_description":"","version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/activation_keys/index","name":"index","apis":[{"api_url":"/api/environments/:environment_id/activation_keys","http_method":"GET","short_description":"List activation keys"},{"api_url":"/api/organizations/:organization_id/activation_keys","http_method":"GET","short_description":"List activation keys"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>lists by activation key name</p>\n","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/activation_keys/show","name":"show","apis":[{"api_url":"/api/activation_keys/:id","http_method":"GET","short_description":"Show an activation key"}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/activation_keys/create","name":"create","apis":[{"api_url":"/api/activation_keys","http_method":"POST","short_description":"Create an activation key"},{"api_url":"/api/environments/:environment_id/activation_keys","http_method":"POST","short_description":"Create an activation key"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"activation_key","full_name":"activation_key","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"name","full_name":"activation_key[name]","description":"\n<p>activation key identifier (alphanum characters, space, _ and -)</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"description","full_name":"activation_key[description]","description":"","required":false,"allow_nil":true,"validator":"String","expected_type":"string"},{"name":"content_view_id","full_name":"activation_key[content_view_id]","description":"\n<p>content view id</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"}]}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/activation_keys/update","name":"update","apis":[{"api_url":"/api/activation_keys/:id","http_method":"PUT","short_description":"Update an activation key"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"activation_key","full_name":"activation_key","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"name","full_name":"activation_key[name]","description":"\n<p>activation key identifier (alphanum characters, space, _ and -)</p>\n","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"description","full_name":"activation_key[description]","description":"","required":false,"allow_nil":true,"validator":"String","expected_type":"string"},{"name":"content_view_id","full_name":"activation_key[content_view_id]","description":"\n<p>content view id</p>\n","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"environment_id","full_name":"activation_key[environment_id]","description":"","required":false,"allow_nil":true,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"}]}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/activation_keys/destroy","name":"destroy","apis":[{"api_url":"/api/activation_keys/:id","http_method":"DELETE","short_description":"Destroy an activation key"}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/activation_keys/add_pool","name":"add_pool","apis":[{"api_url":"/api/activation_keys/:id/pools","http_method":"POST","short_description":"Create an entitlement pool within an activation key"}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/activation_keys/remove_pool","name":"remove_pool","apis":[{"api_url":"/api/activation_keys/:id/pools/:poolid","http_method":"DELETE","short_description":"Delete an entitlement pool within an activation key"}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/activation_keys/add_system_groups","name":"add_system_groups","apis":[{"api_url":"/api/activation_keys/:id/system_groups","http_method":"POST","short_description":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/activation_keys/remove_system_groups","name":"remove_system_groups","apis":[{"api_url":"/api/activation_keys/:id/system_groups","http_method":"DELETE","short_description":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"see":[]}]},"changesets":{"doc_url":"/apidoc/v2/changesets","api_url":"/api","name":"Changesets","short_description":null,"full_description":"","version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/changesets/index","name":"index","apis":[{"api_url":"/api/environments/:environment_id/changesets","http_method":"GET","short_description":"List changesets in an environment"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>An optional changeset name to filter upon</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/changesets/show","name":"show","apis":[{"api_url":"/api/changesets/:id","http_method":"GET","short_description":"Show a changeset"}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/changesets/update","name":"update","apis":[{"api_url":"/api/changesets/:id","http_method":"PUT","short_description":"Update a changeset"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"changeset","full_name":"changeset","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"name","full_name":"changeset[name]","description":"\n<p>The name of the changeset</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"description","full_name":"changeset[description]","description":"\n<p>The description of the changeset</p>\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string"}]}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/changesets/create","name":"create","apis":[{"api_url":"/api/environments/:environment_id/changesets","http_method":"POST","short_description":"Create a changeset"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"changeset","full_name":"changeset","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"name","full_name":"changeset[name]","description":"\n<p>The name of the changeset</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"description","full_name":"changeset[description]","description":"\n<p>The description of the changeset</p>\n","required":false,"allow_nil":true,"validator":"String","expected_type":"string"},{"name":"type","full_name":"changeset[type]","description":"","required":true,"allow_nil":false,"validator":"Must be one of: promotion, deletion.","expected_type":"string"}]}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/changesets/apply","name":"apply","apis":[{"api_url":"/api/changesets/:id/apply","http_method":"POST","short_description":"Apply a changeset on an envrionment."}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/changesets/destroy","name":"destroy","apis":[{"api_url":"/api/changesets/:id","http_method":"DELETE","short_description":"Destroy a changeset"}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"see":[]}]},"organization_default_info":{"doc_url":"/apidoc/v2/organization_default_info","api_url":"/api","name":"Organization default info","short_description":null,"full_description":"","version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/organization_default_info/create","name":"create","apis":[{"api_url":"/api/organizations/:organization_id/default_info/:informable_type","http_method":"POST","short_description":"Create default info"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"informable_type","full_name":"informable_type","description":"\n<p>name of the resource</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"informable_id","full_name":"informable_id","description":"\n<p>resource identifier</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"default_info","full_name":"default_info","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"keyname","full_name":"default_info[keyname]","description":"","required":true,"allow_nil":false,"validator":"String","expected_type":"string"}]}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/organization_default_info/destroy","name":"destroy","apis":[{"api_url":"/api/organizations/:organization_id/default_info/:informable_type/:informable_id/:keyname","http_method":"DELETE","short_description":"Delete default info"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"informable_type","full_name":"informable_type","description":"\n<p>name of the resource</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"informable_id","full_name":"informable_id","description":"\n<p>resource identifier</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"keyname","full_name":"keyname","description":"\n<p>Custom info key</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/organization_default_info/apply_to_all","name":"apply_to_all","apis":[{"api_url":"/api/organizations/:organization_id/default_info/:informable_type/apply","http_method":"POST","short_description":"Apply existing default info on all informable resources"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"informable_type","full_name":"informable_type","description":"\n<p>name of the resource</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"informable_id","full_name":"informable_id","description":"\n<p>resource identifier</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"async","full_name":"async","description":"\n<p>directive to run this asynchronously or not</p>\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string"}],"examples":[],"see":[]}]},"subscriptions":{"doc_url":"/apidoc/v2/subscriptions","api_url":"/api","name":"Subscriptions","short_description":null,"full_description":"\n<p>Systems subscriptions management.</p>\n","version":"v2","formats":null,"methods":[{"doc_url":"/apidoc/v2/subscriptions/index","name":"index","apis":[{"api_url":"/api/systems/:system_id/subscriptions","http_method":"GET","short_description":"List system subscriptions"},{"api_url":"/api/organization/:organization_id/subscriptions","http_method":"GET","short_description":"List organization subscriptions"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"system_id","full_name":"system_id","description":"\n<p>UUID of the system</p>\n","required":false,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"organization_id","full_name":"organization_id","description":"\n<p>Organization id</p>\n","required":false,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/subscriptions/show","name":"show","apis":[{"api_url":"/api/organizations/:organization_id/subscriptions/:id","http_method":"GET","short_description":"Show a subscription"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n<p>Organization identifier</p>\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"id","full_name":"id","description":"\n<p>Subscription identifier</p>\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/subscriptions/available","name":"available","apis":[{"api_url":"/api/systems/:system_id/subscriptions/available","http_method":"GET","short_description":"List available subscriptions"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"system_id","full_name":"system_id","description":"\n<p>UUID of the system</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"match_system","full_name":"match_system","description":"\n<p>Return subscriptions that match system</p>\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string"},{"name":"match_installed","full_name":"match_installed","description":"\n<p>Return subscriptions that match installed</p>\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string"},{"name":"no_overlap","full_name":"no_overlap","description":"\n<p>Return subscriptions that don’t overlap</p>\n","required":false,"allow_nil":false,"validator":"boolean","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/subscriptions/create","name":"create","apis":[{"api_url":"/api/systems/:system_id/subscriptions","http_method":"POST","short_description":"Create a subscription"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"system_id","full_name":"system_id","description":"\n<p>UUID of the system</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"subscription","full_name":"subscription","description":"","required":true,"allow_nil":false,"validator":"Hash","expected_type":"hash","params":[{"name":"pool","full_name":"subscription[pool]","description":"\n<p>Subscription Pool uuid</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"},{"name":"quantity","full_name":"subscription[quantity]","description":"\n<p>Number of subscription to use</p>\n","required":true,"allow_nil":false,"validator":"number.","expected_type":"string"}]}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/subscriptions/destroy","name":"destroy","apis":[{"api_url":"/api/systems/:system_id/subscriptions/:id","http_method":"DELETE","short_description":"Delete a subscription"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Entitlement id</p>\n","required":false,"allow_nil":false,"validator":"number.","expected_type":"string"},{"name":"system_id","full_name":"system_id","description":"\n<p>UUID of the system</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/subscriptions/destroy_all","name":"destroy_all","apis":[{"api_url":"/api/systems/:system_id/subscriptions","http_method":"DELETE","short_description":"Delete all system subscriptions"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"system_id","full_name":"system_id","description":"\n<p>UUID of the system</p>\n","required":true,"allow_nil":false,"validator":"String","expected_type":"string"}],"examples":[],"see":[]},{"doc_url":"/apidoc/v2/subscriptions/upload","name":"upload","apis":[{"api_url":"/api/organizations/:organization_id/subscriptions/upload","http_method":"POST","short_description":"Upload a subscription manifest"},{"api_url":"/api/subscriptions/upload","http_method":"POST","short_description":"Upload a subscription manifest"}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n<p>Organization id</p>\n","required":true,"allow_nil":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string"},{"name":"content","full_name":"content","description":"\n<p>Subscription manifest file</p>\n","required":true,"allow_nil":false,"validator":"File","expected_type":"string"}],"examples":[],"see":[]}]}}}}