katello_api 0.0.3 → 0.0.4

data/lib/katello_api/documentation.json

@@ -1 +1 @@
-{"docs":{"name":"Katello","api_url":"/api","copyright":"Copyright \u00a9 2012 Red Hat, Inc.","resources":{"subnets":{"name":"Subnets","api_url":"/api","version":"1.0","doc_url":"../apidoc/1.0/subnets","formats":null,"full_description":"\n<p>The Subnet API is available only if support for Foreman is installed.</p>\n","short_description":null,"methods":[{"name":"index","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/subnets/index","full_description":"","apis":[{"api_url":"/api/subnets","http_method":"GET","short_description":"Get list of subnets available in Foreman"}],"errors":[],"params":[]},{"name":"show","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/subnets/show","full_description":"","apis":[{"api_url":"/api/subnets/:id","http_method":"GET","short_description":"Show an subnet"}],"errors":[],"params":[{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"String","required":false,"description":"\n<p>subnet name</p>\n"}]},{"name":"create","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/subnets/create","full_description":"","apis":[{"api_url":"/api/subnet","http_method":"POST","short_description":"Create new subnet in Foreman"}],"errors":[],"params":[{"allow_nil":false,"full_name":"subnet","name":"subnet","expected_type":"hash","validator":"Hash","required":true,"params":[{"name":"name","full_name":"subnet[name]","allow_nil":false,"expected_type":"string","validator":"String","required":true,"description":"\n<p>subnet name</p>\n"}],"description":"\n<p>subnet info</p>\n"}]},{"name":"update","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/subnets/update","full_description":"","apis":[{"api_url":"/api/subnets/:id","http_method":"PUT","short_description":"Update an subnet record in Foreman"}],"errors":[],"params":[{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"String","required":false,"description":"\n<p>subnet name</p>\n"},{"allow_nil":false,"full_name":"subnet","name":"subnet","expected_type":"hash","validator":"Hash","required":true,"params":[{"name":"name","full_name":"subnet[name]","allow_nil":false,"expected_type":"string","validator":"String","required":false,"description":"\n<p>subnet name</p>\n"}],"description":"\n<p>subnet info</p>\n"}]},{"name":"destroy","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/subnets/destroy","full_description":"","apis":[{"api_url":"/api/subnets/:id","http_method":"DELETE","short_description":"Remove an subnet from Foreman"}],"errors":[],"params":[{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"String","required":false,"description":"\n<p>subnet name</p>\n"}]}]},"distributions":{"name":"Distributions","api_url":"/api","version":"1.0","doc_url":"../apidoc/1.0/distributions","formats":null,"full_description":null,"short_description":null,"methods":[{"name":"index","examples":["GET /api/repositories/2/distributions\n200\n[\n  {\n    \"family\": \"Test Family\",\n    \"url\": [\n      \"http://katello.example.com/pulp/ks/org_227e003/Library/custom/fewups_product_227e003/repo_227e003/\",\n      \"http://katello.example.com/pulp/ks/org_227e003/Library/custom/fewups_product_227e003/fewups_product_227e003_fakerepos_zoo5/\",\n      \"http://katello.example.com/pulp/ks/org_227e003/env_227e003/custom/fewups_product_227e003/fewups_product_227e003_fakerepos_zoo5/\",\n      \"http://katello.example.com/pulp/ks/org_227e003/env_227e003/custom/fewups_product_227e003/repo_227e003/\"\n    ],\n    \"files\": [\n      \"/var/lib/pulp/distributions/ks-Test Family-TestVariant-16-x86_64/test2.img\",\n      \"/var/lib/pulp/distributions/ks-Test Family-TestVariant-16-x86_64/test1.img\",\n      \"/var/lib/pulp/distributions/ks-Test Family-TestVariant-16-x86_64/.treeinfo\",\n      \"/var/lib/pulp/distributions/ks-Test Family-TestVariant-16-x86_64/empty.iso\"\n    ],\n    \"arch\": \"x86_64\",\n    \"version\": \"16\",\n    \"variant\": \"TestVariant\",\n    \"id\": \"ks-Test Family-TestVariant-16-x86_64\",\n    \"description\": \"ks-Test Family-TestVariant-16-x86_64\"\n  }\n]"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/distributions/index","full_description":"","apis":[{"api_url":"/api/repositories/:repository_id/distributions","http_method":"GET","short_description":"List distributions"}],"errors":[],"params":[]},{"name":"show","examples":["GET /api/repositories/2/distributions/ks-Test%20Family-TestVariant-16-x86_64/\n200\n{\n  \"family\": \"Test Family\",\n  \"url\": [\n    \"http://katello.example.com/pulp/ks/org_227e003/Library/custom/fewups_product_227e003/repo_227e003/\",\n    \"http://katello.example.com/pulp/ks/org_227e003/Library/custom/fewups_product_227e003/fewups_product_227e003_fakerepos_zoo5/\",\n    \"http://katello.example.com/pulp/ks/org_227e003/env_227e003/custom/fewups_product_227e003/fewups_product_227e003_fakerepos_zoo5/\",\n    \"http://katello.example.com/pulp/ks/org_227e003/env_227e003/custom/fewups_product_227e003/repo_227e003/\"\n  ],\n  \"files\": [\n    \"/var/lib/pulp/distributions/ks-Test Family-TestVariant-16-x86_64/test2.img\",\n    \"/var/lib/pulp/distributions/ks-Test Family-TestVariant-16-x86_64/test1.img\",\n    \"/var/lib/pulp/distributions/ks-Test Family-TestVariant-16-x86_64/.treeinfo\",\n    \"/var/lib/pulp/distributions/ks-Test Family-TestVariant-16-x86_64/empty.iso\"\n  ],\n  \"arch\": \"x86_64\",\n  \"version\": \"16\",\n  \"variant\": \"TestVariant\",\n  \"id\": \"ks-Test Family-TestVariant-16-x86_64\",\n  \"description\": \"ks-Test Family-TestVariant-16-x86_64\"\n}"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/distributions/show","full_description":"","apis":[{"api_url":"/api/repositories/:repository_id/distributions/:id","http_method":"GET","short_description":"Show a distribution"}],"errors":[],"params":[{"allow_nil":false,"full_name":"repository_id","name":"repository_id","expected_type":"string","validator":"number.","required":false,"description":"\n<p>repository numeric id</p>\n"}]}]},"content_views":{"name":"Content views","api_url":"/api","version":"1.0","doc_url":"../apidoc/1.0/content_views","formats":null,"full_description":null,"short_description":null,"methods":[{"name":"index","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/content_views/index","full_description":"","apis":[{"api_url":"/api/organizations/:organization_id/content_views","http_method":"GET","short_description":"List content views"}],"errors":[],"params":[{"allow_nil":false,"full_name":"organization_id","name":"organization_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":false,"description":"\n<p>organization identifier</p>\n"},{"allow_nil":false,"full_name":"environment_id","name":"environment_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":false,"description":"\n<p>environment identifier</p>\n"},{"allow_nil":false,"full_name":"label","name":"label","expected_type":"string","validator":"String","required":false,"description":"\n<p>content view label</p>\n"},{"allow_nil":false,"full_name":"name","name":"name","expected_type":"string","validator":"String","required":false,"description":"\n<p>content view name</p>\n"},{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":false,"description":"\n<p>content view id</p>\n"}]},{"name":"show","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/content_views/show","full_description":"","apis":[{"api_url":"/api/content_views/:id","http_method":"GET","short_description":null}],"errors":[],"params":[{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":false,"description":"\n<p>content view id</p>\n"},{"allow_nil":false,"full_name":"environment_id","name":"environment_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":false,"description":"\n<p>environment id</p>\n"}]},{"name":"promote","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/content_views/promote","full_description":"","apis":[{"api_url":"/api/content_views/:id/promote","http_method":"POST","short_description":null}],"errors":[],"params":[{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":false,"description":"\n<p>content view id</p>\n"},{"allow_nil":false,"full_name":"environment_id","name":"environment_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":false,"description":"\n<p>environment promoting to</p>\n"}]},{"name":"refresh","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/content_views/refresh","full_description":"","apis":[{"api_url":"/api/content_views/:id/refresh","http_method":"POST","short_description":null}],"errors":[],"params":[]}]},"gpg_keys":{"name":"Gpg keys","api_url":"/api","version":"1.0","doc_url":"../apidoc/1.0/gpg_keys","formats":null,"full_description":null,"short_description":null,"methods":[{"name":"index","examples":["GET /api/organizations/org_227e003/gpg_keys/\n200\n[\n  {\n    \"name\": \"Another-Dummy-Package-Generator\",\n    \"id\": 2\n  },\n  {\n    \"name\": \"Dummy-Package-Generator\",\n    \"id\": 1\n  }\n]"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/gpg_keys/index","full_description":"","apis":[{"api_url":"/api/organizations/:organization_id/gpg_keys","http_method":"GET","short_description":"List gpg keys"}],"errors":[],"params":[{"allow_nil":false,"full_name":"organization_id","name":"organization_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":false,"description":"\n<p>organization identifier</p>\n"},{"allow_nil":false,"full_name":"name","name":"name","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":false,"description":"\n<p>identifier of the gpg key</p>\n"}]},{"name":"show","examples":["GET /api/gpg_keys/1/\n200\n{\n  \"created_at\": \"2012-08-10T13:45:52Z\",\n  \"name\": \"Dummy-Package-Generator\",\n  \"organization_id\": 2,\n  \"repositories\": [],\n  \"products\": [],\n  \"content\": \"-----BEGIN PGP PUBLIC KEY BLOCK-----\\nVersion: GnuPG v1.4.11 (GNU/Linux)\\n\\nmQENBE8NW6EBCAC/ht3UujFwxol44zilXcwI8v15gf6X4u3A5Oo2FCEweQfbZw8q\\nlPGjzRNHcNVO4NIZ+G1fHyWAgcs/xa4fTju4LOJU2OWfbkvGA7tlIIREkEQ9IgMI\\ni0LJzsHyqhWhJ0S5POCLFyH27R0Vh2wPMwZawoomRVDsghIE8TAJVKIHICVObvGE\\nVqBGSY1OHvGfZ0ZsnQv3hDmxnyywJkJ96HGVqStS2sW0YkQ77dRY0u6eSI55vwBQ\\niV9dCSMs43LpoBL9pFj0ESM76G0GSGF5G9PH2b//y8ehepdS30otiqgjag5Zw76b\\nqFMHFyq1o5hXJpIPiZaagU1X+wMixPOlqE5LABEBAAG0MER1bW15IFBhY2thZ2Vz\\nIEdlbmVyYXRvciA8YWRtaW5Aem9vLmV4YW1wbGUuY29tPokBOAQTAQIAIgUCTw1b\\noQIbAwYLCQgHAwIGFQgCCQoLBBYCAwECHgECF4AACgkQ74XM4/ePsZVeCgf+L+HW\\nf0K7/uzu3Q7G+aOu7qwu0iUK64SEAgtoMdjpjkq+YYxPS60zP7QS3pAzL4N31kT/\\nkHQ+OJAg5Z0oegXu9mdhIenks2DaEzN6P2jAhWoRa/az5F9AaJ01WSsspsBpcAyt\\n3NB2iGNtzs4v6saUz5mTp1bgmsXolzClHlTSUnjjCfuk7HgzJcCpRxb49tQ5Lo3b\\n9k0XPvhhgSdiTFM+CfPl3qgHPENZqyoDOnhvKbMHZg8NCf1NLf8edlk5nWDjHti8\\nVfkuCSgRzR15SgyEUU1MCQBPEYKy8U6LoOwX8Rl3+lCf9D7rReP74wSEdr9p9cFi\\nSCFpN6IUJ9pN0tDU3rkBDQRPDVuhAQgAmZB+DKbraTgeW1UOYS/HWzGOR21NR3nq\\nsxeG249W3OlsZbk/8BJP/DqFAhVbdxvISFkSKURoVXxUwoKx36KZHXIOgCt3vsj5\\nu2mxF2ajrHBwzM8jrrNy8xdd4DplOP2D0DbuswDi5pqmd/Cd0EdC88ZIPt3Ox/GH\\n4uCJOzkCRFcFRZhOT+YC+A3YaVg4UoR3AMup8K81Nm2y8q1pUy/gZvkWMONy5iDX\\nlyU6enBNv+vmhumyYJT8+rPRW/ztsaBzkvpuXkQTJdWDQbigeK1hBNV5PCjyQydj\\nP+sKrMxKjyyZ0rcGP1hcCqZuBHZlW0O2WJFKsZv+fY8UJfU08FeAqQARAQABiQEf\\nBBgBAgAJBQJPDVuhAhsMAAoJEO+FzOP3j7GVhlsH/0emlW/Nk0bSUG4jfAeJAB7H\\nKRYbr5P/YbbFLEOb4yi2DlPxUac0JoXCMLha9G9LBmQ4IL4qPHdycSlEs4cGBX6W\\nxn1ti6rJ3LWm5Hb7iUBfIeuKW31thTJK7SAruiBk7g1/I55HlFW0LEfgfVUQf6hJ\\n9Rnw6YVXyQAod1x/QmLWw5aQcoksHL/4eRpU74EjuKQdZMLuaherKtY6OTtEDTdm\\nbEdEINVqR5hYEHgDEPPrPb5MDbQsrMEAwdWPqC2/9cgacO33/VuvXDu74X+TwE/c\\nOGRCb385XPNS9KApQ4iRTZ6ccOnSJumZbeTTd9DBFwa+T1/xD96yabnaOdJqf6Y=\\n=RrIG\\n-----END PGP PUBLIC KEY BLOCK-----\\n\",\n  \"updated_at\": \"2012-08-10T13:45:52Z\",\n  \"id\": 1\n}"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/gpg_keys/show","full_description":"","apis":[{"api_url":"/api/gpg_keys/:id","http_method":"GET","short_description":"Show a gpg key"}],"errors":[],"params":[{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"number.","required":false,"description":"\n<p>gpg key numeric identifier</p>\n"}]},{"name":"create","examples":["POST /api/organizations/org_227e003/gpg_keys\n{\n  \"gpg_key\": {\n    \"name\": \"Dummy-Package-Generator\",\n    \"content\": \"-----BEGIN PGP PUBLIC KEY BLOCK-----\\nVersion: GnuPG v1.4.11 (GNU/Linux)\\n\\nmQENBE8NW6EBCAC/ht3UujFwxol44zilXcwI8v15gf6X4u3A5Oo2FCEweQfbZw8q\\nlPGjzRNHcNVO4NIZ+G1fHyWAgcs/xa4fTju4LOJU2OWfbkvGA7tlIIREkEQ9IgMI\\ni0LJzsHyqhWhJ0S5POCLFyH27R0Vh2wPMwZawoomRVDsghIE8TAJVKIHICVObvGE\\nVqBGSY1OHvGfZ0ZsnQv3hDmxnyywJkJ96HGVqStS2sW0YkQ77dRY0u6eSI55vwBQ\\niV9dCSMs43LpoBL9pFj0ESM76G0GSGF5G9PH2b//y8ehepdS30otiqgjag5Zw76b\\nqFMHFyq1o5hXJpIPiZaagU1X+wMixPOlqE5LABEBAAG0MER1bW15IFBhY2thZ2Vz\\nIEdlbmVyYXRvciA8YWRtaW5Aem9vLmV4YW1wbGUuY29tPokBOAQTAQIAIgUCTw1b\\noQIbAwYLCQgHAwIGFQgCCQoLBBYCAwECHgECF4AACgkQ74XM4/ePsZVeCgf+L+HW\\nf0K7/uzu3Q7G+aOu7qwu0iUK64SEAgtoMdjpjkq+YYxPS60zP7QS3pAzL4N31kT/\\nkHQ+OJAg5Z0oegXu9mdhIenks2DaEzN6P2jAhWoRa/az5F9AaJ01WSsspsBpcAyt\\n3NB2iGNtzs4v6saUz5mTp1bgmsXolzClHlTSUnjjCfuk7HgzJcCpRxb49tQ5Lo3b\\n9k0XPvhhgSdiTFM+CfPl3qgHPENZqyoDOnhvKbMHZg8NCf1NLf8edlk5nWDjHti8\\nVfkuCSgRzR15SgyEUU1MCQBPEYKy8U6LoOwX8Rl3+lCf9D7rReP74wSEdr9p9cFi\\nSCFpN6IUJ9pN0tDU3rkBDQRPDVuhAQgAmZB+DKbraTgeW1UOYS/HWzGOR21NR3nq\\nsxeG249W3OlsZbk/8BJP/DqFAhVbdxvISFkSKURoVXxUwoKx36KZHXIOgCt3vsj5\\nu2mxF2ajrHBwzM8jrrNy8xdd4DplOP2D0DbuswDi5pqmd/Cd0EdC88ZIPt3Ox/GH\\n4uCJOzkCRFcFRZhOT+YC+A3YaVg4UoR3AMup8K81Nm2y8q1pUy/gZvkWMONy5iDX\\nlyU6enBNv+vmhumyYJT8+rPRW/ztsaBzkvpuXkQTJdWDQbigeK1hBNV5PCjyQydj\\nP+sKrMxKjyyZ0rcGP1hcCqZuBHZlW0O2WJFKsZv+fY8UJfU08FeAqQARAQABiQEf\\nBBgBAgAJBQJPDVuhAhsMAAoJEO+FzOP3j7GVhlsH/0emlW/Nk0bSUG4jfAeJAB7H\\nKRYbr5P/YbbFLEOb4yi2DlPxUac0JoXCMLha9G9LBmQ4IL4qPHdycSlEs4cGBX6W\\nxn1ti6rJ3LWm5Hb7iUBfIeuKW31thTJK7SAruiBk7g1/I55HlFW0LEfgfVUQf6hJ\\n9Rnw6YVXyQAod1x/QmLWw5aQcoksHL/4eRpU74EjuKQdZMLuaherKtY6OTtEDTdm\\nbEdEINVqR5hYEHgDEPPrPb5MDbQsrMEAwdWPqC2/9cgacO33/VuvXDu74X+TwE/c\\nOGRCb385XPNS9KApQ4iRTZ6ccOnSJumZbeTTd9DBFwa+T1/xD96yabnaOdJqf6Y=\\n=RrIG\\n-----END PGP PUBLIC KEY BLOCK-----\\n\"\n  }\n}\n200\n{\n  \"created_at\": \"2012-08-10T13:45:52Z\",\n  \"name\": \"Dummy-Package-Generator\",\n  \"organization_id\": 2,\n  \"content\": \"-----BEGIN PGP PUBLIC KEY BLOCK-----\\nVersion: GnuPG v1.4.11 (GNU/Linux)\\n\\nmQENBE8NW6EBCAC/ht3UujFwxol44zilXcwI8v15gf6X4u3A5Oo2FCEweQfbZw8q\\nlPGjzRNHcNVO4NIZ+G1fHyWAgcs/xa4fTju4LOJU2OWfbkvGA7tlIIREkEQ9IgMI\\ni0LJzsHyqhWhJ0S5POCLFyH27R0Vh2wPMwZawoomRVDsghIE8TAJVKIHICVObvGE\\nVqBGSY1OHvGfZ0ZsnQv3hDmxnyywJkJ96HGVqStS2sW0YkQ77dRY0u6eSI55vwBQ\\niV9dCSMs43LpoBL9pFj0ESM76G0GSGF5G9PH2b//y8ehepdS30otiqgjag5Zw76b\\nqFMHFyq1o5hXJpIPiZaagU1X+wMixPOlqE5LABEBAAG0MER1bW15IFBhY2thZ2Vz\\nIEdlbmVyYXRvciA8YWRtaW5Aem9vLmV4YW1wbGUuY29tPokBOAQTAQIAIgUCTw1b\\noQIbAwYLCQgHAwIGFQgCCQoLBBYCAwECHgECF4AACgkQ74XM4/ePsZVeCgf+L+HW\\nf0K7/uzu3Q7G+aOu7qwu0iUK64SEAgtoMdjpjkq+YYxPS60zP7QS3pAzL4N31kT/\\nkHQ+OJAg5Z0oegXu9mdhIenks2DaEzN6P2jAhWoRa/az5F9AaJ01WSsspsBpcAyt\\n3NB2iGNtzs4v6saUz5mTp1bgmsXolzClHlTSUnjjCfuk7HgzJcCpRxb49tQ5Lo3b\\n9k0XPvhhgSdiTFM+CfPl3qgHPENZqyoDOnhvKbMHZg8NCf1NLf8edlk5nWDjHti8\\nVfkuCSgRzR15SgyEUU1MCQBPEYKy8U6LoOwX8Rl3+lCf9D7rReP74wSEdr9p9cFi\\nSCFpN6IUJ9pN0tDU3rkBDQRPDVuhAQgAmZB+DKbraTgeW1UOYS/HWzGOR21NR3nq\\nsxeG249W3OlsZbk/8BJP/DqFAhVbdxvISFkSKURoVXxUwoKx36KZHXIOgCt3vsj5\\nu2mxF2ajrHBwzM8jrrNy8xdd4DplOP2D0DbuswDi5pqmd/Cd0EdC88ZIPt3Ox/GH\\n4uCJOzkCRFcFRZhOT+YC+A3YaVg4UoR3AMup8K81Nm2y8q1pUy/gZvkWMONy5iDX\\nlyU6enBNv+vmhumyYJT8+rPRW/ztsaBzkvpuXkQTJdWDQbigeK1hBNV5PCjyQydj\\nP+sKrMxKjyyZ0rcGP1hcCqZuBHZlW0O2WJFKsZv+fY8UJfU08FeAqQARAQABiQEf\\nBBgBAgAJBQJPDVuhAhsMAAoJEO+FzOP3j7GVhlsH/0emlW/Nk0bSUG4jfAeJAB7H\\nKRYbr5P/YbbFLEOb4yi2DlPxUac0JoXCMLha9G9LBmQ4IL4qPHdycSlEs4cGBX6W\\nxn1ti6rJ3LWm5Hb7iUBfIeuKW31thTJK7SAruiBk7g1/I55HlFW0LEfgfVUQf6hJ\\n9Rnw6YVXyQAod1x/QmLWw5aQcoksHL/4eRpU74EjuKQdZMLuaherKtY6OTtEDTdm\\nbEdEINVqR5hYEHgDEPPrPb5MDbQsrMEAwdWPqC2/9cgacO33/VuvXDu74X+TwE/c\\nOGRCb385XPNS9KApQ4iRTZ6ccOnSJumZbeTTd9DBFwa+T1/xD96yabnaOdJqf6Y=\\n=RrIG\\n-----END PGP PUBLIC KEY BLOCK-----\\n\",\n  \"updated_at\": \"2012-08-10T13:45:52Z\",\n  \"id\": 1\n}"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/gpg_keys/create","full_description":"","apis":[{"api_url":"/api/organizations/:organization_id/gpg_keys","http_method":"POST","short_description":"Create a gpg key"}],"errors":[],"params":[{"allow_nil":false,"full_name":"organization_id","name":"organization_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":false,"description":"\n<p>organization identifier</p>\n"},{"allow_nil":false,"full_name":"gpg_key","name":"gpg_key","expected_type":"hash","validator":"Hash","required":true,"params":[{"name":"name","full_name":"gpg_key[name]","allow_nil":false,"expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":"\n<p>identifier of the gpg key</p>\n"},{"name":"content","full_name":"gpg_key[content]","allow_nil":false,"expected_type":"string","validator":"String","required":true,"description":"\n<p>public key block in DER encoding</p>\n"}],"description":""}]},{"name":"update","examples":["PUT /api/gpg_keys/2/\n{\n  \"gpg_key\": {\n    \"name\": \"Renamed-Dummy-Package-Generator\"\n  }\n}\n200\n{\n  \"created_at\": \"2012-08-10T13:45:53Z\",\n  \"name\": \"Renamed-Dummy-Package-Generator\",\n  \"organization_id\": 2,\n  \"content\": \"gpg create from input                   [ \\u001b[32mOK\\u001b[m\\u000f ]\\n\",\n  \"updated_at\": \"2012-08-10T13:45:54Z\",\n  \"id\": 2\n}"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/gpg_keys/update","full_description":"","apis":[{"api_url":"/api/gpg_keys/:id","http_method":"PUT","short_description":"Update a gpg key"}],"errors":[],"params":[{"allow_nil":false,"full_name":"gpg_key","name":"gpg_key","expected_type":"hash","validator":"Hash","required":true,"params":[{"name":"name","full_name":"gpg_key[name]","allow_nil":false,"expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":false,"description":"\n<p>identifier of the gpg key</p>\n"},{"name":"content","full_name":"gpg_key[content]","allow_nil":false,"expected_type":"string","validator":"String","required":false,"description":"\n<p>public key block in DER encoding</p>\n"}],"description":""}]},{"name":"destroy","examples":["DELETE /api/gpg_keys/1/\n204"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/gpg_keys/destroy","full_description":"","apis":[{"api_url":"/api/gpg_keys/:id","http_method":"DELETE","short_description":"Destroy a gpg key"}],"errors":[],"params":[{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"number.","required":false,"description":"\n<p>gpg key numeric identifier</p>\n"}]},{"name":"content","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/gpg_keys/content","full_description":"\n<p>Returns the content of a repo gpg key, used directly by yum We\u2019ve amended\nREST best practices (e.g. not using the show action) as we don\u2019t want to\nauthenticate, authorize etc, trying to distinquse between a yum request and\nnormal api request might not always be 100% bullet proof, and its more\nimportant that yum can fetch the key.</p>\n","apis":[{"api_url":"/api/gpg_keys/:id/content","http_method":"GET","short_description":null}],"errors":[],"params":[{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"number.","required":false,"description":"\n<p>gpg key numeric identifier</p>\n"}]}]},"architectures":{"name":"Architectures","api_url":"/api","version":"1.0","doc_url":"../apidoc/1.0/architectures","formats":null,"full_description":"\n<p>The Architectures API is available only if support for Foreman is\ninstalled.</p>\n","short_description":null,"methods":[{"name":"index","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/architectures/index","full_description":"","apis":[{"api_url":"/api/architectures","http_method":"GET","short_description":"Get list of architectures available in Foreman"}],"errors":[],"params":[]},{"name":"show","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/architectures/show","full_description":"","apis":[{"api_url":"/api/architectures/:id","http_method":"GET","short_description":"Show an architecture"}],"errors":[],"params":[{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"String","required":false,"description":"\n<p>architecture name</p>\n"}]},{"name":"create","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/architectures/create","full_description":"","apis":[{"api_url":"/api/architecture","http_method":"POST","short_description":"Create new architecture in Foreman"}],"errors":[],"params":[{"allow_nil":false,"full_name":"architecture","name":"architecture","expected_type":"hash","validator":"Hash","required":true,"params":[{"name":"name","full_name":"architecture[name]","allow_nil":false,"expected_type":"string","validator":"String","required":true,"description":"\n<p>architecture name</p>\n"}],"description":"\n<p>architecture info</p>\n"}]},{"name":"update","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/architectures/update","full_description":"","apis":[{"api_url":"/api/architectures/:id","http_method":"PUT","short_description":"Update an architecture record in Foreman"}],"errors":[],"params":[{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"String","required":false,"description":"\n<p>architecture name</p>\n"},{"allow_nil":false,"full_name":"architecture","name":"architecture","expected_type":"hash","validator":"Hash","required":true,"params":[{"name":"name","full_name":"architecture[name]","allow_nil":false,"expected_type":"string","validator":"String","required":false,"description":"\n<p>architecture name</p>\n"}],"description":"\n<p>architecture info</p>\n"}]},{"name":"destroy","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/architectures/destroy","full_description":"","apis":[{"api_url":"/api/architectures/:id","http_method":"DELETE","short_description":"Remove an architecture from Foreman"}],"errors":[],"params":[{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"String","required":false,"description":"\n<p>architecture name</p>\n"}]}]},"hardware_models":{"name":"Hardware models","api_url":"/api","version":"1.0","doc_url":"../apidoc/1.0/hardware_models","formats":null,"full_description":"\n<p>The HardwareModels API is available only if support for Foreman is\ninstalled.</p>\n","short_description":null,"methods":[{"name":"index","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/hardware_models/index","full_description":"","apis":[{"api_url":"/api/hardware_models","http_method":"GET","short_description":"Get list of hardware models available in Foreman"}],"errors":[],"params":[]},{"name":"show","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/hardware_models/show","full_description":"","apis":[{"api_url":"/api/hardware_models/:id","http_method":"GET","short_description":"Show an hardware model"}],"errors":[],"params":[{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"String","required":false,"description":"\n<p>hardware model name</p>\n"}]},{"name":"create","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/hardware_models/create","full_description":"","apis":[{"api_url":"/api/hardware_models","http_method":"POST","short_description":"Create new hardware model in Foreman"}],"errors":[],"params":[{"allow_nil":false,"full_name":"hardware_model","name":"hardware_model","expected_type":"hash","validator":"Hash","required":true,"params":[{"name":"name","full_name":"hardware_model[name]","allow_nil":false,"expected_type":"string","validator":"String","required":true,"description":""},{"name":"info","full_name":"hardware_model[info]","allow_nil":true,"expected_type":"string","validator":"String","required":false,"description":""},{"name":"vendor_class","full_name":"hardware_model[vendor_class]","allow_nil":true,"expected_type":"string","validator":"String","required":false,"description":""},{"name":"hardware_model","full_name":"hardware_model[hardware_model]","allow_nil":true,"expected_type":"string","validator":"String","required":false,"description":""}],"description":"\n<p>hardware model info</p>\n"}]},{"name":"update","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/hardware_models/update","full_description":"","apis":[{"api_url":"/api/hardware_models/:id","http_method":"PUT","short_description":"Update an hardware model record in Foreman"}],"errors":[],"params":[{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"String","required":false,"description":"\n<p>hardware model name</p>\n"},{"allow_nil":false,"full_name":"hardware_model","name":"hardware_model","expected_type":"hash","validator":"Hash","required":true,"params":[{"name":"name","full_name":"hardware_model[name]","allow_nil":false,"expected_type":"string","validator":"String","required":false,"description":""},{"name":"info","full_name":"hardware_model[info]","allow_nil":true,"expected_type":"string","validator":"String","required":false,"description":""},{"name":"vendor_class","full_name":"hardware_model[vendor_class]","allow_nil":true,"expected_type":"string","validator":"String","required":false,"description":""},{"name":"hardware_model","full_name":"hardware_model[hardware_model]","allow_nil":true,"expected_type":"string","validator":"String","required":false,"description":""}],"description":"\n<p>hardware model info</p>\n"}]},{"name":"destroy","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/hardware_models/destroy","full_description":"","apis":[{"api_url":"/api/hardware_models/:id","http_method":"DELETE","short_description":"Remove an hardware model from Foreman"}],"errors":[],"params":[{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"String","required":false,"description":"\n<p>hardware model name</p>\n"}]}]},"roles":{"name":"Roles","api_url":"/api","version":"1.0","doc_url":"../apidoc/1.0/roles","formats":null,"full_description":null,"short_description":null,"methods":[{"name":"index","examples":["GET /api/roles/?name=tmp_permission_role_227e003\n200\n[\n  {\n    \"created_at\": \"2012-08-10T13:50:06Z\",\n    \"name\": \"tmp_permission_role_227e003\",\n    \"updated_at\": \"2012-08-10T13:50:06Z\",\n    \"locked\": false,\n    \"id\": 6,\n    \"description\": null\n  }\n]"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/roles/index","full_description":"","apis":[{"api_url":"/api/roles","http_method":"GET","short_description":"List roles"},{"api_url":"/api/users/:user_id/roles","http_method":"GET","short_description":"List roles assigned to a user"}],"errors":[],"params":[{"allow_nil":false,"full_name":"name","name":"name","expected_type":"string","validator":null,"required":false,"description":""}]},{"name":"show","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/roles/show","full_description":"","apis":[{"api_url":"/api/roles/:id","http_method":"GET","short_description":"Show a role"},{"api_url":"/api/users/:user_id/roles/:id","http_method":"GET","short_description":"Show a role"}],"errors":[],"params":[]},{"name":"create","examples":["POST /api/roles/\n{\n  \"role\": {\n    \"name\": \"tmp_permission_role_227e003\",\n    \"description\": null\n  }\n}\n200\n{\n  \"created_at\": \"2012-08-10T13:50:06Z\",\n  \"name\": \"tmp_permission_role_227e003\",\n  \"updated_at\": \"2012-08-10T13:50:06Z\",\n  \"locked\": false,\n  \"id\": 6,\n  \"description\": null\n}"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/roles/create","full_description":"","apis":[{"api_url":"/api/roles","http_method":"POST","short_description":"Create a role"},{"api_url":"/api/users/:user_id/roles","http_method":"POST","short_description":"Create a role"}],"errors":[],"params":[{"allow_nil":false,"full_name":"role","name":"role","expected_type":"hash","validator":"Hash","required":true,"params":[{"name":"name","full_name":"role[name]","allow_nil":false,"expected_type":"string","validator":"String","required":true,"description":""},{"name":"description","full_name":"role[description]","allow_nil":true,"expected_type":"string","validator":"String","required":false,"description":""}],"description":""}]},{"name":"update","examples":["PUT /api/roles/7\n{\n  \"role\": {\n    \"name\": \"role_\",\n    \"description\": \"new description of the role\"\n  }\n}\n200\n{\n  \"created_at\": \"2012-08-10T13:58:00Z\",\n  \"name\": \"role_\",\n  \"updated_at\": \"2012-08-10T13:58:02Z\",\n  \"locked\": false,\n  \"id\": 7,\n  \"description\": \"new description of the role\"\n}"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/roles/update","full_description":"","apis":[{"api_url":"/api/roles/:id","http_method":"PUT","short_description":"Update a role"},{"api_url":"/api/users/:user_id/roles/:id","http_method":"PUT","short_description":"Update a role"}],"errors":[],"params":[{"allow_nil":false,"full_name":"role","name":"role","expected_type":"hash","validator":"Hash","required":true,"params":[{"name":"name","full_name":"role[name]","allow_nil":false,"expected_type":"string","validator":"String","required":false,"description":""},{"name":"description","full_name":"role[description]","allow_nil":true,"expected_type":"string","validator":"String","required":false,"description":""}],"description":""}]},{"name":"destroy","examples":["DELETE /api/roles/7\n200\nDeleted role '7'"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/roles/destroy","full_description":"","apis":[{"api_url":"/api/roles/:id","http_method":"DELETE","short_description":"Destroy a role"},{"api_url":"/api/users/:user_id/roles/:id","http_method":"DELETE","short_description":"Destroy a role"}],"errors":[],"params":[]},{"name":"available_verbs","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/roles/available_verbs","full_description":"","apis":[{"api_url":"/api/roles/available_verbs","http_method":"GET","short_description":"List all available verbs that can be set to roles"}],"errors":[],"params":[{"allow_nil":false,"full_name":"organization_id","name":"organization_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":false,"description":"\n<p>With this option specified the listed tags are scoped to the organization.</p>\n"}]}]},"system_packages":{"name":"System packages","api_url":"/api","version":"1.0","doc_url":"../apidoc/1.0/system_packages","formats":null,"full_description":"","short_description":null,"methods":[{"name":"create","examples":["POST /api/systems/3050eb45-0ec4-43ea-8913-83635f06a2b7/packages\n{\n  \"packages\": [\n    \"cheetah\"\n  ]\n}\n202\n{\n  \"finish_time\": null,\n  \"created_at\": \"2012-08-10T13:46:40Z\",\n  \"organization_id\": 2,\n  \"progress\": null,\n  \"system_name\": \"katello.example.com_227e003\",\n  \"task_owner_type\": \"System\",\n  \"pending?\": true,\n  \"user_id\": 1,\n  \"start_time\": null,\n  \"result\": {\n    \"errors\": [\n      null,\n      null\n    ]\n  },\n  \"uuid\": \"d03b47f5-e2f1-11e1-b07c-525400b68f90\",\n  \"updated_at\": \"2012-08-10T13:46:40Z\",\n  \"state\": \"waiting\",\n  \"task_type\": \"package_install\",\n  \"task_owner_id\": 1,\n  \"result_description\": \"\",\n  \"id\": 10,\n  \"parameters\": {\n    \"packages\": [\n      \"cheetah\"\n    ]\n  },\n  \"description\": \"Package Install: cheetah\"\n}"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/system_packages/create","full_description":"","apis":[{"api_url":"/api/systems/:system_id/packages","http_method":"POST","short_description":"Install packages remotely"}],"errors":[],"params":[{"allow_nil":false,"full_name":"system_id","name":"system_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":"\n<p>system identifier</p>\n"},{"allow_nil":false,"full_name":"packages","name":"packages","expected_type":"string","validator":"Array","required":false,"description":"\n<p>List of package names</p>\n"},{"allow_nil":false,"full_name":"groups","name":"groups","expected_type":"string","validator":"Array","required":false,"description":"\n<p>List of package group names</p>\n"}]},{"name":"update","examples":["PUT /api/systems/3050eb45-0ec4-43ea-8913-83635f06a2b7/packages\n{\n  \"packages\": [\n    \"cheetah\"\n  ]\n}\n202\n{\n  \"finish_time\": null,\n  \"created_at\": \"2012-08-10T13:47:09Z\",\n  \"organization_id\": 2,\n  \"progress\": null,\n  \"system_name\": \"katello.example.com_227e003\",\n  \"task_owner_type\": \"System\",\n  \"pending?\": true,\n  \"user_id\": 1,\n  \"start_time\": null,\n  \"result\": {\n    \"errors\": [\n      null,\n      null\n    ]\n  },\n  \"uuid\": \"e15873ca-e2f1-11e1-a0a5-525400b68f90\",\n  \"updated_at\": \"2012-08-10T13:47:09Z\",\n  \"state\": \"waiting\",\n  \"task_type\": \"package_update\",\n  \"task_owner_id\": 1,\n  \"result_description\": \"\",\n  \"id\": 11,\n  \"parameters\": {\n    \"packages\": [\n      \"cheetah\"\n    ]\n  },\n  \"description\": \"Package Update: cheetah\"\n}"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/system_packages/update","full_description":"","apis":[{"api_url":"/api/systems/:system_id/packages","http_method":"PUT","short_description":"Update packages remotely"}],"errors":[],"params":[{"allow_nil":false,"full_name":"system_id","name":"system_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":"\n<p>system identifier</p>\n"},{"allow_nil":false,"full_name":"packages","name":"packages","expected_type":"string","validator":"Array","required":false,"description":"\n<p>list of packages names</p>\n"}]},{"name":"destroy","examples":["DELETE /api/systems/3050eb45-0ec4-43ea-8913-83635f06a2b7/packages\n{\n  \"packages\": [\n    \"cheetah\"\n  ]\n}\n202\n{\n  \"finish_time\": null,\n  \"created_at\": \"2012-08-10T13:47:12Z\",\n  \"organization_id\": 2,\n  \"progress\": null,\n  \"system_name\": \"katello.example.com_227e003\",\n  \"task_owner_type\": \"System\",\n  \"pending?\": true,\n  \"user_id\": 1,\n  \"start_time\": null,\n  \"result\": {\n    \"errors\": [\n      null,\n      null\n    ]\n  },\n  \"uuid\": \"e31919fa-e2f1-11e1-ac21-525400b68f90\",\n  \"updated_at\": \"2012-08-10T13:47:12Z\",\n  \"state\": \"waiting\",\n  \"task_type\": \"package_remove\",\n  \"task_owner_id\": 1,\n  \"result_description\": \"\",\n  \"id\": 12,\n  \"parameters\": {\n    \"packages\": [\n      \"cheetah\"\n    ]\n  },\n  \"description\": \"Package Remove: cheetah\"\n}"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/system_packages/destroy","full_description":"","apis":[{"api_url":"/api/systems/:system_id/packages","http_method":"DELETE","short_description":"Uninstall packages remotely"}],"errors":[],"params":[{"allow_nil":false,"full_name":"system_id","name":"system_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":"\n<p>system identifier</p>\n"},{"allow_nil":false,"full_name":"packages","name":"packages","expected_type":"string","validator":"Array","required":false,"description":"\n<p>List of package names</p>\n"},{"allow_nil":false,"full_name":"groups","name":"groups","expected_type":"string","validator":"Array","required":false,"description":"\n<p>List of package group names</p>\n"}]}]},"compute_resources":{"name":"Compute resources","api_url":"/api","version":"1.0","doc_url":"../apidoc/1.0/compute_resources","formats":null,"full_description":"\n<p>The Architectures API is available only if support for Foreman is\ninstalled.</p>\n","short_description":null,"methods":[{"name":"index","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/compute_resources/index","full_description":"","apis":[{"api_url":"/api/compute_resources","http_method":"GET","short_description":"Get list of compute resources available in Foreman"}],"errors":[],"params":[]},{"name":"show","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/compute_resources/show","full_description":"","apis":[{"api_url":"/api/compute_resources/:id","http_method":"GET","short_description":"Show an compute resource"}],"errors":[],"params":[{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"String","required":true,"description":"\n<p>compute resource name</p>\n"}]},{"name":"create","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/compute_resources/create","full_description":"","apis":[{"api_url":"/api/compute_resources","http_method":"POST","short_description":"Create new compute resource in Foreman"}],"errors":[],"params":[{"allow_nil":false,"full_name":"compute_resource","name":"compute_resource","expected_type":"hash","validator":"Hash","required":true,"params":[{"name":"name","full_name":"compute_resource[name]","allow_nil":false,"expected_type":"string","validator":"String","required":true,"description":""},{"name":"provider","full_name":"compute_resource[provider]","allow_nil":false,"expected_type":"string","validator":"String","required":true,"description":"\n<p>Providers include Libvirt, Ovirt, EC2, Vmware, Openstack, Rackspace</p>\n"},{"name":"url","full_name":"compute_resource[url]","allow_nil":false,"expected_type":"string","validator":"String","required":true,"description":"\n<p>URL for Libvirt, Ovirt, and Openstack</p>\n"},{"name":"description","full_name":"compute_resource[description]","allow_nil":true,"expected_type":"string","validator":"String","required":false,"description":""},{"name":"user","full_name":"compute_resource[user]","allow_nil":true,"expected_type":"string","validator":"String","required":false,"description":"\n<p>Username for Ovirt, EC2, Vmware, Openstack. Access Key for EC2.</p>\n"},{"name":"password","full_name":"compute_resource[password]","allow_nil":true,"expected_type":"string","validator":"String","required":false,"description":"\n<p>Password for Ovirt, EC2, Vmware, Openstack. Secret key for EC2</p>\n"},{"name":"uuid","full_name":"compute_resource[uuid]","allow_nil":true,"expected_type":"string","validator":"String","required":false,"description":"\n<p>for Ovirt, Vmware Datacenter</p>\n"},{"name":"region","full_name":"compute_resource[region]","allow_nil":true,"expected_type":"string","validator":"String","required":false,"description":"\n<p>for EC2 only</p>\n"},{"name":"tenant","full_name":"compute_resource[tenant]","allow_nil":true,"expected_type":"string","validator":"String","required":false,"description":"\n<p>for Openstack only</p>\n"},{"name":"server","full_name":"compute_resource[server]","allow_nil":true,"expected_type":"string","validator":"String","required":false,"description":"\n<p>for Vmware</p>\n"}],"description":"\n<p>compute resource info</p>\n"}]},{"name":"update","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/compute_resources/update","full_description":"","apis":[{"api_url":"/api/compute_resources/:id","http_method":"PUT","short_description":"Update an compute resource record in Foreman"}],"errors":[],"params":[{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"String","required":true,"description":"\n<p>compute resource name</p>\n"},{"allow_nil":false,"full_name":"compute_resource","name":"compute_resource","expected_type":"hash","validator":"Hash","required":true,"params":[{"name":"name","full_name":"compute_resource[name]","allow_nil":false,"expected_type":"string","validator":"String","required":false,"description":""},{"name":"provider","full_name":"compute_resource[provider]","allow_nil":false,"expected_type":"string","validator":"String","required":false,"description":"\n<p>Providers include Libvirt, Ovirt, EC2, Vmware, Openstack, Rackspace</p>\n"},{"name":"url","full_name":"compute_resource[url]","allow_nil":false,"expected_type":"string","validator":"String","required":false,"description":"\n<p>URL for Libvirt, Ovirt, and Openstack</p>\n"},{"name":"description","full_name":"compute_resource[description]","allow_nil":true,"expected_type":"string","validator":"String","required":false,"description":""},{"name":"user","full_name":"compute_resource[user]","allow_nil":true,"expected_type":"string","validator":"String","required":false,"description":"\n<p>Username for Ovirt, EC2, Vmware, Openstack. Access Key for EC2.</p>\n"},{"name":"password","full_name":"compute_resource[password]","allow_nil":true,"expected_type":"string","validator":"String","required":false,"description":"\n<p>Password for Ovirt, EC2, Vmware, Openstack. Secret key for EC2</p>\n"},{"name":"uuid","full_name":"compute_resource[uuid]","allow_nil":true,"expected_type":"string","validator":"String","required":false,"description":"\n<p>for Ovirt, Vmware Datacenter</p>\n"},{"name":"region","full_name":"compute_resource[region]","allow_nil":true,"expected_type":"string","validator":"String","required":false,"description":"\n<p>for EC2 only</p>\n"},{"name":"tenant","full_name":"compute_resource[tenant]","allow_nil":true,"expected_type":"string","validator":"String","required":false,"description":"\n<p>for Openstack only</p>\n"},{"name":"server","full_name":"compute_resource[server]","allow_nil":true,"expected_type":"string","validator":"String","required":false,"description":"\n<p>for Vmware</p>\n"}],"description":"\n<p>compute resource info</p>\n"}]},{"name":"destroy","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/compute_resources/destroy","full_description":"","apis":[{"api_url":"/api/compute_resources/:id","http_method":"DELETE","short_description":"Remove an compute resource from Foreman"}],"errors":[],"params":[{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"String","required":true,"description":"\n<p>compute resource name</p>\n"}]}]},"ping":{"name":"Ping","api_url":"/api","version":"1.0","doc_url":"../apidoc/1.0/ping","formats":null,"full_description":null,"short_description":null,"methods":[{"name":"index","examples":["GET /api/ping/\n200\n{\n  \"result\": \"fail\",\n  \"status\": {\n    \"pulp_auth\": {\n      \"result\": \"ok\",\n      \"duration_ms\": \"183\"\n    },\n    \"candlepin_auth\": {\n      \"result\": \"ok\",\n      \"duration_ms\": \"83\"\n    },\n    \"pulp\": {\n      \"result\": \"ok\",\n      \"duration_ms\": \"99\"\n    },\n    \"candlepin\": {\n      \"result\": \"ok\",\n      \"duration_ms\": \"191\"\n    },\n    \"katello_jobs\": {\n      \"result\": \"fail\",\n      \"message\": \"katello-jobs service not running\"\n    },\n    \"elasticsearch\": {\n      \"result\": \"ok\",\n      \"duration_ms\": \"15\"\n    }\n  }\n}"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/ping/index","full_description":"\n<p>This service is only available for authenticated users</p>\n","apis":[{"api_url":"/api/ping","http_method":"GET","short_description":"Shows status of system and it's subcomponents"}],"errors":[],"params":[]},{"name":"status","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/ping/status","full_description":"\n<p>This service is also available for unauthenticated users</p>\n","apis":[{"api_url":"/api/status","http_method":"GET","short_description":"Shows version information"}],"errors":[],"params":[]},{"name":"version","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/ping/version","full_description":"\n<p>This service is only available for authenticated users</p>\n","apis":[{"api_url":"/api/version","http_method":"GET","short_description":"Shows name and version information"}],"errors":[],"params":[]}]},"permissions":{"name":"Permissions","api_url":"/api","version":"1.0","doc_url":"../apidoc/1.0/permissions","formats":null,"full_description":null,"short_description":null,"methods":[{"name":"index","examples":["GET /api/roles/6/permissions/\n200\n[\n  {\n    \"verbs\": [\n      {\n        \"created_at\": \"2012-08-10T13:41:09Z\",\n        \"permission_id\": \"14\",\n        \"updated_at\": \"2012-08-10T13:41:09Z\",\n        \"verb\": \"read_contents\",\n        \"id\": 3,\n        \"verb_id\": \"3\"\n      }\n    ],\n    \"created_at\": \"2012-08-10T13:50:10Z\",\n    \"name\": \"env_perm_227e003_2\",\n    \"organization_id\": 2,\n    \"resource_type\": {\n      \"created_at\": \"2012-08-10T13:41:09Z\",\n      \"name\": \"environments\",\n      \"updated_at\": \"2012-08-10T13:41:09Z\",\n      \"id\": 4\n    },\n    \"all_verbs\": false,\n    \"tags\": [\n      {\n        \"created_at\": \"2012-08-10T13:50:10Z\",\n        \"formatted\": {\n          \"name\": 2,\n          \"display_name\": \"Library\"\n        },\n        \"tag_id\": 2,\n        \"permission_id\": 14,\n        \"updated_at\": \"2012-08-10T13:50:10Z\",\n        \"id\": 1\n      }\n    ],\n    \"resource_type_id\": 4,\n    \"updated_at\": \"2012-08-10T13:50:10Z\",\n    \"all_tags\": false,\n    \"role_id\": 6,\n    \"id\": 14,\n    \"description\": null\n  },\n  {\n    \"verbs\": [\n      {\n        \"created_at\": \"2012-08-10T13:41:09Z\",\n        \"permission_id\": \"13\",\n        \"updated_at\": \"2012-08-10T13:41:09Z\",\n        \"verb\": \"read_contents\",\n        \"id\": 3,\n        \"verb_id\": \"3\"\n      }\n    ],\n    \"created_at\": \"2012-08-10T13:50:09Z\",\n    \"name\": \"env_perm_227e003\",\n    \"organization_id\": null,\n    \"resource_type\": {\n      \"created_at\": \"2012-08-10T13:41:09Z\",\n      \"name\": \"environments\",\n      \"updated_at\": \"2012-08-10T13:41:09Z\",\n      \"id\": 4\n    },\n    \"all_verbs\": false,\n    \"tags\": [],\n    \"resource_type_id\": 4,\n    \"updated_at\": \"2012-08-10T13:50:09Z\",\n    \"all_tags\": true,\n    \"role_id\": 6,\n    \"id\": 13,\n    \"description\": null\n  },\n  {\n    \"verbs\": [],\n    \"created_at\": \"2012-08-10T13:50:08Z\",\n    \"name\": \"all_perm_227e003_2\",\n    \"organization_id\": 2,\n    \"resource_type\": {\n      \"created_at\": \"2012-08-10T13:41:08Z\",\n      \"name\": \"all\",\n      \"updated_at\": \"2012-08-10T13:41:08Z\",\n      \"id\": 1\n    },\n    \"all_verbs\": true,\n    \"tags\": [],\n    \"resource_type_id\": 1,\n    \"updated_at\": \"2012-08-10T13:50:08Z\",\n    \"all_tags\": true,\n    \"role_id\": 6,\n    \"id\": 12,\n    \"description\": null\n  },\n  {\n    \"verbs\": [],\n    \"created_at\": \"2012-08-10T13:50:08Z\",\n    \"name\": \"all_perm_227e003\",\n    \"organization_id\": null,\n    \"resource_type\": {\n      \"created_at\": \"2012-08-10T13:41:08Z\",\n      \"name\": \"all\",\n      \"updated_at\": \"2012-08-10T13:41:08Z\",\n      \"id\": 1\n    },\n    \"all_verbs\": true,\n    \"tags\": [],\n    \"resource_type_id\": 1,\n    \"updated_at\": \"2012-08-10T13:50:08Z\",\n    \"all_tags\": true,\n    \"role_id\": 6,\n    \"id\": 11,\n    \"description\": null\n  }\n]"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/permissions/index","full_description":"","apis":[{"api_url":"/api/roles/:role_id/permissions","http_method":"GET","short_description":"List permissions for a role"}],"errors":[],"params":[{"allow_nil":false,"full_name":"name","name":"name","expected_type":"string","validator":"String","required":false,"description":"\n<p>filter by name</p>\n"},{"allow_nil":false,"full_name":"description","name":"description","expected_type":"string","validator":"String","required":false,"description":"\n<p>filter by description</p>\n"},{"allow_nil":false,"full_name":"all_verbs","name":"all_verbs","expected_type":"string","validator":"boolean","required":false,"description":"\n<p>filter by all_verbs flag</p>\n"},{"allow_nil":false,"full_name":"all_tags","name":"all_tags","expected_type":"string","validator":"boolean","required":false,"description":"\n<p>filter by all_flags flag</p>\n"}]},{"name":"show","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/permissions/show","full_description":"","apis":[{"api_url":"/api/roles/:role_id/permissions/:id","http_method":"GET","short_description":"Show a permission"}],"errors":[],"params":[]},{"name":"create","examples":["POST /api/roles/6/permissions/\n{\n  \"verbs\": [],\n  \"name\": \"all_perm_227e003\",\n  \"organization_id\": null,\n  \"type\": \"all\",\n  \"tags\": [],\n  \"description\": null\n}\n200\n{\n  \"verbs\": [],\n  \"created_at\": \"2012-08-10T13:50:08Z\",\n  \"name\": \"all_perm_227e003\",\n  \"organization_id\": null,\n  \"resource_type\": {\n    \"created_at\": \"2012-08-10T13:41:08Z\",\n    \"name\": \"all\",\n    \"updated_at\": \"2012-08-10T13:41:08Z\",\n    \"id\": 1\n  },\n  \"all_verbs\": true,\n  \"tags\": [],\n  \"resource_type_id\": 1,\n  \"updated_at\": \"2012-08-10T13:50:08Z\",\n  \"all_tags\": true,\n  \"role_id\": 6,\n  \"id\": 11,\n  \"description\": null\n}"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/permissions/create","full_description":"","apis":[{"api_url":"/api/roles/:role_id/permissions","http_method":"POST","short_description":"Create a roles permission"}],"errors":[],"params":[{"allow_nil":true,"full_name":"description","name":"description","expected_type":"string","validator":"String","required":false,"description":""},{"allow_nil":false,"full_name":"name","name":"name","expected_type":"string","validator":"String","required":true,"description":""},{"allow_nil":false,"full_name":"organization_id","name":"organization_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":false,"description":""},{"allow_nil":false,"full_name":"tags","name":"tags","expected_type":"string","validator":"Array","required":false,"description":"\n<p>array of tag ids</p>\n"},{"allow_nil":false,"full_name":"type","name":"type","expected_type":"string","validator":"String","required":true,"description":"\n<p>name of a resource or \u2018all\u2019</p>\n"},{"allow_nil":false,"full_name":"verbs","name":"verbs","expected_type":"string","validator":"Array","required":false,"description":"\n<p>array of permission verbs</p>\n"},{"allow_nil":false,"full_name":"all_tags","name":"all_tags","expected_type":"string","validator":"boolean","required":false,"description":"\n<p>True if the permission should use all tags</p>\n"}]},{"name":"destroy","examples":["DELETE /api/roles/6/permissions/11\n200\nDeleted permission '11'"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/permissions/destroy","full_description":"","apis":[{"api_url":"/api/roles/:role_id/permissions/:id","http_method":"DELETE","short_description":"Destroy a roles permission"}],"errors":[],"params":[]}]},"sync_plans":{"name":"Sync plans","api_url":"/api","version":"1.0","doc_url":"../apidoc/1.0/sync_plans","formats":null,"full_description":"\n<p>Synchronization plans are used to configure the scheduled synchronization\nof the repository with the upstream.</p>\n","short_description":null,"methods":[{"name":"index","examples":["GET /api/organizations/org_227e003/sync_plans/\n200\n[\n  {\n    \"created_at\": \"2012-08-10T13:56:21Z\",\n    \"name\": \"plan_1\",\n    \"organization_id\": 2,\n    \"updated_at\": \"2012-08-10T13:56:21Z\",\n    \"sync_date\": \"2012-08-11T07:00:00Z\",\n    \"interval\": \"weekly\",\n    \"id\": 1,\n    \"description\": \"plan 1 desc.\"\n  },\n  {\n    \"created_at\": \"2012-08-10T13:56:21Z\",\n    \"name\": \"plan_2\",\n    \"organization_id\": 2,\n    \"updated_at\": \"2012-08-10T13:56:21Z\",\n    \"sync_date\": \"2012-08-11T07:00:00Z\",\n    \"interval\": \"none\",\n    \"id\": 2,\n    \"description\": \"plan 2 desc.\"\n  }\n]"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/sync_plans/index","full_description":"","apis":[{"api_url":"/api/organizations/:organization_id/sync_plans","http_method":"GET","short_description":"List sync plans"}],"errors":[],"params":[{"allow_nil":false,"full_name":"organization_id","name":"organization_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":"\n<p>oranization identifier</p>\n"},{"allow_nil":false,"full_name":"name","name":"name","expected_type":"string","validator":"String","required":false,"description":"\n<p>filter by name</p>\n"},{"allow_nil":false,"full_name":"sync_date","name":"sync_date","expected_type":"string","validator":"String","required":false,"description":"\n<p>filter by sync date</p>\n"},{"allow_nil":false,"full_name":"interval","name":"interval","expected_type":"string","validator":"Must be one of: none, hourly, daily, weekly.","required":false,"description":"\n<p>filter by interval</p>\n"}]},{"name":"show","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/sync_plans/show","full_description":"","apis":[{"api_url":"/api/organizations/:organization_id/sync_plans/:id","http_method":"GET","short_description":"Show a sync plan"}],"errors":[],"params":[{"allow_nil":false,"full_name":"organization_id","name":"organization_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":"\n<p>oranization identifier</p>\n"},{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"number.","required":true,"description":"\n<p>sync plan numeric identifier</p>\n"}]},{"name":"create","examples":["POST /api/organizations/org_227e003/sync_plans/\n{\n  \"sync_plan\": {\n    \"name\": \"plan_1\",\n    \"sync_date\": \"2012-08-11T09:00:00+02:00\",\n    \"interval\": \"weekly\",\n    \"description\": \"plan 1 desc.\"\n  }\n}\n200\n{\n  \"created_at\": \"2012-08-10T13:56:21Z\",\n  \"name\": \"plan_1\",\n  \"organization_id\": 2,\n  \"updated_at\": \"2012-08-10T13:56:21Z\",\n  \"sync_date\": \"2012-08-11T07:00:00Z\",\n  \"interval\": \"weekly\",\n  \"id\": 1,\n  \"description\": \"plan 1 desc.\"\n}"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/sync_plans/create","full_description":"","apis":[{"api_url":"/api/organizations/:organization_id/sync_plans","http_method":"POST","short_description":"Create a sync plan"}],"errors":[],"params":[{"allow_nil":false,"full_name":"organization_id","name":"organization_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":"\n<p>oranization identifier</p>\n"},{"allow_nil":false,"full_name":"sync_plan","name":"sync_plan","expected_type":"hash","validator":"Hash","required":true,"params":[{"name":"name","full_name":"sync_plan[name]","allow_nil":false,"expected_type":"string","validator":"String","required":true,"description":"\n<p>sync plan name</p>\n"},{"name":"interval","full_name":"sync_plan[interval]","allow_nil":true,"expected_type":"string","validator":"Must be one of: none, hourly, daily, weekly.","required":false,"description":"\n<p>how often synchronization should run</p>\n"},{"name":"sync_date","full_name":"sync_plan[sync_date]","allow_nil":true,"expected_type":"string","validator":"String","required":false,"description":"\n<p>start datetime of synchronization</p>\n"},{"name":"description","full_name":"sync_plan[description]","allow_nil":true,"expected_type":"string","validator":"String","required":false,"description":"\n<p>sync plan description</p>\n"}],"description":""}]},{"name":"update","examples":["PUT /api/organizations/org_227e003/sync_plans/1\n{\n  \"sync_plan\": {\n    \"name\": \"plan_1_updated\",\n    \"sync_date\": \"2012-08-11T10:10:10+02:00\",\n    \"interval\": \"daily\",\n    \"description\": \"new plan 1 desc.\"\n  }\n}\n200\n{\n  \"created_at\": \"2012-08-10T13:56:21Z\",\n  \"name\": \"plan_1_updated\",\n  \"organization_id\": 2,\n  \"updated_at\": \"2012-08-10T13:56:22Z\",\n  \"sync_date\": \"2012-08-11T08:10:10Z\",\n  \"interval\": \"daily\",\n  \"id\": 1,\n  \"description\": \"new plan 1 desc.\"\n}"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/sync_plans/update","full_description":"","apis":[{"api_url":"/api/organizations/:organization_id/sync_plans/:id","http_method":"PUT","short_description":"Update a sync plan"}],"errors":[],"params":[{"allow_nil":false,"full_name":"organization_id","name":"organization_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":"\n<p>oranization identifier</p>\n"},{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"number.","required":true,"description":"\n<p>sync plan numeric identifier</p>\n"},{"allow_nil":false,"full_name":"sync_plan","name":"sync_plan","expected_type":"hash","validator":"Hash","required":true,"params":[{"name":"name","full_name":"sync_plan[name]","allow_nil":false,"expected_type":"string","validator":"String","required":false,"description":"\n<p>sync plan name</p>\n"},{"name":"interval","full_name":"sync_plan[interval]","allow_nil":true,"expected_type":"string","validator":"Must be one of: none, hourly, daily, weekly.","required":false,"description":"\n<p>how often synchronization should run</p>\n"},{"name":"sync_date","full_name":"sync_plan[sync_date]","allow_nil":true,"expected_type":"string","validator":"String","required":false,"description":"\n<p>start datetime of synchronization</p>\n"},{"name":"description","full_name":"sync_plan[description]","allow_nil":true,"expected_type":"string","validator":"String","required":false,"description":"\n<p>sync plan description</p>\n"}],"description":""}]},{"name":"destroy","examples":["DELETE /api/organizations/org_227e003/sync_plans/1\n200\nDeleted sync plan '1'"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/sync_plans/destroy","full_description":"","apis":[{"api_url":"/api/organizations/:organization_id/sync_plans/:id","http_method":"DELETE","short_description":"Destroy a sync plan"}],"errors":[],"params":[{"allow_nil":false,"full_name":"organization_id","name":"organization_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":"\n<p>oranization identifier</p>\n"},{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"number.","required":false,"description":"\n<p>sync plan numeric identifier</p>\n"}]}]},"crls":{"name":"Crls","api_url":"/api","version":"1.0","doc_url":"../apidoc/1.0/crls","formats":null,"full_description":null,"short_description":null,"methods":[{"name":"index","examples":["GET /api/crls/\n200\n-----BEGIN X509 CRL-----\nMIICjDCCAXQCAQEwDQYJKoZIhvcNAQEFBQAwfTELMAkGA1UEBhMCVVMxFzAVBgNV\nBAgTDk5vcnRoIENhcm9saW5hMRAwDgYDVQQHEwdSYWxlaWdoMRAwDgYDVQQKEwdS\nZWQgSGF0MREwDwYDVQQLEwhDbG91ZCBCVTEeMBwGA1UEAxMVcmhlbDYzLWthdDgu\naW5lY2FzLmN6Fw0xMjA4MTAxMzQzMDNaFw0xMjA4MTExMzQzMDNaoIHCMIG/MIGw\nBgNVHSMEgagwgaWAFMliTcF7cxwV1nAAMS0F8rPX9OKEoYGBpH8wfTELMAkGA1UE\nBhMCVVMxFzAVBgNVBAgTDk5vcnRoIENhcm9saW5hMRAwDgYDVQQHEwdSYWxlaWdo\nMRAwDgYDVQQKEwdSZWQgSGF0MREwDwYDVQQLEwhDbG91ZCBCVTEeMBwGA1UEAxMV\ncmhlbDYzLWthdDguaW5lY2FzLmN6ggkAskjXhJ4iy9IwCgYDVR0UBAMCAQEwDQYJ\nKoZIhvcNAQEFBQADggEBAC33nZagQA9O2kLnpNcvh0TcJipMutvycmTA2MeMPXAW\noAi1n7K2xbGW/PcRVHWNVSghtJCizB0YVpCEiu0Wlk4k0eoUijLzDKnlSU2UCa3X\nzdJMKoazEaWQTDdT9qIGHbAPb2sLy9sr+G1XQ4HVnzvKRxSbr128R0z9qfI2846p\niKiODEaqETCMY2zLlCwm/wYYjrXf87HN5RkfyrWjZFqlFYBFfbjHZvQ3NN3DvDcN\nZKUGZ7qvdS2yRWuhBkANq2eJqYU54u3IK/zoZKi5pRUNoO3B8f3ztlk+7ZTMDK23\nFySrbxcOW3hYc7aB3mnCATECnG/MfiGoeqfGZsl0cBw=\n-----END X509 CRL-----\n"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/crls/index","full_description":"","apis":[{"api_url":"/api/crls","http_method":"GET","short_description":"Regenerate X.509 CRL immediately and return them"}],"errors":[],"params":[]}]},"templates_content":{"name":"Templates content","api_url":"/api","version":"1.0","doc_url":"../apidoc/1.0/templates_content","formats":null,"full_description":"\n<p>Provides interface to the template content.</p>\n","short_description":null,"methods":[{"name":"add_package","examples":["POST /api/templates/1/packages/\n{\n  \"name\": \"cheetah\"\n}\n200\nAdded package 'cheetah'"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/templates_content/add_package","full_description":"","apis":[{"api_url":"/api/templates/:template_id/packages","http_method":"POST","short_description":"Add a package"}],"errors":[],"params":[{"allow_nil":false,"full_name":"template_id","name":"template_id","expected_type":"string","validator":"number.","required":true,"description":"\n<p>template numeric identifier</p>\n"},{"allow_nil":false,"full_name":"name","name":"name","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":"\n<p>package identifier</p>\n"}]},{"name":"remove_package","examples":["DELETE /api/templates/3/packages/cheetah/\n200\nRemoved package 'cheetah'"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/templates_content/remove_package","full_description":"","apis":[{"api_url":"/api/templates/:template_id/packages/:id","http_method":"DELETE","short_description":"Remove a package"}],"errors":[],"params":[{"allow_nil":false,"full_name":"template_id","name":"template_id","expected_type":"string","validator":"number.","required":true,"description":"\n<p>template numeric identifier</p>\n"},{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":"\n<p>package identifier</p>\n"}]},{"name":"add_parameter","examples":["POST /api/templates/3/parameters/\n{\n  \"name\": \"attr\",\n  \"value\": \"X\"\n}\n200\nParameter 'attr': 'X' was set"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/templates_content/add_parameter","full_description":"","apis":[{"api_url":"/api/templates/:template_id/parameters","http_method":"POST","short_description":"Set parameter value"}],"errors":[],"params":[{"allow_nil":false,"full_name":"template_id","name":"template_id","expected_type":"string","validator":"number.","required":true,"description":"\n<p>template numeric identifier</p>\n"},{"allow_nil":false,"full_name":"name","name":"name","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":"\n<p>parameter identifier</p>\n"},{"allow_nil":false,"full_name":"value","name":"value","expected_type":"string","validator":"String","required":true,"description":"\n<p>parameter value</p>\n"}]},{"name":"remove_parameter","examples":["DELETE /api/templates/3/parameters/attr/\n200\nRemoved parameter 'attr'"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/templates_content/remove_parameter","full_description":"","apis":[{"api_url":"/api/templates/:template_id/parameters/:id","http_method":"DELETE","short_description":"Remove parameter"}],"errors":[],"params":[{"allow_nil":false,"full_name":"template_id","name":"template_id","expected_type":"string","validator":"number.","required":true,"description":"\n<p>template numeric identifier</p>\n"},{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":"\n<p>parameter identifier</p>\n"}]},{"name":"add_package_group","examples":["POST /api/templates/3/package_groups/\n{\n  \"name\": \"mammal\"\n}\n200\nAdded package group 'mammal'"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/templates_content/add_package_group","full_description":"","apis":[{"api_url":"/api/templates/:template_id/package_groups","http_method":"POST","short_description":"Add package group"}],"errors":[],"params":[{"allow_nil":false,"full_name":"template_id","name":"template_id","expected_type":"string","validator":"number.","required":true,"description":"\n<p>template numeric identifier</p>\n"},{"allow_nil":false,"full_name":"name","name":"name","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":"\n<p>package group identifier</p>\n"}]},{"name":"remove_package_group","examples":["DELETE /api/templates/3/package_groups/mammal/\n200\nRemoved package group 'mammal'"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/templates_content/remove_package_group","full_description":"","apis":[{"api_url":"/api/templates/:template_id/package_groups/:id","http_method":"DELETE","short_description":"Remove package group"}],"errors":[],"params":[{"allow_nil":false,"full_name":"template_id","name":"template_id","expected_type":"string","validator":"number.","required":true,"description":"\n<p>template numeric identifier</p>\n"},{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":"\n<p>package group identifier</p>\n"}]},{"name":"add_package_group_category","examples":["POST /api/templates/3/package_group_categories/\n{\n  \"name\": \"all\"\n}\n200\nAdded package group category 'all'"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/templates_content/add_package_group_category","full_description":"","apis":[{"api_url":"/api/templates/:template_id/package_group_categories","http_method":"POST","short_description":"Add package group category"}],"errors":[],"params":[{"allow_nil":false,"full_name":"template_id","name":"template_id","expected_type":"string","validator":"number.","required":true,"description":"\n<p>template numeric identifier</p>\n"},{"allow_nil":false,"full_name":"name","name":"name","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":"\n<p>package group category identifier</p>\n"}]},{"name":"remove_package_group_category","examples":["DELETE /api/templates/3/package_group_categories/all/\n200\nRemoved package group category 'all'"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/templates_content/remove_package_group_category","full_description":"","apis":[{"api_url":"/api/templates/:template_id/package_group_categories/:id","http_method":"DELETE","short_description":"Remove package group category"}],"errors":[],"params":[{"allow_nil":false,"full_name":"template_id","name":"template_id","expected_type":"string","validator":"number.","required":true,"description":"\n<p>template numeric identifier</p>\n"},{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":"\n<p>package group category identifier</p>\n"}]},{"name":"add_distribution","examples":["POST /api/templates/3/distributions/\n{\n  \"id\": \"ks-Test Family-TestVariant-16-x86_64\"\n}\n200\nAdded distribution 'ks-Test Family-TestVariant-16-x86_64'"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/templates_content/add_distribution","full_description":"","apis":[{"api_url":"/api/templates/:template_id/distributions","http_method":"POST","short_description":"Add distribution"}],"errors":[],"params":[{"allow_nil":false,"full_name":"template_id","name":"template_id","expected_type":"string","validator":"number.","required":true,"description":"\n<p>template numeric identifier</p>\n"},{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":"\n<p>distribution identifier</p>\n"}]},{"name":"remove_distribution","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/templates_content/remove_distribution","full_description":"","apis":[{"api_url":"/api/templates/:template_id/distributions/:id","http_method":"DELETE","short_description":"Remove distribution"}],"errors":[],"params":[{"allow_nil":false,"full_name":"template_id","name":"template_id","expected_type":"string","validator":"number.","required":true,"description":"\n<p>template numeric identifier</p>\n"},{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":"\n<p>distribution identifier</p>\n"}]},{"name":"add_repo","examples":["POST /api/templates/3/repositories/\n{\n  \"id\": 2\n}\n200\nAdded repository '2'"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/templates_content/add_repo","full_description":"","apis":[{"api_url":"/api/templates/:template_id/repositories","http_method":"POST","short_description":"Add repository"}],"errors":[],"params":[{"allow_nil":false,"full_name":"template_id","name":"template_id","expected_type":"string","validator":"number.","required":true,"description":"\n<p>template numeric identifier</p>\n"},{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"number.","required":true,"description":"\n<p>repository numeric identifier</p>\n"}]},{"name":"remove_repo","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/templates_content/remove_repo","full_description":"","apis":[{"api_url":"/api/templates/:template_id/repositories/:id","http_method":"DELETE","short_description":"Remove repository"}],"errors":[],"params":[{"allow_nil":false,"full_name":"template_id","name":"template_id","expected_type":"string","validator":"number.","required":true,"description":"\n<p>template numeric identifier</p>\n"},{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"number.","required":true,"description":"\n<p>repository numeric identifier</p>\n"}]}]},"users":{"name":"Users","api_url":"/api","version":"1.0","doc_url":"../apidoc/1.0/users","formats":null,"full_description":null,"short_description":null,"methods":[{"name":"index","examples":["GET /api/users/?username=user_227e003\n200\n[\n  {\n    \"created_at\": \"2012-08-10T13:42:38Z\",\n    \"page_size\": 25,\n    \"disabled\": false,\n    \"email\": \"user_227e003@somewhere.com\",\n    \"preferences\": {},\n    \"helptips_enabled\": true,\n    \"password\": \"7e5370c1fc6863c751c38ff7a2fb7ae30f8d0510a3a17ef3d7b9002fa34548f4e1d8174b5e054bc3e63064e67990b7081a9ce4bb10447a29a921f4615f225fa0fuwnxQ4rWaJzauNX9vO9tJPfqAsixwLB4ixMEJxiTXRECjFc0DcJTbwoxQTYhRpc\",\n    \"own_role_id\": 5,\n    \"default_organization\": null,\n    \"updated_at\": \"2012-08-10T13:42:38Z\",\n    \"password_reset_token\": null,\n    \"default_environment\": null,\n    \"password_reset_sent_at\": null,\n    \"hidden\": false,\n    \"id\": 3,\n    \"username\": \"user_227e003\"\n  }\n]"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/users/index","full_description":"","apis":[{"api_url":"/api/users","http_method":"GET","short_description":"List users"}],"errors":[],"params":[{"allow_nil":false,"full_name":"email","name":"email","expected_type":"string","validator":"String","required":false,"description":"\n<p>filter by email</p>\n"},{"allow_nil":false,"full_name":"disabled","name":"disabled","expected_type":"string","validator":"boolean","required":false,"description":"\n<p>filter by disabled flag</p>\n"},{"allow_nil":false,"full_name":"username","name":"username","expected_type":"string","validator":"String","required":false,"description":"\n<p>filter by username</p>\n"}]},{"name":"show","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/users/show","full_description":"","apis":[{"api_url":"/api/users/:id","http_method":"GET","short_description":"Show a user"}],"errors":[],"params":[]},{"name":"create","examples":["POST /api/users/\n{\n  \"disabled\": false,\n  \"email\": \"user_227e003@somewhere.com\",\n  \"password\": \"password\",\n  \"username\": \"user_227e003\"\n}\n200\n{\n  \"created_at\": \"2012-08-10T13:42:38Z\",\n  \"page_size\": 25,\n  \"disabled\": false,\n  \"email\": \"user_227e003@somewhere.com\",\n  \"preferences\": {},\n  \"helptips_enabled\": true,\n  \"password\": \"7e5370c1fc6863c751c38ff7a2fb7ae30f8d0510a3a17ef3d7b9002fa34548f4e1d8174b5e054bc3e63064e67990b7081a9ce4bb10447a29a921f4615f225fa0fuwnxQ4rWaJzauNX9vO9tJPfqAsixwLB4ixMEJxiTXRECjFc0DcJTbwoxQTYhRpc\",\n  \"own_role_id\": 5,\n  \"default_organization\": null,\n  \"updated_at\": \"2012-08-10T13:42:38Z\",\n  \"password_reset_token\": null,\n  \"default_environment\": null,\n  \"password_reset_sent_at\": null,\n  \"hidden\": false,\n  \"id\": 3,\n  \"username\": \"user_227e003\"\n}"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/users/create","full_description":"","apis":[{"api_url":"/api/users","http_method":"POST","short_description":"Create an user"}],"errors":[],"params":[{"allow_nil":false,"full_name":"username","name":"username","expected_type":"string","validator":"String","required":true,"description":""},{"allow_nil":false,"full_name":"email","name":"email","expected_type":"string","validator":"String","required":true,"description":""},{"allow_nil":false,"full_name":"password","name":"password","expected_type":"string","validator":"String","required":true,"description":""},{"allow_nil":true,"full_name":"default_environment_id","name":"default_environment_id","expected_type":"numeric","validator":"Integer","required":false,"description":""},{"allow_nil":true,"full_name":"disabled","name":"disabled","expected_type":"string","validator":"boolean","required":false,"description":""}]},{"name":"update","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/users/update","full_description":"","apis":[{"api_url":"/api/users/:id","http_method":"PUT","short_description":"Update an user"}],"errors":[],"params":[{"allow_nil":false,"full_name":"email","name":"email","expected_type":"string","validator":"String","required":false,"description":""},{"allow_nil":false,"full_name":"password","name":"password","expected_type":"string","validator":"String","required":false,"description":""},{"allow_nil":true,"full_name":"default_environment_id","name":"default_environment_id","expected_type":"numeric","validator":"Integer","required":false,"description":""},{"allow_nil":true,"full_name":"disabled","name":"disabled","expected_type":"string","validator":"boolean","required":false,"description":""}]},{"name":"destroy","examples":["DELETE /api/users/3\n200\nDeleted user '3'"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/users/destroy","full_description":"","apis":[{"api_url":"/api/users/:id","http_method":"DELETE","short_description":"Destroy an user"}],"errors":[],"params":[]},{"name":"list_roles","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/users/list_roles","full_description":"","apis":[{"api_url":"/api/users/:user_id/roles","http_method":"GET","short_description":"List roles assigned to a user"}],"errors":[],"params":[]},{"name":"sync_ldap_roles","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/users/sync_ldap_roles","full_description":"","apis":[{"api_url":"/api/users/sync_ldap_roles","http_method":"GET","short_description":"Synchronises roles for all users with LDAP groups"}],"errors":[],"params":[]},{"name":"add_role","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/users/add_role","full_description":"","apis":[{"api_url":"/api/users/:user_id/roles","http_method":"POST","short_description":"Assign a role to a user"}],"errors":[],"params":[{"allow_nil":false,"full_name":"role_id","name":"role_id","expected_type":"numeric","validator":"Integer","required":false,"description":""}]},{"name":"remove_role","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/users/remove_role","full_description":"","apis":[{"api_url":"/api/users/:user_id/roles/:id","http_method":"DELETE","short_description":"Remove user's role"}],"errors":[],"params":[]},{"name":"report","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/users/report","full_description":"","apis":[{"api_url":"/api/users/report","http_method":"GET","short_description":"Reports all users in the system in a format according to 'Accept' headers.\n  Supported formats are plain text, html, csv, pdf"}],"errors":[],"params":[]}]},"smart_proxies":{"name":"Smart proxies","api_url":"/api","version":"1.0","doc_url":"../apidoc/1.0/smart_proxies","formats":null,"full_description":"\n<p>A smart proxy is an autonomous web-based foreman component that is placed\non a host performing a specific function in the host commissioning phase.\nIt receives requests from Foreman to perform operations that are required\nduring the commissioning process and executes them on its behalf. More\ndetails can be found on the Foreman Architecture page.</p>\n\n<p>To fully manage the commissioning process then a smart proxy will have to\nmanipulate these services, DHCP, DNS, Puppet CA, Puppet and TFTP. These\nservices may exist on separate machines or several of them may be hosted on\nthe same machine. As each smart proxy instance is capable of managing all\nof these services, there is only need for one proxy per host.</p>\n\n<p>The Domains API is available only if support for Foreman is installed.</p>\n","short_description":null,"methods":[{"name":"index","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/smart_proxies/index","full_description":"","apis":[{"api_url":"/api/smart_proxies","http_method":"GET","short_description":"List of smart proxies"}],"errors":[],"params":[{"allow_nil":false,"full_name":"search","name":"search","expected_type":"string","validator":"String","required":false,"description":"\n<p>Filter results</p>\n"},{"allow_nil":false,"full_name":"order","name":"order","expected_type":"string","validator":"String","required":false,"description":"\n<p>Sort results</p>\n"}]},{"name":"show","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/smart_proxies/show","full_description":"","apis":[{"api_url":"/api/smart_proxies/:id","http_method":"GET","short_description":"Show a smart proxy."}],"errors":[],"params":[{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"String","required":false,"description":"\n<p>domain name (no slashes)</p>\n"}]},{"name":"create","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/smart_proxies/create","full_description":"\n<p>The <b>fullname</b> field is used for human readability in reports and\nother pages that refer to domains, and also available as an external node\nparameter</p>\n","apis":[{"api_url":"/api/smart_proxies","http_method":"POST","short_description":"Create a smart proxy."}],"errors":[],"params":[{"allow_nil":false,"full_name":"smart_proxy","name":"smart_proxy","expected_type":"hash","validator":"Hash","required":true,"params":[{"name":"name","full_name":"smart_proxy[name]","allow_nil":false,"expected_type":"string","validator":"String","required":true,"description":"\n<p>The smart proxy name</p>\n"},{"name":"url","full_name":"smart_proxy[url]","allow_nil":false,"expected_type":"string","validator":"String","required":true,"description":"\n<p>The smart proxy URL starting with \u2018http://\u2019 or \u2018https://\u2019</p>\n"}],"description":""}]},{"name":"update","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/smart_proxies/update","full_description":"","apis":[{"api_url":"/api/smart_proxies/:id","http_method":"PUT","short_description":"Update a smart proxy."}],"errors":[],"params":[{"allow_nil":false,"full_name":"smart_proxy","name":"smart_proxy","expected_type":"hash","validator":"Hash","required":true,"params":[{"name":"name","full_name":"smart_proxy[name]","allow_nil":false,"expected_type":"string","validator":"String","required":false,"description":"\n<p>The smart proxy name</p>\n"},{"name":"url","full_name":"smart_proxy[url]","allow_nil":false,"expected_type":"string","validator":"String","required":false,"description":"\n<p>The smart proxy URL starting with \u2018http://\u2019 or \u2018https://\u2019</p>\n"}],"description":""}]},{"name":"destroy","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/smart_proxies/destroy","full_description":"","apis":[{"api_url":"/api/smart_proxies/:id","http_method":"DELETE","short_description":"Delete a domain."}],"errors":[],"params":[{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"String","required":false,"description":"\n<p>domain name (no slashes)</p>\n"}]}]},"config_templates":{"name":"Config templates","api_url":"/api","version":"1.0","doc_url":"../apidoc/1.0/config_templates","formats":null,"full_description":null,"short_description":null,"methods":[{"name":"index","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/config_templates/index","full_description":"","apis":[{"api_url":"/api/config_templates","http_method":"GET","short_description":"List templates"}],"errors":[],"params":[{"allow_nil":false,"full_name":"search","name":"search","expected_type":"string","validator":"String","required":false,"description":"\n<p>filter results</p>\n"},{"allow_nil":false,"full_name":"order","name":"order","expected_type":"string","validator":"String","required":false,"description":"\n<p>sort results</p>\n"}]},{"name":"show","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/config_templates/show","full_description":"","apis":[{"api_url":"/api/config_templates/:id","http_method":"GET","short_description":"Show template details"}],"errors":[],"params":[]},{"name":"create","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/config_templates/create","full_description":"","apis":[{"api_url":"/api/config_templates","http_method":"POST","short_description":"Create a template"}],"errors":[],"params":[{"allow_nil":false,"full_name":"config_template","name":"config_template","expected_type":"hash","validator":"Hash","required":true,"params":[{"name":"name","full_name":"config_template[name]","allow_nil":false,"expected_type":"string","validator":"String","required":true,"description":"\n<p>template name</p>\n"},{"name":"template","full_name":"config_template[template]","allow_nil":false,"expected_type":"string","validator":"Must be one of: String, File.","required":true,"description":""},{"name":"snippet","full_name":"config_template[snippet]","allow_nil":true,"expected_type":"string","validator":"boolean","required":false,"description":""},{"name":"audit_comment","full_name":"config_template[audit_comment]","allow_nil":true,"expected_type":"string","validator":"String","required":false,"description":""},{"name":"template_kind_id","full_name":"config_template[template_kind_id]","allow_nil":true,"expected_type":"string","validator":"number.","required":false,"description":"\n<p>not relevant for snippet</p>\n"},{"name":"template_combinations_attributes","full_name":"config_template[template_combinations_attributes]","allow_nil":true,"expected_type":"string","validator":"Array","required":false,"description":"\n<p>Array of template combinations (hostgroup_id, environment_id)</p>\n"}],"description":""}]},{"name":"update","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/config_templates/update","full_description":"","apis":[{"api_url":"/api/config_templates/:id","http_method":"PUT","short_description":"Update a template"}],"errors":[],"params":[{"allow_nil":false,"full_name":"config_template","name":"config_template","expected_type":"hash","validator":"Hash","required":true,"params":[{"name":"name","full_name":"config_template[name]","allow_nil":false,"expected_type":"string","validator":"String","required":false,"description":"\n<p>template name</p>\n"},{"name":"template","full_name":"config_template[template]","allow_nil":false,"expected_type":"string","validator":"Must be one of: String, File.","required":false,"description":""},{"name":"snippet","full_name":"config_template[snippet]","allow_nil":true,"expected_type":"string","validator":"boolean","required":false,"description":""},{"name":"audit_comment","full_name":"config_template[audit_comment]","allow_nil":true,"expected_type":"string","validator":"String","required":false,"description":""},{"name":"template_kind_id","full_name":"config_template[template_kind_id]","allow_nil":true,"expected_type":"string","validator":"number.","required":false,"description":"\n<p>not relevant for snippet</p>\n"},{"name":"template_combinations_attributes","full_name":"config_template[template_combinations_attributes]","allow_nil":true,"expected_type":"string","validator":"Array","required":false,"description":"\n<p>Array of template combinations (hostgroup_id, environment_id)</p>\n"}],"description":""}]},{"name":"destroy","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/config_templates/destroy","full_description":"","apis":[{"api_url":"/api/config_templates/:id","http_method":"DELETE","short_description":"Delete a template"}],"errors":[],"params":[]},{"name":"revision","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/config_templates/revision","full_description":"","apis":[{"api_url":"/api/config_templates/revision","http_method":"GET","short_description":null}],"errors":[],"params":[{"allow_nil":false,"full_name":"version","name":"version","expected_type":"string","validator":"String","required":false,"description":"\n<p>template version</p>\n"}]},{"name":"build_pxe_default","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/config_templates/build_pxe_default","full_description":"","apis":[{"api_url":"/api/config_templates/build_pxe_default","http_method":"GET","short_description":"Change the default PXE menu on all configured TFTP servers"}],"errors":[],"params":[]}]},"activation_keys":{"name":"Activation keys","api_url":"/api","version":"1.0","doc_url":"../apidoc/1.0/activation_keys","formats":null,"full_description":null,"short_description":null,"methods":[{"name":"index","examples":["GET /api/environments/3/activation_keys/\n200\n[\n  {\n    \"created_at\": \"2012-08-10T13:43:00Z\",\n    \"name\": \"activation_key_227e003\",\n    \"usage_count\": 0,\n    \"organization_id\": 2,\n    \"user_id\": 1,\n    \"usage_limit\": -1,\n    \"environment_id\": 3,\n    \"updated_at\": \"2012-08-10T13:43:00Z\",\n    \"system_template_id\": null,\n    \"pools\": [],\n    \"id\": 1,\n    \"description\": \"key description\"\n  }\n]"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/activation_keys/index","full_description":"","apis":[{"api_url":"/api/activation_keys","http_method":"GET","short_description":"List activation keys"},{"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"}],"errors":[],"params":[{"allow_nil":false,"full_name":"name","name":"name","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":false,"description":"\n<p>lists by activation key name</p>\n"}]},{"name":"show","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/activation_keys/show","full_description":"","apis":[{"api_url":"/api/activation_keys/:id","http_method":"GET","short_description":"Show an activation key"}],"errors":[],"params":[]},{"name":"create","examples":["POST /api/environments/3/activation_keys/\n{\n  \"activation_key\": {\n    \"name\": \"activation_key_227e003\",\n    \"usage_limit\": -1,\n    \"description\": \"key description\"\n  }\n}\n200\n{\n  \"created_at\": \"2012-08-10T13:43:00Z\",\n  \"name\": \"activation_key_227e003\",\n  \"usage_count\": 0,\n  \"organization_id\": 2,\n  \"user_id\": 1,\n  \"usage_limit\": -1,\n  \"environment_id\": 3,\n  \"updated_at\": \"2012-08-10T13:43:00Z\",\n  \"system_template_id\": null,\n  \"pools\": [],\n  \"id\": 1,\n  \"description\": \"key description\"\n}"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/activation_keys/create","full_description":"","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"}],"errors":[],"params":[{"allow_nil":false,"full_name":"activation_key","name":"activation_key","expected_type":"hash","validator":"Hash","required":true,"params":[{"name":"name","full_name":"activation_key[name]","allow_nil":false,"expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":"\n<p>activation key identifier (alphanum characters, space, _ and -)</p>\n"},{"name":"description","full_name":"activation_key[description]","allow_nil":true,"expected_type":"string","validator":"String","required":false,"description":""},{"name":"content_view_id","full_name":"activation_key[content_view_id]","allow_nil":true,"expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":false,"description":"\n<p>content view id</p>\n"}],"description":""}]},{"name":"update","examples":["PUT /api/activation_keys/2/\n{\n  \"activation_key\": {\n    \"environment_id\": 9\n  }\n}\n200\n{\n  \"created_at\": \"2012-08-10T13:54:45Z\",\n  \"name\": \"ak1_227e003\",\n  \"usage_count\": 0,\n  \"organization_id\": 4,\n  \"user_id\": 1,\n  \"usage_limit\": -1,\n  \"environment_id\": 9,\n  \"updated_at\": \"2012-08-10T13:54:45Z\",\n  \"system_template_id\": null,\n  \"pools\": [],\n  \"id\": 2,\n  \"description\": null\n}"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/activation_keys/update","full_description":"","apis":[{"api_url":"/api/activation_keys/:id","http_method":"PUT","short_description":"Update an activation key"}],"errors":[],"params":[{"allow_nil":false,"full_name":"activation_key","name":"activation_key","expected_type":"hash","validator":"Hash","required":true,"params":[{"name":"name","full_name":"activation_key[name]","allow_nil":false,"expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":false,"description":"\n<p>activation key identifier (alphanum characters, space, _ and -)</p>\n"},{"name":"description","full_name":"activation_key[description]","allow_nil":true,"expected_type":"string","validator":"String","required":false,"description":""},{"name":"content_view_id","full_name":"activation_key[content_view_id]","allow_nil":true,"expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":false,"description":"\n<p>content view id</p>\n"},{"name":"environment_id","full_name":"activation_key[environment_id]","allow_nil":true,"expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":false,"description":""}],"description":""}]},{"name":"add_pool","examples":["POST /api/activation_keys/2/pools\n{\n  \"poolid\": \"ff8080813910c3d3013910d0e0390063\"\n}\n200\n{\n  \"created_at\": \"2012-08-10T13:54:45Z\",\n  \"name\": \"ak1_227e003\",\n  \"usage_count\": 0,\n  \"organization_id\": 4,\n  \"user_id\": 1,\n  \"usage_limit\": -1,\n  \"environment_id\": 9,\n  \"updated_at\": \"2012-08-10T13:54:45Z\",\n  \"system_template_id\": null,\n  \"pools\": [],\n  \"id\": 2,\n  \"description\": null\n}"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/activation_keys/add_pool","full_description":"","apis":[{"api_url":"/api/activation_keys/:id/pools","http_method":"POST","short_description":"Create an entitlement pool within an activation key"}],"errors":[],"params":[]},{"name":"remove_pool","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/activation_keys/remove_pool","full_description":"","apis":[{"api_url":"/api/activation_keys/:id/pools/:poolid","http_method":"DELETE","short_description":"Delete an entitlement pool within an activation key"}],"errors":[],"params":[]},{"name":"destroy","examples":["DELETE /api/activation_keys/1/\n204"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/activation_keys/destroy","full_description":"","apis":[{"api_url":"/api/activation_keys/:id","http_method":"DELETE","short_description":"Destroy an activation key"}],"errors":[],"params":[]},{"name":"add_system_groups","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/activation_keys/add_system_groups","full_description":"","apis":[{"api_url":"/api/organizations/:organization_id/activation_keys/:id/system_groups","http_method":"POST","short_description":null}],"errors":[],"params":[]},{"name":"remove_system_groups","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/activation_keys/remove_system_groups","full_description":"","apis":[{"api_url":"/api/organizations/:organization_id/activation_keys/:id/system_groups","http_method":"DELETE","short_description":null}],"errors":[],"params":[]}]},"repository_sets":{"name":"Repository sets","api_url":"/api","version":"1.0","doc_url":"../apidoc/1.0/repository_sets","formats":null,"full_description":null,"short_description":null,"methods":[{"name":"enable","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/repository_sets/enable","full_description":"","apis":[{"api_url":"/api/product/:product_id/repository_set/:id/enable","http_method":"POST","short_description":"Enable a repository set for a product."}],"errors":[],"params":[{"allow_nil":false,"full_name":"organization_id","name":"organization_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":"\n<p>id of an organization the repository will be contained in</p>\n"},{"allow_nil":false,"full_name":"product_id","name":"product_id","expected_type":"string","validator":"number.","required":true,"description":"\n<p>id of a product the repository will be contained in</p>\n"},{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"number.","required":true,"description":"\n<p>id or name of the repository set to enable</p>\n"}]},{"name":"disable","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/repository_sets/disable","full_description":"","apis":[{"api_url":"/api/product/:product_id/repository_set/:id/disable","http_method":"POST","short_description":"Enable a repository set for a product."}],"errors":[],"params":[{"allow_nil":false,"full_name":"organization_id","name":"organization_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":"\n<p>id of an organization the repository will be contained in</p>\n"},{"allow_nil":false,"full_name":"product_id","name":"product_id","expected_type":"string","validator":"number.","required":true,"description":"\n<p>id of a product the repository will be contained in</p>\n"},{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"number.","required":true,"description":"\n<p>id of the repository set to disable</p>\n"}]},{"name":"index","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/repository_sets/index","full_description":"","apis":[{"api_url":"/api/product/:product_id/repository_set","http_method":"GET","short_description":"List repository sets for a product."}],"errors":[],"params":[{"allow_nil":false,"full_name":"organization_id","name":"organization_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":"\n<p>id of an</p>\n"},{"allow_nil":false,"full_name":"product_id","name":"product_id","expected_type":"string","validator":"number.","required":true,"description":"\n<p>id of a product to list repository sets in</p>\n"}]}]},"packages":{"name":"Packages","api_url":"/api","version":"1.0","doc_url":"../apidoc/1.0/packages","formats":null,"full_description":null,"short_description":null,"methods":[{"name":"index","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/packages/index","full_description":"","apis":[{"api_url":"/api/repositories/:repository_id/packages","http_method":"GET","short_description":"List packages"}],"errors":[],"params":[{"allow_nil":false,"full_name":"repository_id","name":"repository_id","expected_type":"string","validator":"number.","required":false,"description":"\n<p>environment numeric identifier</p>\n"}]},{"name":"search","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/packages/search","full_description":"","apis":[{"api_url":"/api/repositories/:repository_id/packages/search","http_method":"GET","short_description":null}],"errors":[],"params":[{"allow_nil":false,"full_name":"repository_id","name":"repository_id","expected_type":"string","validator":"number.","required":false,"description":"\n<p>environment numeric identifier</p>\n"},{"allow_nil":false,"full_name":"search","name":"search","expected_type":"string","validator":"String","required":false,"description":"\n<p>search expression</p>\n"}]},{"name":"show","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/packages/show","full_description":"","apis":[{"api_url":"/api/repositories/:repository_id/packages/:id","http_method":"GET","short_description":"Show a package"}],"errors":[],"params":[{"allow_nil":false,"full_name":"repository_id","name":"repository_id","expected_type":"string","validator":"number.","required":false,"description":"\n<p>environment numeric identifier</p>\n"},{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"String","required":false,"description":"\n<p>package id</p>\n"}]}]},"repositories":{"name":"Repositories","api_url":"/api","version":"1.0","doc_url":"../apidoc/1.0/repositories","formats":null,"full_description":null,"short_description":null,"methods":[{"name":"create","examples":["POST /api/repositories/\n{\n  \"name\": \"fewups_product_227e003_fakerepos_zoo5\",\n  \"url\": \"http://lzap.fedorapeople.org/fakerepos/zoo5\",\n  \"organization_id\": \"org_227e003\",\n  \"product_id\": \"1344606167242\"\n}\n200\n{\n  \"gpg_key_id\": null,\n  \"created_at\": \"2012-08-10T13:42:53Z\",\n  \"name\": \"fewups_product_227e003_fakerepos_zoo5\",\n  \"major\": null,\n  \"enabled\": true,\n  \"pulp_id\": \"org_227e003-fewups_product_227e003-fewups_product_227e003_fakerepos_zoo5\",\n  \"cp_label\": \"org_227e003_fewups_product_227e003_fewups_product_227e003_fakerepos_zoo5\",\n  \"environment_product_id\": 1,\n  \"package_count\": 0,\n  \"library_instance_id\": null,\n  \"updated_at\": \"2012-08-10T13:42:54Z\",\n  \"gpg_key_name\": \"\",\n  \"last_sync\": null,\n  \"id\": 1,\n  \"minor\": null\n}"],"formats":null,"see":[{"link":"../apidoc/1.0/gpg_keys/index","description":"gpg_keys#index"}],"doc_url":"../apidoc/1.0/repositories/create","full_description":"","apis":[{"api_url":"/api/repositories","http_method":"POST","short_description":"Create a repository"}],"errors":[],"params":[{"allow_nil":false,"full_name":"name","name":"name","expected_type":"string","validator":"String","required":true,"description":""},{"allow_nil":false,"full_name":"organization_id","name":"organization_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":"\n<p>id of an organization the repository will be contained in</p>\n"},{"allow_nil":false,"full_name":"product_id","name":"product_id","expected_type":"string","validator":"number.","required":true,"description":"\n<p>id of a product the repository will be contained in</p>\n"},{"allow_nil":false,"full_name":"url","name":"url","expected_type":"string","validator":null,"required":true,"description":"\n<p>repository source url</p>\n"},{"allow_nil":false,"full_name":"gpg_key_name","name":"gpg_key_name","expected_type":"string","validator":"String","required":false,"description":"\n<p>name of a gpg key that will be assigned to the new repository</p>\n"}]},{"name":"show","examples":["GET /api/repositories/2/\n200\n{\n  \"created_at\": \"2012-08-10T13:42:57Z\",\n  \"gpg_key_id\": null,\n  \"keys\": \"/pulp/api/repositories/org_227e003-fewups_product_227e003-repo_227e003/keys/\",\n  \"distributionid\": [\n    \"ks-Test Family-TestVariant-16-x86_64\"\n  ],\n  \"name\": \"repo_227e003\",\n  \"uri\": \"https://katello.example.com/pulp/repos/org_227e003/Library/custom/fewups_product_227e003/repo_227e003/\",\n  \"comps\": \"/pulp/api/repositories/org_227e003-fewups_product_227e003-repo_227e003/comps/\",\n  \"clone_ids\": [\n    \"org_227e003-env_227e003-fewups_product_227e003-repo_227e003\"\n  ],\n  \"feed_ca\": null,\n  \"source\": {\n    \"url\": \"http://lzap.fedorapeople.org/fakerepos/zoo5/\",\n    \"type\": \"remote\"\n  },\n  \"files_count\": 77,\n  \"major\": null,\n  \"enabled\": true,\n  \"files\": \"/pulp/api/repositories/org_227e003-fewups_product_227e003-repo_227e003/files/\",\n  \"distribution\": \"/pulp/api/repositories/org_227e003-fewups_product_227e003-repo_227e003/distribution/\",\n  \"feed_cert\": null,\n  \"relative_path\": \"org_227e003/Library/custom/fewups_product_227e003/repo_227e003\",\n  \"sync_state\": \"finished\",\n  \"consumer_ca\": null,\n  \"packages\": \"/pulp/api/repositories/org_227e003-fewups_product_227e003-repo_227e003/packages/\",\n  \"consumer_cert\": null,\n  \"filters\": [],\n  \"pulp_id\": \"org_227e003-fewups_product_227e003-repo_227e003\",\n  \"arch\": \"noarch\",\n  \"cp_label\": \"org_227e003_fewups_product_227e003_repo_227e003\",\n  \"packagegroups\": \"/pulp/api/repositories/org_227e003-fewups_product_227e003-repo_227e003/packagegroups/\",\n  \"preserve_metadata\": false,\n  \"notes\": {},\n  \"publish\": true,\n  \"environment_product_id\": 1,\n  \"sync_schedule\": null,\n  \"package_count\": 8,\n  \"library_instance_id\": null,\n  \"_id\": \"org_227e003-fewups_product_227e003-repo_227e003\",\n  \"checksum_type\": \"sha256\",\n  \"updated_at\": \"2012-08-10T13:42:58Z\",\n  \"content_types\": \"yum\",\n  \"groupid\": [\n    \"product:1344606167242\",\n    \"env:2\",\n    \"org:2\",\n    \"content:1344606177624\"\n  ],\n  \"gpg_key_name\": \"\",\n  \"next_scheduled_time\": null,\n  \"uri_ref\": \"/pulp/api/repositories/org_227e003-fewups_product_227e003-repo_227e003/\",\n  \"packagegroupcategories\": \"/pulp/api/repositories/org_227e003-fewups_product_227e003-repo_227e003/packagegroupcategories/\",\n  \"last_sync\": \"2012-08-10T15:43:16+02:00\",\n  \"sync_options\": {},\n  \"errata\": \"/pulp/api/repositories/org_227e003-fewups_product_227e003-repo_227e003/errata/\",\n  \"id\": 2,\n  \"minor\": null\n}"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/repositories/show","full_description":"","apis":[{"api_url":"/api/repositories/:id","http_method":"GET","short_description":"Show a repository"}],"errors":[],"params":[{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":"\n<p>repository id</p>\n"}]},{"name":"update","examples":["PUT /api/repositories/6/\n{\n  \"repository\": {\n    \"gpg_key_name\": \"Dummy-Package-Generator\"\n  }\n}\n200\n{\n  \"created_at\": \"2012-08-10T13:46:03Z\",\n  \"gpg_key_id\": 1,\n  \"keys\": \"/pulp/api/repositories/org_227e003-GPG-product-227e003-GPG-repo-2-227e003/keys/\",\n  \"distributionid\": [],\n  \"name\": \"GPG-repo-2-227e003\",\n  \"uri\": \"https://katello.example.com/pulp/repos/org_227e003/Library/custom/GPG-product-227e003/GPG-repo-2-227e003/\",\n  \"comps\": \"/pulp/api/repositories/org_227e003-GPG-product-227e003-GPG-repo-2-227e003/comps/\",\n  \"clone_ids\": [],\n  \"feed_ca\": null,\n  \"source\": {\n    \"url\": \"http://inecas.fedorapeople.org/fakerepos/zoo\",\n    \"type\": \"remote\"\n  },\n  \"files_count\": 80,\n  \"major\": null,\n  \"enabled\": true,\n  \"files\": \"/pulp/api/repositories/org_227e003-GPG-product-227e003-GPG-repo-2-227e003/files/\",\n  \"distribution\": \"/pulp/api/repositories/org_227e003-GPG-product-227e003-GPG-repo-2-227e003/distribution/\",\n  \"feed_cert\": null,\n  \"relative_path\": \"org_227e003/Library/custom/GPG-product-227e003/GPG-repo-2-227e003\",\n  \"sync_state\": \"not_synced\",\n  \"consumer_ca\": null,\n  \"packages\": \"/pulp/api/repositories/org_227e003-GPG-product-227e003-GPG-repo-2-227e003/packages/\",\n  \"consumer_cert\": null,\n  \"filters\": [],\n  \"pulp_id\": \"org_227e003-GPG-product-227e003-GPG-repo-2-227e003\",\n  \"arch\": \"noarch\",\n  \"cp_label\": \"org_227e003_GPG-product-227e003_GPG-repo-2-227e003\",\n  \"packagegroups\": \"/pulp/api/repositories/org_227e003-GPG-product-227e003-GPG-repo-2-227e003/packagegroups/\",\n  \"preserve_metadata\": false,\n  \"notes\": {},\n  \"publish\": true,\n  \"environment_product_id\": 3,\n  \"sync_schedule\": null,\n  \"package_count\": 0,\n  \"library_instance_id\": null,\n  \"_id\": \"org_227e003-GPG-product-227e003-GPG-repo-2-227e003\",\n  \"checksum_type\": \"sha256\",\n  \"updated_at\": \"2012-08-10T13:46:07Z\",\n  \"content_types\": \"yum\",\n  \"groupid\": [\n    \"product:1344606356883\",\n    \"env:2\",\n    \"org:2\",\n    \"content:1344606363895\"\n  ],\n  \"gpg_key_name\": \"Dummy-Package-Generator\",\n  \"next_scheduled_time\": null,\n  \"uri_ref\": \"/pulp/api/repositories/org_227e003-GPG-product-227e003-GPG-repo-2-227e003/\",\n  \"packagegroupcategories\": \"/pulp/api/repositories/org_227e003-GPG-product-227e003-GPG-repo-2-227e003/packagegroupcategories/\",\n  \"last_sync\": null,\n  \"sync_options\": {},\n  \"errata\": \"/pulp/api/repositories/org_227e003-GPG-product-227e003-GPG-repo-2-227e003/errata/\",\n  \"id\": 6,\n  \"minor\": null\n}"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/repositories/update","full_description":"","apis":[{"api_url":"/api/repositories/:id","http_method":"PUT","short_description":"Update a repository"}],"errors":[],"params":[{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":"\n<p>repository id</p>\n"},{"allow_nil":false,"full_name":"repository","name":"repository","expected_type":"hash","validator":"Hash","required":true,"params":[{"name":"gpg_key_name","full_name":"repository[gpg_key_name]","allow_nil":false,"expected_type":"string","validator":"String","required":false,"description":"\n<p>name of a gpg key that will be assigned to the repository</p>\n"}],"description":""}]},{"name":"destroy","examples":["DELETE /api/repositories/6/\n200\nDeleted repository '6'"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/repositories/destroy","full_description":"","apis":[{"api_url":"/api/repositories/:id","http_method":"DELETE","short_description":"Destroy a repository"}],"errors":[],"params":[{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":""}]},{"name":"enable","examples":["POST /api/repositories/85/enable/\n{\n  \"enable\": true\n}\n200\nRepository 'Zoo Enterprise x86_64 6.2' enabled."],"formats":null,"see":[],"doc_url":"../apidoc/1.0/repositories/enable","full_description":"","apis":[{"api_url":"/api/repositories/:id/enable","http_method":"POST","short_description":"Enable or disable a repository"}],"errors":[],"params":[{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":""},{"allow_nil":false,"full_name":"enable","name":"enable","expected_type":"string","validator":"boolean","required":true,"description":"\n<p>flag that enables/disables the repository</p>\n"}]},{"name":"sync_complete","examples":["POST /api/repositories/sync_complete\n{\n  \"repo_id\": \"org_227e003-fewups_product_227e003-fewups_product_227e003_fakerepos_zoo5\",\n  \"task_id\": \"4fd84a3a-e2f1-11e1-a717-525400b68f90\"\n}\n500\nundefined method `with_indifferent_access' for false:FalseClass"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/repositories/sync_complete","full_description":"\n<p>This function is used by pulp for post sync actions. It is not\nauthenticated, but does not accept requests unless they have been sent from\nlocalhost.  Since we go through apache HTTP_X_FORWARDED_FOR header should\nbe set with original IP. Pulp blocks during the execution of this call, so\n*DO NOT* try to talk back to pulp within it.  Save that for the delayed\njob. Pulp doesn\u2019t send correct headers.\u201c</p>\n","apis":[{"api_url":"/api/repositories/:id/sync_complete","http_method":"POST","short_description":null}],"errors":[],"params":[{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":""}]},{"name":"package_groups","examples":["GET /api/repositories/2/package_groups\n200\n[\n  {\n    \"name\": \"mammal\",\n    \"optional_package_names\": [],\n    \"langonly\": null,\n    \"translated_description\": {},\n    \"default_package_names\": [],\n    \"immutable\": true,\n    \"translated_name\": {},\n    \"repo_defined\": true,\n    \"user_visible\": true,\n    \"default\": true,\n    \"mandatory_package_names\": [\n      \"elephant,giraffe,cheetah,lion,monkey,penguin,squirrel,walrus\",\n      \"penguin\"\n    ],\n    \"_id\": \"mammal\",\n    \"display_order\": 1024,\n    \"conditional_package_names\": {},\n    \"id\": \"mammal\",\n    \"description\": \"\"\n  },\n  {\n    \"name\": \"bird\",\n    \"optional_package_names\": [],\n    \"langonly\": null,\n    \"translated_description\": {},\n    \"default_package_names\": [],\n    \"immutable\": true,\n    \"translated_name\": {},\n    \"repo_defined\": true,\n    \"user_visible\": true,\n    \"default\": true,\n    \"mandatory_package_names\": [\n      \"penguin\"\n    ],\n    \"_id\": \"bird\",\n    \"display_order\": 1024,\n    \"conditional_package_names\": {},\n    \"id\": \"bird\",\n    \"description\": \"\"\n  }\n]"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/repositories/package_groups","full_description":"","apis":[{"api_url":"/api/repositories/:id/package_groups","http_method":"GET","short_description":"List all package groups in a repository"}],"errors":[],"params":[{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":""}]},{"name":"package_group_categories","examples":["GET /api/repositories/2/package_group_categories/\n200\n[\n  {\n    \"name\": \"all\",\n    \"translated_description\": {},\n    \"immutable\": true,\n    \"translated_name\": {},\n    \"repo_defined\": true,\n    \"packagegroupids\": [\n      \"mammal\",\n      \"bird\"\n    ],\n    \"_id\": \"all\",\n    \"display_order\": 99,\n    \"id\": \"all\",\n    \"description\": null\n  }\n]"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/repositories/package_group_categories","full_description":"","apis":[{"api_url":"/api/repositories/:id/package_group_categories","http_method":"GET","short_description":"List all package group categories in a repository"}],"errors":[],"params":[{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":""}]},{"name":"gpg_key_content","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/repositories/gpg_key_content","full_description":"","apis":[{"api_url":"/api/repositories/:id/gpg_key_content","http_method":"GET","short_description":"Return the content of a repo gpg key, used directly by yum"}],"errors":[],"params":[{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":""}]},{"name":"list_content_view_definition_repositories","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/repositories/list_content_view_definition_repositories","full_description":"","apis":[{"api_url":"/api/content_view_definitions/%s/repositories","http_method":"GET","short_description":"List all the repositories for a content view definition"}],"errors":[],"params":[]},{"name":"update_content_view_definition_repositories","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/repositories/update_content_view_definition_repositories","full_description":"","apis":[{"api_url":"/api/content_view_definitions/:content_view_definition_id/repositories","http_method":"PUT","short_description":"Update repositories for content view definition"}],"errors":[],"params":[{"allow_nil":false,"full_name":"content_view_definition_id","name":"content_view_definition_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":"\n<p>content view definition identifier</p>\n"},{"allow_nil":false,"full_name":"repos","name":"repos","expected_type":"string","validator":"Array","required":true,"description":"\n<p>Updated list of repo ids</p>\n"}]}]},"system_group_errata":{"name":"System group errata","api_url":"/api","version":"1.0","doc_url":"../apidoc/1.0/system_group_errata","formats":null,"full_description":"\n<p>methods for handling erratas on system group level</p>\n","short_description":null,"methods":[{"name":"index","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/system_group_errata/index","full_description":"","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"}],"errors":[],"params":[{"allow_nil":false,"full_name":"organization_id","name":"organization_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":"\n<p>oranization identifier</p>\n"},{"allow_nil":false,"full_name":"system_group_id","name":"system_group_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":"\n<p>system_group identifier</p>\n"},{"allow_nil":false,"full_name":"type","name":"type","expected_type":"string","validator":"Must be one of: bugfix, enhancement, security.","required":false,"description":"\n<p>Filter errata by type</p>\n"}]},{"name":"create","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/system_group_errata/create","full_description":"","apis":[{"api_url":"/api/organizations/:organization_id/system_groups/:system_group_id/errata","http_method":"POST","short_description":"Install errata remotely"}],"errors":[],"params":[{"allow_nil":false,"full_name":"organization_id","name":"organization_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":"\n<p>oranization identifier</p>\n"},{"allow_nil":false,"full_name":"system_group_id","name":"system_group_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":"\n<p>system_group identifier</p>\n"},{"allow_nil":false,"full_name":"errata_ids","name":"errata_ids","expected_type":"string","validator":"Array","required":true,"description":"\n<p>List of errata ids to install</p>\n"}]}]},"system_group_packages":{"name":"System group packages","api_url":"/api","version":"1.0","doc_url":"../apidoc/1.0/system_group_packages","formats":null,"full_description":"\n<p>methods for handling packages on system group level</p>\n","short_description":null,"methods":[{"name":"create","examples":["POST /api/organizations/org_227e003/system_groups/1/packages\n{\n  \"packages\": [\n    \"cheetah\"\n  ]\n}\n202\n{\n  \"finish_time\": null,\n  \"created_at\": \"2012-08-10T13:48:24Z\",\n  \"status_message\": \"Installing Package...\",\n  \"pulp_id\": \"0384935e-4216-4d38-9832-6be39e379aba\",\n  \"state\": \"running\",\n  \"tasks\": [\n    {\n      \"finish_time\": null,\n      \"progress\": null,\n      \"start_time\": null,\n      \"result\": {\n        \"errors\": [\n          null,\n          null\n        ]\n      },\n      \"uuid\": \"0e0f181c-e2f2-11e1-85ad-525400b68f90\",\n      \"state\": \"waiting\",\n      \"id\": 15\n    }\n  ],\n  \"task_type\": \"package_install\",\n  \"id\": 1,\n  \"parameters\": {\n    \"packages\": [\n      \"cheetah\"\n    ]\n  }\n}"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/system_group_packages/create","full_description":"","apis":[{"api_url":"/api/organizations/:organization_id/system_groups/:system_group_id/packages","http_method":"POST","short_description":"Install packages remotely"}],"errors":[],"params":[{"allow_nil":false,"full_name":"organization_id","name":"organization_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":"\n<p>oranization identifier</p>\n"},{"allow_nil":false,"full_name":"system_group_id","name":"system_group_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":"\n<p>system_group identifier</p>\n"},{"allow_nil":false,"full_name":"packages","name":"packages","expected_type":"string","validator":"Array","required":false,"description":"\n<p>List of package names</p>\n"},{"allow_nil":false,"full_name":"groups","name":"groups","expected_type":"string","validator":"Array","required":false,"description":"\n<p>List of package group names</p>\n"}]},{"name":"update","examples":["PUT /api/organizations/org_227e003/system_groups/1/packages\n{\n  \"packages\": [\n    \"cheetah\"\n  ]\n}\n202\n{\n  \"finish_time\": null,\n  \"created_at\": \"2012-08-10T13:48:48Z\",\n  \"status_message\": \"Updating Package...\",\n  \"pulp_id\": \"efe07dec-a694-452e-9de1-a0cf4e429da1\",\n  \"state\": \"running\",\n  \"tasks\": [\n    {\n      \"finish_time\": null,\n      \"progress\": null,\n      \"start_time\": null,\n      \"result\": {\n        \"errors\": [\n          null,\n          null\n        ]\n      },\n      \"uuid\": \"1cb315cf-e2f2-11e1-a5a0-525400b68f90\",\n      \"state\": \"waiting\",\n      \"id\": 16\n    }\n  ],\n  \"task_type\": \"package_update\",\n  \"id\": 2,\n  \"parameters\": {\n    \"packages\": [\n      \"cheetah\"\n    ]\n  }\n}"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/system_group_packages/update","full_description":"","apis":[{"api_url":"/api/organizations/:organization_id/system_groups/:system_group_id/packages","http_method":"PUT","short_description":"Update packages remotely"}],"errors":[],"params":[{"allow_nil":false,"full_name":"organization_id","name":"organization_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":"\n<p>oranization identifier</p>\n"},{"allow_nil":false,"full_name":"system_group_id","name":"system_group_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":"\n<p>system_group identifier</p>\n"},{"allow_nil":false,"full_name":"packages","name":"packages","expected_type":"string","validator":"Array","required":false,"description":"\n<p>List of package names</p>\n"},{"allow_nil":false,"full_name":"groups","name":"groups","expected_type":"string","validator":"Array","required":false,"description":"\n<p>List of package group names</p>\n"}]},{"name":"destroy","examples":["DELETE /api/organizations/org_227e003/system_groups/1/packages\n{\n  \"packages\": [\n    \"cheetah\"\n  ]\n}\n202\n{\n  \"finish_time\": null,\n  \"created_at\": \"2012-08-10T13:48:51Z\",\n  \"status_message\": \"Removing Package...\",\n  \"pulp_id\": \"c5846b6b-7415-4fb1-b7ca-1b6fec9d7520\",\n  \"state\": \"running\",\n  \"tasks\": [\n    {\n      \"finish_time\": null,\n      \"progress\": null,\n      \"start_time\": null,\n      \"result\": {\n        \"errors\": [\n          null,\n          null\n        ]\n      },\n      \"uuid\": \"1e087d07-e2f2-11e1-ae5e-525400b68f90\",\n      \"state\": \"waiting\",\n      \"id\": 17\n    }\n  ],\n  \"task_type\": \"package_remove\",\n  \"id\": 3,\n  \"parameters\": {\n    \"packages\": [\n      \"cheetah\"\n    ]\n  }\n}"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/system_group_packages/destroy","full_description":"","apis":[{"api_url":"/api/organizations/:organization_id/system_groups/:system_group_id/packages","http_method":"DELETE","short_description":"Uninstall packages remotely"}],"errors":[],"params":[{"allow_nil":false,"full_name":"organization_id","name":"organization_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":"\n<p>oranization identifier</p>\n"},{"allow_nil":false,"full_name":"system_group_id","name":"system_group_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":"\n<p>system_group identifier</p>\n"},{"allow_nil":false,"full_name":"packages","name":"packages","expected_type":"string","validator":"Array","required":false,"description":"\n<p>List of package names</p>\n"},{"allow_nil":false,"full_name":"groups","name":"groups","expected_type":"string","validator":"Array","required":false,"description":"\n<p>List of package group names</p>\n"}]}]},"status":{"name":"Status","api_url":"/api","version":"1.0","doc_url":"../apidoc/1.0/status","formats":null,"full_description":null,"short_description":null,"methods":[{"name":"memory","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/status/memory","full_description":"","apis":[{"api_url":"/api/status/memory","http_method":"GET","short_description":"Counts objects in memory for debug purposes. Can take a while!"}],"errors":[],"params":[]}]},"systems":{"name":"Systems","api_url":"/api","version":"1.0","doc_url":"../apidoc/1.0/systems","formats":null,"full_description":null,"short_description":null,"methods":[{"name":"create","examples":["POST /api/environments/3/consumers\n{\n  \"name\": \"katello.example.com_227e003\",\n  \"type\": \"system\",\n  \"facts\": {\n    \"net.interface.eth0.ipv4_broadcast\": \"192.168.122.255\",\n    \"net.interface.lo.ipv4_address\": \"127.0.0.1\"\n  },\n  \"installedProducts\": [\n    {\n      \"productName\": \"Red Hat Enterprise Linux Server\",\n      \"productId\": \"69\"\n    }\n  ]\n}\n200\n{\n  \"created_at\": \"2012-08-10T13:46:33Z\",\n  \"name\": \"katello.example.com_227e003\",\n  \"release\": \"\",\n  \"href\": \"/consumers/3050eb45-0ec4-43ea-8913-83635f06a2b7\",\n  \"environment\": {\n    \"prior\": \"Library\",\n    \"created_at\": \"2012-08-10T13:42:44Z\",\n    \"name\": \"env 227e003\",\n    \"prior_id\": 2,\n    \"organization_id\": 2,\n    \"library\": false,\n    \"updated_at\": \"2012-08-10T13:42:44Z\",\n    \"organization\": \"org_227e003\",\n    \"id\": 3,\n    \"description\": null\n  },\n  \"owner\": {\n    \"href\": \"/owners/org_227e003\",\n    \"key\": \"org_227e003\",\n    \"id\": \"ff8080813910c3d3013910c5c1460003\",\n    \"displayName\": \"org_227e003\"\n  },\n  \"idCert\": {\n    \"key\": \"-----BEGIN RSA PRIVATE KEY-----\\n-----END RSA PRIVATE KEY-----\\n\",\n    \"updated\": \"2012-08-10T13:46:33.053+0000\",\n    \"serial\": {\n      \"expiration\": \"2028-08-10T13:46:32.358+0000\",\n      \"updated\": \"2012-08-10T13:46:32.358+0000\",\n      \"serial\": 5585057444669292718,\n      \"revoked\": false,\n      \"collected\": false,\n      \"id\": 5585057444669292718,\n      \"created\": \"2012-08-10T13:46:32.358+0000\"\n    },\n    \"id\": \"ff8080813910c3d3013910c952dd0018\",\n    \"created\": \"2012-08-10T13:46:33.053+0000\",\n    \"cert\": \"-----BEGIN CERTIFICATE-----\\n-----END CERTIFICATE-----\\n\"\n  },\n  \"serviceLevel\": \"\",\n  \"activation_key\": [],\n  \"environment_id\": 3,\n  \"uuid\": \"3050eb45-0ec4-43ea-8913-83635f06a2b7\",\n  \"updated_at\": \"2012-08-10T13:46:33Z\",\n  \"location\": \"None\",\n  \"system_template_id\": null,\n  \"facts\": {\n    \"net.interface.eth0.ipv4_broadcast\": \"192.168.122.255\",\n    \"net.interface.lo.ipv4_address\": \"127.0.0.1\"\n  },\n  \"ipv4_address\": \"127.0.0.1\",\n  \"autoheal\": true,\n  \"id\": 1,\n  \"description\": \"Initial Registration Params\"\n}"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/systems/create","full_description":"","apis":[{"api_url":"/api/environments/:environment_id/consumers","http_method":"POST","short_description":"Register a system in environment (compatibility reason)"},{"api_url":"/api/environments/:environment_id/systems","http_method":"POST","short_description":"Register a system in environment"}],"errors":[],"params":[{"allow_nil":true,"full_name":"facts","name":"facts","expected_type":"hash","validator":"Hash","required":false,"description":"\n<p>Key-value hash of system-specific facts</p>\n"},{"allow_nil":true,"full_name":"installedProducts","name":"installedProducts","expected_type":"string","validator":"Array","required":false,"description":"\n<p>List of products installed on the system</p>\n"},{"allow_nil":false,"full_name":"name","name":"name","expected_type":"string","validator":"String","required":true,"description":"\n<p>Name of the system</p>\n"},{"allow_nil":false,"full_name":"type","name":"type","expected_type":"string","validator":"String","required":true,"description":"\n<p>Type of the system, it should always be \u2018system\u2019</p>\n"},{"allow_nil":true,"full_name":"serviceLevel","name":"serviceLevel","expected_type":"string","validator":"String","required":false,"description":"\n<p>A service level for auto-healing process, e.g. SELF-SUPPORT</p>\n"},{"allow_nil":false,"full_name":"location","name":"location","expected_type":"string","validator":"String","required":false,"description":"\n<p>Physical of the system</p>\n"},{"allow_nil":false,"full_name":"content_view_id","name":"content_view_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":false,"description":""},{"allow_nil":false,"full_name":"environment_id","name":"environment_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":false,"description":""}]},{"name":"hypervisors_update","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/systems/hypervisors_update","full_description":"\n<p>Takes a hash representing the mapping: host system having geust systems,\ne.g.:</p>\n\n<pre>{ &quot;host-uuid&quot;: [&quot;guest-uuid-1&quot;, &quot;guest-uuid-2'] }</pre>\n\n<p>See virt-who tool for more details.</p>\n","apis":[{"api_url":"/api/hypervisors","http_method":"POST","short_description":"Update the hypervisors information for environment"}],"errors":[],"params":[]},{"name":"activate","examples":["POST /api/environments/7/systems\n{\n  \"cp_type\": \"system\",\n  \"name\": \"katello.example.com_227e003\",\n  \"serviceLevel\": \"SELF-SUPPORT\",\n  \"facts\": {\n    \"cpu.cpu_socket(s)\": \"1\",\n    \"distribution.name\": \"Unknown\"\n  }\n}\n200\n{\n  \"created_at\": \"2012-08-10T13:52:27Z\",\n  \"name\": \"katello.example.com_227e003\",\n  \"release\": \"\",\n  \"href\": \"/consumers/269f9e7c-debe-4b3c-b33b-92f309f882df\",\n  \"environment\": {\n    \"prior\": \"Library\",\n    \"created_at\": \"2012-08-10T13:50:26Z\",\n    \"name\": \"env_manifest_227e003\",\n    \"prior_id\": 6,\n    \"organization_id\": 3,\n    \"library\": false,\n    \"updated_at\": \"2012-08-10T13:50:26Z\",\n    \"organization\": \"org_manifest_227e003\",\n    \"id\": 7,\n    \"description\": null\n  },\n  \"owner\": {\n    \"href\": \"/owners/org_manifest_227e003\",\n    \"key\": \"org_manifest_227e003\",\n    \"id\": \"ff8080813910c3d3013910ccdd67001c\",\n    \"displayName\": \"org_manifest_227e003\"\n  },\n  \"idCert\": {\n    \"key\": \"-----BEGIN RSA PRIVATE KEY-----\\n-----END RSA PRIVATE KEY-----\\n\",\n    \"updated\": \"2012-08-10T13:52:24.698+0000\",\n    \"serial\": {\n      \"expiration\": \"2028-08-10T13:52:24.099+0000\",\n      \"updated\": \"2012-08-10T13:52:24.099+0000\",\n      \"serial\": 375757150572080644,\n      \"revoked\": false,\n      \"collected\": false,\n      \"id\": 375757150572080644,\n      \"created\": \"2012-08-10T13:52:24.099+0000\"\n    },\n    \"id\": \"ff8080813910c3d3013910ceb07a003a\",\n    \"created\": \"2012-08-10T13:52:24.698+0000\",\n    \"cert\": \"-----BEGIN CERTIFICATE-----\\n-----END CERTIFICATE-----\\n\"\n  },\n  \"serviceLevel\": \"\",\n  \"activation_key\": [],\n  \"environment_id\": 7,\n  \"uuid\": \"269f9e7c-debe-4b3c-b33b-92f309f882df\",\n  \"updated_at\": \"2012-08-10T13:52:27Z\",\n  \"location\": \"None\",\n  \"system_template_id\": null,\n  \"facts\": {\n    \"cpu.cpu_socket(s)\": \"1\",\n    \"distribution.name\": \"Unknown\"\n  },\n  \"ipv4_address\": null,\n  \"guests\": [],\n  \"autoheal\": true,\n  \"id\": 2,\n  \"description\": \"Initial Registration Params\"\n}"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/systems/activate","full_description":"","apis":[{"api_url":"/api/consumers","http_method":"POST","short_description":"Register a system with activation key (compatibility)"},{"api_url":"/api/organizations/:organization_id/systems","http_method":"POST","short_description":"Register a system with activation key"}],"errors":[],"params":[{"allow_nil":false,"full_name":"activation_keys","name":"activation_keys","expected_type":"string","validator":"String","required":true,"description":""},{"allow_nil":true,"full_name":"facts","name":"facts","expected_type":"hash","validator":"Hash","required":false,"description":"\n<p>Key-value hash of system-specific facts</p>\n"},{"allow_nil":true,"full_name":"installedProducts","name":"installedProducts","expected_type":"string","validator":"Array","required":false,"description":"\n<p>List of products installed on the system</p>\n"},{"allow_nil":false,"full_name":"name","name":"name","expected_type":"string","validator":"String","required":true,"description":"\n<p>Name of the system</p>\n"},{"allow_nil":false,"full_name":"type","name":"type","expected_type":"string","validator":"String","required":true,"description":"\n<p>Type of the system, it should always be \u2018system\u2019</p>\n"},{"allow_nil":true,"full_name":"serviceLevel","name":"serviceLevel","expected_type":"string","validator":"String","required":false,"description":"\n<p>A service level for auto-healing process, e.g. SELF-SUPPORT</p>\n"},{"allow_nil":false,"full_name":"location","name":"location","expected_type":"string","validator":"String","required":false,"description":"\n<p>Physical of the system</p>\n"},{"allow_nil":false,"full_name":"content_view_id","name":"content_view_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":false,"description":""},{"allow_nil":false,"full_name":"environment_id","name":"environment_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":false,"description":""}]},{"name":"regenerate_identity_certificates","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/systems/regenerate_identity_certificates","full_description":"\n<p>Schedules the consumer identity certificate regeneration</p>\n","apis":[{"api_url":"/api/consumers/:id","http_method":"POST","short_description":"Regenerate consumer identity"}],"errors":[],"params":[{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"String","required":false,"description":"\n<p>UUID of the consumer</p>\n"}]},{"name":"update","examples":["PUT /api/systems/269f9e7c-debe-4b3c-b33b-92f309f882df\n{\n  \"serviceLevel\": \"SELF-SUPPORT\"\n}\n200\n{\n  \"created_at\": \"2012-08-10T13:52:27Z\",\n  \"name\": \"katello.example.com_227e003\",\n  \"release\": \"\",\n  \"href\": \"/consumers/269f9e7c-debe-4b3c-b33b-92f309f882df\",\n  \"environment\": {\n    \"prior\": \"Library\",\n    \"created_at\": \"2012-08-10T13:50:26Z\",\n    \"name\": \"env_manifest_227e003\",\n    \"prior_id\": 6,\n    \"organization_id\": 3,\n    \"library\": false,\n    \"updated_at\": \"2012-08-10T13:50:26Z\",\n    \"organization\": \"org_manifest_227e003\",\n    \"id\": 7,\n    \"description\": null\n  },\n  \"owner\": {\n    \"href\": \"/owners/org_manifest_227e003\",\n    \"key\": \"org_manifest_227e003\",\n    \"id\": \"ff8080813910c3d3013910ccdd67001c\",\n    \"displayName\": \"org_manifest_227e003\"\n  },\n  \"idCert\": {\n    \"key\": \"-----BEGIN RSA PRIVATE KEY-----\\n-----END RSA PRIVATE KEY-----\\n\",\n    \"updated\": \"2012-08-10T13:52:24.698+0000\",\n    \"serial\": {\n      \"expiration\": \"2028-08-10T13:52:24.099+0000\",\n      \"updated\": \"2012-08-10T13:52:24.099+0000\",\n      \"serial\": 375757150572080644,\n      \"revoked\": false,\n      \"collected\": false,\n      \"id\": 375757150572080644,\n      \"created\": \"2012-08-10T13:52:24.099+0000\"\n    },\n    \"id\": \"ff8080813910c3d3013910ceb07a003a\",\n    \"created\": \"2012-08-10T13:52:24.698+0000\",\n    \"cert\": \"-----BEGIN CERTIFICATE-----\\n-----END CERTIFICATE-----\\n\"\n  },\n  \"serviceLevel\": \"SELF-SUPPORT\",\n  \"activation_key\": [],\n  \"environment_id\": 7,\n  \"uuid\": \"269f9e7c-debe-4b3c-b33b-92f309f882df\",\n  \"updated_at\": \"2012-08-10T13:52:27Z\",\n  \"location\": \"None\",\n  \"system_template_id\": null,\n  \"facts\": {\n    \"cpu.cpu_socket(s)\": \"1\",\n    \"distribution.name\": \"Unknown\"\n  },\n  \"ipv4_address\": null,\n  \"guests\": [],\n  \"autoheal\": true,\n  \"id\": 2,\n  \"description\": \"Initial Registration Params\"\n}"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/systems/update","full_description":"","apis":[{"api_url":"/api/consumers/:id","http_method":"PUT","short_description":"Update system information (compatibility)"},{"api_url":"/api/systems/:id","http_method":"PUT","short_description":"Update system information"}],"errors":[],"params":[{"allow_nil":true,"full_name":"facts","name":"facts","expected_type":"hash","validator":"Hash","required":false,"description":"\n<p>Key-value hash of system-specific facts</p>\n"},{"allow_nil":true,"full_name":"installedProducts","name":"installedProducts","expected_type":"string","validator":"Array","required":false,"description":"\n<p>List of products installed on the system</p>\n"},{"allow_nil":false,"full_name":"name","name":"name","expected_type":"string","validator":"String","required":false,"description":"\n<p>Name of the system</p>\n"},{"allow_nil":false,"full_name":"type","name":"type","expected_type":"string","validator":"String","required":false,"description":"\n<p>Type of the system, it should always be \u2018system\u2019</p>\n"},{"allow_nil":true,"full_name":"serviceLevel","name":"serviceLevel","expected_type":"string","validator":"String","required":false,"description":"\n<p>A service level for auto-healing process, e.g. SELF-SUPPORT</p>\n"},{"allow_nil":false,"full_name":"location","name":"location","expected_type":"string","validator":"String","required":false,"description":"\n<p>Physical of the system</p>\n"},{"allow_nil":false,"full_name":"content_view_id","name":"content_view_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":false,"description":""},{"allow_nil":false,"full_name":"environment_id","name":"environment_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":false,"description":""}]},{"name":"index","examples":["GET /api/organizations/org_227e003/systems?name=katello.example.com_227e003\n200\n[\n  {\n    \"created_at\": \"2012-08-10T13:46:33Z\",\n    \"name\": \"katello.example.com_227e003\",\n    \"environment\": {\n      \"prior\": \"Library\",\n      \"created_at\": \"2012-08-10T13:42:44Z\",\n      \"name\": \"env 227e003\",\n      \"prior_id\": 2,\n      \"organization_id\": 2,\n      \"library\": false,\n      \"updated_at\": \"2012-08-10T13:42:44Z\",\n      \"organization\": \"org_227e003\",\n      \"id\": 3,\n      \"description\": null\n    },\n    \"serviceLevel\": \"\",\n    \"activation_key\": [],\n    \"environment_id\": 3,\n    \"uuid\": \"3050eb45-0ec4-43ea-8913-83635f06a2b7\",\n    \"updated_at\": \"2012-08-10T13:46:33Z\",\n    \"location\": \"None\",\n    \"system_template_id\": null,\n    \"ipv4_address\": \"127.0.0.1\",\n    \"id\": 1,\n    \"description\": \"Initial Registration Params\"\n  }\n]"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/systems/index","full_description":"","apis":[{"api_url":"/api/environments/:environment_id/consumers","http_method":"GET","short_description":"List systems (compatibilty)"},{"api_url":"/api/environments/:environment_id/systems","http_method":"GET","short_description":"List systems in environment"},{"api_url":"/api/organizations/:organization_id/systems","http_method":"GET","short_description":"List systems in organization"}],"errors":[],"params":[{"allow_nil":false,"full_name":"name","name":"name","expected_type":"string","validator":"String","required":false,"description":"\n<p>Filter systems by name</p>\n"},{"allow_nil":false,"full_name":"pool_id","name":"pool_id","expected_type":"string","validator":"String","required":false,"description":"\n<p>Filter systems by subscribed pool</p>\n"},{"allow_nil":false,"full_name":"search","name":"search","expected_type":"string","validator":"String","required":false,"description":"\n<p>Filter systems by advanced search query</p>\n"}]},{"name":"show","examples":["GET /api/systems/269f9e7c-debe-4b3c-b33b-92f309f882df\n200\n{\n  \"created_at\": \"2012-08-10T13:52:27Z\",\n  \"name\": \"katello.example.com_227e003\",\n  \"release\": \"\",\n  \"href\": \"/consumers/269f9e7c-debe-4b3c-b33b-92f309f882df\",\n  \"environment\": {\n    \"prior\": \"Library\",\n    \"created_at\": \"2012-08-10T13:50:26Z\",\n    \"name\": \"env_manifest_227e003\",\n    \"prior_id\": 6,\n    \"organization_id\": 3,\n    \"library\": false,\n    \"updated_at\": \"2012-08-10T13:50:26Z\",\n    \"organization\": \"org_manifest_227e003\",\n    \"id\": 7,\n    \"description\": null\n  },\n  \"owner\": {\n    \"href\": \"/owners/org_manifest_227e003\",\n    \"key\": \"org_manifest_227e003\",\n    \"id\": \"ff8080813910c3d3013910ccdd67001c\",\n    \"displayName\": \"org_manifest_227e003\"\n  },\n  \"idCert\": {\n    \"key\": \"-----BEGIN RSA PRIVATE KEY-----\\n-----END RSA PRIVATE KEY-----\\n\",\n    \"updated\": \"2012-08-10T13:52:24.698+0000\",\n    \"serial\": {\n      \"expiration\": \"2028-08-10T13:52:24.099+0000\",\n      \"updated\": \"2012-08-10T13:52:24.099+0000\",\n      \"serial\": 375757150572080644,\n      \"revoked\": false,\n      \"collected\": false,\n      \"id\": 375757150572080644,\n      \"created\": \"2012-08-10T13:52:24.099+0000\"\n    },\n    \"id\": \"ff8080813910c3d3013910ceb07a003a\",\n    \"created\": \"2012-08-10T13:52:24.698+0000\",\n    \"cert\": \"-----BEGIN CERTIFICATE-----\\n-----END CERTIFICATE-----\\n\"\n  },\n  \"serviceLevel\": \"\",\n  \"activation_key\": [],\n  \"environment_id\": 7,\n  \"uuid\": \"269f9e7c-debe-4b3c-b33b-92f309f882df\",\n  \"updated_at\": \"2012-08-10T13:52:27Z\",\n  \"location\": \"None\",\n  \"system_template_id\": null,\n  \"facts\": {\n    \"cpu.cpu_socket(s)\": \"1\",\n    \"distribution.name\": \"Unknown\"\n  },\n  \"ipv4_address\": null,\n  \"guests\": [],\n  \"autoheal\": true,\n  \"id\": 2,\n  \"description\": \"Initial Registration Params\"\n}"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/systems/show","full_description":"","apis":[{"api_url":"/api/consumers/:id","http_method":"GET","short_description":"Show a system (compatibility)"},{"api_url":"/api/systems/:id","http_method":"GET","short_description":"Show a system"}],"errors":[],"params":[{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"String","required":true,"description":"\n<p>UUID of the system</p>\n"}]},{"name":"destroy","examples":["DELETE /api/consumers/3050eb45-0ec4-43ea-8913-83635f06a2b7\n204"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/systems/destroy","full_description":"","apis":[{"api_url":"/api/consumers/:id","http_method":"DELETE","short_description":"Unregister a system (compatibility)"},{"api_url":"/api/systems/:id","http_method":"DELETE","short_description":"Unregister a system"}],"errors":[],"params":[{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"String","required":true,"description":"\n<p>UUID of the system</p>\n"}]},{"name":"pools","examples":["GET /api/systems/d2a99f27-6c0d-41de-9f3d-3279e4fbadd4/pools\n200\n{\n  \"pools\": [\n    {\n      \"sockets\": \"\",\n      \"endDate\": \"2042-08-03\",\n      \"consumed\": 0,\n      \"multiEntitlement\": false,\n      \"poolId\": \"ff8080813910c3d3013910c5e47b000d\",\n      \"supportLevel\": \"\",\n      \"poolName\": \"fewups_product_227e003\",\n      \"startDate\": \"2012-08-10\",\n      \"quantity\": -1,\n      \"providedProducts\": []\n    }\n  ]\n}"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/systems/pools","full_description":"","apis":[{"api_url":"/api/systems/:id/pools","http_method":"GET","short_description":"List pools a system is subscribed to"}],"errors":[],"params":[{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"String","required":true,"description":"\n<p>UUID of the system</p>\n"}]},{"name":"releases","examples":["GET /api/systems/d2a99f27-6c0d-41de-9f3d-3279e4fbadd4/releases\n200\n{\n  \"releases\": []\n}"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/systems/releases","full_description":"\n<p>A hint for choosing the right value for the releaseVer param</p>\n","apis":[{"api_url":"/api/systems/:id/releases","http_method":"GET","short_description":"Show releases available for the system"}],"errors":[],"params":[{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"String","required":true,"description":"\n<p>UUID of the system</p>\n"}]},{"name":"package_profile","examples":["GET /api/systems/d2a99f27-6c0d-41de-9f3d-3279e4fbadd4/packages\n200\n[\n\n]"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/systems/package_profile","full_description":"","apis":[{"api_url":"/api/systems/:id/packages","http_method":"GET","short_description":"List packages installed on the system"}],"errors":[],"params":[{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"String","required":true,"description":"\n<p>UUID of the system</p>\n"}]},{"name":"errata","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/systems/errata","full_description":"","apis":[{"api_url":"/api/systems/:id/errata","http_method":"GET","short_description":"List errata available for the system"}],"errors":[],"params":[{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"String","required":true,"description":"\n<p>UUID of the system</p>\n"}]},{"name":"upload_package_profile","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/systems/upload_package_profile","full_description":"","apis":[{"api_url":"/api/consumers/:id/packages","http_method":"PUT","short_description":"Update installed packages"},{"api_url":"/api/consumers/:id/profile","http_method":"PUT","short_description":"Update installed packages"}],"errors":[],"params":[{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"String","required":true,"description":"\n<p>UUID of the system</p>\n"}]},{"name":"report","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/systems/report","full_description":"","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"}],"errors":[],"params":[]},{"name":"tasks","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/systems/tasks","full_description":"","apis":[{"api_url":"/api/organizations/:organization_id/systems/tasks","http_method":"GET","short_description":"List async tasks for the system"}],"errors":[],"params":[{"allow_nil":false,"full_name":"system_name","name":"system_name","expected_type":"string","validator":"String","required":false,"description":"\n<p>Name of the system</p>\n"},{"allow_nil":false,"full_name":"system_uuid","name":"system_uuid","expected_type":"string","validator":"String","required":false,"description":"\n<p>UUID of the system</p>\n"}]},{"name":"task_show","examples":["GET /api/systems/tasks/d03b47f5-e2f1-11e1-b07c-525400b68f90\n200\n{\n  \"finish_time\": null,\n  \"created_at\": \"2012-08-10T13:46:40Z\",\n  \"organization_id\": 2,\n  \"progress\": null,\n  \"system_name\": \"katello.example.com_227e003\",\n  \"task_owner_type\": \"System\",\n  \"pending?\": true,\n  \"user_id\": 1,\n  \"start_time\": null,\n  \"result\": {\n    \"errors\": [\n      null,\n      null\n    ]\n  },\n  \"uuid\": \"d03b47f5-e2f1-11e1-b07c-525400b68f90\",\n  \"updated_at\": \"2012-08-10T13:46:42Z\",\n  \"state\": \"running\",\n  \"task_type\": \"package_install\",\n  \"task_owner_id\": 1,\n  \"result_description\": \"\",\n  \"id\": 10,\n  \"parameters\": {\n    \"packages\": [\n      \"cheetah\"\n    ]\n  },\n  \"description\": \"Package Install: cheetah\"\n}"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/systems/task_show","full_description":"","apis":[{"api_url":"/api/systems/tasks/:id","http_method":"GET","short_description":"Show details of the async task"}],"errors":[],"params":[{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"String","required":true,"description":"\n<p>UUID of the task</p>\n"}]},{"name":"enabled_repos","examples":["PUT /api/systems/82b34fd1-8758-493d-8fa6-5b2b1bf8559d/enabled_repos\n{\n  \"enabled_repos\": {\n    \"repos\": [\n      {\n        \"repositoryid\": \"zoo-enterprise\"\n      }\n    ]\n  }\n}\n200\n{\n  \"unknown_labels\": [],\n  \"result\": \"ok\",\n  \"error_ids\": [],\n  \"processed_ids\": [\n    \"org_manifest_227e003-env_manifest_227e003-Zoo_Enterprise-Zoo_Enterprise_x86_64_6_2\"\n  ]\n}"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/systems/enabled_repos","full_description":"\n<p>Used by katello-agent to keep the information about enabled repositories up\nto date. This information is then used for computing the errata available\nfor the system.</p>\n","apis":[{"api_url":"/api/systems/:id/enabled_repos","http_method":"PUT","short_description":"Update the information about enabled repositories"}],"errors":[],"params":[]},{"name":"add_system_groups","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/systems/add_system_groups","full_description":"","apis":[{"api_url":"/api/systems/:id/system_groups","http_method":"POST","short_description":"Add a system to groups"}],"errors":[],"params":[{"allow_nil":false,"full_name":"system","name":"system","expected_type":"hash","validator":"Hash","required":true,"params":[{"name":"system_group_ids","full_name":"system[system_group_ids]","allow_nil":false,"expected_type":"string","validator":"Array","required":true,"description":"\n<p>List of group ids to add the system to</p>\n"}],"description":""}]},{"name":"remove_system_groups","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/systems/remove_system_groups","full_description":"","apis":[{"api_url":"/api/systems/:id/system_groups","http_method":"DELETE","short_description":"Remove a system from groups"}],"errors":[],"params":[{"allow_nil":false,"full_name":"system","name":"system","expected_type":"hash","validator":"Hash","required":true,"params":[{"name":"system_group_ids","full_name":"system[system_group_ids]","allow_nil":false,"expected_type":"string","validator":"Array","required":true,"description":"\n<p>List of group ids to add the system to</p>\n"}],"description":""}]}]},"environments":{"name":"Environments","api_url":"/api","version":"1.0","doc_url":"../apidoc/1.0/environments","formats":null,"full_description":"\n<p># Description</p>\n\n<p>An environment is a basic organization structure that groups systems,\nproducts, repositories, templates etc.  Every system belongs to one\nenvironment and it\u2019s isolated inside so that it can see only content that\nis in its environment.</p>\n\n<p>## Chains</p>\n\n<p>Environments are ordered into chains and their content (propducts,\nrepositories, tempaltes, packages) can be moved to an environment only from\nits prior environment. You can have for example chain like:</p>\n\n<pre>Library -&gt; Development -&gt; Testing -&gt; Production</pre>\n\n<p>Each change in an environment is done through a changeset in an action\ncalled promotion.</p>\n\n<p>## Library</p>\n\n<p>Library is a special environment that has no ascendant: all the content\nstarts in this environment. More chains can start from the library\nenvironment but no further branching of a chain is enabled.</p>\n","short_description":null,"methods":[{"name":"index","examples":["GET /api/organizations/org_227e003/environments/?name=Library\n200\n[\n  {\n    \"prior\": null,\n    \"created_at\": \"2012-08-10T13:42:39Z\",\n    \"name\": \"Library\",\n    \"prior_id\": null,\n    \"organization_id\": 2,\n    \"library\": true,\n    \"updated_at\": \"2012-08-10T13:42:39Z\",\n    \"organization\": \"org_227e003\",\n    \"id\": 2,\n    \"description\": null\n  }\n]"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/environments/index","full_description":"","apis":[{"api_url":"/api/organizations/:organization_id/environments","http_method":"GET","short_description":"List environments in an organization"}],"errors":[],"params":[{"allow_nil":false,"full_name":"organization_id","name":"organization_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":false,"description":"\n<p>organization identifier</p>\n"},{"allow_nil":false,"full_name":"library","name":"library","expected_type":"string","validator":"boolean","required":false,"description":"\n<p>set true if you want to see only library environment</p>\n"},{"allow_nil":false,"full_name":"name","name":"name","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":false,"description":"\n<p>filter only environments with this identifier</p>\n"}]},{"name":"rhsm_index","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/environments/rhsm_index","full_description":"","apis":[{"api_url":"/api/owners/:organization_id/environments","http_method":"GET","short_description":"List environments for RHSM"}],"errors":[],"params":[{"allow_nil":false,"full_name":"organization_id","name":"organization_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":false,"description":"\n<p>organization identifier</p>\n"},{"allow_nil":false,"full_name":"library","name":"library","expected_type":"string","validator":"boolean","required":false,"description":"\n<p>set true if you want to see only library environment</p>\n"},{"allow_nil":false,"full_name":"name","name":"name","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":false,"description":"\n<p>filter only environments with this identifier</p>\n"}]},{"name":"show","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/environments/show","full_description":"","apis":[{"api_url":"/api/environments/:id","http_method":"GET","short_description":"Show an environment"},{"api_url":"/api/organizations/:organization_id/environments/:id","http_method":"GET","short_description":"Show an environment"}],"errors":[],"params":[{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":false,"description":"\n<p>environment identifier</p>\n"},{"allow_nil":false,"full_name":"organization_id","name":"organization_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":false,"description":"\n<p>organization identifier</p>\n"}]},{"name":"create","examples":["POST /api/organizations/org_227e003/environments/\n{\n  \"environment\": {\n    \"prior\": 2,\n    \"name\": \"env 227e003\"\n  }\n}\n200\n{\n  \"prior\": \"Library\",\n  \"created_at\": \"2012-08-10T13:42:44Z\",\n  \"name\": \"env 227e003\",\n  \"prior_id\": 2,\n  \"organization_id\": 2,\n  \"library\": false,\n  \"updated_at\": \"2012-08-10T13:42:44Z\",\n  \"organization\": \"org_227e003\",\n  \"id\": 3,\n  \"description\": null\n}"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/environments/create","full_description":"","apis":[{"api_url":"/api/organizations/:organization_id/environments","http_method":"POST","short_description":"Create an environment in an organization"}],"errors":[],"params":[{"allow_nil":false,"full_name":"organization_id","name":"organization_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":false,"description":"\n<p>organization identifier</p>\n"},{"allow_nil":false,"full_name":"environment","name":"environment","expected_type":"hash","validator":"Hash","required":true,"params":[{"name":"name","full_name":"environment[name]","allow_nil":false,"expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":"\n<p>name of the environment (identifier)</p>\n"},{"name":"description","full_name":"environment[description]","allow_nil":true,"expected_type":"string","validator":"String","required":false,"description":""},{"name":"prior","full_name":"environment[prior]","allow_nil":false,"expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":"\n<p>identifier of an environment that is prior the new environment in the\nchain, it has to be either library or an environment at the end of the\nchain</p>\n"}],"description":""}]},{"name":"update","examples":["PUT /api/organizations/org_227e003/environments/5\n{\n  \"environment\": {\n    \"name\": \"tstenv_227e003\",\n    \"description\": \"Test environment\"\n  }\n}\n200\n{\n  \"prior\": \"Library\",\n  \"created_at\": \"2012-08-10T13:45:23Z\",\n  \"name\": \"tstenv_227e003\",\n  \"prior_id\": 2,\n  \"organization_id\": 2,\n  \"library\": false,\n  \"updated_at\": \"2012-08-10T13:45:24Z\",\n  \"organization\": \"org_227e003\",\n  \"id\": 5,\n  \"description\": \"Test environment\"\n}"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/environments/update","full_description":"","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"}],"errors":[],"params":[{"allow_nil":false,"full_name":"environment","name":"environment","expected_type":"hash","validator":"Hash","required":true,"params":[{"name":"name","full_name":"environment[name]","allow_nil":false,"expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":false,"description":"\n<p>name of the environment (identifier)</p>\n"},{"name":"description","full_name":"environment[description]","allow_nil":true,"expected_type":"string","validator":"String","required":false,"description":""}],"description":""}]},{"name":"destroy","examples":["DELETE /api/organizations/org_227e003/environments/5\n200\nDeleted environment '5'"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/environments/destroy","full_description":"","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"}],"errors":[],"params":[{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":false,"description":"\n<p>environment identifier</p>\n"},{"allow_nil":false,"full_name":"organization_id","name":"organization_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":false,"description":"\n<p>organization identifier</p>\n"}]},{"name":"repositories","examples":["GET /api/organizations/org_227e003/environments/2/repositories?include_disabled=False\n200\n[\n  {\n    \"gpg_key_id\": null,\n    \"created_at\": \"2012-08-10T13:42:53Z\",\n    \"name\": \"fewups_product_227e003_fakerepos_zoo5\",\n    \"major\": null,\n    \"enabled\": true,\n    \"pulp_id\": \"org_227e003-fewups_product_227e003-fewups_product_227e003_fakerepos_zoo5\",\n    \"cp_label\": \"org_227e003_fewups_product_227e003_fewups_product_227e003_fakerepos_zoo5\",\n    \"environment_product_id\": 1,\n    \"package_count\": 0,\n    \"library_instance_id\": null,\n    \"updated_at\": \"2012-08-10T13:42:54Z\",\n    \"gpg_key_name\": \"\",\n    \"last_sync\": null,\n    \"id\": 1,\n    \"minor\": null\n  },\n  {\n    \"gpg_key_id\": null,\n    \"created_at\": \"2012-08-10T13:42:57Z\",\n    \"name\": \"repo_227e003\",\n    \"major\": null,\n    \"enabled\": true,\n    \"pulp_id\": \"org_227e003-fewups_product_227e003-repo_227e003\",\n    \"cp_label\": \"org_227e003_fewups_product_227e003_repo_227e003\",\n    \"environment_product_id\": 1,\n    \"package_count\": 0,\n    \"library_instance_id\": null,\n    \"updated_at\": \"2012-08-10T13:42:58Z\",\n    \"gpg_key_name\": \"\",\n    \"last_sync\": null,\n    \"id\": 2,\n    \"minor\": null\n  }\n]"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/environments/repositories","full_description":"","apis":[{"api_url":"/api/organizations/:organization_id/environments/:id/repositories","http_method":"GET","short_description":"List repositories available in the environment"}],"errors":[],"params":[{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":false,"description":"\n<p>environment identifier</p>\n"},{"allow_nil":false,"full_name":"organization_id","name":"organization_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":false,"description":"\n<p>organization identifier</p>\n"},{"allow_nil":false,"full_name":"include_disabled","name":"include_disabled","expected_type":"string","validator":"boolean","required":false,"description":"\n<p>set to true if you want to see also disabled repositories</p>\n"}]},{"name":"releases","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/environments/releases","full_description":"","apis":[{"api_url":"/api/environments/:id/releases","http_method":"GET","short_description":"List available releases for given environment"}],"errors":[],"params":[{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":false,"description":"\n<p>environment identifier</p>\n"}]}]},"changesets_content":{"name":"Changesets content","api_url":"/api","version":"1.0","doc_url":"../apidoc/1.0/changesets_content","formats":null,"full_description":null,"short_description":null,"methods":[{"name":"add_product","examples":["POST /api/changesets/1/products/\n{\n  \"product_id\": \"1344606167242\"\n}\n200\nAdded product 'fewups_product_227e003'"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/changesets_content/add_product","full_description":"","apis":[{"api_url":"/api/changesets/:changeset_id/products","http_method":"POST","short_description":"Add a product to a changeset"}],"errors":[],"params":[{"allow_nil":false,"full_name":"product_id","name":"product_id","expected_type":"string","validator":"number.","required":false,"description":"\n<p>The id of the product which should be added</p>\n"}]},{"name":"remove_product","examples":["DELETE /api/changesets/1/products/1344606167242/\n{\n  \"content_id\": \"1344606167242\"\n}\n200\nRemoved product '1344606167242'"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/changesets_content/remove_product","full_description":"","apis":[{"api_url":"/api/changesets/:changeset_id/products/:id","http_method":"DELETE","short_description":"Removes a product from a changeset"}],"errors":[],"params":[{"allow_nil":false,"full_name":"content_id","name":"content_id","expected_type":"string","validator":"number.","required":false,"description":"\n<p>The id of the product to remove</p>\n"}]},{"name":"add_package","examples":["POST /api/changesets/2/packages/\n{\n  \"name\": \"monkey-0.3-0.8.noarch.rpm\",\n  \"product_id\": \"1344606167242\"\n}\n200\nAdded package 'monkey-0.3-0.8.noarch.rpm'"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/changesets_content/add_package","full_description":"","apis":[{"api_url":"/api/changesets/:changeset_id/packages","http_method":"POST","short_description":"Add a package to a changeset"}],"errors":[],"params":[{"allow_nil":false,"full_name":"name","name":"name","expected_type":"string","validator":"String","required":false,"description":"\n<p>The nvrea of the package to add</p>\n"},{"allow_nil":false,"full_name":"product_id","name":"product_id","expected_type":"string","validator":"number.","required":false,"description":"\n<p>The id of the product which contains the package</p>\n"}]},{"name":"remove_package","examples":["DELETE /api/changesets/2/packages/monkey-0.3-0.8.noarch.rpm/\n{\n  \"product_id\": \"1344606167242\",\n  \"content_id\": \"monkey-0.3-0.8.noarch.rpm\"\n}\n200\nPackage 'monkey-0.3-0.8.noarch.rpm' not found in the changeset"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/changesets_content/remove_package","full_description":"","apis":[{"api_url":"/api/changesets/:changeset_id/packages/:id","http_method":"DELETE","short_description":"Remove a package from a changeset"}],"errors":[],"params":[{"allow_nil":false,"full_name":"product_id","name":"product_id","expected_type":"string","validator":"number.","required":false,"description":"\n<p>The id of the product which contains the package</p>\n"}]},{"name":"add_erratum","examples":["POST /api/changesets/2/errata/\n{\n  \"erratum_id\": \"RHEA-2010:0001\",\n  \"product_id\": \"1344606167242\"\n}\n200\nAdded erratum 'RHEA-2010:0001'"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/changesets_content/add_erratum","full_description":"","apis":[{"api_url":"/api/changesets/:changeset_id/errata","http_method":"POST","short_description":"Add an errata to a changeset"}],"errors":[],"params":[{"allow_nil":false,"full_name":"erratum_id","name":"erratum_id","expected_type":"string","validator":"number.","required":false,"description":"\n<p>The id of the errata to add</p>\n"},{"allow_nil":false,"full_name":"product_id","name":"product_id","expected_type":"string","validator":"number.","required":false,"description":"\n<p>The product which contains the errata</p>\n"}]},{"name":"remove_erratum","examples":["DELETE /api/changesets/2/errata/RHEA-2010:9984/\n{\n  \"product_id\": \"1344606167242\",\n  \"content_id\": \"RHEA-2010:9984\"\n}\n200\nErratum 'RHEA-2010:9984' not found in the changeset"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/changesets_content/remove_erratum","full_description":"","apis":[{"api_url":"/api/changesets/:changeset_id/errata/:id","http_method":"DELETE","short_description":"Remove an errata from a changeset"}],"errors":[],"params":[{"allow_nil":false,"full_name":"product_id","name":"product_id","expected_type":"string","validator":"number.","required":false,"description":"\n<p>The product which contains the errata</p>\n"}]},{"name":"add_repo","examples":["POST /api/changesets/2/repositories/\n{\n  \"repository_id\": 2,\n  \"product_id\": \"1344606167242\"\n}\n200\nAdded repository 'repo_227e003'"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/changesets_content/add_repo","full_description":"","apis":[{"api_url":"/api/changesets/:changeset_id/repositories","http_method":"POST","short_description":"Add a repository to a changeset"}],"errors":[],"params":[{"allow_nil":false,"full_name":"repository_id","name":"repository_id","expected_type":"string","validator":"number.","required":false,"description":"\n<p>The id of the repository to add</p>\n"}]},{"name":"remove_repo","examples":["DELETE /api/changesets/2/repositories/2/\n{\n  \"product_id\": \"1344606167242\",\n  \"content_id\": 2\n}\n200\nRemoved repository'2'"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/changesets_content/remove_repo","full_description":"","apis":[{"api_url":"/api/changesets/:changeset_id/repositories/:id","http_method":"DELETE","short_description":"Remove a repository from a changeset"}],"errors":[],"params":[]},{"name":"add_template","examples":["POST /api/changesets/3/templates/\n{\n  \"template_id\": 1\n}\n200\nAdded template 'promotion_test_tpl_227e003'"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/changesets_content/add_template","full_description":"","apis":[{"api_url":"/api/changesets/:changeset_id/templates","http_method":"POST","short_description":"Add a template to a changeset"}],"errors":[],"params":[{"allow_nil":false,"full_name":"template_id","name":"template_id","expected_type":"string","validator":"number.","required":false,"description":"\n<p>The id of the template to add</p>\n"}]},{"name":"remove_template","examples":["DELETE /api/changesets/3/templates/1/\n{\n  \"content_id\": 1\n}\n200\nRemoved template '1'"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/changesets_content/remove_template","full_description":"","apis":[{"api_url":"/api/changesets/:changeset_id/templates/:id","http_method":"DELETE","short_description":"Remove a template from a changeset"}],"errors":[],"params":[]},{"name":"add_content_view","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/changesets_content/add_content_view","full_description":"","apis":[{"api_url":"/api/changesets/:changeset_id/content_views","http_method":"POST","short_description":"Add a content view to a changeset"}],"errors":[],"params":[{"allow_nil":false,"full_name":"content_view_id","name":"content_view_id","expected_type":"string","validator":"number.","required":false,"description":"\n<p>The id of the content view to add</p>\n"}]},{"name":"remove_content_view","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/changesets_content/remove_content_view","full_description":"","apis":[{"api_url":"/api/changesets/:changeset_id/content_views/:id","http_method":"DELETE","short_description":"Remove a content_view from a changeset"}],"errors":[],"params":[]},{"name":"add_distribution","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/changesets_content/add_distribution","full_description":"","apis":[{"api_url":"/api/changesets/:changeset_id/distributions","http_method":"POST","short_description":"Add a distribution to a changeset"}],"errors":[],"params":[{"allow_nil":false,"full_name":"distribution_id","name":"distribution_id","expected_type":"string","validator":"number.","required":false,"description":"\n<p>The id of the distribution to add</p>\n"},{"allow_nil":false,"full_name":"product_id","name":"product_id","expected_type":"string","validator":"number.","required":false,"description":"\n<p>The product which contains the distribution</p>\n"}]},{"name":"remove_distribution","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/changesets_content/remove_distribution","full_description":"","apis":[{"api_url":"/api/changesets/:changeset_id/distributions/:id","http_method":"DELETE","short_description":"Remove a distribution from a changeset"}],"errors":[],"params":[]}]},"products":{"name":"Products","api_url":"/api","version":"1.0","doc_url":"../apidoc/1.0/products","formats":null,"full_description":null,"short_description":null,"methods":[{"name":"show","examples":["GET /api/organizations/org_227e003/products/1344606167242/\n200\n{\n  \"gpg_key_id\": null,\n  \"created_at\": \"2012-08-10T13:42:48Z\",\n  \"name\": \"fewups_product_227e003\",\n  \"sync_plan_id\": null,\n  \"multiplier\": 1,\n  \"marketing_product\": false,\n  \"sync_state\": \"finished\",\n  \"attributes\": [],\n  \"productContent\": [\n    {\n      \"enabled\": true,\n      \"content\": {\n        \"name\": \"repo_227e003\",\n        \"type\": \"yum\",\n        \"updated\": \"2012-08-10T13:42:57.624+0000\",\n        \"vendor\": \"Custom\",\n        \"modifiedProductIds\": [],\n        \"contentUrl\": \"/custom/fewups_product_227e003/repo_227e003\",\n        \"id\": \"1344606177624\",\n        \"gpgUrl\": \"\",\n        \"created\": \"2012-08-10T13:42:57.624+0000\",\n        \"label\": \"org_227e003_fewups_product_227e003_repo_227e003\"\n      }\n    },\n    {\n      \"enabled\": true,\n      \"content\": {\n        \"name\": \"fewups_product_227e003_fakerepos_zoo5\",\n        \"type\": \"yum\",\n        \"updated\": \"2012-08-10T13:42:53.879+0000\",\n        \"vendor\": \"Custom\",\n        \"modifiedProductIds\": [],\n        \"contentUrl\": \"/custom/fewups_product_227e003/fewups_product_227e003_fakerepos_zoo5\",\n        \"id\": \"1344606173878\",\n        \"gpgUrl\": \"\",\n        \"created\": \"2012-08-10T13:42:53.879+0000\",\n        \"label\": \"org_227e003_fewups_product_227e003_fewups_product_227e003_fakerepos_zoo5\"\n      }\n    }\n  ],\n  \"updated_at\": \"2012-08-10T13:42:48Z\",\n  \"gpg_key_name\": \"\",\n  \"last_sync\": \"2012-08-10T15:45:36+02:00\",\n  \"provider_id\": 3,\n  \"id\": \"1344606167242\",\n  \"sync_plan_name\": null,\n  \"description\": null\n}"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/products/show","full_description":"","apis":[{"api_url":"/api/organizations/:organization_id/products/:id","http_method":"GET","short_description":"Show a product"}],"errors":[],"params":[{"allow_nil":false,"full_name":"organization_id","name":"organization_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":false,"description":"\n<p>organization identifier</p>\n"},{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"number.","required":false,"description":"\n<p>product numeric identifier</p>\n"}]},{"name":"update","examples":["PUT /api/organizations/org_227e003/products/1344606356883/\n{\n  \"product\": {\n    \"gpg_key_name\": \"Renamed-Dummy-Package-Generator\"\n  }\n}\n200\n{\n  \"gpg_key_id\": 2,\n  \"created_at\": \"2012-08-10T13:45:57Z\",\n  \"name\": \"GPG-product-227e003\",\n  \"sync_plan_id\": null,\n  \"multiplier\": 1,\n  \"marketing_product\": false,\n  \"sync_state\": \"not_synced\",\n  \"attributes\": [],\n  \"productContent\": [\n    {\n      \"enabled\": true,\n      \"content\": {\n        \"name\": \"GPG-repo-2-227e003\",\n        \"type\": \"yum\",\n        \"updated\": \"2012-08-10T13:46:07.395+0000\",\n        \"vendor\": \"Custom\",\n        \"modifiedProductIds\": [],\n        \"contentUrl\": \"/custom/GPG-product-227e003/GPG-repo-2-227e003\",\n        \"id\": \"1344606367395\",\n        \"gpgUrl\": \"https://katello.example.com/katello/api/repositories/6/gpg_key_content\",\n        \"created\": \"2012-08-10T13:46:07.395+0000\",\n        \"label\": \"org_227e003_GPG-product-227e003_GPG-repo-2-227e003\"\n      }\n    },\n    {\n      \"enabled\": true,\n      \"content\": {\n        \"name\": \"GPG-repo-227e003\",\n        \"type\": \"yum\",\n        \"updated\": \"2012-08-10T13:46:00.376+0000\",\n        \"vendor\": \"Custom\",\n        \"modifiedProductIds\": [],\n        \"contentUrl\": \"/custom/GPG-product-227e003/GPG-repo-227e003\",\n        \"id\": \"1344606360376\",\n        \"gpgUrl\": \"https://katello.example.com/katello/api/repositories/5/gpg_key_content\",\n        \"created\": \"2012-08-10T13:46:00.376+0000\",\n        \"label\": \"org_227e003_GPG-product-227e003_GPG-repo-227e003\"\n      }\n    }\n  ],\n  \"updated_at\": \"2012-08-10T13:46:09Z\",\n  \"gpg_key_name\": \"Renamed-Dummy-Package-Generator\",\n  \"last_sync\": null,\n  \"provider_id\": 3,\n  \"id\": \"1344606356883\",\n  \"sync_plan_name\": null,\n  \"description\": null\n}"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/products/update","full_description":"","apis":[{"api_url":"/api/organizations/:organization_id/products/:id","http_method":"PUT","short_description":"Update a product"}],"errors":[],"params":[{"allow_nil":false,"full_name":"organization_id","name":"organization_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":false,"description":"\n<p>organization identifier</p>\n"},{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"number.","required":false,"description":"\n<p>product numeric identifier</p>\n"},{"allow_nil":false,"full_name":"product","name":"product","expected_type":"hash","validator":"Hash","required":true,"params":[{"name":"gpg_key_name","full_name":"product[gpg_key_name]","allow_nil":true,"expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":false,"description":"\n<p>identifier of the gpg key</p>\n"},{"name":"description","full_name":"product[description]","allow_nil":true,"expected_type":"string","validator":"String","required":false,"description":"\n<p>Product description</p>\n"},{"name":"recursive","full_name":"product[recursive]","allow_nil":false,"expected_type":"string","validator":"boolean","required":false,"description":"\n<p>set to true to recursive update gpg key</p>\n"}],"description":""}]},{"name":"index","examples":["GET /api/organizations/org_227e003/products?name=fewups_product_227e003\n200\n[\n  {\n    \"gpg_key_id\": null,\n    \"created_at\": \"2012-08-10T13:42:48Z\",\n    \"name\": \"fewups_product_227e003\",\n    \"sync_plan_id\": null,\n    \"provider_name\": \"yum_provider_227e003\",\n    \"multiplier\": 1,\n    \"marketing_product\": false,\n    \"sync_state\": \"not_synced\",\n    \"attributes\": [],\n    \"productContent\": [\n      {\n        \"enabled\": true,\n        \"content\": {\n          \"name\": \"fewups_product_227e003_fakerepos_zoo5\",\n          \"type\": \"yum\",\n          \"updated\": \"2012-08-10T13:42:53.879+0000\",\n          \"vendor\": \"Custom\",\n          \"modifiedProductIds\": [],\n          \"contentUrl\": \"/custom/fewups_product_227e003/fewups_product_227e003_fakerepos_zoo5\",\n          \"id\": \"1344606173878\",\n          \"gpgUrl\": \"\",\n          \"created\": \"2012-08-10T13:42:53.879+0000\",\n          \"label\": \"org_227e003_fewups_product_227e003_fewups_product_227e003_fakerepos_zoo5\"\n        }\n      }\n    ],\n    \"updated_at\": \"2012-08-10T13:42:48Z\",\n    \"gpg_key_name\": \"\",\n    \"last_sync\": null,\n    \"provider_id\": 3,\n    \"id\": \"1344606167242\",\n    \"sync_plan_name\": null,\n    \"description\": null\n  }\n]"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/products/index","full_description":"","apis":[{"api_url":"/api/environments/:environment_id/products","http_method":"GET","short_description":"List products"},{"api_url":"/api/organizations/:organization_id/products","http_method":"GET","short_description":"List products"}],"errors":[],"params":[{"allow_nil":false,"full_name":"organization_id","name":"organization_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":false,"description":"\n<p>organization identifier</p>\n"},{"allow_nil":false,"full_name":"environment_id","name":"environment_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":false,"description":"\n<p>environment identifier</p>\n"},{"allow_nil":false,"full_name":"name","name":"name","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":false,"description":"\n<p>product identifier</p>\n"}]},{"name":"destroy","examples":["DELETE /api/organizations/org_227e003/products/1344606356883/\n200\nDeleted product '1344606356883'"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/products/destroy","full_description":"","apis":[{"api_url":"/api/organizations/:organization_id/products/:id","http_method":"DELETE","short_description":"Destroy a product"}],"errors":[],"params":[{"allow_nil":false,"full_name":"organization_id","name":"organization_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":false,"description":"\n<p>organization identifier</p>\n"},{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"number.","required":false,"description":"\n<p>product numeric identifier</p>\n"}]},{"name":"repositories","examples":["GET /api/environments/2/products/1344606167242/repositories?include_disabled=False&name=repo_227e003\n200\n[\n  {\n    \"gpg_key_id\": null,\n    \"created_at\": \"2012-08-10T13:42:57Z\",\n    \"name\": \"repo_227e003\",\n    \"major\": null,\n    \"enabled\": true,\n    \"pulp_id\": \"org_227e003-fewups_product_227e003-repo_227e003\",\n    \"cp_label\": \"org_227e003_fewups_product_227e003_repo_227e003\",\n    \"environment_product_id\": 1,\n    \"package_count\": 8,\n    \"library_instance_id\": null,\n    \"updated_at\": \"2012-08-10T13:42:58Z\",\n    \"gpg_key_name\": \"\",\n    \"last_sync\": \"2012-08-10T15:43:16+02:00\",\n    \"id\": 2,\n    \"minor\": null\n  }\n]"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/products/repositories","full_description":"","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}],"errors":[],"params":[{"allow_nil":false,"full_name":"organization_id","name":"organization_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":false,"description":"\n<p>organization identifier</p>\n"},{"allow_nil":false,"full_name":"environment_id","name":"environment_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":false,"description":"\n<p>environment identifier</p>\n"},{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"number.","required":false,"description":"\n<p>product numeric identifier</p>\n"},{"allow_nil":false,"full_name":"include_disabled","name":"include_disabled","expected_type":"string","validator":"boolean","required":false,"description":"\n<p>set to True if you want to list disabled repositories</p>\n"},{"allow_nil":false,"full_name":"name","name":"name","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":false,"description":"\n<p>repository identifier</p>\n"}]},{"name":"set_sync_plan","examples":["POST /api/organizations/org_227e003/products/1344606167242/sync_plan\n{\n  \"plan_id\": 1\n}\n200\nSynchronization plan assigned."],"formats":null,"see":[],"doc_url":"../apidoc/1.0/products/set_sync_plan","full_description":"","apis":[{"api_url":"/api/organizations/:organization_id/products/:id/sync_plan","http_method":"POST","short_description":"Assign sync plan to product"}],"errors":[],"params":[{"allow_nil":false,"full_name":"organization_id","name":"organization_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":false,"description":"\n<p>organization identifier</p>\n"},{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"number.","required":false,"description":"\n<p>product numeric identifier</p>\n"},{"allow_nil":false,"full_name":"plan_id","name":"plan_id","expected_type":"string","validator":"number.","required":false,"description":"\n<p>Plan numeric identifier</p>\n"}]},{"name":"remove_sync_plan","examples":["DELETE /api/organizations/org_227e003/products/1344606167242/sync_plan\n200\nSynchronization plan removed."],"formats":null,"see":[],"doc_url":"../apidoc/1.0/products/remove_sync_plan","full_description":"","apis":[{"api_url":"/api/organizations/:organization_id/products/:id/sync_plan","http_method":"DELETE","short_description":"Delete assignment sync plan and product"}],"errors":[],"params":[{"allow_nil":false,"full_name":"organization_id","name":"organization_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":false,"description":"\n<p>organization identifier</p>\n"},{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"number.","required":false,"description":"\n<p>product numeric identifier</p>\n"},{"allow_nil":false,"full_name":"plan_id","name":"plan_id","expected_type":"string","validator":"number.","required":false,"description":"\n<p>Plan numeric identifier</p>\n"}]},{"name":"list_content_view_definition_products","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/products/list_content_view_definition_products","full_description":"","apis":[{"api_url":"/api/content_view_definitions/:content_view_definition_id/products","http_method":"GET","short_description":"Get products for content view definition"}],"errors":[],"params":[{"allow_nil":false,"full_name":"content_view_definition_id","name":"content_view_definition_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":"\n<p>content view definition identifier</p>\n"}]},{"name":"update_content_view_definition_products","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/products/update_content_view_definition_products","full_description":"","apis":[{"api_url":"/api/content_view_definitions/:content_view_definition_id/products","http_method":"PUT","short_description":"Update products for content view definition"}],"errors":[],"params":[{"allow_nil":false,"full_name":"content_view_definition_id","name":"content_view_definition_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":"\n<p>content view definition identifier</p>\n"},{"allow_nil":false,"full_name":"products","name":"products","expected_type":"string","validator":"Array","required":true,"description":"\n<p>Updated list of products</p>\n"}]}]},"domains":{"name":"Domains","api_url":"/api","version":"1.0","doc_url":"../apidoc/1.0/domains","formats":null,"full_description":"\n<p>Foreman considers a domain and a DNS zone as the same thing. That is, if\nyou are planning to manage a site where all the machines are or the form\n<em>hostname</em>.<b>somewhere.com</b> then the domain is\n<b>somewhere.com</b>. This allows Foreman to associate a puppet variable\nwith a domain/site and automatically append this variable to all external\nnode requests made by machines at that site.</p>\n\n<p>The Domains API is available only if support for Foreman is installed.</p>\n","short_description":null,"methods":[{"name":"index","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/domains/index","full_description":"","apis":[{"api_url":"/api/domains","http_method":"GET","short_description":"List of domains"}],"errors":[],"params":[{"allow_nil":false,"full_name":"search","name":"search","expected_type":"string","validator":"String","required":false,"description":"\n<p>Filter results</p>\n"},{"allow_nil":false,"full_name":"order","name":"order","expected_type":"string","validator":"String","required":false,"description":"\n<p>Sort results</p>\n"}]},{"name":"show","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/domains/show","full_description":"","apis":[{"api_url":"/api/domains/:id","http_method":"GET","short_description":"Show a domain."}],"errors":[],"params":[{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"String","required":false,"description":"\n<p>domain name (no slashes)</p>\n"}]},{"name":"create","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/domains/create","full_description":"\n<p>The <b>fullname</b> field is used for human readability in reports and\nother pages that refer to domains, and also available as an external node\nparameter</p>\n","apis":[{"api_url":"/api/domains","http_method":"POST","short_description":"Create a domain."}],"errors":[],"params":[{"allow_nil":false,"full_name":"domain","name":"domain","expected_type":"hash","validator":"Hash","required":true,"params":[{"name":"name","full_name":"domain[name]","allow_nil":false,"expected_type":"string","validator":"String","required":true,"description":"\n<p>The full DNS Domain name</p>\n"},{"name":"fullname","full_name":"domain[fullname]","allow_nil":true,"expected_type":"string","validator":"String","required":false,"description":"\n<p>Full name describing the domain</p>\n"},{"name":"dns_id","full_name":"domain[dns_id]","allow_nil":true,"expected_type":"string","validator":"number.","required":false,"description":"\n<p>DNS Proxy to use within this domain</p>\n"},{"name":"domain_parameters_attributes","full_name":"domain[domain_parameters_attributes]","allow_nil":true,"expected_type":"string","validator":"Array","required":false,"description":"\n<p>Array of parameters (name, value)</p>\n"}],"description":""}]},{"name":"update","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/domains/update","full_description":"","apis":[{"api_url":"/api/domains/:id","http_method":"PUT","short_description":"Update a domain."}],"errors":[],"params":[{"allow_nil":false,"full_name":"domain","name":"domain","expected_type":"hash","validator":"Hash","required":true,"params":[{"name":"name","full_name":"domain[name]","allow_nil":false,"expected_type":"string","validator":"String","required":false,"description":"\n<p>The full DNS Domain name</p>\n"},{"name":"fullname","full_name":"domain[fullname]","allow_nil":true,"expected_type":"string","validator":"String","required":false,"description":"\n<p>Full name describing the domain</p>\n"},{"name":"dns_id","full_name":"domain[dns_id]","allow_nil":true,"expected_type":"string","validator":"number.","required":false,"description":"\n<p>DNS Proxy to use within this domain</p>\n"},{"name":"domain_parameters_attributes","full_name":"domain[domain_parameters_attributes]","allow_nil":true,"expected_type":"string","validator":"Array","required":false,"description":"\n<p>Array of parameters (name, value)</p>\n"}],"description":""}]},{"name":"destroy","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/domains/destroy","full_description":"","apis":[{"api_url":"/api/domains/:id","http_method":"DELETE","short_description":"Delete a domain."}],"errors":[],"params":[{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"String","required":false,"description":"\n<p>domain name (no slashes)</p>\n"}]}]},"distributors":{"name":"Distributors","api_url":"/api","version":"1.0","doc_url":"../apidoc/1.0/distributors","formats":null,"full_description":null,"short_description":null,"methods":[{"name":"create","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/distributors/create","full_description":"","apis":[{"api_url":"/api/environments/:environment_id/distributors","http_method":"POST","short_description":"Register a distributor in environment"}],"errors":[],"params":[{"allow_nil":false,"full_name":"name","name":"name","expected_type":"string","validator":"String","required":true,"description":"\n<p>Name of the distributor</p>\n"},{"allow_nil":false,"full_name":"facts","name":"facts","expected_type":"hash","validator":"Hash","required":false,"description":"\n<p>Key-value hash of distributor-specific facts</p>\n"},{"allow_nil":false,"full_name":"installedProducts","name":"installedProducts","expected_type":"string","validator":"Array","required":false,"description":"\n<p>List of products installed on the distributor</p>\n"},{"allow_nil":true,"full_name":"serviceLevel","name":"serviceLevel","expected_type":"string","validator":"String","required":false,"description":"\n<p>A service level for auto-healing process, e.g. SELF-SUPPORT</p>\n"},{"allow_nil":false,"full_name":"releaseVer","name":"releaseVer","expected_type":"string","validator":"String","required":false,"description":"\n<p>Release of the os. The $releasever variable in repo url will be replaced\nwith this value</p>\n"},{"allow_nil":false,"full_name":"location","name":"location","expected_type":"string","validator":"String","required":false,"description":"\n<p>Physical of the distributor</p>\n"},{"allow_nil":false,"full_name":"type","name":"type","expected_type":"string","validator":"String","required":true,"description":"\n<p>Type of the distributor, it should always be \u2018distributor\u2019</p>\n"}]},{"name":"update","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/distributors/update","full_description":"","apis":[{"api_url":"/api/distributors/:id","http_method":"PUT","short_description":"Update distributor information"}],"errors":[],"params":[{"allow_nil":false,"full_name":"name","name":"name","expected_type":"string","validator":"String","required":false,"description":"\n<p>Name of the distributor</p>\n"},{"allow_nil":false,"full_name":"facts","name":"facts","expected_type":"hash","validator":"Hash","required":false,"description":"\n<p>Key-value hash of distributor-specific facts</p>\n"},{"allow_nil":false,"full_name":"installedProducts","name":"installedProducts","expected_type":"string","validator":"Array","required":false,"description":"\n<p>List of products installed on the distributor</p>\n"},{"allow_nil":true,"full_name":"serviceLevel","name":"serviceLevel","expected_type":"string","validator":"String","required":false,"description":"\n<p>A service level for auto-healing process, e.g. SELF-SUPPORT</p>\n"},{"allow_nil":false,"full_name":"releaseVer","name":"releaseVer","expected_type":"string","validator":"String","required":false,"description":"\n<p>Release of the os. The $releasever variable in repo url will be replaced\nwith this value</p>\n"},{"allow_nil":false,"full_name":"location","name":"location","expected_type":"string","validator":"String","required":false,"description":"\n<p>Physical of the distributor</p>\n"}]},{"name":"index","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/distributors/index","full_description":"","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"}],"errors":[],"params":[{"allow_nil":false,"full_name":"name","name":"name","expected_type":"string","validator":"String","required":false,"description":"\n<p>Filter distributors by name</p>\n"},{"allow_nil":false,"full_name":"pool_id","name":"pool_id","expected_type":"string","validator":"String","required":false,"description":"\n<p>Filter distributors by subscribed pool</p>\n"}]},{"name":"show","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/distributors/show","full_description":"","apis":[{"api_url":"/api/distributors/:id","http_method":"GET","short_description":"Show a distributor"}],"errors":[],"params":[{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"String","required":true,"description":"\n<p>UUID of the distributor</p>\n"}]},{"name":"destroy","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/distributors/destroy","full_description":"","apis":[{"api_url":"/api/distributors/:id","http_method":"DELETE","short_description":"Unregister a distributor"}],"errors":[],"params":[{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"String","required":true,"description":"\n<p>UUID of the distributor</p>\n"}]},{"name":"pools","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/distributors/pools","full_description":"","apis":[{"api_url":"/api/distributors/:id/pools","http_method":"GET","short_description":"List pools a distributor is subscribed to"}],"errors":[],"params":[{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"String","required":true,"description":"\n<p>UUID of the distributor</p>\n"}]},{"name":"report","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/distributors/report","full_description":"","apis":[{"api_url":"/api/environments/:environment_id/distributors/report","http_method":"GET","short_description":"Get distributor reports for the environment"},{"api_url":"/api/organizations/:organization_id/distributors/report","http_method":"GET","short_description":"Get distributor reports for the organization"}],"errors":[],"params":[]},{"name":"tasks","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/distributors/tasks","full_description":"","apis":[{"api_url":"/api/organizations/:organization_id/distributors/tasks","http_method":"GET","short_description":"List async tasks for the distributor"}],"errors":[],"params":[{"allow_nil":false,"full_name":"distributor_name","name":"distributor_name","expected_type":"string","validator":"String","required":false,"description":"\n<p>Name of the distributor</p>\n"},{"allow_nil":false,"full_name":"distributor_uuid","name":"distributor_uuid","expected_type":"string","validator":"String","required":false,"description":"\n<p>UUID of the distributor</p>\n"}]},{"name":"task_show","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/distributors/task_show","full_description":"","apis":[{"api_url":"/api/distributors/tasks/:id","http_method":"GET","short_description":"Show details of the async task"}],"errors":[],"params":[{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"String","required":true,"description":"\n<p>UUID of the task</p>\n"}]}]},"tasks":{"name":"Tasks","api_url":"/api","version":"1.0","doc_url":"../apidoc/1.0/tasks","formats":null,"full_description":null,"short_description":null,"methods":[{"name":"index","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/tasks/index","full_description":"","apis":[{"api_url":"/api/organizations/:organization_id/tasks","http_method":"GET","short_description":"List tasks of given organization"}],"errors":[],"params":[{"allow_nil":false,"full_name":"organization_id","name":"organization_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":"\n<p>organization identifier</p>\n"}]},{"name":"show","examples":["GET /api/tasks/45f57d6b-e2f1-11e1-a64d-525400b68f90\n200\n{\n  \"finish_time\": null,\n  \"created_at\": \"2012-08-10T13:42:48Z\",\n  \"organization_id\": 2,\n  \"progress\": {\n    \"total_count\": 0,\n    \"step\": 0,\n    \"size_left\": 0,\n    \"total_size\": 0,\n    \"error_details\": [],\n    \"items_left\": 0\n  },\n  \"task_owner_type\": null,\n  \"pending?\": true,\n  \"user_id\": 1,\n  \"start_time\": null,\n  \"result\": {\n    \"errors\": [\n      null,\n      null\n    ]\n  },\n  \"uuid\": \"45f57d6b-e2f1-11e1-a64d-525400b68f90\",\n  \"updated_at\": \"2012-08-10T13:42:50Z\",\n  \"state\": \"running\",\n  \"task_type\": \"PulpSyncStatus\",\n  \"task_owner_id\": null,\n  \"id\": 1,\n  \"parameters\": null\n}"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/tasks/show","full_description":"","apis":[{"api_url":"/api/tasks/:id","http_method":"GET","short_description":"Show a task info"}],"errors":[],"params":[{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":"\n<p>task identifier</p>\n"}]}]},"templates":{"name":"Templates","api_url":"/api","version":"1.0","doc_url":"../apidoc/1.0/templates","formats":null,"full_description":"\n<p>System templates allow to group content (products, repositories, packages)\nand handle them in changesets as a unit. They also provide an export\nconsumable by different systems (such as Aeolus Conductor to generate\nsystem images).</p>\n","short_description":null,"methods":[{"name":"index","examples":["GET /api/environments/2/templates/?name=promotion_test_tpl_227e003\n200\n[\n  {\n    \"revision\": 1,\n    \"created_at\": \"2012-08-10T13:44:51Z\",\n    \"name\": \"promotion_test_tpl_227e003\",\n    \"parameters_json\": \"{}\",\n    \"environment_id\": 2,\n    \"updated_at\": \"2012-08-10T13:44:51Z\",\n    \"parent_id\": null,\n    \"id\": 1,\n    \"description\": \"template description\"\n  }\n]"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/templates/index","full_description":"","apis":[{"api_url":"/api/environments/:environment_id/templates","http_method":"GET","short_description":"List system templates for given environment."}],"errors":[],"params":[{"allow_nil":false,"full_name":"environment_id","name":"environment_id","expected_type":"string","validator":"number.","required":true,"description":"\n<p>environment numeric identifier</p>\n"},{"allow_nil":false,"full_name":"name","name":"name","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":false,"description":"\n<p>system template identifier</p>\n"}]},{"name":"show","examples":["GET /api/templates/1\n200\n{\n  \"revision\": 1,\n  \"created_at\": \"2012-08-10T13:44:51Z\",\n  \"name\": \"promotion_test_tpl_227e003\",\n  \"parameters_json\": \"{}\",\n  \"packages\": [],\n  \"repositories\": [],\n  \"products\": [],\n  \"environment_id\": 2,\n  \"updated_at\": \"2012-08-10T13:44:51Z\",\n  \"parent_id\": null,\n  \"pg_categories\": [],\n  \"id\": 1,\n  \"package_groups\": [],\n  \"parameters\": {},\n  \"description\": \"template description\"\n}"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/templates/show","full_description":"","apis":[{"api_url":"/api/templates/:id","http_method":"GET","short_description":"Show a template"}],"errors":[],"params":[{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"number.","required":true,"description":"\n<p>system template numeric identifier</p>\n"}]},{"name":"create","examples":["POST /api/templates/\n{\n  \"template\": {\n    \"name\": \"promotion_test_tpl_227e003\",\n    \"description\": \"template description\"\n  },\n  \"environment_id\": 2\n}\n200\n{\n  \"revision\": 1,\n  \"created_at\": \"2012-08-10T13:44:51Z\",\n  \"name\": \"promotion_test_tpl_227e003\",\n  \"parameters_json\": \"{}\",\n  \"packages\": [],\n  \"repositories\": [],\n  \"products\": [],\n  \"environment_id\": 2,\n  \"updated_at\": \"2012-08-10T13:44:51Z\",\n  \"parent_id\": null,\n  \"pg_categories\": [],\n  \"id\": 1,\n  \"package_groups\": [],\n  \"parameters\": {},\n  \"description\": \"template description\"\n}"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/templates/create","full_description":"","apis":[{"api_url":"/api/templates","http_method":"POST","short_description":"Create a template"}],"errors":[],"params":[{"allow_nil":false,"full_name":"environment_id","name":"environment_id","expected_type":"string","validator":"number.","required":true,"description":"\n<p>environment numeric identifier</p>\n"},{"allow_nil":false,"full_name":"template","name":"template","expected_type":"hash","validator":"Hash","required":true,"params":[{"name":"name","full_name":"template[name]","allow_nil":false,"expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":"\n<p>new template name</p>\n"},{"name":"parent_id","full_name":"template[parent_id]","allow_nil":true,"expected_type":"string","validator":"number.","required":false,"description":"\n<p>parent template numeric identifier</p>\n"},{"name":"description","full_name":"template[description]","allow_nil":true,"expected_type":"string","validator":"String","required":false,"description":"\n<p>template description</p>\n"}],"description":""}]},{"name":"update","examples":["PUT /api/templates/1\n{\n  \"template\": {}\n}\n200\n{\n  \"revision\": 1,\n  \"created_at\": \"2012-08-10T13:44:51Z\",\n  \"name\": \"promotion_test_tpl_227e003\",\n  \"parameters_json\": \"{}\",\n  \"packages\": [],\n  \"repositories\": [],\n  \"products\": [],\n  \"environment_id\": 2,\n  \"updated_at\": \"2012-08-10T13:44:51Z\",\n  \"parent_id\": null,\n  \"pg_categories\": [],\n  \"id\": 1,\n  \"package_groups\": [],\n  \"parameters\": {},\n  \"description\": \"template description\"\n}"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/templates/update","full_description":"","apis":[{"api_url":"/api/templates/:id","http_method":"PUT","short_description":"Update a template"}],"errors":[],"params":[{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"number.","required":true,"description":"\n<p>template numeric identifier</p>\n"},{"allow_nil":false,"full_name":"template","name":"template","expected_type":"hash","validator":"Hash","required":true,"params":[{"name":"name","full_name":"template[name]","allow_nil":false,"expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":false,"description":"\n<p>new template name</p>\n"},{"name":"parent_id","full_name":"template[parent_id]","allow_nil":true,"expected_type":"string","validator":"number.","required":false,"description":"\n<p>parent template numeric identifier</p>\n"},{"name":"description","full_name":"template[description]","allow_nil":true,"expected_type":"string","validator":"String","required":false,"description":"\n<p>template description</p>\n"}],"description":""}]},{"name":"destroy","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/templates/destroy","full_description":"","apis":[{"api_url":"/api/templates/:id","http_method":"DELETE","short_description":"Destroy a template"}],"errors":[],"params":[{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"number.","required":true,"description":"\n<p>template numeric identifier</p>\n"}]},{"name":"import","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/templates/import","full_description":"","apis":[{"api_url":"/api/templates/import","http_method":"POST","short_description":"Import a template"}],"errors":[],"params":[{"allow_nil":false,"full_name":"environment_id","name":"environment_id","expected_type":"string","validator":"number.","required":true,"description":"\n<p>environment numeric identifier</p>\n"},{"allow_nil":false,"full_name":"template_file","name":"template_file","expected_type":"string","validator":"File","required":true,"description":"\n<p>template file to import</p>\n"},{"allow_nil":false,"full_name":"template","name":"template","expected_type":"hash","validator":"Hash","required":true,"params":[{"name":"name","full_name":"template[name]","allow_nil":false,"expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":"\n<p>new template name</p>\n"},{"name":"parent_id","full_name":"template[parent_id]","allow_nil":true,"expected_type":"string","validator":"number.","required":false,"description":"\n<p>parent template numeric identifier</p>\n"},{"name":"description","full_name":"template[description]","allow_nil":true,"expected_type":"string","validator":"String","required":false,"description":"\n<p>template description</p>\n"}],"description":""}]},{"name":"validate","examples":["GET /api/templates/5/validate\n200\nOK"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/templates/validate","full_description":"","apis":[{"api_url":"/api/templates/:id/validate","http_method":"GET","short_description":"Validate a template TDL"}],"errors":[],"params":[{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"number.","required":true,"description":"\n<p>template numeric identifier</p>\n"}]},{"name":"export","examples":["GET /api/templates/5/export\n200\n<?xml version=\"1.0\" encoding=\"UTF-8\"?><template><name>template_227e003</name><os><name>Test Family</name><version>16</version><arch>x86_64</arch><install type=\"url\"><url></url></install><rootpw>redhat</rootpw></os><description>template description</description><packages><package name=\"cheetah\"/><package name=\"@mammal\"/></packages><repositories><repository name=\"repo_227e003\"><url>https://katello.example.com/pulp/repos/org_227e003/env_227e003/custom/fewups_product_227e003/repo_227e003/</url><persisted>No</persisted><clientcert>-----BEGIN CERTIFICATE-----\nMIIG0DCCBbigAwIBAgIIHbTLbK7pLx0wDQYJKoZIhvcNAQEFBQAwfTELMAkGA1UE\nBhMCVVMxFzAVBgNVBAgTDk5vcnRoIENhcm9saW5hMRAwDgYDVQQHEwdSYWxlaWdo\nMRAwDgYDVQQKEwdSZWQgSGF0MREwDwYDVQQLEwhDbG91ZCBCVTEeMBwGA1UEAxMV\ncmhlbDYzLWthdDguaW5lY2FzLmN6MCAXDTEyMDgxMDEzNDI0MVoYDzIxMTIwODEw\nMTM0MjQxWjArMSkwJwYDVQQDEyBmZjgwODA4MTM5MTBjM2QzMDEzOTEwYzVjYjY2\nMDAwOTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBANOH587u34QCl1lS\n4YqxgKf/TUOK9YKZN+HSZI3cs/vH7jqkXd2dH26GIio4euYSOwlGs2DNHVN7GTKd\nhXimmleLpKOr5P2I+L4AzUdh7CwdSqiWZGE7a3kKqDVi6shhVKYObbJ69cOlJbWt\nMbstCEujvspirnfsmRWjkjoUd7wfmDaGQmWT8+W8TXQ+kIln8stUNczh645n4VQd\nw46QSkIBswY3dr99d10l3Wv++neSgGfP6y84jusMMac0Ri0GI7L8DFzXImaN/l/s\nqOIbWrKBBmx9+x82Z7mzFomo4yOFwi4Ik/u2mKoeqbcEqHsdVElEhr/rcn2RaSQW\nkpmBhq0CAwEAAaOCA6IwggOeMBEGCWCGSAGG+EIBAQQEAwIFoDALBgNVHQ8EBAMC\nBLAwgbAGA1UdIwSBqDCBpYAUyWJNwXtzHBXWcAAxLQXys9f04oShgYGkfzB9MQsw\nCQYDVQQGEwJVUzEXMBUGA1UECBMOTm9ydGggQ2Fyb2xpbmExEDAOBgNVBAcTB1Jh\nbGVpZ2gxEDAOBgNVBAoTB1JlZCBIYXQxETAPBgNVBAsTCENsb3VkIEJVMR4wHAYD\nVQQDExVyaGVsNjMta2F0OC5pbmVjYXMuY3qCCQCySNeEniLL0jAdBgNVHQ4EFgQU\nW/VVEqoWrRZFpSzf2yF8YQYdUaYwEwYDVR0lBAwwCgYIKwYBBQUHAwIwLwYQKwYB\nBAGSCAkBp5GGl5EYAQQbDBlvcmdfMjI3ZTAwM191ZWJlcl9wcm9kdWN0MBYGECsG\nAQQBkggJAaeRhpeRGAMEAgwAMBYGECsGAQQBkggJAaeRhpeRGAIEAgwAMBkGECsG\nAQQBkggJAqeRhpeRHwEEBQwDeXVtMCQGESsGAQQBkggJAqeRhpeRHwEBBA8MDXVl\nYmVyX2NvbnRlbnQwMgYRKwYBBAGSCAkCp5GGl5EfAQIEHQwbMTM0NDYwNjE2MTA0\nOF91ZWJlcl9jb250ZW50MB0GESsGAQQBkggJAqeRhpeRHwEFBAgMBkN1c3RvbTAj\nBhErBgEEAZIICQKnkYaXkR8BBgQODAwvb3JnXzIyN2UwMDMwFwYRKwYBBAGSCAkC\np5GGl5EfAQcEAgwAMBgGESsGAQQBkggJAqeRhpeRHwEIBAMMATEwKQYKKwYBBAGS\nCAkEAQQbDBlvcmdfMjI3ZTAwM191ZWJlcl9wcm9kdWN0MDAGCisGAQQBkggJBAIE\nIgwgZmY4MDgwODEzOTEwYzNkMzAxMzkxMGM1YzhiMDAwMDUwHQYKKwYBBAGSCAkE\nAwQPDA0xMzQ0NjA2MTYxMDQ4MBEGCisGAQQBkggJBAUEAwwBMTAkBgorBgEEAZII\nCQQGBBYMFDIwMTItMDgtMTBUMTM6NDI6NDFaMCQGCisGAQQBkggJBAcEFgwUMjEx\nMi0wOC0xMFQxMzo0Mjo0MVowEQYKKwYBBAGSCAkEDAQDDAEwMBEGCisGAQQBkggJ\nBA4EAwwBMDARBgorBgEEAZIICQQLBAMMATEwNAYKKwYBBAGSCAkFAQQmDCQ0M2Iw\nNTRiMi0yZGQ1LTQyNzAtODU4Zi03NTM5NDAwZjM5YTIwDQYJKoZIhvcNAQEFBQAD\nggEBABRG4zWXgy7NVXoMtsYOtqvnYX7XzzMSSrljGqa3DRpWsTLYTNfkyRgODlXP\nqAGN8z0ITgbgpUyqX5Ehvfo7j5gly0CdPZu54gPS3MBVxxSbrTTQ0vl91zPusA9W\n9/ZzIREdcpDaTJzPL3o2mBw9IrwXHtjDotZjXQj8Yw5cjiaIYIDb9PG9EgDaTHTr\nsBMJSg+Z7EMdxxMFNZY8AJrxL2c+Cis8eP0IXvUtLgYwlQ1X1hqovrQZbJK1YIFc\nem9FfbssaBnY1DnW1j8JZAUoZ6Dc0VAHZdHIXjJeahoN9RDXHvUcGFIan41vcwM9\n4lgwKGnTV67bozjBm+s8eek+sW8=\n-----END CERTIFICATE-----\n</clientcert><clientkey>-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEA04fnzu7fhAKXWVLhirGAp/9NQ4r1gpk34dJkjdyz+8fuOqRd\n3Z0fboYiKjh65hI7CUazYM0dU3sZMp2FeKaaV4uko6vk/Yj4vgDNR2HsLB1KqJZk\nYTtreQqoNWLqyGFUpg5tsnr1w6Ulta0xuy0IS6O+ymKud+yZFaOSOhR3vB+YNoZC\nZZPz5bxNdD6QiWfyy1Q1zOHrjmfhVB3DjpBKQgGzBjd2v313XSXda/76d5KAZ8/r\nLziO6wwxpzRGLQYjsvwMXNciZo3+X+yo4htasoEGbH37HzZnubMWiajjI4XCLgiT\n+7aYqh6ptwSoex1USUSGv+tyfZFpJBaSmYGGrQIDAQABAoIBAF3tkjxsC6pFsEkE\nqYv5h8SRdBCS6rOkL5FB6E6p+u3JeHpntBqNA4EDZLZUwBXbcIWM9Gf+jJAeMDEu\niy7o484N/vyCfrsqEDHmj0CsNb/c/eLgbRBT30QvPEQAeXqi5YCbFZDUUr8eXSFQ\nF64ir/VOb5DUwt4TnGJkcLEDl6tbmWoAOWCmHpOqdR4BU2tqIWZXqeUPIxfDAq72\nxpFdPhW3/XbGBFiRPkNrckarlK06xUWZyKr+kQCc8rVKCAiVwVkZAHbZTusQzC4Y\n3lCEzg2ToU7az2+HRMMbJYFt0bxnGFytgFSrNdUOdXB3oPj0FpDTdhK9W63tjAu5\nlTuul60CgYEA8Cp+B8bFJsNMbLyLCrE+Te/3N2GD+1tPhaXt2WIXkSSxpjzlKRo9\ncygdbVjgguEXSwjX7b5Nbus8dG1XwF3RxprfjJoz1G0WFRsuSQEaQUpqIMXBD29v\npPxS0U8CDnop9dwQ9DMotfz0tuaULbSVHvFta5j6JjcQ0Gmbj+OuSPMCgYEA4Xoc\nji8FR2D5ZwQ7FsAAXIz0m24F+evNw89kQHz3H1ydaKDuM6d4c0oIqQ9vMZVXsNd4\nBLfWX356q3sBTwZ+xxKDbV4AuK/d6N+j0BtjerKO8zZCV2b7+IwhrLzce1pdDKL9\nBoD+vvMdWM6DIlEr43z/kqprAAMbXs6TdSo+2d8CgYEAyv7/m88UoRj+JgKPe7Ao\nu3OS/8p65iBd7Nc9XTqeNN5REfPytnUpb4Z+qQgwbC+ZoqCM8rShepl2depd+4jR\nYQ9S2OMV3/18ZsacrrQx3vHpFl5QOp20Pj3QOn6PfHEhumASLHZ5eKmgpl/q617x\nlD/4frPE7DwrCB3bkRmfHKUCgYBgu1aM2TdWjA/zVilTdUOycPZvyB/gPH2mR88m\nq3YJil4tiP0oQ+y06UoV3X1CtGNOhuIChCwAA+70qmzBTnQNS6/+t5lvomN9iJRq\nr5VaCkixptGHVbM7ykKYLN4aPYY16abLp4OiwAITG2W+zzwY+INclKga9TpEzjMM\nzPbx2QKBgGbn+Rop8m09d/xaiRdoedRuaaIf5fH/nGb3BpUXe6Y3PYwbl5lXb41M\nUKdjr/S+rl1rVJOq0en8uVNOh+nPeBfd5DQ6v6zk679X6nuLxzlHUlhpN3Y6QFR7\nZtikyjWc7jNdm495jW3lRTmI/LvFTjGB9LSp0/E76euOYa1tItaj\n-----END RSA PRIVATE KEY-----\n</clientkey></repository></repositories></template>"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/templates/export","full_description":"","apis":[{"api_url":"/api/templates/:id/export","http_method":"GET","short_description":"Export template as TDL or JSON"}],"errors":[],"params":[{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"number.","required":true,"description":"\n<p>template numeric identifier</p>\n"}]}]},"role_ldap_groups":{"name":"Role ldap groups","api_url":"/api","version":"1.0","doc_url":"../apidoc/1.0/role_ldap_groups","formats":null,"full_description":null,"short_description":null,"methods":[{"name":"create","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/role_ldap_groups/create","full_description":"","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"}],"errors":[],"params":[{"allow_nil":false,"full_name":"name","name":"name","expected_type":"string","validator":"String","required":false,"description":"\n<p>name of the LDAP group</p>\n"}]},{"name":"destroy","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/role_ldap_groups/destroy","full_description":"","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"}],"errors":[],"params":[{"allow_nil":false,"full_name":"role_id","name":"role_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":false,"description":"\n<p>role identifier</p>\n"},{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"String","required":false,"description":"\n<p>ldap group (name)</p>\n"}]},{"name":"index","examples":["GET /api/roles/7/ldap_groups/\n200\n[\n\n]"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/role_ldap_groups/index","full_description":"","apis":[{"api_url":"/api/roles/:role_id/ldap_groups","http_method":"GET","short_description":"List LDAP groups associated with the role"}],"errors":[],"params":[{"allow_nil":false,"full_name":"role_id","name":"role_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":false,"description":"\n<p>role identifier</p>\n"}]}]},"organizations":{"name":"Organizations","api_url":"/api","version":"1.0","doc_url":"../apidoc/1.0/organizations","formats":null,"full_description":null,"short_description":null,"methods":[{"name":"index","examples":["GET /api/organizations/\n200\n[\n  {\n    \"created_at\": \"2012-08-10T13:41:14Z\",\n    \"service_levels\": [],\n    \"name\": \"ACME_Corporation\",\n    \"updated_at\": \"2012-08-10T13:41:14Z\",\n    \"task_id\": null,\n    \"id\": 1,\n    \"label\": \"ACME_Corporation\",\n    \"description\": \"ACME_Corporation Organization\"\n  },\n  {\n    \"created_at\": \"2012-08-10T13:42:39Z\",\n    \"service_levels\": [],\n    \"name\": \"org_227e003\",\n    \"updated_at\": \"2012-08-10T13:50:00Z\",\n    \"task_id\": null,\n    \"id\": 2,\n    \"label\": \"org_227e003\",\n    \"description\": \"org description 2\"\n  }\n]"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/organizations/index","full_description":"","apis":[{"api_url":"/api/organizations","http_method":"GET","short_description":"List organizations"}],"errors":[],"params":[{"allow_nil":false,"full_name":"name","name":"name","expected_type":"string","validator":"String","required":false,"description":"\n<p>name for the organization</p>\n"},{"allow_nil":false,"full_name":"description","name":"description","expected_type":"string","validator":"String","required":false,"description":""},{"allow_nil":false,"full_name":"label","name":"label","expected_type":"string","validator":"String","required":false,"description":"\n<p>label for filtering</p>\n"}]},{"name":"show","examples":["GET /api/organizations/org_227e003\n200\n{\n  \"created_at\": \"2012-08-10T13:42:39Z\",\n  \"service_levels\": [],\n  \"name\": \"org_227e003\",\n  \"updated_at\": \"2012-08-10T13:42:39Z\",\n  \"task_id\": null,\n  \"id\": 2,\n  \"label\": \"org_227e003\",\n  \"description\": \"org description\"\n}"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/organizations/show","full_description":"","apis":[{"api_url":"/api/organizations/:id","http_method":"GET","short_description":"Show an organization"}],"errors":[],"params":[]},{"name":"create","examples":["POST /api/organizations/\n{\n  \"name\": \"org_227e003\",\n  \"description\": \"org description\"\n}\n200\n{\n  \"created_at\": \"2012-08-10T13:42:39Z\",\n  \"service_levels\": [],\n  \"name\": \"org_227e003\",\n  \"updated_at\": \"2012-08-10T13:42:39Z\",\n  \"task_id\": null,\n  \"id\": 2,\n  \"label\": \"org_227e003\",\n  \"description\": \"org description\"\n}"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/organizations/create","full_description":"","apis":[{"api_url":"/api/organizations","http_method":"POST","short_description":"Create an organization"}],"errors":[],"params":[{"allow_nil":false,"full_name":"name","name":"name","expected_type":"string","validator":"String","required":true,"description":"\n<p>name for the organization</p>\n"},{"allow_nil":false,"full_name":"description","name":"description","expected_type":"string","validator":"String","required":false,"description":""}]},{"name":"update","examples":["PUT /api/organizations/org_227e003\n{\n  \"organization\": {\n    \"description\": \"org description 2\"\n  }\n}\n200\ntrue"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/organizations/update","full_description":"","apis":[{"api_url":"/api/organizations/:id","http_method":"PUT","short_description":"Update an organization"}],"errors":[],"params":[{"allow_nil":false,"full_name":"organization","name":"organization","expected_type":"hash","validator":"Hash","required":false,"params":[{"name":"name","full_name":"organization[name]","allow_nil":false,"expected_type":"string","validator":"String","required":false,"description":"\n<p>name for the organization</p>\n"},{"name":"description","full_name":"organization[description]","allow_nil":false,"expected_type":"string","validator":"String","required":false,"description":""}],"description":""}]},{"name":"destroy","examples":["DELETE /api/organizations/org_manifest_227e003\n202\n{\n  \"finish_time\": null,\n  \"created_at\": \"2012-08-10T13:53:34Z\",\n  \"organization_id\": 3,\n  \"progress\": null,\n  \"task_owner_type\": null,\n  \"pending?\": true,\n  \"user_id\": 1,\n  \"start_time\": null,\n  \"result\": null,\n  \"uuid\": \"56cc9d06-5d69-453d-b36d-6baa1626025b\",\n  \"updated_at\": \"2012-08-10T13:53:34Z\",\n  \"state\": \"waiting\",\n  \"task_type\": \"TaskStatus\",\n  \"task_owner_id\": null,\n  \"id\": 23,\n  \"parameters\": null\n}"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/organizations/destroy","full_description":"","apis":[{"api_url":"/api/organizations/:id","http_method":"DELETE","short_description":"Destroy an organization. Asynchronous operation."}],"errors":[],"params":[]}]},"content_view_definitions":{"name":"Content view definitions","api_url":"/api","version":"1.0","doc_url":"../apidoc/1.0/content_view_definitions","formats":null,"full_description":null,"short_description":null,"methods":[{"name":"index","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/content_view_definitions/index","full_description":"","apis":[{"api_url":"/api/organizations/:organization_id/content_view_definitions","http_method":"GET","short_description":"List content view definitions"}],"errors":[],"params":[{"allow_nil":false,"full_name":"organization_id","name":"organization_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":false,"description":"\n<p>organization identifier</p>\n"},{"allow_nil":false,"full_name":"label","name":"label","expected_type":"string","validator":"String","required":false,"description":"\n<p>content view label</p>\n"},{"allow_nil":false,"full_name":"name","name":"name","expected_type":"string","validator":"String","required":false,"description":"\n<p>content view name</p>\n"},{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":false,"description":"\n<p>content view id</p>\n"}]},{"name":"create","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/content_view_definitions/create","full_description":"","apis":[{"api_url":"/api/content_view_definitions","http_method":"POST","short_description":"Create a content view definition"}],"errors":[],"params":[{"allow_nil":false,"full_name":"organization_id","name":"organization_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":false,"description":"\n<p>organization identifier</p>\n"},{"allow_nil":false,"full_name":"content_view_definition","name":"content_view_definition","expected_type":"hash","validator":"Hash","required":true,"params":[{"name":"name","full_name":"content_view_definition[name]","allow_nil":false,"expected_type":"string","validator":"String","required":true,"description":"\n<p>Content view definition name</p>\n"},{"name":"description","full_name":"content_view_definition[description]","allow_nil":true,"expected_type":"string","validator":"String","required":false,"description":"\n<p>Definition description</p>\n"},{"name":"label","full_name":"content_view_definition[label]","allow_nil":false,"expected_type":"string","validator":"String","required":false,"description":"\n<p>Content view identifier</p>\n"}],"description":""}]},{"name":"update","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/content_view_definitions/update","full_description":"","apis":[{"api_url":"/api/organizations/:org/content_view_definitions/:id","http_method":"PUT","short_description":"Update a definition"}],"errors":[],"params":[{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"number.","required":true,"description":"\n<p>Definition identifer</p>\n"},{"allow_nil":false,"full_name":"org","name":"org","expected_type":"string","validator":"String","required":true,"description":"\n<p>Organization name</p>\n"},{"allow_nil":false,"full_name":"content_view_definition","name":"content_view_definition","expected_type":"hash","validator":"Hash","required":true,"params":[{"name":"name","full_name":"content_view_definition[name]","allow_nil":false,"expected_type":"string","validator":"String","required":false,"description":"\n<p>Content view definition name</p>\n"},{"name":"description","full_name":"content_view_definition[description]","allow_nil":true,"expected_type":"string","validator":"String","required":false,"description":"\n<p>Definition description</p>\n"}],"description":""}]},{"name":"show","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/content_view_definitions/show","full_description":"","apis":[{"api_url":"/api/content_view_definitions/:id","http_method":"GET","short_description":"Show definition info"}],"errors":[],"params":[{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"number.","required":true,"description":"\n<p>Definition identifier</p>\n"}]},{"name":"publish","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/content_view_definitions/publish","full_description":"","apis":[{"api_url":"/api/organizations/:name/content_view_definitions/:id/publish","http_method":"POST","short_description":"Publish a content view"}],"errors":[],"params":[{"allow_nil":false,"full_name":"name","name":"name","expected_type":"string","validator":"String","required":true,"description":"\n<p>Name for the new content view</p>\n"},{"allow_nil":false,"full_name":"label","name":"label","expected_type":"string","validator":"String","required":false,"description":"\n<p>Label for the new content view</p>\n"},{"allow_nil":false,"full_name":"description","name":"description","expected_type":"string","validator":"String","required":false,"description":"\n<p>Description for the new content view</p>\n"},{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":"\n<p>Definition identifier</p>\n"}]},{"name":"destroy","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/content_view_definitions/destroy","full_description":"","apis":[{"api_url":"/api/content_view_definitions/:id","http_method":"DELETE","short_description":"Delete a cv definition"}],"errors":[],"params":[{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":"\n<p>Definition identifier</p>\n"}]},{"name":"content_views","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/content_view_definitions/content_views","full_description":"","apis":[{"api_url":"/api/content_view_definitions/:id/content_views","http_method":"GET","short_description":"List a definition's content views"}],"errors":[],"params":[{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":"\n<p>Definition identifier</p>\n"}]},{"name":"update_content_views","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/content_view_definitions/update_content_views","full_description":"","apis":[{"api_url":"/api/content_view_definitions/:id/content_views","http_method":"PUT","short_description":"Update a definition's content views"}],"errors":[],"params":[{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":"\n<p>Definition identifier</p>\n"},{"allow_nil":false,"full_name":"views","name":"views","expected_type":"string","validator":"Array","required":true,"description":"\n<p>Updated list of view ids</p>\n"}]}]},"changesets":{"name":"Changesets","api_url":"/api","version":"1.0","doc_url":"../apidoc/1.0/changesets","formats":null,"full_description":null,"short_description":null,"methods":[{"name":"index","examples":["GET /api/organizations/org_227e003/environments/3/changesets/?name=changeset_227e003\n200\n[\n  {\n    \"created_at\": \"2012-08-10T13:43:17Z\",\n    \"name\": \"changeset_227e003\",\n    \"task_status_id\": null,\n    \"environment_id\": 3,\n    \"updated_at\": \"2012-08-10T13:43:17Z\",\n    \"state\": \"new\",\n    \"promotion_date\": null,\n    \"id\": 1,\n    \"environment_name\": \"env 227e003\",\n    \"description\": null\n  }\n]"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/changesets/index","full_description":"","apis":[{"api_url":"/api/organizations/:organization_id/environments/:environment_id/changesets","http_method":"GET","short_description":"List changesets in an environment"}],"errors":[],"params":[{"allow_nil":false,"full_name":"name","name":"name","expected_type":"string","validator":"String","required":false,"description":"\n<p>An optional changeset name to filter upon</p>\n"}]},{"name":"show","examples":["GET /api/changesets/1\n200\n{\n  \"created_at\": \"2012-08-10T13:43:17Z\",\n  \"name\": \"changeset_227e003\",\n  \"repos\": [],\n  \"distributions\": [],\n  \"task_status_id\": null,\n  \"packages\": [],\n  \"system_templates\": [],\n  \"products\": [],\n  \"environment_id\": 3,\n  \"updated_at\": \"2012-08-10T13:43:17Z\",\n  \"state\": \"new\",\n  \"promotion_date\": null,\n  \"errata\": [],\n  \"id\": 1,\n  \"description\": null\n}"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/changesets/show","full_description":"","apis":[{"api_url":"/api/changesets/:id","http_method":"GET","short_description":"Show a changeset"}],"errors":[],"params":[]},{"name":"update","examples":["PUT /api/changesets/1\n{\n  \"changeset\": {}\n}\n200\n{\n  \"created_at\": \"2012-08-10T13:43:17Z\",\n  \"name\": \"changeset_227e003\",\n  \"task_status_id\": null,\n  \"environment_id\": 3,\n  \"updated_at\": \"2012-08-10T13:43:17Z\",\n  \"state\": \"new\",\n  \"promotion_date\": null,\n  \"id\": 1,\n  \"description\": null\n}"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/changesets/update","full_description":"","apis":[{"api_url":"/api/changesets/:id","http_method":"PUT","short_description":"Update a changeset"}],"errors":[],"params":[{"allow_nil":false,"full_name":"changeset","name":"changeset","expected_type":"hash","validator":"Hash","required":true,"params":[{"name":"name","full_name":"changeset[name]","allow_nil":false,"expected_type":"string","validator":"String","required":false,"description":"\n<p>The name of the changeset</p>\n"},{"name":"description","full_name":"changeset[description]","allow_nil":true,"expected_type":"string","validator":"String","required":false,"description":"\n<p>The description of the changeset</p>\n"}],"description":""}]},{"name":"dependencies","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/changesets/dependencies","full_description":"","apis":[{"api_url":"/api/changesets/:id/dependencies","http_method":"GET","short_description":"List the Depenencies for a changeset"}],"errors":[],"params":[]},{"name":"create","examples":["POST /api/organizations/org_227e003/environments/3/changesets/\n{\n  \"changeset\": {\n    \"name\": \"changeset_227e003\",\n    \"description\": null\n  }\n}\n200\n{\n  \"created_at\": \"2012-08-10T13:43:17Z\",\n  \"name\": \"changeset_227e003\",\n  \"task_status_id\": null,\n  \"environment_id\": 3,\n  \"updated_at\": \"2012-08-10T13:43:17Z\",\n  \"state\": \"new\",\n  \"promotion_date\": null,\n  \"id\": 1,\n  \"description\": null\n}"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/changesets/create","full_description":"","apis":[{"api_url":"/api/organizations/:organization_id/environments/:environment_id/changesets","http_method":"POST","short_description":"Create a changeset"}],"errors":[],"params":[{"allow_nil":false,"full_name":"changeset","name":"changeset","expected_type":"hash","validator":"Hash","required":true,"params":[{"name":"name","full_name":"changeset[name]","allow_nil":false,"expected_type":"string","validator":"String","required":true,"description":"\n<p>The name of the changeset</p>\n"},{"name":"description","full_name":"changeset[description]","allow_nil":true,"expected_type":"string","validator":"String","required":false,"description":"\n<p>The description of the changeset</p>\n"},{"name":"type","full_name":"changeset[type]","allow_nil":false,"expected_type":"string","validator":"Must be one of: PROMOTION, DELETION.","required":true,"description":""}],"description":""}]},{"name":"promote","examples":["POST /api/changesets/1/promote\n202\n{\n  \"finish_time\": null,\n  \"created_at\": \"2012-08-10T13:43:21Z\",\n  \"organization_id\": 2,\n  \"progress\": null,\n  \"task_owner_type\": null,\n  \"pending?\": true,\n  \"user_id\": 1,\n  \"start_time\": null,\n  \"result\": null,\n  \"uuid\": \"776e7ee0-3ff6-4994-a37a-50a8d5b0375e\",\n  \"updated_at\": \"2012-08-10T13:43:21Z\",\n  \"state\": \"waiting\",\n  \"task_type\": \"TaskStatus\",\n  \"task_owner_id\": null,\n  \"id\": 4,\n  \"parameters\": null\n}"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/changesets/promote","full_description":"","apis":[{"api_url":"/api/changesets/:id/promote","http_method":"POST","short_description":"Promote a changeset into a new envrionment."}],"errors":[],"params":[]},{"name":"destroy","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/changesets/destroy","full_description":"","apis":[{"api_url":"/api/changesets/:id","http_method":"DELETE","short_description":"Destroy a changeset"}],"errors":[],"params":[]}]},"errata":{"name":"Errata","api_url":"/api","version":"1.0","doc_url":"../apidoc/1.0/errata","formats":null,"full_description":"","short_description":null,"methods":[{"name":"index","examples":["GET /api/errata?environment_id=2\n200\n[\n  {\n    \"title\": \"Empty errata\",\n    \"repoids\": [\n      \"org_227e003-fewups_product_227e003-fewups_product_227e003_fakerepos_zoo5\",\n      \"org_227e003-fewups_product_227e003-repo_227e003\",\n      \"org_227e003-env_227e003-fewups_product_227e003-fewups_product_227e003_fakerepos_zoo5\",\n      \"org_227e003-env_227e003-fewups_product_227e003-repo_227e003\"\n    ],\n    \"type\": \"security\",\n    \"severity\": \"\",\n    \"_id\": \"RHEA-2010:0001\",\n    \"id\": \"RHEA-2010:0001\"\n  },\n  {\n    \"title\": \"One package errata\",\n    \"repoids\": [\n      \"org_227e003-fewups_product_227e003-fewups_product_227e003_fakerepos_zoo5\",\n      \"org_227e003-fewups_product_227e003-repo_227e003\",\n      \"org_227e003-env_227e003-fewups_product_227e003-fewups_product_227e003_fakerepos_zoo5\",\n      \"org_227e003-env_227e003-fewups_product_227e003-repo_227e003\"\n    ],\n    \"type\": \"security\",\n    \"severity\": \"\",\n    \"_id\": \"RHEA-2010:0002\",\n    \"id\": \"RHEA-2010:0002\"\n  },\n  {\n    \"title\": \"Empty errata\",\n    \"repoids\": [\n      \"org_227e003-fewups_product_227e003-fewups_product_227e003_fakerepos_zoo5\",\n      \"org_227e003-fewups_product_227e003-repo_227e003\",\n      \"org_227e003-env_227e003-fewups_product_227e003-fewups_product_227e003_fakerepos_zoo5\",\n      \"org_227e003-env_227e003-fewups_product_227e003-repo_227e003\"\n    ],\n    \"type\": \"security\",\n    \"severity\": \"\",\n    \"_id\": \"RHEA-2010:0001\",\n    \"id\": \"RHEA-2010:0001\"\n  },\n  {\n    \"title\": \"One package errata\",\n    \"repoids\": [\n      \"org_227e003-fewups_product_227e003-fewups_product_227e003_fakerepos_zoo5\",\n      \"org_227e003-fewups_product_227e003-repo_227e003\",\n      \"org_227e003-env_227e003-fewups_product_227e003-fewups_product_227e003_fakerepos_zoo5\",\n      \"org_227e003-env_227e003-fewups_product_227e003-repo_227e003\"\n    ],\n    \"type\": \"security\",\n    \"severity\": \"\",\n    \"_id\": \"RHEA-2010:0002\",\n    \"id\": \"RHEA-2010:0002\"\n  }\n]"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/errata/index","full_description":"\n<p>Either :repoid or :product_id is required.</p>\n","apis":[{"api_url":"/api/errata","http_method":"GET","short_description":"List errata"},{"api_url":"/api/repositories/:repository_id/errata","http_method":"GET","short_description":"List errata"}],"errors":[{"code":401,"description":"Unauthorized"},{"code":404,"description":"Not found"},{"code":400,"description":"Repo id or environment must be provided"}],"params":[{"allow_nil":false,"full_name":"environment_id","name":"environment_id","expected_type":"string","validator":"number.","required":false,"description":"\n<p>Id of environment containing the errata.</p>\n"},{"allow_nil":false,"full_name":"product_id","name":"product_id","expected_type":"string","validator":"number.","required":false,"description":"\n<p>The product which contains the errata.</p>\n"},{"allow_nil":false,"full_name":"repoid","name":"repoid","expected_type":"string","validator":"number.","required":false,"description":"\n<p>Id of repository containing the errata.</p>\n"},{"allow_nil":false,"full_name":"severity","name":"severity","expected_type":"string","validator":"String","required":false,"description":"\n<p>Severity of errata. Usually one of: Critical, Important, Moderate, Low.\nCase insensitive.</p>\n"},{"allow_nil":false,"full_name":"type","name":"type","expected_type":"string","validator":"String","required":false,"description":"\n<p>Type of errata. Usually one of: security, bugfix, enhancement. Case\ninsensitive.</p>\n"}]},{"name":"show","examples":["GET /api/repositories/2/errata/RHEA-2010:0002/\n200\n{\n  \"release\": \"1\",\n  \"from_str\": \"lzap+pub@redhat.com\",\n  \"pkglist\": [\n    {\n      \"name\": \"1\",\n      \"short\": \"\",\n      \"packages\": [\n        {\n          \"name\": \"elephant\",\n          \"src\": \"http://www.fedoraproject.org\",\n          \"release\": \"0.8\",\n          \"epoch\": null,\n          \"arch\": \"noarch\",\n          \"version\": \"0.3\",\n          \"filename\": \"elephant-0.3-0.8.noarch.rpm\"\n        }\n      ]\n    }\n  ],\n  \"immutable\": true,\n  \"title\": \"One package errata\",\n  \"repo_defined\": true,\n  \"repoids\": [\n    \"org_227e003-fewups_product_227e003-fewups_product_227e003_fakerepos_zoo5\",\n    \"org_227e003-fewups_product_227e003-repo_227e003\",\n    \"org_227e003-env_227e003-fewups_product_227e003-fewups_product_227e003_fakerepos_zoo5\",\n    \"org_227e003-env_227e003-fewups_product_227e003-repo_227e003\"\n  ],\n  \"pushcount\": 1,\n  \"solution\": \"\",\n  \"reboot_suggested\": false,\n  \"type\": \"security\",\n  \"updated\": \"\",\n  \"status\": \"stable\",\n  \"version\": \"1\",\n  \"severity\": \"\",\n  \"rights\": \"\",\n  \"_id\": \"RHEA-2010:0002\",\n  \"issued\": \"2010-01-01 01:01:01\",\n  \"references\": [],\n  \"id\": \"RHEA-2010:0002\",\n  \"_ns\": \"errata\",\n  \"summary\": \"\",\n  \"description\": \"One package errata\"\n}"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/errata/show","full_description":"","apis":[{"api_url":"/api/repositories/:repository_id/errata/:id","http_method":"GET","short_description":"Show an erratum"}],"errors":[{"code":401,"description":"Unauthorized"},{"code":404,"description":"Not found"}],"params":[]}]},"subscriptions":{"name":"Subscriptions","api_url":"/api","version":"1.0","doc_url":"../apidoc/1.0/subscriptions","formats":null,"full_description":"\n<p>Systems subscriptions management.</p>\n","short_description":null,"methods":[{"name":"index","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/subscriptions/index","full_description":"","apis":[{"api_url":"/api/systems/:system_id/subscriptions","http_method":"GET","short_description":"List subscriptions"}],"errors":[],"params":[{"allow_nil":false,"full_name":"system_id","name":"system_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":"\n<p>System uuid</p>\n"}]},{"name":"create","examples":["POST /api/systems/d2a99f27-6c0d-41de-9f3d-3279e4fbadd4/subscriptions\n{\n  \"quantity\": 1,\n  \"pool\": \"ff8080813910c3d3013910c5e47b000d\"\n}\n200\n{\n  \"created_at\": \"2012-08-10T13:56:31Z\",\n  \"name\": \"admin_system_227e003\",\n  \"release\": \"\",\n  \"href\": \"/consumers/d2a99f27-6c0d-41de-9f3d-3279e4fbadd4\",\n  \"environment\": {\n    \"prior\": \"Library\",\n    \"created_at\": \"2012-08-10T13:42:44Z\",\n    \"name\": \"env 227e003\",\n    \"prior_id\": 2,\n    \"organization_id\": 2,\n    \"library\": false,\n    \"updated_at\": \"2012-08-10T13:42:44Z\",\n    \"organization\": \"org_227e003\",\n    \"id\": 3,\n    \"description\": null\n  },\n  \"owner\": {\n    \"href\": \"/owners/org_227e003\",\n    \"key\": \"org_227e003\",\n    \"id\": \"ff8080813910c3d3013910c5c1460003\",\n    \"displayName\": \"org_227e003\"\n  },\n  \"idCert\": {\n    \"key\": \"-----BEGIN RSA PRIVATE KEY-----\\nMIIEpAIBAAKCAQEAp95esmGZsOntZSgSBAYmNceQ3D77s6hBuQ8RytPRQlo+BBv9\\n/jWD/Qg8q627J55N0O4VKNX3o8NNTuULZ3wRpmUnG28n9NjBkMhYMVxVflnxXGI6\\nI3P+eh0ExLBO0JKm0Ozvh7/96mbrrnRH3Ky3SAiYehcb+IoFPOlK8emxW4H32NT9\\n+kvgX7os5cq+DTMIC+DUU3k1IOd8d+nIymD97McXAd+eBoi1r2hjLfHboRLT5lmp\\ni/yHcd9V0zMDfL0u2ccrh1szz6GdmJ0o3TRq3NyotTt9K+8bDArwL+MZd9Wd3EDl\\nw/SBSqLMJw6QGGGcD9MNeKbyzipBA8TyMB2uWwIDAQABAoIBAQCkaSOAPB0l64bJ\\nqzwx2r/zrjiPrdQhemqcUEkRyPFLtkzFA5F5N3rFCRs63dXOkLoQJg5tR1radn6y\\nBZxsx1QWDz4FHZIZuW2jWsUd2xwUuwysebwNWx7jBKbV6QPYPbnKKDTVVNHgkNrF\\nqzdyx2pez6Re92E6xBsrNCZl1ocRYhx+kyFTWDQZ3lPHI4Ki/l7s4BrUn0Ipmwy0\\nOt0RYmSgljgapLioz4jn//hoR7Nl/HMjWw3DYnYiYWL/bkIHq46IgrW9uX6A4AHk\\nL2sZIwzKIfBzEhG8qF5toXiftA3hGA+7y03l+fMjZJJpZ+Vpc8fxnq2bOrZvzhRJ\\nfc6W22iBAoGBANG2sC8FIqSENJuRETLUAHSDvzfNL8QD+UMg6/ons7/k3cj0Fua9\\n0qhPO7NayHQUGhGUNMU8mUEe+0rIOX4qzT/21p6ugpp2r4r7ZU1lxAW4VRgzaFve\\nynu8foiRpN4yAIpRmvtToJLPJrUjo94w0a9n98arO+Ism1iGAD/5dYvBAoGBAMzr\\nV2aoEXYkligZvnRTBqxDNF6qmK/p/5+4NIKYvWtDSFEHmlF8wh9C43ywc2K30bJb\\nNnzqGlNl8e3WQXXzAyLf0uNJ6zQoWoEnhVZ4DHWaFERckEMhr4QhUecVwljgsCcl\\nF7p8W3kbokqCzqzwCmiyFpIG6LH6QtBrWYt++DEbAoGBAJPkGsE+BN0yIotmtVM7\\n8Io6croeaEX6a2ksqV2DbB6yfrl9cT0NtqZdIgPszJoXpv6onsJNZuJmv95P70OL\\nWa13HIlRFedqNYd0nE8FqkRCZzgm4LyRFAhIuI8E7tiHOJxSylHc+sstbOWnGaPS\\nl7z0O+cN0LBCttapwTlcacnBAoGAGwvs60W/mEJX907+jkfvF4l/PgdyQ7W04ZXk\\niGA0kBW/U8KXIa4/yPSBJhH8CMmOSeY0GOSlOOC5v9SJq1G51j6IjStSef3hhC59\\nMN6DdnoxtpwpBlNJ4TysnL2Ie0acuW3x5dFIGYIGN6NwN+8u0IbA5+E1kVggvXWN\\nyhWmGIUCgYBOyh3umRnQV/zf9nOfNd6kdfdomiP2sbI8AxB5mHYGFWwu4hvWL3WY\\ni7UAzsaAvCBfYxmqGjccOO6Vj4w4scL+87mjAZ+K+x3WYNqUE2LNkUERTadoIv4D\\nEHhokZe9wq7fAUecJdRLD5uUprFt956p5f7afTkWMTnkX4v+Ki9Pwg==\\n-----END RSA PRIVATE KEY-----\\n\",\n    \"updated\": \"2012-08-10T13:56:31.330+0000\",\n    \"serial\": {\n      \"expiration\": \"2028-08-10T13:56:31.094+0000\",\n      \"updated\": \"2012-08-10T13:56:31.120+0000\",\n      \"serial\": 633745815739335707,\n      \"revoked\": false,\n      \"collected\": false,\n      \"id\": 633745815739335707,\n      \"created\": \"2012-08-10T13:56:31.120+0000\"\n    },\n    \"id\": \"ff8080813910c3d3013910d273e200a5\",\n    \"created\": \"2012-08-10T13:56:31.330+0000\",\n    \"cert\": \"-----BEGIN CERTIFICATE-----\\nMIIEaTCCA1GgAwIBAgIICMuEdjEIhBswDQYJKoZIhvcNAQEFBQAwfTELMAkGA1UE\\nBhMCVVMxFzAVBgNVBAgTDk5vcnRoIENhcm9saW5hMRAwDgYDVQQHEwdSYWxlaWdo\\nMRAwDgYDVQQKEwdSZWQgSGF0MREwDwYDVQQLEwhDbG91ZCBCVTEeMBwGA1UEAxMV\\ncmhlbDYzLWthdDguaW5lY2FzLmN6MB4XDTEyMDgxMDEzNTYzMVoXDTI4MDgxMDEz\\nNTYzMVowLzEtMCsGA1UEAxMkZDJhOTlmMjctNmMwZC00MWRlLTlmM2QtMzI3OWU0\\nZmJhZGQ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAp95esmGZsOnt\\nZSgSBAYmNceQ3D77s6hBuQ8RytPRQlo+BBv9/jWD/Qg8q627J55N0O4VKNX3o8NN\\nTuULZ3wRpmUnG28n9NjBkMhYMVxVflnxXGI6I3P+eh0ExLBO0JKm0Ozvh7/96mbr\\nrnRH3Ky3SAiYehcb+IoFPOlK8emxW4H32NT9+kvgX7os5cq+DTMIC+DUU3k1IOd8\\nd+nIymD97McXAd+eBoi1r2hjLfHboRLT5lmpi/yHcd9V0zMDfL0u2ccrh1szz6Gd\\nmJ0o3TRq3NyotTt9K+8bDArwL+MZd9Wd3EDlw/SBSqLMJw6QGGGcD9MNeKbyzipB\\nA8TyMB2uWwIDAQABo4IBOTCCATUwEQYJYIZIAYb4QgEBBAQDAgWgMAsGA1UdDwQE\\nAwIEsDCBsAYDVR0jBIGoMIGlgBTJYk3Be3McFdZwADEtBfKz1/TihKGBgaR/MH0x\\nCzAJBgNVBAYTAlVTMRcwFQYDVQQIEw5Ob3J0aCBDYXJvbGluYTEQMA4GA1UEBxMH\\nUmFsZWlnaDEQMA4GA1UEChMHUmVkIEhhdDERMA8GA1UECxMIQ2xvdWQgQlUxHjAc\\nBgNVBAMTFXJoZWw2My1rYXQ4LmluZWNhcy5jeoIJALJI14SeIsvSMB0GA1UdDgQW\\nBBSao4lqdqR/nkWXNh9n3OmZkdj5XzATBgNVHSUEDDAKBggrBgEFBQcDAjAsBgNV\\nHREEJTAjpCEwHzEdMBsGA1UEAwwUYWRtaW5fc3lzdGVtXzIyN2UwMDMwDQYJKoZI\\nhvcNAQEFBQADggEBAAl4TZON4y5lPUOjwTFYo3MdU4K8JPS+K0aIIndHCu7qCm/6\\nrMl+OgFfRquGGXEQ7T6fPzw3kXx1XFYi1+TUgqKIQzUgyjOSHXzGz3NuiQAu4kGF\\nQ9soPF5rTEc6QzWcWODhLdxAxwJNcVEXBgnMBdLCELRhOwi0NAP8N2ftRSRyM69Z\\nNS2a5yl4kK60MFKJfbsSt+WsDX1SzLFIUihx6W+pmiBaYtAgmjBhIgMD9poJ0wHl\\nDiohTPxQloZnmyYUv88Z2UHeVbkiNf5MC6qQBNZW7KSsU0MTbfIiNSjIKemh4+af\\nKVB+MYhjNlr/Hkf17J5FSQmBjntx4ATN5and45c=\\n-----END CERTIFICATE-----\\n\"\n  },\n  \"serviceLevel\": \"\",\n  \"activation_key\": [],\n  \"environment_id\": 3,\n  \"uuid\": \"d2a99f27-6c0d-41de-9f3d-3279e4fbadd4\",\n  \"updated_at\": \"2012-08-10T13:56:31Z\",\n  \"location\": \"None\",\n  \"system_template_id\": null,\n  \"facts\": {\n    \"cpu.cpu_socket(s)\": \"1\",\n    \"distribution.name\": \"Unknown\"\n  },\n  \"ipv4_address\": null,\n  \"guests\": [],\n  \"autoheal\": true,\n  \"id\": 10,\n  \"description\": \"Initial Registration Params\"\n}"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/subscriptions/create","full_description":"","apis":[{"api_url":"/api/systems/:system_id/subscriptions","http_method":"POST","short_description":"Create a subscription"}],"errors":[],"params":[{"allow_nil":false,"full_name":"system_id","name":"system_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":"\n<p>System uuid</p>\n"},{"allow_nil":false,"full_name":"pool","name":"pool","expected_type":"string","validator":"String","required":true,"description":"\n<p>Subscription Pool uuid</p>\n"},{"allow_nil":false,"full_name":"quantity","name":"quantity","expected_type":"string","validator":"number.","required":true,"description":"\n<p>Number of subscription to use</p>\n"}]},{"name":"destroy","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/subscriptions/destroy","full_description":"","apis":[{"api_url":"/api/systems/:system_id/subscriptions/:id","http_method":"DELETE","short_description":"Delete a subscription"}],"errors":[],"params":[{"allow_nil":false,"full_name":"system_id","name":"system_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":"\n<p>System uuid</p>\n"},{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"number.","required":false,"description":"\n<p>Entitlement id</p>\n"}]},{"name":"destroy_all","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/subscriptions/destroy_all","full_description":"","apis":[{"api_url":"/api/systems/:system_id/subscriptions","http_method":"DELETE","short_description":"Delete all system subscriptions"}],"errors":[],"params":[{"allow_nil":false,"full_name":"system_id","name":"system_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":"\n<p>System uuid</p>\n"}]},{"name":"destroy_by_serial","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/subscriptions/destroy_by_serial","full_description":"","apis":[{"api_url":"/api/systems/:system_id/subscriptions/serials/:serial_id","http_method":"DELETE","short_description":"Delete a subscription by serial id"}],"errors":[],"params":[{"allow_nil":false,"full_name":"system_id","name":"system_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":"\n<p>System uuid</p>\n"},{"allow_nil":false,"full_name":"serial_id","name":"serial_id","expected_type":"string","validator":"String","required":false,"description":"\n<p>Subscription serial id</p>\n"}]}]},"providers":{"name":"Providers","api_url":"/api","version":"1.0","doc_url":"../apidoc/1.0/providers","formats":null,"full_description":"\n<p>Custom Content Repositories and Red Hat repositories management.</p>\n","short_description":null,"methods":[{"name":"index","examples":["GET /api/organizations/org_227e003/providers/?name=yum_provider_227e003\n200\n[\n  {\n    \"created_at\": \"2012-08-10T13:42:46Z\",\n    \"name\": \"yum_provider_227e003\",\n    \"organization_id\": 2,\n    \"provider_type\": \"Custom\",\n    \"task_status_id\": null,\n    \"sync_state\": \"not_synced\",\n    \"repository_url\": \"http://lzap.fedorapeople.org/fakerepos/zoo5/\",\n    \"updated_at\": \"2012-08-10T13:42:46Z\",\n    \"last_sync\": null,\n    \"id\": 3,\n    \"description\": \"prov description\"\n  }\n]"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/providers/index","full_description":"","apis":[{"api_url":"/api/organizations/:organization_id/providers","http_method":"GET","short_description":"List providers"}],"errors":[],"params":[{"allow_nil":false,"full_name":"organization_id","name":"organization_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":"\n<p>Organization identifier</p>\n"},{"allow_nil":false,"full_name":"name","name":"name","expected_type":"string","validator":"String","required":false,"description":"\n<p>Filter providers by name</p>\n"}]},{"name":"show","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/providers/show","full_description":"","apis":[{"api_url":"/api/providers/:id","http_method":"GET","short_description":"Show a provider"}],"errors":[],"params":[{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"number.","required":true,"description":"\n<p>Provider numeric identifier</p>\n"}]},{"name":"create","examples":["POST /api/providers/\n{\n  \"organization_id\": \"org_227e003\",\n  \"provider\": {\n    \"name\": \"yum_provider_227e003\",\n    \"provider_type\": \"Custom\",\n    \"repository_url\": \"http://lzap.fedorapeople.org/fakerepos/zoo5/\",\n    \"description\": \"prov description\"\n  }\n}\n200\n{\n  \"created_at\": \"2012-08-10T13:42:46Z\",\n  \"name\": \"yum_provider_227e003\",\n  \"organization_id\": 2,\n  \"provider_type\": \"Custom\",\n  \"task_status_id\": null,\n  \"sync_state\": \"not_synced\",\n  \"repository_url\": \"http://lzap.fedorapeople.org/fakerepos/zoo5/\",\n  \"updated_at\": \"2012-08-10T13:42:46Z\",\n  \"last_sync\": null,\n  \"id\": 3,\n  \"description\": \"prov description\"\n}"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/providers/create","full_description":"","apis":[{"api_url":"/api/providers","http_method":"POST","short_description":"Create a provider"}],"errors":[],"params":[{"allow_nil":false,"full_name":"organization_id","name":"organization_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":"\n<p>Organization identifier</p>\n"},{"allow_nil":false,"full_name":"provider","name":"provider","expected_type":"hash","validator":"Hash","required":true,"params":[{"name":"name","full_name":"provider[name]","allow_nil":false,"expected_type":"string","validator":"String","required":true,"description":"\n<p>Provider name</p>\n"},{"name":"description","full_name":"provider[description]","allow_nil":true,"expected_type":"string","validator":"String","required":false,"description":"\n<p>Provider description</p>\n"},{"name":"repository_url","full_name":"provider[repository_url]","allow_nil":true,"expected_type":"string","validator":"String","required":false,"description":"\n<p>Repository URL</p>\n"},{"name":"provider_type","full_name":"provider[provider_type]","allow_nil":false,"expected_type":"string","validator":"Must be one of: Red Hat, Custom.","required":true,"description":""}],"description":""}]},{"name":"update","examples":["PUT /api/providers/4\n{\n  \"provider\": {\n    \"repository_url\": \"http://inecas.fedorapeople.org/fakerepos/cds/\"\n  }\n}\n200\n{\n  \"created_at\": \"2012-08-10T13:50:25Z\",\n  \"name\": \"Red Hat\",\n  \"organization_id\": 3,\n  \"provider_type\": \"Red Hat\",\n  \"task_status_id\": null,\n  \"sync_state\": \"not_synced\",\n  \"repository_url\": \"http://inecas.fedorapeople.org/fakerepos/cds/\",\n  \"updated_at\": \"2012-08-10T13:50:27Z\",\n  \"last_sync\": null,\n  \"id\": 4,\n  \"description\": null\n}"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/providers/update","full_description":"","apis":[{"api_url":"/api/providers/:id","http_method":"PUT","short_description":"Update a provider"}],"errors":[],"params":[{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"number.","required":true,"description":"\n<p>Provider numeric identifier</p>\n"},{"allow_nil":false,"full_name":"provider","name":"provider","expected_type":"hash","validator":"Hash","required":true,"params":[{"name":"name","full_name":"provider[name]","allow_nil":false,"expected_type":"string","validator":"String","required":false,"description":"\n<p>Provider name</p>\n"},{"name":"description","full_name":"provider[description]","allow_nil":true,"expected_type":"string","validator":"String","required":false,"description":"\n<p>Provider description</p>\n"},{"name":"repository_url","full_name":"provider[repository_url]","allow_nil":true,"expected_type":"string","validator":"String","required":false,"description":"\n<p>Repository URL</p>\n"}],"description":""}]},{"name":"destroy","examples":["DELETE /api/providers/3\n200\nDeleted provider [ yum_provider_227e003 ]"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/providers/destroy","full_description":"","apis":[{"api_url":"/api/providers/:id","http_method":"DELETE","short_description":"Destroy a provider"}],"errors":[],"params":[{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"number.","required":true,"description":"\n<p>Provider numeric identifier</p>\n"}]},{"name":"products","examples":["GET /api/providers/3/products/\n200\n[\n  {\n    \"gpg_key_id\": null,\n    \"created_at\": \"2012-08-10T13:42:48Z\",\n    \"name\": \"fewups_product_227e003\",\n    \"sync_plan_id\": null,\n    \"provider_name\": \"yum_provider_227e003\",\n    \"multiplier\": 1,\n    \"marketing_product\": false,\n    \"sync_state\": \"finished\",\n    \"attributes\": [],\n    \"productContent\": [\n      {\n        \"enabled\": true,\n        \"content\": {\n          \"name\": \"repo_227e003\",\n          \"type\": \"yum\",\n          \"updated\": \"2012-08-10T13:42:57.624+0000\",\n          \"vendor\": \"Custom\",\n          \"modifiedProductIds\": [],\n          \"contentUrl\": \"/custom/fewups_product_227e003/repo_227e003\",\n          \"id\": \"1344606177624\",\n          \"gpgUrl\": \"\",\n          \"created\": \"2012-08-10T13:42:57.624+0000\",\n          \"label\": \"org_227e003_fewups_product_227e003_repo_227e003\"\n        }\n      },\n      {\n        \"enabled\": true,\n        \"content\": {\n          \"name\": \"fewups_product_227e003_fakerepos_zoo5\",\n          \"type\": \"yum\",\n          \"updated\": \"2012-08-10T13:42:53.879+0000\",\n          \"vendor\": \"Custom\",\n          \"modifiedProductIds\": [],\n          \"contentUrl\": \"/custom/fewups_product_227e003/fewups_product_227e003_fakerepos_zoo5\",\n          \"id\": \"1344606173878\",\n          \"gpgUrl\": \"\",\n          \"created\": \"2012-08-10T13:42:53.879+0000\",\n          \"label\": \"org_227e003_fewups_product_227e003_fewups_product_227e003_fakerepos_zoo5\"\n        }\n      }\n    ],\n    \"updated_at\": \"2012-08-10T13:42:48Z\",\n    \"gpg_key_name\": \"\",\n    \"last_sync\": \"2012-08-10T15:45:36+02:00\",\n    \"provider_id\": 3,\n    \"id\": \"1344606167242\",\n    \"sync_plan_name\": null,\n    \"description\": null\n  }\n]"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/providers/products","full_description":"","apis":[{"api_url":"/api/providers/:id/products","http_method":"GET","short_description":"List of provider's products"}],"errors":[],"params":[{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"number.","required":true,"description":"\n<p>Provider numeric identifier</p>\n"}]},{"name":"discovery","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/providers/discovery","full_description":"","apis":[{"api_url":"/api/providers/:id/discovery","http_method":"POST","short_description":"Discover repository urls with metadata and find candidate repos. Supports http, https and file based urls. Async task, returns the delayed job."}],"errors":[],"params":[{"allow_nil":false,"full_name":"url","name":"url","expected_type":"string","validator":"String","required":true,"description":"\n<p>remote url to perform discovery</p>\n"}]},{"name":"import_manifest","examples":["POST /api/providers/4/import_manifest\n200\nManifest imported"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/providers/import_manifest","full_description":"","apis":[{"api_url":"/api/providers/:id/import_manifest","http_method":"POST","short_description":"Import manifest for Red Hat provider"}],"errors":[],"params":[{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"number.","required":true,"description":"\n<p>Provider numeric identifier</p>\n"},{"allow_nil":false,"full_name":"import","name":"import","expected_type":"string","validator":"File","required":false,"description":"\n<p>Manifest file</p>\n"},{"allow_nil":false,"full_name":"force","name":"force","expected_type":"string","validator":"boolean","required":false,"description":"\n<p>Force import</p>\n"}]},{"name":"delete_manifest","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/providers/delete_manifest","full_description":"","apis":[{"api_url":"/api/providers/:id/delete_manifest","http_method":"POST","short_description":"Delete manifest from Red Hat provider"}],"errors":[],"params":[{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"number.","required":true,"description":"\n<p>Provider numeric identifier</p>\n"}]},{"name":"refresh_products","examples":["POST /api/providers/4/refresh_products\n{}\n200\nProducts refreshed from CDN"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/providers/refresh_products","full_description":"","apis":[{"api_url":"/api/providers/:id/refresh_products","http_method":"POST","short_description":"Refresh products for Red Hat provider"}],"errors":[],"params":[{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"number.","required":true,"description":"\n<p>Provider numeric identifier</p>\n"}]},{"name":"import_products","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/providers/import_products","full_description":"","apis":[{"api_url":"/api/providers/:id/import_products","http_method":"POST","short_description":"Import products"}],"errors":[],"params":[{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"number.","required":true,"description":"\n<p>Provider numeric identifier</p>\n"},{"allow_nil":false,"full_name":"products","name":"products","expected_type":"string","validator":"Array","required":true,"description":"\n<p>Array of products to import</p>\n"}]},{"name":"product_create","examples":["POST /api/providers/3/product_create\n{\n  \"product\": {\n    \"name\": \"fewups_product_227e003\",\n    \"gpg_key_name\": null,\n    \"description\": null\n  }\n}\n200\n{\n  \"gpg_key_id\": null,\n  \"created_at\": \"2012-08-10T13:42:48Z\",\n  \"name\": \"fewups_product_227e003\",\n  \"sync_plan_id\": null,\n  \"multiplier\": null,\n  \"marketing_product\": false,\n  \"sync_state\": \"not_synced\",\n  \"attributes\": [],\n  \"productContent\": [],\n  \"updated_at\": \"2012-08-10T13:42:48Z\",\n  \"gpg_key_name\": \"\",\n  \"last_sync\": null,\n  \"provider_id\": 3,\n  \"id\": \"1344606167242\",\n  \"sync_plan_name\": null,\n  \"description\": null\n}"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/providers/product_create","full_description":"","apis":[{"api_url":"/api/providers/:id/product_create","http_method":"POST","short_description":"Create a new product in custom provider"}],"errors":[],"params":[{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"number.","required":true,"description":"\n<p>Provider numeric identifier</p>\n"},{"allow_nil":false,"full_name":"product","name":"product","expected_type":"hash","validator":"Hash","required":true,"params":[{"name":"gpg_key_name","full_name":"product[gpg_key_name]","allow_nil":true,"expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":false,"description":"\n<p>identifier of the gpg key</p>\n"},{"name":"description","full_name":"product[description]","allow_nil":true,"expected_type":"string","validator":"String","required":false,"description":"\n<p>Product description</p>\n"},{"name":"name","full_name":"product[name]","allow_nil":false,"expected_type":"string","validator":"String","required":true,"description":"\n<p>Product name</p>\n"},{"name":"label","full_name":"product[label]","allow_nil":false,"expected_type":"string","validator":"String","required":false,"description":""}],"description":""}]}]},"system_groups":{"name":"System groups","api_url":"/api","version":"1.0","doc_url":"../apidoc/1.0/system_groups","formats":null,"full_description":null,"short_description":null,"methods":[{"name":"index","examples":["GET /api/organizations/org_227e003/system_groups/?name=system_group_227e003\n200\n[\n  {\n    \"created_at\": \"2012-08-10T13:48:21Z\",\n    \"name\": \"system_group_227e003\",\n    \"organization_id\": 2,\n    \"max_systems\": -1,\n    \"pulp_id\": \"org_227e003-system_group_227e003-9b0aed1f\",\n    \"updated_at\": \"2012-08-10T13:48:21Z\",\n    \"id\": 1,\n    \"description\": \"group description\"\n  }\n]"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/system_groups/index","full_description":"","apis":[{"api_url":"/api/organizations/:organization_id/system_groups","http_method":"GET","short_description":"List system groups"}],"errors":[],"params":[{"allow_nil":false,"full_name":"organization_id","name":"organization_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":"\n<p>organization identifier</p>\n"},{"allow_nil":false,"full_name":"name","name":"name","expected_type":"string","validator":"String","required":false,"description":"\n<p>System group name to filter by</p>\n"}]},{"name":"show","examples":["GET /api/organizations/org_227e003/system_groups/1\n200\n{\n  \"created_at\": \"2012-08-10T13:48:21Z\",\n  \"name\": \"system_group_227e003\",\n  \"organization_id\": 2,\n  \"max_systems\": -1,\n  \"total_systems\": 0,\n  \"pulp_id\": \"org_227e003-system_group_227e003-9b0aed1f\",\n  \"updated_at\": \"2012-08-10T13:48:21Z\",\n  \"id\": 1,\n  \"description\": \"group description\"\n}"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/system_groups/show","full_description":"","apis":[{"api_url":"/api/organizations/:organization_id/system_groups/:id","http_method":"GET","short_description":"Show a system group"}],"errors":[],"params":[{"allow_nil":false,"full_name":"organization_id","name":"organization_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":"\n<p>organization identifier</p>\n"},{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":"\n<p>Id of the system group</p>\n"}]},{"name":"update","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/system_groups/update","full_description":"","apis":[{"api_url":"/api/organizations/:organization_id/system_groups/:id","http_method":"PUT","short_description":"Update a system group"}],"errors":[],"params":[{"allow_nil":false,"full_name":"organization_id","name":"organization_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":"\n<p>organization identifier</p>\n"},{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":"\n<p>Id of the system group</p>\n"},{"allow_nil":false,"full_name":"system_group","name":"system_group","expected_type":"hash","validator":"Hash","required":true,"params":[{"name":"name","full_name":"system_group[name]","allow_nil":false,"expected_type":"string","validator":"String","required":false,"description":"\n<p>System group name</p>\n"},{"name":"description","full_name":"system_group[description]","allow_nil":true,"expected_type":"string","validator":"String","required":false,"description":""},{"name":"max_systems","full_name":"system_group[max_systems]","allow_nil":true,"expected_type":"numeric","validator":"Integer","required":false,"description":"\n<p>Maximum number of systems in the group</p>\n"}],"description":""}]},{"name":"systems","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/system_groups/systems","full_description":"","apis":[{"api_url":"/api/organizations/:organization_id/system_groups/:id/systems","http_method":"GET","short_description":"List systems in the group"}],"errors":[],"params":[{"allow_nil":false,"full_name":"organization_id","name":"organization_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":"\n<p>organization identifier</p>\n"},{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":"\n<p>Id of the system group</p>\n"}]},{"name":"add_systems","examples":["POST /api/organizations/org_227e003/system_groups/1/add_systems\n{\n  \"system_group\": {\n    \"system_ids\": [\n      \"3050eb45-0ec4-43ea-8913-83635f06a2b7\"\n    ]\n  }\n}\n200\n[\n  {\n    \"name\": \"katello.example.com_227e003\",\n    \"id\": \"3050eb45-0ec4-43ea-8913-83635f06a2b7\"\n  }\n]"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/system_groups/add_systems","full_description":"","apis":[{"api_url":"/api/organizations/:organization_id/system_groups/:id/add_systems","http_method":"POST","short_description":"Add systems to the group"}],"errors":[],"params":[{"allow_nil":false,"full_name":"organization_id","name":"organization_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":"\n<p>organization identifier</p>\n"},{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":"\n<p>Id of the system group</p>\n"},{"allow_nil":false,"full_name":"system_group","name":"system_group","expected_type":"hash","validator":"Hash","required":true,"params":[{"name":"system_ids","full_name":"system_group[system_ids]","allow_nil":false,"expected_type":"string","validator":"Array","required":false,"description":"\n<p>Array of system ids</p>\n"}],"description":""}]},{"name":"remove_systems","examples":["POST /api/organizations/org_227e003/system_groups/1/remove_systems\n{\n  \"system_group\": {\n    \"system_ids\": [\n      \"3050eb45-0ec4-43ea-8913-83635f06a2b7\"\n    ]\n  }\n}\n200\n[\n\n]"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/system_groups/remove_systems","full_description":"","apis":[{"api_url":"/api/organizations/:organization_id/system_groups/:id/remove_systems","http_method":"POST","short_description":"Remove systems from the group"}],"errors":[],"params":[{"allow_nil":false,"full_name":"organization_id","name":"organization_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":"\n<p>organization identifier</p>\n"},{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":"\n<p>Id of the system group</p>\n"},{"allow_nil":false,"full_name":"system_group","name":"system_group","expected_type":"hash","validator":"Hash","required":true,"params":[{"name":"system_ids","full_name":"system_group[system_ids]","allow_nil":false,"expected_type":"string","validator":"Array","required":false,"description":"\n<p>Array of system ids</p>\n"}],"description":""}]},{"name":"history","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/system_groups/history","full_description":"","apis":[{"api_url":"/api/organizations/:organization_id/system_groups/:id/history","http_method":"GET","short_description":"History of jobs performed on a system group"}],"errors":[],"params":[{"allow_nil":false,"full_name":"organization_id","name":"organization_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":"\n<p>organization identifier</p>\n"},{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":"\n<p>Id of the system group</p>\n"}]},{"name":"history_show","examples":["GET /api/organizations/org_227e003/system_groups/1/history/1\n200\n{\n  \"finish_time\": null,\n  \"created_at\": \"2012-08-10T13:48:24Z\",\n  \"status_message\": \"Installing Package...\",\n  \"pulp_id\": \"0384935e-4216-4d38-9832-6be39e379aba\",\n  \"state\": \"running\",\n  \"tasks\": [\n    {\n      \"finish_time\": null,\n      \"progress\": null,\n      \"start_time\": \"2012-08-10T13:48:24Z\",\n      \"result\": {\n        \"errors\": [\n          null,\n          null\n        ]\n      },\n      \"uuid\": \"0e0f181c-e2f2-11e1-85ad-525400b68f90\",\n      \"state\": \"running\",\n      \"id\": 15\n    }\n  ],\n  \"task_type\": \"package_install\",\n  \"id\": 1,\n  \"parameters\": {\n    \"packages\": [\n      \"cheetah\"\n    ]\n  }\n}"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/system_groups/history_show","full_description":"","apis":[{"api_url":"/api/organizations/:organization_id/system_groups/:id/history","http_method":"GET","short_description":"History of a job performed on a system group"}],"errors":[],"params":[{"allow_nil":false,"full_name":"organization_id","name":"organization_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":"\n<p>organization identifier</p>\n"},{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":"\n<p>Id of the system group</p>\n"},{"allow_nil":false,"full_name":"job_id","name":"job_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":false,"description":"\n<p>Id of a job for filtering</p>\n"}]},{"name":"create","examples":["POST /api/organizations/org_227e003/system_groups/\n{\n  \"system_group\": {\n    \"name\": \"system_group_227e003\",\n    \"max_systems\": \"-1\",\n    \"description\": \"group description\"\n  }\n}\n200\n{\n  \"created_at\": \"2012-08-10T13:48:21Z\",\n  \"name\": \"system_group_227e003\",\n  \"organization_id\": 2,\n  \"max_systems\": -1,\n  \"pulp_id\": \"org_227e003-system_group_227e003-9b0aed1f\",\n  \"updated_at\": \"2012-08-10T13:48:21Z\",\n  \"id\": 1,\n  \"description\": \"group description\"\n}"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/system_groups/create","full_description":"","apis":[{"api_url":"/api/organizations/:organization_id/system_groups","http_method":"POST","short_description":"Create a system group"}],"errors":[],"params":[{"allow_nil":false,"full_name":"organization_id","name":"organization_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":"\n<p>organization identifier</p>\n"},{"allow_nil":false,"full_name":"system_group","name":"system_group","expected_type":"hash","validator":"Hash","required":true,"params":[{"name":"name","full_name":"system_group[name]","allow_nil":false,"expected_type":"string","validator":"String","required":true,"description":"\n<p>System group name</p>\n"},{"name":"description","full_name":"system_group[description]","allow_nil":true,"expected_type":"string","validator":"String","required":false,"description":""},{"name":"max_systems","full_name":"system_group[max_systems]","allow_nil":true,"expected_type":"numeric","validator":"Integer","required":false,"description":"\n<p>Maximum number of systems in the group</p>\n"}],"description":""}]},{"name":"destroy","examples":["DELETE /api/organizations/org_227e003/system_groups/1\n200\nDeleted system group '1'"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/system_groups/destroy","full_description":"","apis":[{"api_url":"/api/organizations/:organization_id/system_groups/:id","http_method":"DELETE","short_description":"Destroy a system group"}],"errors":[],"params":[{"allow_nil":false,"full_name":"organization_id","name":"organization_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":"\n<p>organization identifier</p>\n"},{"allow_nil":false,"full_name":"id","name":"id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":"\n<p>Id of the system group</p>\n"}]}]},"uebercerts":{"name":"Uebercerts","api_url":"/api","version":"1.0","doc_url":"../apidoc/1.0/uebercerts","formats":null,"full_description":null,"short_description":null,"methods":[{"name":"show","examples":["GET /api/organizations/org_227e003/uebercert?regenerate=None\n200\n{\n  \"key\": \"-----BEGIN RSA PRIVATE KEY-----\\nMIIEowIBAAKCAQEA04fnzu7fhAKXWVLhirGAp/9NQ4r1gpk34dJkjdyz+8fuOqRd\\n3Z0fboYiKjh65hI7CUazYM0dU3sZMp2FeKaaV4uko6vk/Yj4vgDNR2HsLB1KqJZk\\nYTtreQqoNWLqyGFUpg5tsnr1w6Ulta0xuy0IS6O+ymKud+yZFaOSOhR3vB+YNoZC\\nZZPz5bxNdD6QiWfyy1Q1zOHrjmfhVB3DjpBKQgGzBjd2v313XSXda/76d5KAZ8/r\\nLziO6wwxpzRGLQYjsvwMXNciZo3+X+yo4htasoEGbH37HzZnubMWiajjI4XCLgiT\\n+7aYqh6ptwSoex1USUSGv+tyfZFpJBaSmYGGrQIDAQABAoIBAF3tkjxsC6pFsEkE\\nqYv5h8SRdBCS6rOkL5FB6E6p+u3JeHpntBqNA4EDZLZUwBXbcIWM9Gf+jJAeMDEu\\niy7o484N/vyCfrsqEDHmj0CsNb/c/eLgbRBT30QvPEQAeXqi5YCbFZDUUr8eXSFQ\\nF64ir/VOb5DUwt4TnGJkcLEDl6tbmWoAOWCmHpOqdR4BU2tqIWZXqeUPIxfDAq72\\nxpFdPhW3/XbGBFiRPkNrckarlK06xUWZyKr+kQCc8rVKCAiVwVkZAHbZTusQzC4Y\\n3lCEzg2ToU7az2+HRMMbJYFt0bxnGFytgFSrNdUOdXB3oPj0FpDTdhK9W63tjAu5\\nlTuul60CgYEA8Cp+B8bFJsNMbLyLCrE+Te/3N2GD+1tPhaXt2WIXkSSxpjzlKRo9\\ncygdbVjgguEXSwjX7b5Nbus8dG1XwF3RxprfjJoz1G0WFRsuSQEaQUpqIMXBD29v\\npPxS0U8CDnop9dwQ9DMotfz0tuaULbSVHvFta5j6JjcQ0Gmbj+OuSPMCgYEA4Xoc\\nji8FR2D5ZwQ7FsAAXIz0m24F+evNw89kQHz3H1ydaKDuM6d4c0oIqQ9vMZVXsNd4\\nBLfWX356q3sBTwZ+xxKDbV4AuK/d6N+j0BtjerKO8zZCV2b7+IwhrLzce1pdDKL9\\nBoD+vvMdWM6DIlEr43z/kqprAAMbXs6TdSo+2d8CgYEAyv7/m88UoRj+JgKPe7Ao\\nu3OS/8p65iBd7Nc9XTqeNN5REfPytnUpb4Z+qQgwbC+ZoqCM8rShepl2depd+4jR\\nYQ9S2OMV3/18ZsacrrQx3vHpFl5QOp20Pj3QOn6PfHEhumASLHZ5eKmgpl/q617x\\nlD/4frPE7DwrCB3bkRmfHKUCgYBgu1aM2TdWjA/zVilTdUOycPZvyB/gPH2mR88m\\nq3YJil4tiP0oQ+y06UoV3X1CtGNOhuIChCwAA+70qmzBTnQNS6/+t5lvomN9iJRq\\nr5VaCkixptGHVbM7ykKYLN4aPYY16abLp4OiwAITG2W+zzwY+INclKga9TpEzjMM\\nzPbx2QKBgGbn+Rop8m09d/xaiRdoedRuaaIf5fH/nGb3BpUXe6Y3PYwbl5lXb41M\\nUKdjr/S+rl1rVJOq0en8uVNOh+nPeBfd5DQ6v6zk679X6nuLxzlHUlhpN3Y6QFR7\\nZtikyjWc7jNdm495jW3lRTmI/LvFTjGB9LSp0/E76euOYa1tItaj\\n-----END RSA PRIVATE KEY-----\\n\",\n  \"updated\": \"2012-08-10T13:42:43.432+0000\",\n  \"serial\": {\n    \"expiration\": \"2112-08-10T13:42:41.059+0000\",\n    \"updated\": \"2012-08-10T13:42:43.332+0000\",\n    \"serial\": 2140559390559252253,\n    \"revoked\": false,\n    \"collected\": false,\n    \"id\": 2140559390559252253,\n    \"created\": \"2012-08-10T13:42:43.332+0000\"\n  },\n  \"id\": \"ff8080813910c3d3013910c5d1e8000b\",\n  \"created\": \"2012-08-10T13:42:43.432+0000\",\n  \"cert\": \"-----BEGIN CERTIFICATE-----\\nMIIG0DCCBbigAwIBAgIIHbTLbK7pLx0wDQYJKoZIhvcNAQEFBQAwfTELMAkGA1UE\\nBhMCVVMxFzAVBgNVBAgTDk5vcnRoIENhcm9saW5hMRAwDgYDVQQHEwdSYWxlaWdo\\nMRAwDgYDVQQKEwdSZWQgSGF0MREwDwYDVQQLEwhDbG91ZCBCVTEeMBwGA1UEAxMV\\ncmhlbDYzLWthdDguaW5lY2FzLmN6MCAXDTEyMDgxMDEzNDI0MVoYDzIxMTIwODEw\\nMTM0MjQxWjArMSkwJwYDVQQDEyBmZjgwODA4MTM5MTBjM2QzMDEzOTEwYzVjYjY2\\nMDAwOTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBANOH587u34QCl1lS\\n4YqxgKf/TUOK9YKZN+HSZI3cs/vH7jqkXd2dH26GIio4euYSOwlGs2DNHVN7GTKd\\nhXimmleLpKOr5P2I+L4AzUdh7CwdSqiWZGE7a3kKqDVi6shhVKYObbJ69cOlJbWt\\nMbstCEujvspirnfsmRWjkjoUd7wfmDaGQmWT8+W8TXQ+kIln8stUNczh645n4VQd\\nw46QSkIBswY3dr99d10l3Wv++neSgGfP6y84jusMMac0Ri0GI7L8DFzXImaN/l/s\\nqOIbWrKBBmx9+x82Z7mzFomo4yOFwi4Ik/u2mKoeqbcEqHsdVElEhr/rcn2RaSQW\\nkpmBhq0CAwEAAaOCA6IwggOeMBEGCWCGSAGG+EIBAQQEAwIFoDALBgNVHQ8EBAMC\\nBLAwgbAGA1UdIwSBqDCBpYAUyWJNwXtzHBXWcAAxLQXys9f04oShgYGkfzB9MQsw\\nCQYDVQQGEwJVUzEXMBUGA1UECBMOTm9ydGggQ2Fyb2xpbmExEDAOBgNVBAcTB1Jh\\nbGVpZ2gxEDAOBgNVBAoTB1JlZCBIYXQxETAPBgNVBAsTCENsb3VkIEJVMR4wHAYD\\nVQQDExVyaGVsNjMta2F0OC5pbmVjYXMuY3qCCQCySNeEniLL0jAdBgNVHQ4EFgQU\\nW/VVEqoWrRZFpSzf2yF8YQYdUaYwEwYDVR0lBAwwCgYIKwYBBQUHAwIwLwYQKwYB\\nBAGSCAkBp5GGl5EYAQQbDBlvcmdfMjI3ZTAwM191ZWJlcl9wcm9kdWN0MBYGECsG\\nAQQBkggJAaeRhpeRGAMEAgwAMBYGECsGAQQBkggJAaeRhpeRGAIEAgwAMBkGECsG\\nAQQBkggJAqeRhpeRHwEEBQwDeXVtMCQGESsGAQQBkggJAqeRhpeRHwEBBA8MDXVl\\nYmVyX2NvbnRlbnQwMgYRKwYBBAGSCAkCp5GGl5EfAQIEHQwbMTM0NDYwNjE2MTA0\\nOF91ZWJlcl9jb250ZW50MB0GESsGAQQBkggJAqeRhpeRHwEFBAgMBkN1c3RvbTAj\\nBhErBgEEAZIICQKnkYaXkR8BBgQODAwvb3JnXzIyN2UwMDMwFwYRKwYBBAGSCAkC\\np5GGl5EfAQcEAgwAMBgGESsGAQQBkggJAqeRhpeRHwEIBAMMATEwKQYKKwYBBAGS\\nCAkEAQQbDBlvcmdfMjI3ZTAwM191ZWJlcl9wcm9kdWN0MDAGCisGAQQBkggJBAIE\\nIgwgZmY4MDgwODEzOTEwYzNkMzAxMzkxMGM1YzhiMDAwMDUwHQYKKwYBBAGSCAkE\\nAwQPDA0xMzQ0NjA2MTYxMDQ4MBEGCisGAQQBkggJBAUEAwwBMTAkBgorBgEEAZII\\nCQQGBBYMFDIwMTItMDgtMTBUMTM6NDI6NDFaMCQGCisGAQQBkggJBAcEFgwUMjEx\\nMi0wOC0xMFQxMzo0Mjo0MVowEQYKKwYBBAGSCAkEDAQDDAEwMBEGCisGAQQBkggJ\\nBA4EAwwBMDARBgorBgEEAZIICQQLBAMMATEwNAYKKwYBBAGSCAkFAQQmDCQ0M2Iw\\nNTRiMi0yZGQ1LTQyNzAtODU4Zi03NTM5NDAwZjM5YTIwDQYJKoZIhvcNAQEFBQAD\\nggEBABRG4zWXgy7NVXoMtsYOtqvnYX7XzzMSSrljGqa3DRpWsTLYTNfkyRgODlXP\\nqAGN8z0ITgbgpUyqX5Ehvfo7j5gly0CdPZu54gPS3MBVxxSbrTTQ0vl91zPusA9W\\n9/ZzIREdcpDaTJzPL3o2mBw9IrwXHtjDotZjXQj8Yw5cjiaIYIDb9PG9EgDaTHTr\\nsBMJSg+Z7EMdxxMFNZY8AJrxL2c+Cis8eP0IXvUtLgYwlQ1X1hqovrQZbJK1YIFc\\nem9FfbssaBnY1DnW1j8JZAUoZ6Dc0VAHZdHIXjJeahoN9RDXHvUcGFIan41vcwM9\\n4lgwKGnTV67bozjBm+s8eek+sW8=\\n-----END CERTIFICATE-----\\n\"\n}"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/uebercerts/show","full_description":"","apis":[{"api_url":"/api/organizations/:organization_id/uebercert","http_method":"GET","short_description":"Show an ueber certificate for an organization"}],"errors":[],"params":[{"allow_nil":false,"full_name":"regenerate","name":"regenerate","expected_type":"string","validator":"boolean","required":false,"description":"\n<p>When set to \u2018True\u2019 certificate will be re-issued</p>\n"}]}]},"sync":{"name":"Sync","api_url":"/api","version":"1.0","doc_url":"../apidoc/1.0/sync","formats":null,"full_description":"\n<p>methods for handeling repositories synchronisation. Repositories can be\nselecteted individualy by id, by product or by provider</p>\n","short_description":null,"methods":[{"name":"index","examples":["GET /api/repositories/2/sync\n200\n{\n  \"finish_time\": \"2012-08-10T13:43:16Z\",\n  \"created_at\": \"2012-08-10T13:43:05Z\",\n  \"organization_id\": 2,\n  \"progress\": {\n    \"total_count\": 8,\n    \"step\": \"Running Createrepo\",\n    \"size_left\": 0,\n    \"total_size\": 17872,\n    \"error_details\": [],\n    \"items_left\": 0\n  },\n  \"task_owner_type\": null,\n  \"pending?\": false,\n  \"user_id\": 1,\n  \"start_time\": \"2012-08-10T13:43:05Z\",\n  \"result\": true,\n  \"uuid\": \"4ff91fc7-e2f1-11e1-a7ee-525400b68f90\",\n  \"updated_at\": \"2012-08-10T13:45:06Z\",\n  \"state\": \"finished\",\n  \"task_type\": \"PulpSyncStatus\",\n  \"task_owner_id\": null,\n  \"id\": 3,\n  \"parameters\": {\n    \"options\": {}\n  }\n}"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/sync/index","full_description":"","apis":[{"api_url":"/api/providers/:provider_id/sync","http_method":"GET","short_description":"Get status of repo synchronisation for given provider"},{"api_url":"/api/organizations/:organization_id/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"}],"errors":[],"params":[{"allow_nil":false,"full_name":"organization_id","name":"organization_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":"\n<p>oranization identifier</p>\n"},{"allow_nil":false,"full_name":"product_id","name":"product_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":"\n<p>product identifier</p>\n"},{"allow_nil":false,"full_name":"provider_id","name":"provider_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":"\n<p>provider identifier</p>\n"},{"allow_nil":false,"full_name":"repository_id","name":"repository_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":"\n<p>repository identifier</p>\n"}]},{"name":"create","examples":["POST /api/organizations/org_227e003/products/1344606167242/sync\n202\n[\n  {\n    \"finish_time\": null,\n    \"created_at\": \"2012-08-10T13:43:05Z\",\n    \"organization_id\": 2,\n    \"progress\": {\n      \"total_count\": 0,\n      \"size_left\": 0,\n      \"total_size\": 0,\n      \"items_left\": 0\n    },\n    \"task_owner_type\": null,\n    \"pending?\": true,\n    \"user_id\": 1,\n    \"start_time\": null,\n    \"result\": {\n      \"errors\": [\n        null,\n        null\n      ]\n    },\n    \"uuid\": \"4fd84a3a-e2f1-11e1-a717-525400b68f90\",\n    \"updated_at\": \"2012-08-10T13:43:05Z\",\n    \"state\": \"waiting\",\n    \"task_type\": \"PulpSyncStatus\",\n    \"task_owner_id\": null,\n    \"id\": 2,\n    \"parameters\": {\n      \"options\": {}\n    }\n  },\n  {\n    \"finish_time\": null,\n    \"created_at\": \"2012-08-10T13:43:05Z\",\n    \"organization_id\": 2,\n    \"progress\": {\n      \"total_count\": 0,\n      \"size_left\": 0,\n      \"total_size\": 0,\n      \"items_left\": 0\n    },\n    \"task_owner_type\": null,\n    \"pending?\": true,\n    \"user_id\": 1,\n    \"start_time\": null,\n    \"result\": {\n      \"errors\": [\n        null,\n        null\n      ]\n    },\n    \"uuid\": \"4ff91fc7-e2f1-11e1-a7ee-525400b68f90\",\n    \"updated_at\": \"2012-08-10T13:43:05Z\",\n    \"state\": \"waiting\",\n    \"task_type\": \"PulpSyncStatus\",\n    \"task_owner_id\": null,\n    \"id\": 3,\n    \"parameters\": {\n      \"options\": {}\n    }\n  }\n]"],"formats":null,"see":[],"doc_url":"../apidoc/1.0/sync/create","full_description":"","apis":[{"api_url":"/api/providers/:provider_id/sync","http_method":"POST","short_description":"Synchronize all provider's repositories"},{"api_url":"/apiorganizations/:organization_id/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"}],"errors":[],"params":[{"allow_nil":false,"full_name":"organization_id","name":"organization_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":"\n<p>oranization identifier</p>\n"},{"allow_nil":false,"full_name":"product_id","name":"product_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":"\n<p>product identifier</p>\n"},{"allow_nil":false,"full_name":"provider_id","name":"provider_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":"\n<p>provider identifier</p>\n"},{"allow_nil":false,"full_name":"repository_id","name":"repository_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":"\n<p>repository identifier</p>\n"}]},{"name":"cancel","examples":[],"formats":null,"see":[],"doc_url":"../apidoc/1.0/sync/cancel","full_description":"","apis":[{"api_url":"/api/providers/:provider_id/sync","http_method":"DELETE","short_description":"Cancel running synchronisation for given provider"},{"api_url":"/api/organizations/:organization_id/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"}],"errors":[],"params":[{"allow_nil":false,"full_name":"organization_id","name":"organization_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":"\n<p>oranization identifier</p>\n"},{"allow_nil":false,"full_name":"product_id","name":"product_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":"\n<p>product identifier</p>\n"},{"allow_nil":false,"full_name":"provider_id","name":"provider_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":"\n<p>provider identifier</p>\n"},{"allow_nil":false,"full_name":"repository_id","name":"repository_id","expected_type":"string","validator":"string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","required":true,"description":"\n<p>repository identifier</p>\n"}]}]}},"doc_url":"../apidoc/1.0","info":"\n<p>The sysadmin\u2019s fortress.</p>\n"}}
+{"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":[]}]}}}}