{ "openapi": "3.1.0", "info": { "title": "Cloud Services for RHEL Compliance API v2", "version": "v2", "description": "This is the API for Cloud Services for RHEL Compliance. You can find out more about Red Hat Cloud Services for RHEL at [https://console.redhat.com/](https://console.redhat.com/)" }, "servers": [ { "url": "https://{defaultHost}/api/compliance/v2", "variables": { "defaultHost": { "default": "console.redhat.com" } } } ], "paths": { "/policies": { "get": { "summary": "Request Policies", "parameters": [ { "name": "X-RH-IDENTITY", "in": "header", "schema": { "type": "string" }, "description": "For internal use only" }, { "name": "limit", "in": "query", "required": false, "description": "Number of items to return per page", "schema": { "type": "number", "maximum": 100, "minimum": 1, "default": 10 } }, { "name": "offset", "in": "query", "required": false, "description": "Offset of first item of paginated response", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "ids_only", "in": "query", "required": false, "description": "Indicates whether to return only resource IDs.", "schema": { "type": "boolean" } }, { "name": "sort_by", "in": "query", "required": false, "description": "Attribute and direction to sort the items by. Represented by an array of fields with an optional direction (`:asc` or `:desc`).

If no direction is selected, `:asc` is used by default.", "schema": { "type": "array", "items": { "enum": [ "title", "os_major_version", "total_system_count", "business_objective", "compliance_threshold", "title:asc", "title:desc", "os_major_version:asc", "os_major_version:desc", "total_system_count:asc", "total_system_count:desc", "business_objective:asc", "business_objective:desc", "compliance_threshold:asc", "compliance_threshold:desc" ] } } }, { "name": "filter", "in": "query", "required": false, "description": "Query string to filter items by their attributes. Compliant with scoped_search query language. However, only `=` or `!=` (resp. `<>`) operators are supported.

Policies are searchable using attributes `title`, `os_major_version`, and `os_minor_version`

(e.g.: `(field_1=something AND field_2!=\"something else\") OR field_3>40`)", "schema": { "type": "string" } } ], "tags": [ "Policies" ], "description": "Retrieve the list of policies that have been created to test the compliance of your registered systems.", "operationId": "Policies", "responses": { "200": { "description": "Lists Policies", "content": { "application/vnd.api+json": { "examples": { "List of Policies": { "value": { "data": [ { "id": "077a9752-ee71-4f3a-9a33-4b96e521c3e2", "title": "Accusamus quod ut repellendus.", "description": "Corrupti est esse. Officiis nihil modi. Id rerum voluptatem.", "business_objective": null, "compliance_threshold": 97.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Quod iste est necessitatibus.", "ref_id": "xccdf_org.ssgproject.content_profile_554ac6bd976381924f52f5836d2702bc" }, { "id": "0f9dce4b-aaf4-4dc6-b022-63a641a6edfa", "title": "Accusantium nihil reiciendis eum.", "description": "Cumque aut ut. Error sed voluptatem. Recusandae laborum voluptatibus.", "business_objective": null, "compliance_threshold": 27.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Dolor eum id asperiores.", "ref_id": "xccdf_org.ssgproject.content_profile_4b0a907039a2414d6d6c3860e2ce5762" }, { "id": "1688ac91-d789-4354-83db-990cc160600b", "title": "Rerum nobis mollitia voluptate.", "description": "Quam tenetur at. Velit deserunt delectus. Dolor rerum ipsum.", "business_objective": null, "compliance_threshold": 41.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Veniam iste similique vero.", "ref_id": "xccdf_org.ssgproject.content_profile_ca353bf191d5e7529ce05686fb80b5aa" }, { "id": "22e01879-58d4-42b8-a539-447e58abadff", "title": "Omnis esse veritatis vel.", "description": "Ut reiciendis alias. Dignissimos hic provident. Voluptatem et est.", "business_objective": null, "compliance_threshold": 2.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Nulla hic vel qui.", "ref_id": "xccdf_org.ssgproject.content_profile_3374444dab6aa6a7c4eecb3175cbc75f" }, { "id": "3db4edb4-62e2-4302-8aa4-3d0d0799697e", "title": "Occaecati repudiandae exercitationem incidunt.", "description": "Beatae dolorem nesciunt. Sed ex ipsam. Aspernatur sunt laudantium.", "business_objective": null, "compliance_threshold": 0.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Nihil quis sequi rerum.", "ref_id": "xccdf_org.ssgproject.content_profile_fc66e4542a0d76b237e2bf5ce5473cfa" }, { "id": "405ccfdb-87ac-4f3d-81c1-a6e3614e79f7", "title": "Consequuntur et qui consequatur.", "description": "Delectus consequuntur est. Sapiente consectetur reprehenderit. Unde ducimus modi.", "business_objective": null, "compliance_threshold": 67.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Quibusdam et nostrum hic.", "ref_id": "xccdf_org.ssgproject.content_profile_0979e9415e6c65d2092d3fdac0b0b484" }, { "id": "55254562-2207-49ad-b0ea-389ad324d24c", "title": "Sed non consequatur quisquam.", "description": "Distinctio ducimus numquam. Possimus nam porro. Fugiat velit omnis.", "business_objective": null, "compliance_threshold": 79.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Ad unde consequatur consequatur.", "ref_id": "xccdf_org.ssgproject.content_profile_dca905e57d5a645cb52d53403b379f70" }, { "id": "69f14c64-e8d7-4735-8bcb-62349a8abd4a", "title": "Nihil voluptatem harum dolorem.", "description": "Alias eos beatae. Aut et modi. Ex animi quia.", "business_objective": null, "compliance_threshold": 34.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Veritatis aut velit et.", "ref_id": "xccdf_org.ssgproject.content_profile_07b522718d5c3be48ae11040c6896740" }, { "id": "6e56b1fa-6f0f-49be-af12-4547ddecb578", "title": "Voluptatem sint nihil voluptates.", "description": "Qui rerum natus. Consequatur molestiae culpa. Velit quis quasi.", "business_objective": null, "compliance_threshold": 74.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Nemo quisquam harum velit.", "ref_id": "xccdf_org.ssgproject.content_profile_f90cb6dbd7dc6c3a59769b76542b0725" }, { "id": "7170cbc9-7fcf-4d66-b6ab-91d90c58a6f1", "title": "Ut aut voluptatibus et.", "description": "Non sed aut. Omnis sunt quidem. Magni veniam explicabo.", "business_objective": null, "compliance_threshold": 64.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Quo consectetur dolorem consequatur.", "ref_id": "xccdf_org.ssgproject.content_profile_84fc04b5b0bbf3e4545d149d393e8945" } ], "meta": { "total": 25, "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/policies?limit=10&offset=0", "last": "/api/compliance/v2/policies?limit=10&offset=20", "next": "/api/compliance/v2/policies?limit=10&offset=10" } }, "summary": "", "description": "" }, "List of Policies sorted by \"os_major_version:asc\"": { "value": { "data": [ { "id": "2c00387e-207b-4838-a6d5-4918624f60ad", "title": "Est ducimus excepturi ut.", "description": "Iste ut mollitia. Dolor dolore non. Dolorem voluptatum consequatur.", "business_objective": null, "compliance_threshold": 1.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Voluptate rerum repudiandae dolor.", "ref_id": "xccdf_org.ssgproject.content_profile_bb833ea7667164c8090c0cd66f3627a0" }, { "id": "2d3cb938-5aed-40b8-a911-869544d82afd", "title": "Beatae autem eos non.", "description": "Amet est doloremque. Qui animi totam. Vel nesciunt eius.", "business_objective": null, "compliance_threshold": 70.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Et cumque unde nihil.", "ref_id": "xccdf_org.ssgproject.content_profile_b314f5434a980d53db6510f88d2bf1f9" }, { "id": "30eb50aa-b61d-43f5-b7ea-37000af2d603", "title": "Aspernatur qui enim fugit.", "description": "Corporis quibusdam ducimus. Est minus asperiores. Eos iusto sunt.", "business_objective": null, "compliance_threshold": 78.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Est odio porro nihil.", "ref_id": "xccdf_org.ssgproject.content_profile_ad2135b21e144b7c8e1b9b1371bb999c" }, { "id": "396ed9e2-1d49-4ff4-871f-56ac25bfbf4e", "title": "Asperiores rerum quo doloremque.", "description": "Itaque dolore magnam. Dolor numquam ea. Sequi temporibus doloribus.", "business_objective": null, "compliance_threshold": 60.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Excepturi ut quibusdam voluptas.", "ref_id": "xccdf_org.ssgproject.content_profile_79253c9a3a3620c766727ac57bdc1b67" }, { "id": "3c50161e-629e-4489-86b2-a69e21f835ca", "title": "Corporis minus possimus est.", "description": "Et quas laboriosam. Reiciendis aut nulla. Aut maxime consectetur.", "business_objective": null, "compliance_threshold": 79.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Est saepe error quia.", "ref_id": "xccdf_org.ssgproject.content_profile_5d9f8077a80450d7a1fbb1f563c55b70" }, { "id": "416aecd3-85f6-4d96-ba87-59b355d4a3aa", "title": "Distinctio quibusdam dicta alias.", "description": "Exercitationem ad aut. Nesciunt doloribus inventore. Ut aperiam provident.", "business_objective": null, "compliance_threshold": 38.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Eaque laudantium nulla natus.", "ref_id": "xccdf_org.ssgproject.content_profile_6330a22c6fde83ac2fa3aeb47a50c957" }, { "id": "48514561-0ba7-4457-860e-daca88926378", "title": "Odit et natus eaque.", "description": "Consequatur optio debitis. Alias nihil tempore. Debitis aut et.", "business_objective": null, "compliance_threshold": 52.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Fuga quod adipisci aliquam.", "ref_id": "xccdf_org.ssgproject.content_profile_a75c39b8fd081ff409757978753e1232" }, { "id": "48c15d56-1954-4969-8c36-6011ad833610", "title": "Doloribus reiciendis ut at.", "description": "Voluptatem velit est. Labore et blanditiis. Aut tenetur velit.", "business_objective": null, "compliance_threshold": 76.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Quo omnis consectetur animi.", "ref_id": "xccdf_org.ssgproject.content_profile_0b821ba6ccad35b506ea955031a270c4" }, { "id": "4b81f8c9-8653-42af-877f-8d6f39da6386", "title": "Ex nesciunt dolore accusantium.", "description": "Neque aliquid cum. Illo natus at. Corporis quas in.", "business_objective": null, "compliance_threshold": 92.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Quas sit occaecati quibusdam.", "ref_id": "xccdf_org.ssgproject.content_profile_e9860b1ab29ab1c96f5c0730f0cf69eb" }, { "id": "56fb3307-0773-485e-b224-c4467a49ee1e", "title": "Et sunt quidem sed.", "description": "Eum officiis sint. Sit odio dicta. Ut minima consequatur.", "business_objective": null, "compliance_threshold": 25.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Adipisci tempore aut laboriosam.", "ref_id": "xccdf_org.ssgproject.content_profile_4441c4afbedd73b76c299a30a5fc307d" } ], "meta": { "total": 25, "limit": 10, "offset": 0, "sort_by": "os_major_version" }, "links": { "first": "/api/compliance/v2/policies?limit=10&offset=0&sort_by=os_major_version", "last": "/api/compliance/v2/policies?limit=10&offset=20&sort_by=os_major_version", "next": "/api/compliance/v2/policies?limit=10&offset=10&sort_by=os_major_version" } }, "summary": "", "description": "" }, "List of Policies filtered by \"(os_major_version=8)\"": { "value": { "data": [], "meta": { "total": 0, "filter": "(os_major_version=8)", "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/policies?filter=%28os_major_version%3D8%29&limit=10&offset=0", "last": "/api/compliance/v2/policies?filter=%28os_major_version%3D8%29&limit=10&offset=0" } }, "summary": "", "description": "" } }, "schema": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/metadata" }, "links": { "$ref": "#/components/schemas/links" }, "data": { "type": "array", "items": { "properties": { "schema": { "$ref": "#/components/schemas/policy" } } } } } } } } }, "422": { "description": "Returns with Unprocessable Content", "content": { "application/vnd.api+json": { "examples": { "Description of an error when sorting by incorrect parameter": { "value": { "errors": [ "Result cannot be sorted by the 'description' column." ] }, "summary": "", "description": "" }, "Description of an error when requesting higher limit than supported": { "value": { "errors": [ "Invalid parameter: limit must be less than or equal to 100" ] }, "summary": "", "description": "" } }, "schema": { "$ref": "#/components/schemas/errors" } } } } } }, "post": { "summary": "Create a Policy", "parameters": [ { "name": "X-RH-IDENTITY", "in": "header", "schema": { "type": "string" }, "description": "For internal use only" } ], "tags": [ "Policies" ], "description": "Create a new security policy.", "operationId": "CreatePolicy", "responses": { "201": { "description": "Creates a Policy", "content": { "application/vnd.api+json": { "examples": { "Response example": { "value": { "data": { "id": "ec8b846c-5131-4a66-a731-be96d14d397e", "title": "Foo", "description": "Hello World", "business_objective": "Serious Business Objective", "compliance_threshold": 33.3, "total_system_count": null, "type": "policy", "os_major_version": 7, "profile_title": "Sit rerum nisi aliquid.", "ref_id": "xccdf_org.ssgproject.content_profile_015c9db4d83e2d5749abc5dd264a490c" } }, "summary": "", "description": "" } }, "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/policy" } } } } } } } } }, "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/policy" } } } } } }, "/policies/{policy_id}": { "get": { "summary": "Request a Policy", "parameters": [ { "name": "X-RH-IDENTITY", "in": "header", "schema": { "type": "string" }, "description": "For internal use only" }, { "name": "policy_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "Policies" ], "description": "Retrieve a specific policy.", "operationId": "Policy", "responses": { "200": { "description": "Returns a Policy", "content": { "application/vnd.api+json": { "examples": { "Returns a Policy": { "value": { "data": { "id": "c4bacb1a-b409-481f-b4c4-f0ec7a0f5ea8", "title": "Facilis reiciendis aperiam eligendi.", "description": "Non nulla quod. Magni similique ut. Reprehenderit et et.", "business_objective": null, "compliance_threshold": 21.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Quam dicta quisquam expedita.", "ref_id": "xccdf_org.ssgproject.content_profile_f71170a4648a3f7c16c3eef4d81d5626" } }, "summary": "", "description": "" } }, "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/policy" } } } } } } } }, "404": { "description": "Returns with Not Found", "content": { "application/vnd.api+json": { "examples": { "Description of an error when requesting a non-existing Policy": { "value": { "errors": [ "V2::Policy not found with ID aa9245c9-2275-4300-ad8f-cf91c36b0598" ] }, "summary": "", "description": "" } }, "schema": { "$ref": "#/components/schemas/errors" } } } } } }, "patch": { "summary": "Update a Policy", "parameters": [ { "name": "X-RH-IDENTITY", "in": "header", "schema": { "type": "string" }, "description": "For internal use only" }, { "name": "policy_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "Policies" ], "description": "Edit or update an existing policy.", "operationId": "UpdatePolicy", "responses": { "202": { "description": "Updates a Policy", "content": { "application/vnd.api+json": { "examples": { "Returns the updated Policy": { "value": { "data": { "id": "6b1d4420-0c62-425f-9e1f-42cd2a4b907d", "title": "Nulla cumque repudiandae molestias.", "description": "Maxime minima quae. Quod iusto adipisci. Suscipit sequi modi.", "business_objective": null, "compliance_threshold": 100.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Quia iure vel sed.", "ref_id": "xccdf_org.ssgproject.content_profile_11a5ad6bf52a2c6be84d4005ecfe32fa" } }, "summary": "", "description": "" } }, "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/policy" } } } } } } } } }, "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/policy_update" } } } } }, "delete": { "summary": "Delete a Policy", "parameters": [ { "name": "X-RH-IDENTITY", "in": "header", "schema": { "type": "string" }, "description": "For internal use only" }, { "name": "policy_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "Policies" ], "description": "Delete a specific policy.", "operationId": "DeletePolicy", "responses": { "202": { "description": "Deletes a Policy", "content": { "application/vnd.api+json": { "examples": { "Deletes a Policy": { "value": { "data": { "id": "472fb172-430a-4d14-a475-c606a98765e4", "title": "Consectetur commodi quis ipsum.", "description": "Quibusdam nihil porro. Eos necessitatibus quaerat. Consequatur ut ex.", "business_objective": null, "compliance_threshold": 85.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Consequuntur enim soluta eos.", "ref_id": "xccdf_org.ssgproject.content_profile_e9d7b161cd4f26864fbea0008177ae16" } }, "summary": "", "description": "" } }, "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/policy" } } } } } } } } } } }, "/systems/{system_id}/policies": { "get": { "summary": "Request Policies assigned to a System", "parameters": [ { "name": "X-RH-IDENTITY", "in": "header", "schema": { "type": "string" }, "description": "For internal use only" }, { "name": "limit", "in": "query", "required": false, "description": "Number of items to return per page", "schema": { "type": "number", "maximum": 100, "minimum": 1, "default": 10 } }, { "name": "offset", "in": "query", "required": false, "description": "Offset of first item of paginated response", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "ids_only", "in": "query", "required": false, "description": "Indicates whether to return only resource IDs.", "schema": { "type": "boolean" } }, { "name": "sort_by", "in": "query", "required": false, "description": "Attribute and direction to sort the items by. Represented by an array of fields with an optional direction (`:asc` or `:desc`).

If no direction is selected, `:asc` is used by default.", "schema": { "type": "array", "items": { "enum": [ "title", "business_objective", "compliance_threshold", "title:asc", "title:desc", "business_objective:asc", "business_objective:desc", "compliance_threshold:asc", "compliance_threshold:desc" ] } } }, { "name": "filter", "in": "query", "required": false, "description": "Query string to filter items by their attributes. Compliant with scoped_search query language. However, only `=` or `!=` (resp. `<>`) operators are supported.

Policies are searchable using attributes `title` and `os_minor_version`

(e.g.: `(field_1=something AND field_2!=\"something else\") OR field_3>40`)", "schema": { "type": "string" } }, { "name": "system_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "Systems" ], "description": "List all policies assigned to a single system.", "operationId": "SystemsPolicies", "responses": { "200": { "description": "Lists Policies", "content": { "application/vnd.api+json": { "examples": { "List of Policies under a System": { "value": { "data": [ { "id": "138ade25-de3d-4204-b92c-c29ccfa6f09d", "title": "Quae qui et quod.", "description": "Ut amet ea. Cupiditate distinctio beatae. Aut optio ipsum.", "business_objective": null, "compliance_threshold": 53.0, "total_system_count": 1, "type": "policy", "os_major_version": 7, "profile_title": "Sint atque iste accusamus.", "ref_id": "xccdf_org.ssgproject.content_profile_a2babe1e341fa09ecca8fd0021d139a0" }, { "id": "168604e7-7fab-49a7-b756-e446dd0242d6", "title": "Quasi aperiam illum maxime.", "description": "Excepturi minus repudiandae. Recusandae at saepe. Dolores ea consequatur.", "business_objective": null, "compliance_threshold": 86.0, "total_system_count": 1, "type": "policy", "os_major_version": 7, "profile_title": "Repellat iure veritatis facilis.", "ref_id": "xccdf_org.ssgproject.content_profile_530c754be8c596eb005ca4d9bfabfdf0" }, { "id": "16f65f9a-618b-4402-96b8-c8df20cd9caf", "title": "Commodi ipsum odio nihil.", "description": "Aut cumque ut. Sint eum id. Ipsa dolorem aut.", "business_objective": null, "compliance_threshold": 19.0, "total_system_count": 1, "type": "policy", "os_major_version": 7, "profile_title": "Labore quia non molestiae.", "ref_id": "xccdf_org.ssgproject.content_profile_846bdcd412bb8f23cb801912063a10fa" }, { "id": "2b4157ea-5e6a-442d-b93a-97fea79937e2", "title": "Quasi quaerat rem quidem.", "description": "Odio sed minus. Excepturi mollitia et. Quo non amet.", "business_objective": null, "compliance_threshold": 79.0, "total_system_count": 1, "type": "policy", "os_major_version": 7, "profile_title": "Accusamus similique cum minima.", "ref_id": "xccdf_org.ssgproject.content_profile_728bcc29113548d249240c3e502b2ca7" }, { "id": "34284ee8-7249-478c-88a7-34ce62278d3b", "title": "Cum aut officiis natus.", "description": "Perferendis minima consequuntur. Rerum necessitatibus quaerat. Itaque recusandae delectus.", "business_objective": null, "compliance_threshold": 38.0, "total_system_count": 1, "type": "policy", "os_major_version": 7, "profile_title": "Omnis deleniti occaecati laudantium.", "ref_id": "xccdf_org.ssgproject.content_profile_da3ad6c6b02bf5407b38e80466d23396" }, { "id": "46760192-b346-4238-8b1d-f0d69ee696f0", "title": "Repellat iste mollitia qui.", "description": "Consequatur pariatur id. Nam beatae et. Deleniti quasi maxime.", "business_objective": null, "compliance_threshold": 96.0, "total_system_count": 1, "type": "policy", "os_major_version": 7, "profile_title": "Ab in suscipit consequatur.", "ref_id": "xccdf_org.ssgproject.content_profile_6e7708094c36fcb56d5a4aedeaef2a2b" }, { "id": "4b965685-47bf-4225-b13c-3947f5e7a745", "title": "Mollitia minima repellendus fuga.", "description": "Vero vel sunt. Aut et ut. Cum recusandae eos.", "business_objective": null, "compliance_threshold": 4.0, "total_system_count": 1, "type": "policy", "os_major_version": 7, "profile_title": "Enim totam et cum.", "ref_id": "xccdf_org.ssgproject.content_profile_b8976a9f5bc30017ceeb9dd2b4a07e52" }, { "id": "4d5a0e25-044f-4eef-a70c-a7c5c5a069dd", "title": "Aliquam maiores voluptatibus id.", "description": "Odit assumenda ullam. Error rerum et. Hic nemo quis.", "business_objective": null, "compliance_threshold": 88.0, "total_system_count": 1, "type": "policy", "os_major_version": 7, "profile_title": "Voluptatibus molestiae ipsa deserunt.", "ref_id": "xccdf_org.ssgproject.content_profile_9e9a0b559f811a4bdecf202388db708e" }, { "id": "4e21ff6e-c288-4caf-8d36-34c977e11565", "title": "Corrupti consectetur et saepe.", "description": "Impedit minima nulla. Voluptatum ut illo. Voluptatibus tempora nisi.", "business_objective": null, "compliance_threshold": 21.0, "total_system_count": 1, "type": "policy", "os_major_version": 7, "profile_title": "Perferendis maiores aut magni.", "ref_id": "xccdf_org.ssgproject.content_profile_d7c3c6c103a1f56b3fd0ff694b659f3f" }, { "id": "59b3af1e-c1d7-4628-98c0-0f067e7f02a4", "title": "Laborum aperiam quibusdam quidem.", "description": "Et non provident. Dolores eaque fuga. Vel facilis libero.", "business_objective": null, "compliance_threshold": 92.0, "total_system_count": 1, "type": "policy", "os_major_version": 7, "profile_title": "Enim nemo minima consequuntur.", "ref_id": "xccdf_org.ssgproject.content_profile_9b3e7bab10e5414f5414587c3b499ab0" } ], "meta": { "total": 25, "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/systems/4c144b3c-e098-4fff-a1ef-8321bf8b0ea0/policies?limit=10&offset=0", "last": "/api/compliance/v2/systems/4c144b3c-e098-4fff-a1ef-8321bf8b0ea0/policies?limit=10&offset=20", "next": "/api/compliance/v2/systems/4c144b3c-e098-4fff-a1ef-8321bf8b0ea0/policies?limit=10&offset=10" } }, "summary": "", "description": "" } }, "schema": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/metadata" }, "links": { "$ref": "#/components/schemas/links" }, "data": { "type": "array", "items": { "properties": { "schema": { "$ref": "#/components/schemas/policy" } } } } } } } } } } } }, "/security_guides/{security_guide_id}/profiles": { "get": { "summary": "Request Profiles", "parameters": [ { "name": "X-RH-IDENTITY", "in": "header", "schema": { "type": "string" }, "description": "For internal use only" }, { "name": "limit", "in": "query", "required": false, "description": "Number of items to return per page", "schema": { "type": "number", "maximum": 100, "minimum": 1, "default": 10 } }, { "name": "offset", "in": "query", "required": false, "description": "Offset of first item of paginated response", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "ids_only", "in": "query", "required": false, "description": "Indicates whether to return only resource IDs.", "schema": { "type": "boolean" } }, { "name": "sort_by", "in": "query", "required": false, "description": "Attribute and direction to sort the items by. Represented by an array of fields with an optional direction (`:asc` or `:desc`).

If no direction is selected, `:asc` is used by default.", "schema": { "type": "array", "items": { "enum": [ "title", "title:asc", "title:desc" ] } } }, { "name": "filter", "in": "query", "required": false, "description": "Query string to filter items by their attributes. Compliant with scoped_search query language. However, only `=` or `!=` (resp. `<>`) operators are supported.

Profiles are searchable using attributes `title` and `ref_id`

(e.g.: `(field_1=something AND field_2!=\"something else\") OR field_3>40`)", "schema": { "type": "string" } }, { "name": "security_guide_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "Content" ], "description": "List all security guide profiles.", "operationId": "Profiles", "responses": { "200": { "description": "Lists Profiles", "content": { "application/vnd.api+json": { "examples": { "List of Profiles": { "value": { "data": [ { "id": "08fbf870-c612-4dbc-ba8e-03536154a108", "ref_id": "xccdf_org.ssgproject.content_profile_18bc7e3b92ca3db9602afe2402eb244c", "title": "Nihil molestiae voluptas minima.", "description": "Quia impedit qui. Perspiciatis autem deleniti. Nostrum suscipit est.", "value_overrides": {}, "type": "profile" }, { "id": "108b5306-c8fa-4a52-8df6-6616204bdcb7", "ref_id": "xccdf_org.ssgproject.content_profile_4c56b051a0a092190669eb22a57e19b8", "title": "Illum excepturi quos sed.", "description": "Nostrum aut dolorum. Ut quis occaecati. Ut dolor et.", "value_overrides": {}, "type": "profile" }, { "id": "278987ec-86e1-4a14-90ae-a0380f480415", "ref_id": "xccdf_org.ssgproject.content_profile_b04f2d13f05d85be5613d7d420fc6146", "title": "Aut placeat esse iste.", "description": "Est consequatur placeat. Minima nihil iste. Eaque perferendis accusamus.", "value_overrides": {}, "type": "profile" }, { "id": "2dabf7cf-6847-47ba-b0ec-1b05cd24f444", "ref_id": "xccdf_org.ssgproject.content_profile_c8499d6b6b7221b23d48bc913811da91", "title": "Exercitationem ut expedita quo.", "description": "Dicta rerum aut. Perspiciatis aperiam omnis. Voluptatem sit aut.", "value_overrides": {}, "type": "profile" }, { "id": "3ff5ea36-817d-49b6-8de7-d437799a7478", "ref_id": "xccdf_org.ssgproject.content_profile_38420e9e47d1839fed8f7552b9761166", "title": "Et cumque repellat corrupti.", "description": "Quia voluptas sunt. Voluptas commodi quae. Perferendis sint magnam.", "value_overrides": {}, "type": "profile" }, { "id": "50e61351-c328-4a64-9e7e-a781c2a2f1ce", "ref_id": "xccdf_org.ssgproject.content_profile_f3787e025e589c33930226a67401a53f", "title": "Perspiciatis quae nulla nemo.", "description": "Et aut enim. Recusandae atque inventore. Reiciendis laboriosam fugiat.", "value_overrides": {}, "type": "profile" }, { "id": "541a9b26-2ce3-48ee-bdce-4c4877e7257a", "ref_id": "xccdf_org.ssgproject.content_profile_614e4f384a02b2666a47d88f2c11038f", "title": "Ut quod cumque excepturi.", "description": "Veritatis harum voluptatum. In voluptatem quo. Est repudiandae voluptate.", "value_overrides": {}, "type": "profile" }, { "id": "54d68ecf-3e28-4cd7-af63-07c36d39cd11", "ref_id": "xccdf_org.ssgproject.content_profile_241d567ada41937fe27109c56e3be1e5", "title": "Labore alias quibusdam natus.", "description": "Corporis asperiores nesciunt. Ratione nostrum cumque. Qui nobis ut.", "value_overrides": {}, "type": "profile" }, { "id": "5be2f004-be8e-42f7-a57a-8a5a8e923cb0", "ref_id": "xccdf_org.ssgproject.content_profile_a9e8bbb9ad6e1e677b09c96c2eca1880", "title": "Aperiam dolore nihil numquam.", "description": "Ut autem quam. Omnis iste perferendis. Assumenda facere possimus.", "value_overrides": {}, "type": "profile" }, { "id": "6c240403-4edb-4103-91a9-36ae4288a354", "ref_id": "xccdf_org.ssgproject.content_profile_ab33fe0eaf2bcc3a11eca65d64836edf", "title": "Et aliquam sapiente et.", "description": "Quia corporis atque. Vel id sed. Aut enim minima.", "value_overrides": {}, "type": "profile" } ], "meta": { "total": 25, "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/security_guides/a95c256d-24fd-46c0-8b10-4eddf35ea0e3/profiles?limit=10&offset=0", "last": "/api/compliance/v2/security_guides/a95c256d-24fd-46c0-8b10-4eddf35ea0e3/profiles?limit=10&offset=20", "next": "/api/compliance/v2/security_guides/a95c256d-24fd-46c0-8b10-4eddf35ea0e3/profiles?limit=10&offset=10" } }, "summary": "", "description": "" }, "List of Profiles sorted by \"title:asc\"": { "value": { "data": [ { "id": "2d659470-7a17-4de5-abbe-2dbc920ceb18", "ref_id": "xccdf_org.ssgproject.content_profile_d8ee4ba2348b4643220064a85095f918", "title": "Accusamus autem ut eum.", "description": "Qui sapiente sit. Eligendi rem quaerat. Rerum fuga voluptatem.", "value_overrides": {}, "type": "profile" }, { "id": "b82b0275-a0c1-4864-ad60-0f2282e6304c", "ref_id": "xccdf_org.ssgproject.content_profile_efebacf71fdc90cfe83f2206b9676d99", "title": "Asperiores nobis rerum quos.", "description": "Consequatur incidunt dolores. Explicabo libero quam. Aspernatur magnam unde.", "value_overrides": {}, "type": "profile" }, { "id": "f3712991-557d-4cfe-9a79-1e4956e2c168", "ref_id": "xccdf_org.ssgproject.content_profile_f5c4e85c631f4ae60f4c763c1f917015", "title": "Aut pariatur nesciunt hic.", "description": "Vel voluptas accusamus. Nemo neque est. Voluptas quia molestiae.", "value_overrides": {}, "type": "profile" }, { "id": "3a02fdcf-7d4d-4eb0-b0b8-6ea901058f4d", "ref_id": "xccdf_org.ssgproject.content_profile_0a98b8f8e6f13be5be849114032fc2bd", "title": "Consequatur iure reiciendis officiis.", "description": "Tempore quibusdam eos. Consequatur et accusantium. Saepe aperiam quia.", "value_overrides": {}, "type": "profile" }, { "id": "3c1d5d0c-5132-4aff-b084-5f934e092f1b", "ref_id": "xccdf_org.ssgproject.content_profile_75edbc6399f0d8ef23811edae8ece396", "title": "Debitis voluptatem voluptatem voluptas.", "description": "Velit repellat qui. Delectus mollitia reiciendis. Quia tenetur rerum.", "value_overrides": {}, "type": "profile" }, { "id": "15e6c871-148c-470a-9891-34da9bf469a2", "ref_id": "xccdf_org.ssgproject.content_profile_47a650ee4fdb436e778a7679069adcbc", "title": "Eligendi eum et sequi.", "description": "Quia aut assumenda. Autem culpa et. Aliquid eum repellat.", "value_overrides": {}, "type": "profile" }, { "id": "4a07557b-3921-4542-b633-4fec64cf051b", "ref_id": "xccdf_org.ssgproject.content_profile_ccbf837e7822d4c415da94dc457c4a70", "title": "Enim dolores odio dolores.", "description": "Repellat omnis aut. Autem est quasi. Quasi veniam beatae.", "value_overrides": {}, "type": "profile" }, { "id": "b8827687-7aa8-4787-8905-ff7a6ca57ef5", "ref_id": "xccdf_org.ssgproject.content_profile_501c01b1f82a20ab9c55bc0017b99e53", "title": "In eligendi est placeat.", "description": "Harum laudantium reiciendis. Sit quam alias. Vitae nulla facilis.", "value_overrides": {}, "type": "profile" }, { "id": "ffddf7e6-be3d-4ac4-af7c-e257a1f86372", "ref_id": "xccdf_org.ssgproject.content_profile_d3abee24a76eb337396b286bbf103477", "title": "Inventore cum sed tempora.", "description": "Blanditiis dolore nesciunt. Doloremque aut error. Necessitatibus ducimus id.", "value_overrides": {}, "type": "profile" }, { "id": "bb925a65-ff49-437d-8d2e-107f6dca3582", "ref_id": "xccdf_org.ssgproject.content_profile_73572b0a27c021f1bc77c7b850fd1d8a", "title": "Iure ut sit velit.", "description": "Vitae amet aliquid. Magnam ut rerum. Totam quia molestiae.", "value_overrides": {}, "type": "profile" } ], "meta": { "total": 25, "limit": 10, "offset": 0, "sort_by": "title" }, "links": { "first": "/api/compliance/v2/security_guides/d8431b78-7bca-44db-8845-403cf92d7792/profiles?limit=10&offset=0&sort_by=title", "last": "/api/compliance/v2/security_guides/d8431b78-7bca-44db-8845-403cf92d7792/profiles?limit=10&offset=20&sort_by=title", "next": "/api/compliance/v2/security_guides/d8431b78-7bca-44db-8845-403cf92d7792/profiles?limit=10&offset=10&sort_by=title" } }, "summary": "", "description": "" }, "List of Profiles filtered by '(title=Amet aut laborum doloremque.)'": { "value": { "data": [ { "id": "08a6a5b6-4981-406e-b703-c35a296ee541", "ref_id": "xccdf_org.ssgproject.content_profile_c004e5362b2a1eb900a5c42031af52c6", "title": "Amet aut laborum doloremque.", "description": "Similique sit assumenda. Fugit ut adipisci. Animi qui voluptas.", "value_overrides": {}, "type": "profile" } ], "meta": { "total": 1, "filter": "(title=\"Amet aut laborum doloremque.\")", "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/security_guides/c6d23b1f-f0c3-4bcf-aec4-57ffdc980437/profiles?filter=%28title%3D%22Amet+aut+laborum+doloremque.%22%29&limit=10&offset=0", "last": "/api/compliance/v2/security_guides/c6d23b1f-f0c3-4bcf-aec4-57ffdc980437/profiles?filter=%28title%3D%22Amet+aut+laborum+doloremque.%22%29&limit=10&offset=0" } }, "summary": "", "description": "" } }, "schema": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/metadata" }, "links": { "$ref": "#/components/schemas/links" }, "data": { "type": "array", "items": { "properties": { "schema": { "$ref": "#/components/schemas/profile" } } } } } } } } }, "422": { "description": "Returns with Unprocessable Content", "content": { "application/vnd.api+json": { "examples": { "Description of an error when sorting by incorrect parameter": { "value": { "errors": [ "Result cannot be sorted by the 'description' column." ] }, "summary": "", "description": "" }, "Description of an error when requesting higher limit than supported": { "value": { "errors": [ "Invalid parameter: limit must be less than or equal to 100" ] }, "summary": "", "description": "" } }, "schema": { "$ref": "#/components/schemas/errors" } } } } } } }, "/security_guides/{security_guide_id}/profiles/{profile_id}": { "get": { "summary": "Request a Profile", "parameters": [ { "name": "X-RH-IDENTITY", "in": "header", "schema": { "type": "string" }, "description": "For internal use only" }, { "name": "security_guide_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "profile_id", "in": "path", "required": true, "description": "UUID or a ref_id with '.' characters replaced with '-'", "schema": { "type": "string" } } ], "tags": [ "Content" ], "description": "Retrieve a specific profile.", "operationId": "Profile", "responses": { "200": { "description": "Returns a Profile", "content": { "application/vnd.api+json": { "examples": { "Returns a Profile": { "value": { "data": { "id": "d58d5300-b9a2-456f-b588-c94541f63369", "ref_id": "xccdf_org.ssgproject.content_profile_a1869a84056f5a53f7ee885e9116c833", "title": "Odit quia aliquid aspernatur.", "description": "Dolor nostrum iusto. Quae corporis qui. Non quos sint.", "value_overrides": {}, "type": "profile" } }, "summary": "", "description": "" } }, "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/profile" } } } } } } } }, "404": { "description": "Returns with Not Found", "content": { "application/vnd.api+json": { "examples": { "Description of an error when requesting a non-existing Profile": { "value": { "errors": [ "V2::Profile not found with ID aa5b2798-56a2-49d5-a214-fc86e20558db" ] }, "summary": "", "description": "" } }, "schema": { "$ref": "#/components/schemas/errors" } } } } } } }, "/security_guides/{security_guide_id}/profiles/{profile_id}/rule_tree": { "get": { "summary": "Request the Rule Tree of a Profile", "parameters": [ { "name": "X-RH-IDENTITY", "in": "header", "schema": { "type": "string" }, "description": "For internal use only" }, { "name": "security_guide_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "profile_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "Content" ], "description": "Returns the Rule Tree of a Profile", "operationId": "ProfileTree", "deprecated": true, "responses": { "200": { "description": "Returns the Rule Tree of a Profile", "content": { "application/vnd.api+json": { "examples": { "Returns the Rule Tree of a Profile": { "value": [ { "id": "f83fc4d8-9787-4de7-8bef-de7edb1c88e7", "type": "rule_group", "children": [ { "id": "565b575f-497e-42ab-a311-7dfa40a81a19", "type": "rule" } ] }, { "id": "6c79ec86-6cd6-43bc-8f2f-3c3d59aa301e", "type": "rule_group", "children": [ { "id": "a6f9cb0c-d079-4534-be72-ad608bedece3", "type": "rule" } ] }, { "id": "498b2441-08fa-402a-b88e-5f1d1fff850e", "type": "rule_group", "children": [ { "id": "d330e27e-d162-4b79-812e-7a734e68f3a4", "type": "rule" } ] }, { "id": "b6af9c14-c408-4d00-a7cf-b741f4af7ebe", "type": "rule_group", "children": [ { "id": "c9003a33-4a3b-4475-8175-151bcf2160d6", "type": "rule" } ] }, { "id": "2d4919d0-d17f-449a-b36d-5bde952371d2", "type": "rule_group", "children": [ { "id": "de1508f0-6134-48f5-8e64-748b902aea64", "type": "rule" } ] }, { "id": "701bdf55-4a68-44cf-a67e-12c2c407d952", "type": "rule_group", "children": [ { "id": "fa651b62-1e1f-40b5-aa80-02d20ee7a60d", "type": "rule" } ] }, { "id": "eb0f10e6-9531-423a-99ce-8f9b2d397e00", "type": "rule_group", "children": [ { "id": "ea8ad2f2-b4ea-49e4-89fd-2c694fbe374c", "type": "rule" } ] }, { "id": "80a7b3d4-106c-434a-87cd-d042cd5959d9", "type": "rule_group", "children": [ { "id": "7798ecdc-cb1b-451c-b538-9be7f6f9468b", "type": "rule" } ] }, { "id": "6a6d2e12-506b-41e3-9f1d-7863245a2380", "type": "rule_group", "children": [ { "id": "01c6ade7-c163-44f7-912c-0dbd684a5b06", "type": "rule" } ] }, { "id": "9e995afa-e20a-4aa6-8edc-0218dddec470", "type": "rule_group", "children": [ { "id": "516bba93-a694-4d04-aa78-cc64d4a9687f", "type": "rule" } ] } ], "summary": "", "description": "" } }, "schema": { "$ref": "#/components/schemas/rule_tree" } } } }, "404": { "description": "Returns with Not Found", "content": { "application/vnd.api+json": { "examples": { "Description of an error when requesting a non-existing Profile": { "value": { "errors": [ "V2::Profile not found with ID c2d5a3e6-7147-4a01-b3f0-3e02af40d37f" ] }, "summary": "", "description": "" } }, "schema": { "$ref": "#/components/schemas/errors" } } } } } } }, "/reports": { "get": { "summary": "Request Reports", "parameters": [ { "name": "X-RH-IDENTITY", "in": "header", "schema": { "type": "string" }, "description": "For internal use only" }, { "name": "limit", "in": "query", "required": false, "description": "Number of items to return per page", "schema": { "type": "number", "maximum": 100, "minimum": 1, "default": 10 } }, { "name": "offset", "in": "query", "required": false, "description": "Offset of first item of paginated response", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "ids_only", "in": "query", "required": false, "description": "Indicates whether to return only resource IDs.", "schema": { "type": "boolean" } }, { "name": "sort_by", "in": "query", "required": false, "description": "Attribute and direction to sort the items by. Represented by an array of fields with an optional direction (`:asc` or `:desc`).

If no direction is selected, `:asc` is used by default.", "schema": { "type": "array", "items": { "enum": [ "title", "os_major_version", "business_objective", "compliance_threshold", "percent_compliant", "title:asc", "title:desc", "os_major_version:asc", "os_major_version:desc", "business_objective:asc", "business_objective:desc", "compliance_threshold:asc", "compliance_threshold:desc", "percent_compliant:asc", "percent_compliant:desc" ] } } }, { "name": "filter", "in": "query", "required": false, "description": "Query string to filter items by their attributes. Compliant with scoped_search query language. However, only `=` or `!=` (resp. `<>`) operators are supported.

Reports are searchable using attributes `title`, `os_major_version`, `with_reported_systems`, and `percent_compliant`

(e.g.: `(field_1=something AND field_2!=\"something else\") OR field_3>40`)", "schema": { "type": "string" } } ], "tags": [ "Reports" ], "description": "Retrieve a list of all available reports.", "operationId": "Reports", "responses": { "200": { "description": "Lists Reports", "content": { "application/vnd.api+json": { "examples": { "List of Reports": { "value": { "data": [ { "id": "641af3b5-32dd-4f78-bff2-e99ac264ca39", "title": "Et nulla fugiat et.", "description": "Occaecati quasi praesentium. Maxime ipsam qui. Iure sapiente at.", "business_objective": "alarm", "compliance_threshold": 90.0, "type": "report", "os_major_version": 8, "profile_title": "Placeat fugit odit quo.", "ref_id": "xccdf_org.ssgproject.content_profile_eb3f03e54c6e5589174dd5bd66bd9714", "all_systems_exposed": true, "percent_compliant": 25, "assigned_system_count": 4, "compliant_system_count": 1, "unsupported_system_count": 2, "reported_system_count": 4, "never_reported_system_count": 0 }, { "id": "6ffb05ea-3eb9-4709-8a31-072006b8a7b1", "title": "Molestias et quos ipsam.", "description": "Ad sint suscipit. Voluptatem delectus modi. Cumque iure ut.", "business_objective": "feed", "compliance_threshold": 90.0, "type": "report", "os_major_version": 8, "profile_title": "Molestias quaerat quia qui.", "ref_id": "xccdf_org.ssgproject.content_profile_a58b9eaa7e73816d8dfe617542bc708b", "all_systems_exposed": true, "percent_compliant": 25, "assigned_system_count": 4, "compliant_system_count": 1, "unsupported_system_count": 2, "reported_system_count": 4, "never_reported_system_count": 0 }, { "id": "85d7983c-a330-46f7-879a-92a103b32610", "title": "Illo reprehenderit doloribus dolores.", "description": "Animi soluta et. Voluptatem occaecati consectetur. Cupiditate illo dolorum.", "business_objective": "bandwidth", "compliance_threshold": 90.0, "type": "report", "os_major_version": 8, "profile_title": "Ad voluptas quae id.", "ref_id": "xccdf_org.ssgproject.content_profile_0e88c1360b2016f580961f978d1cb250", "all_systems_exposed": true, "percent_compliant": 25, "assigned_system_count": 4, "compliant_system_count": 1, "unsupported_system_count": 2, "reported_system_count": 4, "never_reported_system_count": 0 }, { "id": "af696e31-0028-406a-9da5-b6b75609d7d1", "title": "Ut similique eos necessitatibus.", "description": "Possimus quo nam. Doloribus molestias et. Et distinctio explicabo.", "business_objective": "matrix", "compliance_threshold": 90.0, "type": "report", "os_major_version": 8, "profile_title": "Odio sed aspernatur modi.", "ref_id": "xccdf_org.ssgproject.content_profile_d9a4819034e34270f0fec51a55e29647", "all_systems_exposed": true, "percent_compliant": 25, "assigned_system_count": 4, "compliant_system_count": 1, "unsupported_system_count": 2, "reported_system_count": 4, "never_reported_system_count": 0 }, { "id": "f5cad6df-5a10-4e0e-82ac-f32a85e85668", "title": "Reprehenderit quidem omnis eveniet.", "description": "Nisi iusto explicabo. At eum nisi. Dolor enim commodi.", "business_objective": "driver", "compliance_threshold": 90.0, "type": "report", "os_major_version": 8, "profile_title": "Odio esse officiis quos.", "ref_id": "xccdf_org.ssgproject.content_profile_c8b02cf0cf4dd85d5b03ea41f915f3cf", "all_systems_exposed": true, "percent_compliant": 25, "assigned_system_count": 4, "compliant_system_count": 1, "unsupported_system_count": 2, "reported_system_count": 4, "never_reported_system_count": 0 } ], "meta": { "total": 5, "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/reports?limit=10&offset=0", "last": "/api/compliance/v2/reports?limit=10&offset=0" } }, "summary": "", "description": "" }, "List of Reports sorted by \"os_major_version:asc\"": { "value": { "data": [ { "id": "19987a4d-c6aa-4125-8db2-d33403a3f256", "title": "Esse vel illum voluptate.", "description": "Nobis eos in. Et delectus et. Voluptates sequi ipsam.", "business_objective": "panel", "compliance_threshold": 90.0, "type": "report", "os_major_version": 8, "profile_title": "Et aspernatur in est.", "ref_id": "xccdf_org.ssgproject.content_profile_e68f0b4235927e78567516e2ee6677b9", "all_systems_exposed": true, "percent_compliant": 25, "assigned_system_count": 4, "compliant_system_count": 1, "unsupported_system_count": 2, "reported_system_count": 4, "never_reported_system_count": 0 }, { "id": "361eb119-34ef-49a6-b3c2-1c294fc494c0", "title": "Soluta hic adipisci aliquid.", "description": "Libero nesciunt commodi. Ut velit debitis. Beatae dignissimos reiciendis.", "business_objective": "panel", "compliance_threshold": 90.0, "type": "report", "os_major_version": 8, "profile_title": "Temporibus cum repellendus pariatur.", "ref_id": "xccdf_org.ssgproject.content_profile_e65f3398df2002faf46d29e6375f477b", "all_systems_exposed": true, "percent_compliant": 25, "assigned_system_count": 4, "compliant_system_count": 1, "unsupported_system_count": 2, "reported_system_count": 4, "never_reported_system_count": 0 }, { "id": "74715a54-7527-42e4-9800-e9aee1dfc228", "title": "Quidem rerum voluptatem occaecati.", "description": "Temporibus repudiandae a. Placeat adipisci facere. Beatae ducimus qui.", "business_objective": "panel", "compliance_threshold": 90.0, "type": "report", "os_major_version": 8, "profile_title": "Voluptatem officiis et eum.", "ref_id": "xccdf_org.ssgproject.content_profile_d97e574f31fde6e780853d249ec1707a", "all_systems_exposed": true, "percent_compliant": 25, "assigned_system_count": 4, "compliant_system_count": 1, "unsupported_system_count": 2, "reported_system_count": 4, "never_reported_system_count": 0 }, { "id": "e26cff2e-70bc-4cbc-bbf1-24b0493452c9", "title": "Delectus numquam ut exercitationem.", "description": "Voluptatibus rem dolorem. Mollitia vitae asperiores. Quae provident accusantium.", "business_objective": "monitor", "compliance_threshold": 90.0, "type": "report", "os_major_version": 8, "profile_title": "Quo reiciendis maxime quo.", "ref_id": "xccdf_org.ssgproject.content_profile_987618ba6bb5d38f12f60d0c2114795a", "all_systems_exposed": true, "percent_compliant": 25, "assigned_system_count": 4, "compliant_system_count": 1, "unsupported_system_count": 2, "reported_system_count": 4, "never_reported_system_count": 0 }, { "id": "ff001944-b9ac-41df-9e3b-bd5c286a1a21", "title": "Nisi in adipisci at.", "description": "Hic voluptas ut. Non distinctio nisi. Sed et est.", "business_objective": "firewall", "compliance_threshold": 90.0, "type": "report", "os_major_version": 8, "profile_title": "Iusto odio ullam architecto.", "ref_id": "xccdf_org.ssgproject.content_profile_1d684cce3d7a1055e78c988fcf9acbb5", "all_systems_exposed": true, "percent_compliant": 25, "assigned_system_count": 4, "compliant_system_count": 1, "unsupported_system_count": 2, "reported_system_count": 4, "never_reported_system_count": 0 } ], "meta": { "total": 5, "limit": 10, "offset": 0, "sort_by": "os_major_version" }, "links": { "first": "/api/compliance/v2/reports?limit=10&offset=0&sort_by=os_major_version", "last": "/api/compliance/v2/reports?limit=10&offset=0&sort_by=os_major_version" } }, "summary": "", "description": "" } }, "schema": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/metadata" }, "links": { "$ref": "#/components/schemas/links" }, "data": { "type": "array", "items": { "properties": { "schema": { "$ref": "#/components/schemas/report" } } } } } } } } }, "422": { "description": "Returns with Unprocessable Content", "content": { "application/vnd.api+json": { "examples": { "Description of an error when sorting by incorrect parameter": { "value": { "errors": [ "Result cannot be sorted by the 'description' column." ] }, "summary": "", "description": "" }, "Description of an error when requesting higher limit than supported": { "value": { "errors": [ "Invalid parameter: limit must be less than or equal to 100" ] }, "summary": "", "description": "" } }, "schema": { "$ref": "#/components/schemas/errors" } } } } } } }, "/reports/os_versions": { "get": { "summary": "Request the list of available OS versions", "parameters": [ { "name": "X-RH-IDENTITY", "in": "header", "schema": { "type": "string" }, "description": "For internal use only" }, { "name": "filter", "in": "query", "required": false, "description": "Query string to filter items by their attributes. Compliant with scoped_search query language. However, only `=` or `!=` (resp. `<>`) operators are supported.

Reports are searchable using attributes `title`, `os_major_version`, `with_reported_systems`, and `percent_compliant`

(e.g.: `(field_1=something AND field_2!=\"something else\") OR field_3>40`)", "schema": { "type": "string" } } ], "tags": [ "Reports" ], "description": "This feature is exclusively used by the frontend", "operationId": "ReportsOS", "deprecated": true, "responses": { "200": { "description": "Lists available OS versions", "content": { "application/vnd.api+json": { "examples": { "List of available OS versions": { "value": [], "summary": "", "description": "" } }, "schema": { "type": "array", "items": { "type": "integer" } } } } } } } }, "/reports/{report_id}": { "get": { "summary": "Request a Report", "parameters": [ { "name": "X-RH-IDENTITY", "in": "header", "schema": { "type": "string" }, "description": "For internal use only" }, { "name": "report_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "Reports" ], "description": "Retrieve a specific report.", "operationId": "Report", "responses": { "200": { "description": "Returns a Report", "content": { "application/vnd.api+json": { "examples": { "Returns a Report": { "value": { "data": { "id": "cb245d6a-24c3-4346-a812-4d1031ef4218", "title": "Nisi est magnam rerum.", "description": "Dolores ad non. Praesentium consequatur nemo. Commodi sit est.", "business_objective": "bus", "compliance_threshold": 90.0, "type": "report", "os_major_version": 9, "profile_title": "Totam excepturi sequi impedit.", "ref_id": "xccdf_org.ssgproject.content_profile_844e594a6fb71db36e2927fb77833a3b", "all_systems_exposed": true, "percent_compliant": 25, "assigned_system_count": 4, "compliant_system_count": 1, "unsupported_system_count": 2, "reported_system_count": 4, "never_reported_system_count": 0 } }, "summary": "", "description": "" } }, "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/report" } } } } } } } }, "404": { "description": "Returns with Not Found", "content": { "application/vnd.api+json": { "examples": { "Description of an error when requesting a non-existing Report": { "value": { "errors": [ "V2::Report not found with ID efb4925f-79cb-4f13-aee3-2f35f24216c3" ] }, "summary": "", "description": "" } }, "schema": { "$ref": "#/components/schemas/errors" } } } } } }, "delete": { "summary": "Delete a Report results", "parameters": [ { "name": "X-RH-IDENTITY", "in": "header", "schema": { "type": "string" }, "description": "For internal use only" }, { "name": "report_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "Reports" ], "description": "Delete test results for a specific report.", "operationId": "DeleteReport", "responses": { "202": { "description": "Deletes Report's test results", "content": { "application/vnd.api+json": { "examples": { "Deletes Report's test results": { "value": { "data": { "id": "6b3a8fd5-7495-4a59-8ecc-b9d25decfc09", "title": "Voluptate dignissimos aliquam accusantium.", "description": "Quaerat sunt perferendis. Consequatur eum tempora. Doloremque voluptatibus magni.", "business_objective": "array", "compliance_threshold": 90.0, "type": "report", "os_major_version": 9, "profile_title": "Ab perspiciatis officiis sed.", "ref_id": "xccdf_org.ssgproject.content_profile_652211967d6d7a37df1edbf42cafe37b", "all_systems_exposed": true, "percent_compliant": 25, "assigned_system_count": 4, "compliant_system_count": 1, "unsupported_system_count": 2, "reported_system_count": 4, "never_reported_system_count": 0 } }, "summary": "", "description": "" } } } } } } } }, "/reports/{report_id}/stats": { "get": { "summary": "Request detailed stats for a Report", "parameters": [ { "name": "X-RH-IDENTITY", "in": "header", "schema": { "type": "string" }, "description": "For internal use only" }, { "name": "report_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "Reports" ], "description": "Returns detailed stats for a Report", "deprecated": true, "operationId": "ReportStats", "responses": { "200": { "description": "Returns detailed stats for a Report", "content": { "application/vnd.api+json": { "examples": { "Returns detailed stats for a Report": { "value": { "top_failed_rules": [] }, "summary": "", "description": "" } }, "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/report_stats" } } } } } } } }, "404": { "description": "Returns with Not Found", "content": { "application/vnd.api+json": { "examples": { "Description of an error when requesting a non-existing Report": { "value": { "errors": [ "V2::Report not found with ID 08cbc8bb-4117-46ff-a957-82094cec3359" ] }, "summary": "", "description": "" } }, "schema": { "$ref": "#/components/schemas/errors" } } } } } } }, "/systems/{system_id}/reports": { "get": { "summary": "Request Reports", "parameters": [ { "name": "X-RH-IDENTITY", "in": "header", "schema": { "type": "string" }, "description": "For internal use only" }, { "name": "limit", "in": "query", "required": false, "description": "Number of items to return per page", "schema": { "type": "number", "maximum": 100, "minimum": 1, "default": 10 } }, { "name": "offset", "in": "query", "required": false, "description": "Offset of first item of paginated response", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "ids_only", "in": "query", "required": false, "description": "Indicates whether to return only resource IDs.", "schema": { "type": "boolean" } }, { "name": "sort_by", "in": "query", "required": false, "description": "Attribute and direction to sort the items by. Represented by an array of fields with an optional direction (`:asc` or `:desc`).

If no direction is selected, `:asc` is used by default.", "schema": { "type": "array", "items": { "enum": [ "title", "business_objective", "compliance_threshold", "percent_compliant", "title:asc", "title:desc", "business_objective:asc", "business_objective:desc", "compliance_threshold:asc", "compliance_threshold:desc", "percent_compliant:asc", "percent_compliant:desc" ] } } }, { "name": "filter", "in": "query", "required": false, "description": "Query string to filter items by their attributes. Compliant with scoped_search query language. However, only `=` or `!=` (resp. `<>`) operators are supported.

Reports are searchable using attributes `title`

(e.g.: `(field_1=something AND field_2!=\"something else\") OR field_3>40`)", "schema": { "type": "string" } }, { "name": "system_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "Reports" ], "description": "Retrieve a list of reports for a specific system.", "operationId": "SystemReports", "responses": { "200": { "description": "Lists Reports", "content": { "application/vnd.api+json": { "examples": { "List of Reports": { "value": { "data": [ { "id": "018dc776-e71d-43cb-aa8a-6c6884190ddc", "title": "Aut inventore deleniti et.", "description": "Velit sed quia. Repellat quo voluptas. Corporis rerum in.", "business_objective": "system", "compliance_threshold": 90.0, "type": "report", "os_major_version": 8, "profile_title": "Et provident id soluta.", "ref_id": "xccdf_org.ssgproject.content_profile_65fac15b8c6752be90d567022ea1f601", "all_systems_exposed": true, "percent_compliant": 0, "assigned_system_count": 1, "compliant_system_count": 0, "unsupported_system_count": 0, "reported_system_count": 0, "never_reported_system_count": 1 }, { "id": "3241fe24-c419-4441-b3ce-fe17e4e9cc3e", "title": "Tempora delectus fugiat inventore.", "description": "Qui corporis culpa. Perspiciatis sequi ipsa. Ut rerum iusto.", "business_objective": "pixel", "compliance_threshold": 90.0, "type": "report", "os_major_version": 8, "profile_title": "Perferendis eos et quis.", "ref_id": "xccdf_org.ssgproject.content_profile_6ad11d63586c72485171ffe1b076127c", "all_systems_exposed": true, "percent_compliant": 0, "assigned_system_count": 1, "compliant_system_count": 0, "unsupported_system_count": 0, "reported_system_count": 0, "never_reported_system_count": 1 }, { "id": "4e5cb1f5-0b5f-477c-8f06-f280a93a9f89", "title": "Dolor et dolorem architecto.", "description": "Ut cumque aperiam. Qui corporis nulla. Voluptatibus commodi et.", "business_objective": "array", "compliance_threshold": 90.0, "type": "report", "os_major_version": 8, "profile_title": "Beatae sequi non accusantium.", "ref_id": "xccdf_org.ssgproject.content_profile_cd3c911f095d2057620bf34638be73fc", "all_systems_exposed": true, "percent_compliant": 0, "assigned_system_count": 1, "compliant_system_count": 0, "unsupported_system_count": 0, "reported_system_count": 0, "never_reported_system_count": 1 }, { "id": "b7069be0-400c-4906-ac6d-626fba73a2bd", "title": "Dolorum eaque occaecati vero.", "description": "Qui sit qui. Et deserunt distinctio. Hic autem tempora.", "business_objective": "application", "compliance_threshold": 90.0, "type": "report", "os_major_version": 8, "profile_title": "Dolor nihil iste voluptas.", "ref_id": "xccdf_org.ssgproject.content_profile_af2fa3e3a54557b1db3f44b0ac230e89", "all_systems_exposed": true, "percent_compliant": 0, "assigned_system_count": 1, "compliant_system_count": 0, "unsupported_system_count": 0, "reported_system_count": 0, "never_reported_system_count": 1 }, { "id": "fa458e32-eae0-4bdc-bd7b-751311012327", "title": "Autem ut provident necessitatibus.", "description": "Ullam quia delectus. Neque corrupti dicta. Reprehenderit occaecati magni.", "business_objective": "bus", "compliance_threshold": 90.0, "type": "report", "os_major_version": 8, "profile_title": "Aliquam consequuntur quia nemo.", "ref_id": "xccdf_org.ssgproject.content_profile_a4cd515e9dccaa65c9b9e9d4e5336379", "all_systems_exposed": true, "percent_compliant": 0, "assigned_system_count": 1, "compliant_system_count": 0, "unsupported_system_count": 0, "reported_system_count": 0, "never_reported_system_count": 1 } ], "meta": { "total": 5, "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/systems/d1d170e9-ab3e-41c4-8d8a-c7e267fabe06/reports?limit=10&offset=0", "last": "/api/compliance/v2/systems/d1d170e9-ab3e-41c4-8d8a-c7e267fabe06/reports?limit=10&offset=0" } }, "summary": "", "description": "" }, "List of Reports sorted by \"title:asc\"": { "value": { "data": [ { "id": "9ce01560-bcb9-4998-a952-343aee7f8641", "title": "Eos odit perferendis aut.", "description": "Voluptas sunt minima. Impedit facilis libero. Sequi rem sint.", "business_objective": "capacitor", "compliance_threshold": 90.0, "type": "report", "os_major_version": 8, "profile_title": "Perspiciatis dolores quis aut.", "ref_id": "xccdf_org.ssgproject.content_profile_180471d1b74781461b0521cbc74a1ee3", "all_systems_exposed": true, "percent_compliant": 0, "assigned_system_count": 1, "compliant_system_count": 0, "unsupported_system_count": 0, "reported_system_count": 0, "never_reported_system_count": 1 }, { "id": "ceb6adde-9114-4f8e-b991-10acbea2a908", "title": "Est dolorem et molestias.", "description": "Atque et sunt. Repellat porro laudantium. Id eveniet iure.", "business_objective": "application", "compliance_threshold": 90.0, "type": "report", "os_major_version": 8, "profile_title": "Adipisci placeat sapiente nemo.", "ref_id": "xccdf_org.ssgproject.content_profile_4ba9e09a40c73b6f674904f7e80b0d91", "all_systems_exposed": true, "percent_compliant": 0, "assigned_system_count": 1, "compliant_system_count": 0, "unsupported_system_count": 0, "reported_system_count": 0, "never_reported_system_count": 1 }, { "id": "fa83a4dd-dc31-4cfd-8c2a-ee5889a260c7", "title": "Et voluptatem non enim.", "description": "Blanditiis saepe veritatis. Iusto error maiores. Et neque et.", "business_objective": "port", "compliance_threshold": 90.0, "type": "report", "os_major_version": 8, "profile_title": "Sequi et sed et.", "ref_id": "xccdf_org.ssgproject.content_profile_c9b912924a429f9684ab3aa1b74089ca", "all_systems_exposed": true, "percent_compliant": 0, "assigned_system_count": 1, "compliant_system_count": 0, "unsupported_system_count": 0, "reported_system_count": 0, "never_reported_system_count": 1 }, { "id": "0738b115-1136-4457-a813-3d1b4ac11e41", "title": "Iusto sed odit debitis.", "description": "Deserunt ut similique. Quas earum dignissimos. Rerum neque vel.", "business_objective": "transmitter", "compliance_threshold": 90.0, "type": "report", "os_major_version": 8, "profile_title": "Eius rerum et sunt.", "ref_id": "xccdf_org.ssgproject.content_profile_2b23cd67835c44225baca2026bdd77b0", "all_systems_exposed": true, "percent_compliant": 0, "assigned_system_count": 1, "compliant_system_count": 0, "unsupported_system_count": 0, "reported_system_count": 0, "never_reported_system_count": 1 }, { "id": "7b8eb5c4-b59f-4e2e-b996-cdcd9ef1ae0c", "title": "Velit rerum eos et.", "description": "Autem ut quo. Sint et consequatur. Dolores rerum placeat.", "business_objective": "feed", "compliance_threshold": 90.0, "type": "report", "os_major_version": 8, "profile_title": "Aut perferendis in sunt.", "ref_id": "xccdf_org.ssgproject.content_profile_ee3c46655af9e9a22b0dc8d30b98431c", "all_systems_exposed": true, "percent_compliant": 0, "assigned_system_count": 1, "compliant_system_count": 0, "unsupported_system_count": 0, "reported_system_count": 0, "never_reported_system_count": 1 } ], "meta": { "total": 5, "limit": 10, "offset": 0, "sort_by": "title" }, "links": { "first": "/api/compliance/v2/systems/1e66534e-f608-4d3d-acb6-8a877ebe8fa3/reports?limit=10&offset=0&sort_by=title", "last": "/api/compliance/v2/systems/1e66534e-f608-4d3d-acb6-8a877ebe8fa3/reports?limit=10&offset=0&sort_by=title" } }, "summary": "", "description": "" } }, "schema": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/metadata" }, "links": { "$ref": "#/components/schemas/links" }, "data": { "type": "array", "items": { "properties": { "schema": { "$ref": "#/components/schemas/report" } } } } } } } } }, "422": { "description": "Returns with Unprocessable Content", "content": { "application/vnd.api+json": { "examples": { "Description of an error when sorting by incorrect parameter": { "value": { "errors": [ "Result cannot be sorted by the 'description' column." ] }, "summary": "", "description": "" }, "Description of an error when requesting higher limit than supported": { "value": { "errors": [ "Invalid parameter: limit must be less than or equal to 100" ] }, "summary": "", "description": "" } }, "schema": { "$ref": "#/components/schemas/errors" } } } } } } }, "/security_guides/{security_guide_id}/rule_groups": { "get": { "summary": "Request Rule Groups", "parameters": [ { "name": "X-RH-IDENTITY", "in": "header", "schema": { "type": "string" }, "description": "For internal use only" }, { "name": "limit", "in": "query", "required": false, "description": "Number of items to return per page", "schema": { "type": "number", "maximum": 100, "minimum": 1, "default": 10 } }, { "name": "offset", "in": "query", "required": false, "description": "Offset of first item of paginated response", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "ids_only", "in": "query", "required": false, "description": "Indicates whether to return only resource IDs.", "schema": { "type": "boolean" } }, { "name": "sort_by", "in": "query", "required": false, "description": "Attribute and direction to sort the items by. Represented by an array of fields with an optional direction (`:asc` or `:desc`).

If no direction is selected, `:asc` is used by default.", "schema": { "type": "array", "items": { "enum": [ "precedence", "precedence:asc", "precedence:desc" ] } } }, { "name": "filter", "in": "query", "required": false, "description": "Query string to filter items by their attributes. Compliant with scoped_search query language. However, only `=` or `!=` (resp. `<>`) operators are supported.

Rule Groups are searchable using attributes `title` and `ref_id`

(e.g.: `(field_1=something AND field_2!=\"something else\") OR field_3>40`)", "schema": { "type": "string" } }, { "name": "security_guide_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "Content" ], "description": "List all rules groups.", "operationId": "RuleGroups", "responses": { "200": { "description": "Lists Rule Groups", "content": { "application/vnd.api+json": { "examples": { "List of Rule Groups": { "value": { "data": [ { "id": "0c028941-83e4-45dd-849f-9bd3daa445b6", "ref_id": "xccdf_org.ssgproject.content_rule_group_376e0efd600024a29a48e1664c11c553", "title": "Dolor aut illum dolore.", "rationale": "Ea quod earum. Vel aliquid dicta. Ut fugiat mollitia.", "description": "Voluptatem consequatur et. Aut aut aliquid. Nihil eos modi.", "precedence": null, "type": "rule_group" }, { "id": "1002fe09-a296-4f2b-9ab3-73769462d977", "ref_id": "xccdf_org.ssgproject.content_rule_group_8c179ed39dfaca8f49ba56a76540698f", "title": "At similique inventore quidem.", "rationale": "Quia unde iure. Iusto quo est. Vitae et quia.", "description": "Et labore necessitatibus. Sint sit similique. Sunt pariatur delectus.", "precedence": null, "type": "rule_group" }, { "id": "103a7865-9232-4f27-840a-f81436900d6a", "ref_id": "xccdf_org.ssgproject.content_rule_group_c9a4ffef2e9ab0ec9b5625f5d0edf027", "title": "Ut architecto perferendis aut.", "rationale": "Dolorum dolor ratione. Molestiae consectetur perspiciatis. Omnis et voluptatem.", "description": "Pariatur accusamus numquam. Impedit atque debitis. Enim rerum veniam.", "precedence": null, "type": "rule_group" }, { "id": "15bde071-dd51-470c-a997-65e16c1db48b", "ref_id": "xccdf_org.ssgproject.content_rule_group_6f604d32814a17ef5f38890c9de48c7e", "title": "Explicabo aspernatur error sunt.", "rationale": "Culpa velit commodi. Vero quae voluptas. Maxime sunt quo.", "description": "Cum eos est. Nulla eveniet laudantium. Vero dolorum facere.", "precedence": null, "type": "rule_group" }, { "id": "1abcc038-0424-4972-8d0b-3e3da074de14", "ref_id": "xccdf_org.ssgproject.content_rule_group_5b86557edc0e37e31df39ec76320da58", "title": "Vel eum dicta et.", "rationale": "Nisi delectus quas. Id dolorem ea. Veniam repudiandae cumque.", "description": "Eum aliquid id. Facere id doloribus. Dolorum quo dolorem.", "precedence": null, "type": "rule_group" }, { "id": "295d84c0-d91f-40e9-b5f8-4068648d9eac", "ref_id": "xccdf_org.ssgproject.content_rule_group_c4c8f50b48d5032e7116b977f081136b", "title": "Sunt et natus voluptatem.", "rationale": "Vel voluptatem non. Fuga dolor magnam. Qui laboriosam quo.", "description": "Impedit in assumenda. Voluptatem ab optio. Nesciunt quidem iusto.", "precedence": null, "type": "rule_group" }, { "id": "2ea5f612-5581-4228-a388-315d63df0749", "ref_id": "xccdf_org.ssgproject.content_rule_group_6340e14ceae6d6c524b673d2a93e1857", "title": "Nam consequatur et fugiat.", "rationale": "Adipisci a saepe. Rerum cumque incidunt. Quaerat in corporis.", "description": "Minus molestiae explicabo. Ipsam voluptatem quisquam. Sint quia at.", "precedence": null, "type": "rule_group" }, { "id": "423c9845-3198-4d5b-ad47-e3c6306571a6", "ref_id": "xccdf_org.ssgproject.content_rule_group_196c2bfd6c76fdfec7e07bb7fddd3bd1", "title": "Voluptas qui quaerat sint.", "rationale": "Aut molestiae cupiditate. Porro ipsam aut. Illum similique voluptates.", "description": "Rerum labore magni. Quis tenetur harum. Ut veniam nihil.", "precedence": null, "type": "rule_group" }, { "id": "5e3d033a-7741-4f92-92f4-69e85ee47114", "ref_id": "xccdf_org.ssgproject.content_rule_group_42635cbd1bed5742d73ac56f36907657", "title": "Esse tempore atque ullam.", "rationale": "Tenetur aperiam quo. In nam at. Voluptatem omnis vel.", "description": "Quod tempora nemo. Nesciunt ullam harum. Rerum illum vel.", "precedence": null, "type": "rule_group" }, { "id": "68fdd8bd-c5c2-425c-86a3-295c678289ae", "ref_id": "xccdf_org.ssgproject.content_rule_group_3ce32e86820317b8f9843c3d6ad04eeb", "title": "Facilis delectus aut ea.", "rationale": "Quasi repellendus aperiam. Tenetur numquam repellendus. Sit qui et.", "description": "Quo culpa beatae. Aperiam sed aut. Minus eum expedita.", "precedence": null, "type": "rule_group" } ], "meta": { "total": 25, "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/security_guides/cf40ab96-3b7c-4c5b-bd08-d6a1c93917a9/rule_groups?limit=10&offset=0", "last": "/api/compliance/v2/security_guides/cf40ab96-3b7c-4c5b-bd08-d6a1c93917a9/rule_groups?limit=10&offset=20", "next": "/api/compliance/v2/security_guides/cf40ab96-3b7c-4c5b-bd08-d6a1c93917a9/rule_groups?limit=10&offset=10" } }, "summary": "", "description": "" }, "List of Rule Groups sorted by \"precedence:asc\"": { "value": { "data": [ { "id": "093883f8-12ef-4de7-a1fe-6f8ffa99b831", "ref_id": "xccdf_org.ssgproject.content_rule_group_f8ce5184b42859acd770083d3d01d94f", "title": "Ut nihil velit neque.", "rationale": "Ab accusantium vero. Fuga ducimus repudiandae. Sed cum beatae.", "description": "Tempore reiciendis et. Sunt voluptatum pariatur. Dignissimos aliquid quia.", "precedence": null, "type": "rule_group" }, { "id": "0faaca97-11c7-47e7-8b48-f6569fcdfd81", "ref_id": "xccdf_org.ssgproject.content_rule_group_b434682663dd43d85ff2a8e94cf6b395", "title": "Mollitia architecto tempora accusantium.", "rationale": "Quidem excepturi aut. Error ea et. Vitae sequi sunt.", "description": "Iste quam commodi. Sed occaecati omnis. Quia necessitatibus quaerat.", "precedence": null, "type": "rule_group" }, { "id": "11ad3140-47d4-47e1-9a6f-4f82acf100e8", "ref_id": "xccdf_org.ssgproject.content_rule_group_4fbe70b7da3046642e724f544066a370", "title": "Quos architecto et qui.", "rationale": "Enim repudiandae consequatur. Corporis vel voluptate. Doloribus earum quis.", "description": "Dolore et voluptates. Error ipsam doloribus. Est ut voluptatem.", "precedence": null, "type": "rule_group" }, { "id": "2e135754-ca2f-431c-aef1-74deb87734c1", "ref_id": "xccdf_org.ssgproject.content_rule_group_655a7a744e1684d45d3468a761735c7b", "title": "Accusamus nobis ut et.", "rationale": "Dolorem incidunt veniam. Repudiandae accusantium ut. Officia rerum nihil.", "description": "Delectus cum placeat. Repellat ad consequatur. Officiis rerum dolores.", "precedence": null, "type": "rule_group" }, { "id": "4fba9b1a-b192-49af-ad7c-32c23dee91cb", "ref_id": "xccdf_org.ssgproject.content_rule_group_6f79a6623811e833cbf75467e17e9b0c", "title": "Exercitationem aut vel deleniti.", "rationale": "Possimus accusantium iure. Sed rem ea. Delectus ut voluptatum.", "description": "Aliquam animi aut. Ipsum consequatur non. Eius aspernatur beatae.", "precedence": null, "type": "rule_group" }, { "id": "5f04503a-79e9-4b04-82a5-74c5f6789cbd", "ref_id": "xccdf_org.ssgproject.content_rule_group_7e6af9eebcbe9bcc1921583036d0b586", "title": "Repellendus officia voluptatem odit.", "rationale": "Nam perferendis non. Illum nesciunt molestiae. Magnam repellat omnis.", "description": "Error amet aliquid. Minus in eligendi. Sit distinctio est.", "precedence": null, "type": "rule_group" }, { "id": "5f256ee4-2fce-400b-bd23-9c59d78fd6a1", "ref_id": "xccdf_org.ssgproject.content_rule_group_a3c8333eadacf9d7723bd8efa8aff569", "title": "Aut iusto aut quo.", "rationale": "Quod id repudiandae. Voluptate ut dolore. Nam voluptas aperiam.", "description": "Aut tempore dolore. Nobis omnis distinctio. Laboriosam eveniet corrupti.", "precedence": null, "type": "rule_group" }, { "id": "6207497f-8fa1-4ea8-9b8c-02428eaf1120", "ref_id": "xccdf_org.ssgproject.content_rule_group_8ed381e8682a30f957cf095b92ab55c6", "title": "Ducimus voluptas earum dicta.", "rationale": "Occaecati nobis suscipit. Suscipit rerum rerum. Repellendus maxime omnis.", "description": "Omnis perspiciatis dolor. Velit perspiciatis ut. Nemo architecto tenetur.", "precedence": null, "type": "rule_group" }, { "id": "631624af-06a7-4dec-9e2a-8b16bcc8c6b4", "ref_id": "xccdf_org.ssgproject.content_rule_group_6b4a39b9039792fdaa9b3c3262a38e97", "title": "Incidunt assumenda itaque ut.", "rationale": "Voluptate non occaecati. Aut ab sapiente. Voluptates possimus officiis.", "description": "Quia numquam dolorem. Enim molestiae vel. Sunt et dignissimos.", "precedence": null, "type": "rule_group" }, { "id": "65659268-4e78-43d0-9360-008844168cd9", "ref_id": "xccdf_org.ssgproject.content_rule_group_7be1cf6bd0e8a378dc46a2bfb6c4e7d8", "title": "Qui accusamus voluptas sunt.", "rationale": "Fugit qui iure. Necessitatibus reprehenderit nemo. Mollitia quaerat quia.", "description": "Et ipsam quasi. Aspernatur et velit. Est necessitatibus et.", "precedence": null, "type": "rule_group" } ], "meta": { "total": 25, "limit": 10, "offset": 0, "sort_by": "precedence" }, "links": { "first": "/api/compliance/v2/security_guides/744fc3fa-0cc1-427e-b27e-526875138502/rule_groups?limit=10&offset=0&sort_by=precedence", "last": "/api/compliance/v2/security_guides/744fc3fa-0cc1-427e-b27e-526875138502/rule_groups?limit=10&offset=20&sort_by=precedence", "next": "/api/compliance/v2/security_guides/744fc3fa-0cc1-427e-b27e-526875138502/rule_groups?limit=10&offset=10&sort_by=precedence" } }, "summary": "", "description": "" } }, "schema": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/metadata" }, "links": { "$ref": "#/components/schemas/links" }, "data": { "type": "array", "items": { "properties": { "schema": { "$ref": "#/components/schemas/rule_group" } } } } } } } } }, "422": { "description": "Returns with Unprocessable Content", "content": { "application/vnd.api+json": { "examples": { "Description of an error when sorting by incorrect parameter": { "value": { "errors": [ "Result cannot be sorted by the 'description' column." ] }, "summary": "", "description": "" }, "Description of an error when requesting higher limit than supported": { "value": { "errors": [ "Invalid parameter: limit must be less than or equal to 100" ] }, "summary": "", "description": "" } }, "schema": { "$ref": "#/components/schemas/errors" } } } } } } }, "/security_guides/{security_guide_id}/rule_groups/{rule_group_id}": { "get": { "summary": "Request a Rule Group", "parameters": [ { "name": "X-RH-IDENTITY", "in": "header", "schema": { "type": "string" }, "description": "For internal use only" }, { "name": "security_guide_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "rule_group_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "Content" ], "description": "Retrieve a specific rule group.", "operationId": "RuleGroup", "responses": { "200": { "description": "Returns a Rule Group", "content": { "application/vnd.api+json": { "examples": { "Returns a Rule Group": { "value": { "data": { "id": "e1f8d121-cfda-4581-a985-d0d553021031", "ref_id": "xccdf_org.ssgproject.content_rule_group_9ed105d9b3fbd6096cd3c23592a12bd6", "title": "Nihil saepe id et.", "rationale": "Similique est quis. Sed quia occaecati. Harum dolorem expedita.", "description": "Delectus tempore possimus. Eaque sunt praesentium. Odio expedita debitis.", "precedence": null, "type": "rule_group" } }, "summary": "", "description": "" } }, "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/rule_group" } } } } } } } }, "404": { "description": "Returns with Not Found", "content": { "application/vnd.api+json": { "examples": { "Description of an error when requesting a non-existing Rule Group": { "value": { "errors": [ "V2::RuleGroup not found with ID 0df7231b-1621-4ecc-a319-648b0aabf164" ] }, "summary": "", "description": "" } }, "schema": { "$ref": "#/components/schemas/errors" } } } } } } }, "/reports/{report_id}/test_results/{test_result_id}/rule_results": { "get": { "summary": "Request Rule Results under a Report", "parameters": [ { "name": "X-RH-IDENTITY", "in": "header", "schema": { "type": "string" }, "description": "For internal use only" }, { "name": "limit", "in": "query", "required": false, "description": "Number of items to return per page", "schema": { "type": "number", "maximum": 100, "minimum": 1, "default": 10 } }, { "name": "offset", "in": "query", "required": false, "description": "Offset of first item of paginated response", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "ids_only", "in": "query", "required": false, "description": "Indicates whether to return only resource IDs.", "schema": { "type": "boolean" } }, { "name": "sort_by", "in": "query", "required": false, "description": "Attribute and direction to sort the items by. Represented by an array of fields with an optional direction (`:asc` or `:desc`).

If no direction is selected, `:asc` is used by default.", "schema": { "type": "array", "items": { "enum": [ "result", "severity", "title", "precedence", "remediation_available", "result:asc", "result:desc", "severity:asc", "severity:desc", "title:asc", "title:desc", "precedence:asc", "precedence:desc", "remediation_available:asc", "remediation_available:desc" ] } } }, { "name": "filter", "in": "query", "required": false, "description": "Query string to filter items by their attributes. Compliant with scoped_search query language. However, only `=` or `!=` (resp. `<>`) operators are supported.

Rule Results are searchable using attributes `result`, `title`, `severity`, `rule_group_id`, and `identifier_label`

(e.g.: `(field_1=something AND field_2!=\"something else\") OR field_3>40`)", "schema": { "type": "string" } }, { "name": "test_result_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "report_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "Reports" ], "description": "Retrieve all of the rule results for a specific report.", "operationId": "ReportRuleResults", "responses": { "200": { "description": "Lists Rule Results under a Report", "content": { "application/vnd.api+json": { "examples": { "List of Rule Results": { "value": { "data": [ { "id": "5813a294-a57b-4d94-bc5b-e2d90b468eff", "result": "fail", "rule_id": "ed2bdca5-b825-4029-bdde-c2a5879e3c42", "type": "rule_result", "system_id": "7bb12128-1415-472c-b1c9-e0337a13567a", "ref_id": "xccdf_org.ssgproject.content_rule_2746645637327257d75645cff0b1fc9f", "rule_group_id": "3e72cf75-39a3-4116-93c5-6b2fd2377c75", "title": "Impedit blanditiis enim est.", "rationale": "Error rerum facere. Quae accusantium rerum. Consectetur impedit asperiores.", "description": "Vel sed soluta. Aliquam cum itaque. Omnis ut accusamus.", "severity": "medium", "precedence": 3281, "identifier": { "href": "http://sipes.example/belia", "label": "Lothíriel" }, "references": [ { "href": "http://smith-witting.test/tomas.king", "label": "Tindómiel" }, { "href": "http://hodkiewicz-buckridge.example/rico", "label": "Daisy Baggins" }, { "href": "http://fay.test/reed", "label": "Rowlie Appledore" }, { "href": "http://dicki-schamberger.example/gene", "label": "Esmeralda Took" }, { "href": "http://stanton.test/mandi_conn", "label": "Nimrodel" } ], "remediation_issue_id": null } ], "meta": { "total": 1, "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/reports/306034b6-245a-4a9f-a117-034a7403df62/test_results/b2ff3c51-48bb-490f-b322-40b82b633cdc/rule_results?limit=10&offset=0", "last": "/api/compliance/v2/reports/306034b6-245a-4a9f-a117-034a7403df62/test_results/b2ff3c51-48bb-490f-b322-40b82b633cdc/rule_results?limit=10&offset=0" } }, "summary": "", "description": "" }, "List of Rule Results sorted by \"result:asc\"": { "value": { "data": [ { "id": "db7c52ea-647a-4c62-9689-bfee125a9198", "result": "fail", "rule_id": "9b056252-8d6c-4008-9321-645b50c9976b", "type": "rule_result", "system_id": "01126d78-2437-4ccf-9233-b287802abeb4", "ref_id": "xccdf_org.ssgproject.content_rule_7dee1f4803254242aa7559214ec2a69f", "rule_group_id": "38f9edb5-736d-44b4-8f20-443072141476", "title": "Et fuga repellendus voluptatum.", "rationale": "Voluptatum repellendus quos. Nisi porro a. Temporibus esse voluptas.", "description": "Architecto dolorum quaerat. Maiores aspernatur sunt. Consequatur quo expedita.", "severity": "medium", "precedence": 7135, "identifier": { "href": "http://toy.example/freeman", "label": "Tarondor" }, "references": [ { "href": "http://reilly-howell.example/franklin", "label": "Agathor" }, { "href": "http://marks-daugherty.test/gayle_kutch", "label": "Scatha" }, { "href": "http://kirlin.example/johnsie", "label": "Celeborn" }, { "href": "http://leannon.example/shanelle_bergnaum", "label": "Beleth" }, { "href": "http://volkman-schuppe.example/patti", "label": "Bór" } ], "remediation_issue_id": null } ], "meta": { "total": 1, "limit": 10, "offset": 0, "sort_by": "result" }, "links": { "first": "/api/compliance/v2/reports/7e855710-4e2f-4b19-ae3f-ecc36efeb142/test_results/0f9db902-47e4-40b8-a80a-296c75e7be31/rule_results?limit=10&offset=0&sort_by=result", "last": "/api/compliance/v2/reports/7e855710-4e2f-4b19-ae3f-ecc36efeb142/test_results/0f9db902-47e4-40b8-a80a-296c75e7be31/rule_results?limit=10&offset=0&sort_by=result" } }, "summary": "", "description": "" }, "List of Rule Results filtered by \"(title=foo)\"": { "value": { "data": [], "meta": { "total": 0, "filter": "(title=foo)", "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/reports/f19f1ee3-969c-48e1-8068-58c286e21a0c/test_results/b7efa33e-dc4d-4ec9-bf8c-834bf75b6e06/rule_results?filter=%28title%3Dfoo%29&limit=10&offset=0", "last": "/api/compliance/v2/reports/f19f1ee3-969c-48e1-8068-58c286e21a0c/test_results/b7efa33e-dc4d-4ec9-bf8c-834bf75b6e06/rule_results?filter=%28title%3Dfoo%29&limit=10&offset=0" } }, "summary": "", "description": "" } }, "schema": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/metadata" }, "links": { "$ref": "#/components/schemas/links" }, "data": { "type": "array", "items": { "properties": { "schema": { "$ref": "#/components/schemas/rule_result" } } } } } } } } }, "422": { "description": "Returns with Unprocessable Content", "content": { "application/vnd.api+json": { "examples": { "Description of an error when sorting by incorrect parameter": { "value": { "errors": [ "Result cannot be sorted by the 'description' column." ] }, "summary": "", "description": "" }, "Description of an error when requesting higher limit than supported": { "value": { "errors": [ "Invalid parameter: limit must be less than or equal to 100" ] }, "summary": "", "description": "" } }, "schema": { "$ref": "#/components/schemas/errors" } } } } } } }, "/security_guides/{security_guide_id}/rules": { "get": { "summary": "Request Rules", "parameters": [ { "name": "X-RH-IDENTITY", "in": "header", "schema": { "type": "string" }, "description": "For internal use only" }, { "name": "limit", "in": "query", "required": false, "description": "Number of items to return per page", "schema": { "type": "number", "maximum": 100, "minimum": 1, "default": 10 } }, { "name": "offset", "in": "query", "required": false, "description": "Offset of first item of paginated response", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "ids_only", "in": "query", "required": false, "description": "Indicates whether to return only resource IDs.", "schema": { "type": "boolean" } }, { "name": "sort_by", "in": "query", "required": false, "description": "Attribute and direction to sort the items by. Represented by an array of fields with an optional direction (`:asc` or `:desc`).

If no direction is selected, `:asc` is used by default.", "schema": { "type": "array", "items": { "enum": [ "title", "severity", "precedence", "remediation_available", "title:asc", "title:desc", "severity:asc", "severity:desc", "precedence:asc", "precedence:desc", "remediation_available:asc", "remediation_available:desc" ] } } }, { "name": "filter", "in": "query", "required": false, "description": "Query string to filter items by their attributes. Compliant with scoped_search query language. However, only `=` or `!=` (resp. `<>`) operators are supported.

Rules are searchable using attributes `title`, `severity`, `remediation_available`, `rule_group_id`, and `identifier_label`

(e.g.: `(field_1=something AND field_2!=\"something else\") OR field_3>40`)", "schema": { "type": "string" } }, { "name": "security_guide_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "Content" ], "description": "Retrieve a list of rules for a specific security guide.", "operationId": "Rules", "responses": { "200": { "description": "Lists Rules", "content": { "application/vnd.api+json": { "examples": { "List of Rules": { "value": { "data": [ { "id": "0f594191-2a4d-4182-9161-6a32da5ec671", "ref_id": "xccdf_org.ssgproject.content_rule_77e784fe5eeaf841e4135eb2e3417e15", "title": "Laudantium et fugiat porro.", "rationale": "Tenetur est exercitationem. Placeat odit dolorum. Nihil iure beatae.", "description": "Repellat repudiandae esse. Ea molestias laborum. Quia voluptatem natus.", "severity": "medium", "precedence": 2383, "identifier": { "href": "http://dooley.example/anya", "label": "Aegnor" }, "references": [ { "href": "http://rogahn.test/german", "label": "Melilot Brandybuck" }, { "href": "http://schinner-bosco.example/robert.bode", "label": "Porto Baggins" }, { "href": "http://sawayn.test/pablo", "label": "Forlong" }, { "href": "http://rutherford.example/precious.mertz", "label": "Arciryas" }, { "href": "http://crona.example/olympia.moore", "label": "Harry Goatleaf" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "7e341987-472e-48e5-8324-f4dd71247df3", "type": "rule" }, { "id": "0fb72b33-0be8-4f99-9974-daf6b3db1feb", "ref_id": "xccdf_org.ssgproject.content_rule_54b0c7a9a64dbc1c6ce15e55b08f21b0", "title": "Sint aperiam rerum accusantium.", "rationale": "Doloribus sint aliquam. Nisi repellendus et. Ut aut vel.", "description": "Quisquam quos voluptatibus. Tempore magni explicabo. Ut nihil ratione.", "severity": "high", "precedence": 4728, "identifier": { "href": "http://corwin.example/britney", "label": "Belba Baggins" }, "references": [ { "href": "http://bartoletti.example/milagro.little", "label": "Pippin Gardner" }, { "href": "http://lehner.test/palmer", "label": "Galadriel" }, { "href": "http://weissnat.test/flor", "label": "Eärendil" }, { "href": "http://terry.test/eldridge_feil", "label": "Thingol" }, { "href": "http://howell-pacocha.example/ian", "label": "Flambard Took" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "ccb369c3-cb51-41fb-9aaf-bc32fd2e674c", "type": "rule" }, { "id": "121aac58-7883-4300-8180-bf36f52fd713", "ref_id": "xccdf_org.ssgproject.content_rule_91561af457f05d0cfbf8a661b6573380", "title": "Reprehenderit quo qui id.", "rationale": "Incidunt provident dignissimos. Voluptate dolores vel. Qui ut enim.", "description": "Laborum assumenda rerum. Sunt nihil debitis. Et consectetur inventore.", "severity": "high", "precedence": 7837, "identifier": { "href": "http://kuhic.example/sonya.balistreri", "label": "Moro Burrows" }, "references": [ { "href": "http://towne.test/bryant", "label": "Enthor" }, { "href": "http://braun.test/robert", "label": "Celeborn" }, { "href": "http://denesik-harvey.test/deadra", "label": "Tar-Telperiën" }, { "href": "http://skiles.example/temple", "label": "Elulindo" }, { "href": "http://boyle.example/reginald_pollich", "label": "Gimilkhâd" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "8f154819-7926-4a62-87e8-f62801abdb1e", "type": "rule" }, { "id": "16eb946f-e03e-4781-8e01-b21ea8c99246", "ref_id": "xccdf_org.ssgproject.content_rule_c317c0653109e7394532039a18f0d8d9", "title": "Consequatur error reprehenderit est.", "rationale": "Id mollitia non. Vero vel eos. Ab veritatis pariatur.", "description": "Culpa officia perspiciatis. Voluptas officiis animi. In molestiae sed.", "severity": "high", "precedence": 5434, "identifier": { "href": "http://haag-zboncak.test/renaldo.green", "label": "Artamir" }, "references": [ { "href": "http://okuneva.test/patsy_ebert", "label": "Grór" }, { "href": "http://hettinger.example/anja", "label": "Ingwion" }, { "href": "http://lubowitz-murray.test/carroll.durgan", "label": "Dodinas Brandybuck" }, { "href": "http://mcglynn.test/carylon", "label": "Angbor" }, { "href": "http://hyatt.example/harriett", "label": "Celebrindor" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "ebff8222-a4d6-49df-9982-e89221366cf4", "type": "rule" }, { "id": "1a70ba2e-08c6-4f55-b957-e17723f3dcee", "ref_id": "xccdf_org.ssgproject.content_rule_fb44866bf2f7198b649d31c5858375bd", "title": "Rem enim soluta ut.", "rationale": "Consequatur similique iusto. Eius veritatis reprehenderit. Aut temporibus quo.", "description": "Ut molestiae dolor. Sequi molestias rerum. Illum eos sunt.", "severity": "low", "precedence": 265, "identifier": { "href": "http://barton.test/junie", "label": "Derufin" }, "references": [ { "href": "http://krajcik.example/buford", "label": "Ragnor" }, { "href": "http://kunze.example/brandon", "label": "Elatan" }, { "href": "http://reichert-crona.test/tristan", "label": "Narmacil" }, { "href": "http://wintheiser.example/deidra.yundt", "label": "Azog" }, { "href": "http://kreiger.test/nga", "label": "Turambar" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "441975e1-a368-4a79-90f7-0d85b7f41b9d", "type": "rule" }, { "id": "1ffb0d27-bd0c-4db3-8a47-2b1d869a63b6", "ref_id": "xccdf_org.ssgproject.content_rule_abd89ef9c64c85dba16359191eca1287", "title": "Nostrum est repellendus culpa.", "rationale": "Est itaque quis. Sunt porro et. Perferendis non sed.", "description": "Tempore nesciunt neque. Maiores deleniti dolor. Expedita reiciendis magnam.", "severity": "high", "precedence": 3156, "identifier": { "href": "http://christiansen.test/joella", "label": "Amrod" }, "references": [ { "href": "http://goyette-bins.example/mikel", "label": "Rudolph Bolger" }, { "href": "http://nicolas-hamill.example/dallas", "label": "Filibert Bolger" }, { "href": "http://barrows.test/fabiola", "label": "Everard Took" }, { "href": "http://durgan.test/rich_gislason", "label": "Zamîn" }, { "href": "http://schiller.test/wendie", "label": "Borlach" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "2e3962de-f46f-4b81-9671-41eb98c757e4", "type": "rule" }, { "id": "20eca01a-5c6c-4c61-a249-b7a097fa7e06", "ref_id": "xccdf_org.ssgproject.content_rule_683919dbee2cb9a7de79ae2cfb9bdb27", "title": "Laborum sit magni nobis.", "rationale": "Veniam debitis sequi. Necessitatibus quos libero. Asperiores ipsum fugiat.", "description": "Inventore exercitationem enim. Nostrum voluptas praesentium. Et eos porro.", "severity": "low", "precedence": 7958, "identifier": { "href": "http://medhurst.test/grant.larkin", "label": "Rose Cotton" }, "references": [ { "href": "http://sanford-dooley.example/cortez", "label": "Narvi" }, { "href": "http://hodkiewicz.example/mui.romaguera", "label": "Herugar Bolger" }, { "href": "http://connelly-dibbert.example/collin_hirthe", "label": "Finarfin" }, { "href": "http://runolfsson.example/tracy", "label": "Morwen" }, { "href": "http://langworth.example/aaron_bogan", "label": "Gundolpho Bolger" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "625b5d78-143c-4f90-8f09-f065b257055f", "type": "rule" }, { "id": "26badbdc-445a-4c11-b349-2dd3cce5e313", "ref_id": "xccdf_org.ssgproject.content_rule_24cce816ae0b4c7247014ea4c726f8b2", "title": "Laudantium accusantium officiis voluptas.", "rationale": "Doloribus provident distinctio. Itaque quo minus. Dicta et hic.", "description": "Assumenda amet dolores. Aperiam et maiores. Et soluta enim.", "severity": "low", "precedence": 4344, "identifier": { "href": "http://ohara.example/violette", "label": "Vardilmë" }, "references": [ { "href": "http://smith.test/rogelio_quitzon", "label": "Thorin" }, { "href": "http://kuhn-mcdermott.example/mitsue", "label": "Valacar" }, { "href": "http://breitenberg.test/donna_oconner", "label": "Esmeralda Took" }, { "href": "http://howell-hand.example/rhett.ebert", "label": "Dáin" }, { "href": "http://jakubowski.example/eddy_jacobson", "label": "Dáin" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "27ef4695-fdf6-4952-9b03-fcdc4a5bdf1f", "type": "rule" }, { "id": "2b45aad5-d65a-45b8-8cf5-b787808cd169", "ref_id": "xccdf_org.ssgproject.content_rule_0d4e71a56018191332c50336e1e3ba1f", "title": "Voluptates tempora atque et.", "rationale": "Illum et magnam. Sit autem accusantium. Id necessitatibus nisi.", "description": "Atque sunt id. Cum velit quia. Dolorum dolores perferendis.", "severity": "high", "precedence": 6975, "identifier": { "href": "http://waelchi.test/noel", "label": "Lugdush" }, "references": [ { "href": "http://mcglynn.example/domingo.champlin", "label": "Pervinca Took" }, { "href": "http://kiehn.example/quentin_marvin", "label": "Rían" }, { "href": "http://macejkovic.test/laverna_kunde", "label": "Snaga" }, { "href": "http://will-streich.example/olen", "label": "Farmer Cotton" }, { "href": "http://hermiston-cronin.example/angle_kovacek", "label": "Gildor" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "6808fac0-0cb0-4075-ae08-cf5486bb610e", "type": "rule" }, { "id": "2bb8d86e-1a8e-443f-ae3a-80a560d05b04", "ref_id": "xccdf_org.ssgproject.content_rule_a0da6cd394511b1d6786101d1473644c", "title": "Provident est quasi minima.", "rationale": "Doloremque amet enim. Perspiciatis ut et. Optio eos perferendis.", "description": "Aspernatur dignissimos eaque. Consequuntur numquam voluptas. Earum accusantium modi.", "severity": "high", "precedence": 8325, "identifier": { "href": "http://senger.test/adolfo", "label": "Malantur" }, "references": [ { "href": "http://miller.example/demetria", "label": "Galathil" }, { "href": "http://kutch.test/barry.carroll", "label": "Telemnar" }, { "href": "http://schamberger.test/janna_douglas", "label": "Arveleg" }, { "href": "http://weber.test/bret.swaniawski", "label": "Indis" }, { "href": "http://lemke-padberg.test/jena.keeling", "label": "Bert" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "aa2a22c9-9865-42ac-860a-63c97ef3f49f", "type": "rule" } ], "meta": { "total": 25, "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/security_guides/ba572580-12e4-4e71-a6a2-78f5437e2461/rules?limit=10&offset=0", "last": "/api/compliance/v2/security_guides/ba572580-12e4-4e71-a6a2-78f5437e2461/rules?limit=10&offset=20", "next": "/api/compliance/v2/security_guides/ba572580-12e4-4e71-a6a2-78f5437e2461/rules?limit=10&offset=10" } }, "summary": "", "description": "" }, "List of Rules sorted by \"precedence:asc\"": { "value": { "data": [ { "id": "3a04b010-0319-4f9c-bba6-432dd85dc774", "ref_id": "xccdf_org.ssgproject.content_rule_36fc51dfb2caafdb0996a21e2d953791", "title": "Quos voluptatem minus inventore.", "rationale": "Sit rerum et. Consectetur eos ratione. Ab repellat atque.", "description": "Quisquam omnis est. Ut neque libero. Est vero et.", "severity": "medium", "precedence": 939, "identifier": { "href": "http://windler.example/arcelia.crona", "label": "Paladin Took" }, "references": [ { "href": "http://price-grant.example/buster.boyle", "label": "Turgon" }, { "href": "http://feest.test/freddy_rice", "label": "Halmir" }, { "href": "http://robel-kulas.example/chris", "label": "Nurwë" }, { "href": "http://hand-mayer.test/cameron", "label": "Fréaláf" }, { "href": "http://schinner.test/hai", "label": "Eldacar" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "c3e37b2b-5ad8-4208-a0f8-d7027eb0f561", "type": "rule" }, { "id": "827df72e-3195-4f01-aa06-bcb351f72c30", "ref_id": "xccdf_org.ssgproject.content_rule_fceeb9fa9dc8b88500b75fa59a4470db", "title": "Debitis illo eveniet sed.", "rationale": "Earum est recusandae. Facilis fuga quia. Repellat consectetur minima.", "description": "Omnis numquam totam. Quia nihil accusantium. Pariatur qui vel.", "severity": "high", "precedence": 1648, "identifier": { "href": "http://sawayn-moore.test/billy.tromp", "label": "Silmariën" }, "references": [ { "href": "http://okuneva-murphy.example/florida", "label": "Briffo Boffin" }, { "href": "http://pfeffer-treutel.example/eric", "label": "Cemendur" }, { "href": "http://zulauf.example/india_schaden", "label": "Erendis" }, { "href": "http://hartmann.example/rod_lebsack", "label": "Everard Took" }, { "href": "http://kuhic-gusikowski.test/kimberlie", "label": "Arantar" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "d0b1f2d1-3373-405b-b43a-49a5810ed381", "type": "rule" }, { "id": "c72134ab-299d-467a-97b5-7a5b7bdc1a4c", "ref_id": "xccdf_org.ssgproject.content_rule_470f16c053372a76733aa4a0d07413d4", "title": "Et nemo quam iusto.", "rationale": "Et sint nam. Enim nisi qui. Quo odio et.", "description": "Quia accusamus voluptatum. Alias laboriosam aut. Ea numquam aut.", "severity": "low", "precedence": 1900, "identifier": { "href": "http://abernathy.example/bonny", "label": "Elenwë" }, "references": [ { "href": "http://weber.test/markus_mcdermott", "label": "Tar-Súrion" }, { "href": "http://langworth.example/ken", "label": "Balin" }, { "href": "http://collins.example/leif", "label": "Lindissë" }, { "href": "http://conroy.test/lauran.schowalter", "label": "Gundolpho Bolger" }, { "href": "http://legros-hammes.test/marlin", "label": "Beleg" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "3cded316-0b84-4511-8905-3b3c31e141cd", "type": "rule" }, { "id": "e03012ec-c8d8-4856-b07a-a95039f61f20", "ref_id": "xccdf_org.ssgproject.content_rule_7a204df62cf8335ecd695a296526b715", "title": "Porro dolorem odit aut.", "rationale": "Aliquam est in. Vel ut aspernatur. Et tempora ut.", "description": "Earum mollitia ducimus. Vel cum ea. Dolorem optio voluptate.", "severity": "high", "precedence": 2199, "identifier": { "href": "http://smitham.example/laurence_witting", "label": "Indor" }, "references": [ { "href": "http://gibson.example/nickolas_hudson", "label": "Nazgûl" }, { "href": "http://jast.example/kasi.blick", "label": "Thrór" }, { "href": "http://bayer.test/keitha_beatty", "label": "Gandalf" }, { "href": "http://shanahan.example/arlen", "label": "Arthad" }, { "href": "http://zemlak-konopelski.test/lemuel.treutel", "label": "Hildifons Took" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "5489f290-370c-4362-8096-fe9120f34930", "type": "rule" }, { "id": "e27ddb44-7631-4950-89ca-091e1084a9c6", "ref_id": "xccdf_org.ssgproject.content_rule_d24d456d3c30ee2e8df9486d3e596e46", "title": "Beatae debitis consequuntur saepe.", "rationale": "Consequatur dignissimos voluptas. Necessitatibus et est. Quod distinctio labore.", "description": "Enim inventore autem. Dolores aut vel. Et reiciendis quisquam.", "severity": "high", "precedence": 2819, "identifier": { "href": "http://hyatt.test/chung", "label": "Gorbadoc Brandybuck" }, "references": [ { "href": "http://collier.example/monnie.bernhard", "label": "Ornil" }, { "href": "http://ziemann.test/preston", "label": "Lily Baggins" }, { "href": "http://goyette-stracke.test/hazel", "label": "Lofar" }, { "href": "http://nicolas-deckow.example/mohammad", "label": "Ragnir" }, { "href": "http://wolff.test/lincoln", "label": "Elendur" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "d7227be3-3af7-4649-81bb-9eca9208e212", "type": "rule" }, { "id": "3c617aa1-f21c-42ff-b21d-2262fcad5200", "ref_id": "xccdf_org.ssgproject.content_rule_c138473d2e4c0af6353b564b19f6a90e", "title": "Iste voluptas quis unde.", "rationale": "Aut harum illo. Atque recusandae voluptates. Quae quidem consequatur.", "description": "Nulla explicabo et. Voluptate molestias qui. Repudiandae dolorum vitae.", "severity": "high", "precedence": 3250, "identifier": { "href": "http://rogahn.example/noel", "label": "Bilbo Baggins" }, "references": [ { "href": "http://keeling.example/margurite", "label": "Ori" }, { "href": "http://bogisich.example/federico", "label": "Angrod" }, { "href": "http://corwin.example/britt", "label": "Orchaldor" }, { "href": "http://runte.test/clyde", "label": "Wídfara" }, { "href": "http://wilkinson-wilkinson.example/carey.kozey", "label": "Oromendil" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "25b2c047-f68a-4dfa-a940-2662db77e19e", "type": "rule" }, { "id": "472c5d2a-d691-4f35-976b-2f37a2799a29", "ref_id": "xccdf_org.ssgproject.content_rule_c103ef19c90aeae83f6ad97de28cef00", "title": "Totam ex ut est.", "rationale": "Impedit dolorum qui. Rerum perferendis quidem. Laudantium velit iure.", "description": "Atque deserunt voluptas. Necessitatibus sunt non. Aperiam odit tenetur.", "severity": "medium", "precedence": 3446, "identifier": { "href": "http://pouros.example/ivana", "label": "Ponto Baggins" }, "references": [ { "href": "http://runte.test/les", "label": "Éothéod" }, { "href": "http://sanford.test/talia_block", "label": "Muzgash" }, { "href": "http://reichert.example/cameron_larson", "label": "Brodda" }, { "href": "http://runte.test/hubert", "label": "Wídfara" }, { "href": "http://bruen.test/perry", "label": "Argeleb" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "fea7c0a1-8813-467e-aad8-e2d9344ec607", "type": "rule" }, { "id": "20d68221-3665-43fb-8f6c-d8cfa0ca72c8", "ref_id": "xccdf_org.ssgproject.content_rule_ff1a9417b6425bdcaa8e10fd4753a27d", "title": "Doloremque pariatur id libero.", "rationale": "Excepturi recusandae molestiae. Dolor rerum pariatur. Numquam et dolores.", "description": "Numquam aspernatur eos. Quisquam labore non. Tempore necessitatibus aspernatur.", "severity": "medium", "precedence": 3588, "identifier": { "href": "http://klocko.test/nia", "label": "Tar-Anducal" }, "references": [ { "href": "http://ratke.test/marianne", "label": "Nerdanel" }, { "href": "http://schmeler-lehner.example/paulina", "label": "Erling" }, { "href": "http://mccullough.example/america", "label": "Frór" }, { "href": "http://hintz.example/lemuel_lueilwitz", "label": "Adelard Took" }, { "href": "http://graham-predovic.example/colby", "label": "Mallor" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "359ebdbc-7368-427d-91cd-b15ae1aaff6f", "type": "rule" }, { "id": "b89145c9-c0dd-45d0-81fb-cc841d01d2f6", "ref_id": "xccdf_org.ssgproject.content_rule_6ef34b63c5130fe4720a0222ec23d359", "title": "Ab voluptate neque delectus.", "rationale": "Animi placeat dolor. Sit numquam consequatur. Quibusdam nulla pariatur.", "description": "Ipsum ab nemo. Consequuntur quia iusto. Sapiente culpa molestias.", "severity": "medium", "precedence": 4663, "identifier": { "href": "http://spinka.test/numbers_predovic", "label": "Harding of the Hill" }, "references": [ { "href": "http://walsh.test/tana.stracke", "label": "Hugo Boffin" }, { "href": "http://emard.test/asuncion.schuster", "label": "Elendil" }, { "href": "http://franecki.test/dori.wolf", "label": "Bosco Boffin" }, { "href": "http://purdy-ward.test/angella.dooley", "label": "Minastan" }, { "href": "http://schultz.test/irving", "label": "Aravir" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "329996b6-3706-4af7-aa88-521d9baea1d0", "type": "rule" }, { "id": "f5f484e1-aacf-40a1-a041-64ee0a129e7c", "ref_id": "xccdf_org.ssgproject.content_rule_5581387db090e88a2826c7ac03bc2d2d", "title": "Dolor voluptatem perspiciatis saepe.", "rationale": "Provident culpa saepe. Labore veniam temporibus. Ducimus ipsam illum.", "description": "Illo rerum mollitia. Ut tempore ad. Labore nemo nihil.", "severity": "low", "precedence": 5462, "identifier": { "href": "http://goodwin.test/vertie", "label": "Buldar" }, "references": [ { "href": "http://bruen-jakubowski.example/clayton_erdman", "label": "Mardil" }, { "href": "http://purdy.test/gwendolyn_wisoky", "label": "Adaldrida Bolger" }, { "href": "http://oberbrunner-osinski.example/jae", "label": "Tar-Aldarion" }, { "href": "http://pollich-vonrueden.example/aron_johnston", "label": "Elurín" }, { "href": "http://deckow-harber.example/beatrice", "label": "Gorlim" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "4fb6ebc7-2cd6-4217-8270-d8cdc4d7dffd", "type": "rule" } ], "meta": { "total": 25, "limit": 10, "offset": 0, "sort_by": "precedence" }, "links": { "first": "/api/compliance/v2/security_guides/2d669dd2-c05c-400c-a1a6-1cd11fafc2c3/rules?limit=10&offset=0&sort_by=precedence", "last": "/api/compliance/v2/security_guides/2d669dd2-c05c-400c-a1a6-1cd11fafc2c3/rules?limit=10&offset=20&sort_by=precedence", "next": "/api/compliance/v2/security_guides/2d669dd2-c05c-400c-a1a6-1cd11fafc2c3/rules?limit=10&offset=10&sort_by=precedence" } }, "summary": "", "description": "" } }, "schema": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/metadata" }, "links": { "$ref": "#/components/schemas/links" }, "data": { "type": "array", "items": { "properties": { "schema": { "$ref": "#/components/schemas/rule" } } } } } } } } }, "422": { "description": "Returns with Unprocessable Content", "content": { "application/vnd.api+json": { "examples": { "Description of an error when sorting by incorrect parameter": { "value": { "errors": [ "Result cannot be sorted by the 'description' column." ] }, "summary": "", "description": "" }, "Description of an error when requesting higher limit than supported": { "value": { "errors": [ "Invalid parameter: limit must be less than or equal to 100" ] }, "summary": "", "description": "" } }, "schema": { "$ref": "#/components/schemas/errors" } } } } } } }, "/security_guides/{security_guide_id}/rules/{rule_id}": { "get": { "summary": "Request a Rule", "parameters": [ { "name": "X-RH-IDENTITY", "in": "header", "schema": { "type": "string" }, "description": "For internal use only" }, { "name": "security_guide_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "rule_id", "in": "path", "required": true, "description": "UUID or a ref_id with '.' characters replaced with '-'", "schema": { "type": "string" } } ], "tags": [ "Content" ], "description": "Retrieve a specific rule from a specific security guide.", "operationId": "Rule", "responses": { "200": { "description": "Returns a Rule", "content": { "application/vnd.api+json": { "examples": { "Returns a Rule": { "value": { "data": { "id": "3e2d317e-f211-4d6b-9422-8e19f2f0cf28", "ref_id": "xccdf_org.ssgproject.content_rule_4426d0afcd93bed2c308436fa65492d2", "title": "Consectetur id aut dolores.", "rationale": "Recusandae reiciendis quasi. Quo nobis repellendus. Aut ex blanditiis.", "description": "Corrupti ut ratione. Consequatur pariatur iste. Debitis consequatur dolores.", "severity": "high", "precedence": 5098, "identifier": { "href": "http://legros.test/nathanial_abernathy", "label": "Nolondil" }, "references": [ { "href": "http://reinger-reichert.example/santos", "label": "Halfred of Overhill" }, { "href": "http://haley.test/rico", "label": "Elendur" }, { "href": "http://dibbert.example/clarence", "label": "Tar-Telemmaitë" }, { "href": "http://frami-lowe.example/german.watsica", "label": "Hundar" }, { "href": "http://kerluke.test/rodolfo", "label": "Hirgon" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "1644ee2a-3d67-4851-8fa3-ad37248232e3", "type": "rule" } }, "summary": "", "description": "" } }, "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/rule" } } } } } } } }, "404": { "description": "Returns with Not Found", "content": { "application/vnd.api+json": { "examples": { "Description of an error when requesting a non-existing Rule": { "value": { "errors": [ "V2::Rule not found with ID ebd3920a-11bb-4fda-be73-9e5af6a8c97f" ] }, "summary": "", "description": "" } }, "schema": { "$ref": "#/components/schemas/errors" } } } } } } }, "/security_guides/{security_guide_id}/profiles/{profile_id}/rules": { "get": { "summary": "Request Rules assigned to a Profile", "parameters": [ { "name": "X-RH-IDENTITY", "in": "header", "schema": { "type": "string" }, "description": "For internal use only" }, { "name": "limit", "in": "query", "required": false, "description": "Number of items to return per page", "schema": { "type": "number", "maximum": 100, "minimum": 1, "default": 10 } }, { "name": "offset", "in": "query", "required": false, "description": "Offset of first item of paginated response", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "ids_only", "in": "query", "required": false, "description": "Indicates whether to return only resource IDs.", "schema": { "type": "boolean" } }, { "name": "sort_by", "in": "query", "required": false, "description": "Attribute and direction to sort the items by. Represented by an array of fields with an optional direction (`:asc` or `:desc`).

If no direction is selected, `:asc` is used by default.", "schema": { "type": "array", "items": { "enum": [ "title", "severity", "precedence", "remediation_available", "title:asc", "title:desc", "severity:asc", "severity:desc", "precedence:asc", "precedence:desc", "remediation_available:asc", "remediation_available:desc" ] } } }, { "name": "filter", "in": "query", "required": false, "description": "Query string to filter items by their attributes. Compliant with scoped_search query language. However, only `=` or `!=` (resp. `<>`) operators are supported.

Rules are searchable using attributes `title`, `severity`, `remediation_available`, `rule_group_id`, and `identifier_label`

(e.g.: `(field_1=something AND field_2!=\"something else\") OR field_3>40`)", "schema": { "type": "string" } }, { "name": "security_guide_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "profile_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "Content" ], "description": "Retrieve a list of all security guide rules for a specific profile.", "operationId": "ProfileRules", "responses": { "200": { "description": "Lists Rules assigned to a Profile", "content": { "application/vnd.api+json": { "examples": { "List of Rules": { "value": { "data": [ { "id": "0b93aa45-2704-4c16-9927-0bc58eb82b05", "ref_id": "xccdf_org.ssgproject.content_rule_a838c0a24d8d3f8f25580846b2698ab6", "title": "Quod voluptatibus id error.", "rationale": "Eum non quis. Provident quod repellendus. Quod iure et.", "description": "Ex et molestiae. Perferendis ut enim. Placeat fugit praesentium.", "severity": "low", "precedence": 8618, "identifier": { "href": "http://green-nicolas.example/darin", "label": "Finduilas" }, "references": [ { "href": "http://thiel-mohr.example/randy.feest", "label": "Bandobras Took" }, { "href": "http://miller-miller.example/lorri", "label": "Marach" }, { "href": "http://lemke.test/lashonda_okuneva", "label": "Estella Bolger" }, { "href": "http://dooley.example/ismael", "label": "Glorfindel" }, { "href": "http://cormier.test/alberto_little", "label": "Shagram" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "b26d70af-ee9d-443d-b586-db4d547798ed", "type": "rule", "remediation_issue_id": null }, { "id": "28c16706-678c-42e3-9785-1ec2ee3ec7ed", "ref_id": "xccdf_org.ssgproject.content_rule_9d272f2be0263c35fc23867b5746a0e6", "title": "Ut magni quam a.", "rationale": "Enim dolore recusandae. Est non beatae. Dolore nobis fugiat.", "description": "Porro ea et. Culpa optio blanditiis. Non quasi eaque.", "severity": "medium", "precedence": 4364, "identifier": { "href": "http://williamson.example/jarrett_mohr", "label": "Herugar Bolger" }, "references": [ { "href": "http://rodriguez-herzog.test/mila", "label": "Hatholdir" }, { "href": "http://lockman.test/wilbert.roob", "label": "Herion" }, { "href": "http://turcotte-daugherty.test/arron", "label": "Primula Brandybuck" }, { "href": "http://oberbrunner.test/angla", "label": "Hareth" }, { "href": "http://torp.example/vernon", "label": "Gerontius Took" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "22137e4d-3762-415c-8e81-b40793afb9e0", "type": "rule", "remediation_issue_id": null }, { "id": "2cf2ef0f-3994-4de9-8108-7a0aa39c9c4a", "ref_id": "xccdf_org.ssgproject.content_rule_f0508545907b9d19e17a347e67f5e176", "title": "Exercitationem dignissimos in cumque.", "rationale": "Enim occaecati aut. Eaque aut dolorum. Dolor eaque suscipit.", "description": "Nostrum ut enim. Laboriosam fuga libero. Veniam consequatur pariatur.", "severity": "medium", "precedence": 2553, "identifier": { "href": "http://nader-franecki.test/enriqueta", "label": "Elfhild" }, "references": [ { "href": "http://konopelski-bernier.test/darcie", "label": "Paladin Took" }, { "href": "http://upton-greenholt.test/anastacia_corkery", "label": "Fengel" }, { "href": "http://armstrong-murphy.example/madalene_lemke", "label": "Dinodas Brandybuck" }, { "href": "http://lubowitz.example/allyson", "label": "Marhwini" }, { "href": "http://rau-brakus.test/lyman.grant", "label": "Witch-king" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "1ca55a0e-0573-4992-a4a2-82bef9d6fac0", "type": "rule", "remediation_issue_id": null }, { "id": "3017f211-a825-4bc1-a367-c243f34f5bfa", "ref_id": "xccdf_org.ssgproject.content_rule_e8c832d7fdd925b371f57260db28ba06", "title": "Laudantium repellendus dolorum velit.", "rationale": "Necessitatibus deserunt nesciunt. Modi tempora at. Ut est quia.", "description": "Et consequatur sed. Aliquid provident sit. Et est et.", "severity": "high", "precedence": 1438, "identifier": { "href": "http://thiel.example/hildred", "label": "Ingwë" }, "references": [ { "href": "http://johnston-glover.test/austin", "label": "Éowyn" }, { "href": "http://hermann.example/terresa.bernhard", "label": "Brand" }, { "href": "http://lowe.test/corina", "label": "Aulendil" }, { "href": "http://howe-price.test/lu", "label": "Ciryatur" }, { "href": "http://volkman.test/latia", "label": "Mimosa Bunce" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "794241e7-dc65-43a2-9b24-cabcf664df89", "type": "rule", "remediation_issue_id": null }, { "id": "30dd81cb-8f4c-40dd-b3c9-298c1f24e788", "ref_id": "xccdf_org.ssgproject.content_rule_fab494b696289705355a8e83a98e2ddc", "title": "Sit atque dicta eum.", "rationale": "Iure adipisci natus. Voluptas quia dolor. Aperiam aut ducimus.", "description": "Quo soluta ut. Odit id dolorum. Dolores ad quas.", "severity": "medium", "precedence": 3518, "identifier": { "href": "http://kuhlman.test/ashton_jaskolski", "label": "Araphant" }, "references": [ { "href": "http://hirthe.example/thanh", "label": "Gimilkhâd" }, { "href": "http://stoltenberg.example/adaline_stehr", "label": "Bill Ferny" }, { "href": "http://huels.test/rosamaria_jacobson", "label": "Togo Goodbody" }, { "href": "http://reynolds.test/alfonso", "label": "Eärendur" }, { "href": "http://kerluke.test/mariano_osinski", "label": "Nar" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "6dc1b8ef-c9ce-4d84-9255-6cfb649d8050", "type": "rule", "remediation_issue_id": null }, { "id": "3535039b-8d34-4304-95a9-289ecfa5c076", "ref_id": "xccdf_org.ssgproject.content_rule_82244f458007642c267373fcc5349dc7", "title": "Minima ut aut neque.", "rationale": "Voluptatibus amet eum. Ab minus mollitia. Enim est sed.", "description": "A dolore ut. Itaque qui fugit. Ut aut voluptatem.", "severity": "medium", "precedence": 2661, "identifier": { "href": "http://mohr.test/norman.johns", "label": "Ragnir" }, "references": [ { "href": "http://effertz.test/donald", "label": "Iminyë" }, { "href": "http://bins-graham.example/gary_hahn", "label": "Herendil" }, { "href": "http://russel.test/scott_douglas", "label": "Linda Baggins" }, { "href": "http://jacobson.example/rufina.oberbrunner", "label": "Poldor" }, { "href": "http://mayert-bins.test/cleopatra.yundt", "label": "Ornendil" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "27c84a6b-207e-4bbd-9413-15ce8b800b08", "type": "rule", "remediation_issue_id": null }, { "id": "381635b8-743c-42d1-b73e-6218cb9d5819", "ref_id": "xccdf_org.ssgproject.content_rule_7a900437822e0a00bef52c4cb02c086a", "title": "Quod dolorem fugit rerum.", "rationale": "Eaque asperiores corporis. Aut magnam quasi. Aliquam culpa in.", "description": "Quia quae voluptatem. Ea est commodi. Tenetur totam harum.", "severity": "medium", "precedence": 7333, "identifier": { "href": "http://weber.example/clarice", "label": "Asgon" }, "references": [ { "href": "http://gibson-dicki.test/le.beier", "label": "Fastolph Bolger" }, { "href": "http://farrell.test/lincoln.marks", "label": "Dáin" }, { "href": "http://yost.test/wilford", "label": "Adamanta Chubb" }, { "href": "http://oberbrunner.example/lane.fahey", "label": "Vardilmë" }, { "href": "http://cole.example/marquerite.weissnat", "label": "Bereg" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "1d543312-4d20-47e0-9163-c666b918aecf", "type": "rule", "remediation_issue_id": null }, { "id": "474d9d00-8b32-46e0-bfed-735eade00fd5", "ref_id": "xccdf_org.ssgproject.content_rule_f81504b3057539696795920756ee662b", "title": "Ipsa beatae in sit.", "rationale": "Illum sed veniam. Laudantium non assumenda. Neque ab perspiciatis.", "description": "Aliquam possimus error. Soluta odio commodi. Est qui expedita.", "severity": "medium", "precedence": 6713, "identifier": { "href": "http://hermiston.test/amelia", "label": "Indis" }, "references": [ { "href": "http://weimann.example/loyce", "label": "Araglas" }, { "href": "http://huel.example/rhett.stiedemann", "label": "Hild" }, { "href": "http://abshire-heidenreich.example/shanice.morissette", "label": "Carc" }, { "href": "http://doyle-hilpert.test/tamara", "label": "Cemendur" }, { "href": "http://gleason.test/jack_donnelly", "label": "Griffo Boffin" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "2995b9c2-1015-43ea-ad39-0f5deed20b09", "type": "rule", "remediation_issue_id": null }, { "id": "6609ec3d-c08f-4d2a-a382-71060c607f89", "ref_id": "xccdf_org.ssgproject.content_rule_3878ddcc9e4d3cb926674b3254c231d0", "title": "Itaque magnam et consectetur.", "rationale": "Enim vitae alias. Sequi nihil praesentium. Eum porro illo.", "description": "Neque reiciendis quia. Deleniti delectus enim. Quaerat quidem corrupti.", "severity": "low", "precedence": 1227, "identifier": { "href": "http://shanahan.test/randal.bayer", "label": "Erien" }, "references": [ { "href": "http://schulist-hirthe.test/kennith", "label": "Ingwë" }, { "href": "http://mante.example/barabara", "label": "May Gamgee" }, { "href": "http://beahan-barton.example/gwyn", "label": "Helm" }, { "href": "http://zemlak.example/mckinley.schamberger", "label": "Tar-Palantir" }, { "href": "http://legros.example/malik_macejkovic", "label": "Malvegil" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "c4c746f2-ac61-4b91-9fc3-55127c9d470c", "type": "rule", "remediation_issue_id": null }, { "id": "6a25787b-1067-4e85-b50d-7ab3f230d2e0", "ref_id": "xccdf_org.ssgproject.content_rule_8dc80fd96cf95217c662bed388eed967", "title": "Omnis molestiae pariatur vero.", "rationale": "Expedita nam debitis. Tenetur nostrum veritatis. Nisi quis sint.", "description": "Odit alias voluptas. Voluptas beatae recusandae. Omnis porro architecto.", "severity": "low", "precedence": 4517, "identifier": { "href": "http://franecki.example/truman.dibbert", "label": "Pansy Baggins" }, "references": [ { "href": "http://walsh-lockman.example/elenor_lang", "label": "Erendis" }, { "href": "http://kassulke.example/charlyn_schinner", "label": "Gundor" }, { "href": "http://carroll-smith.example/lolita_keeling", "label": "Nienor" }, { "href": "http://johnson.example/lesha", "label": "Ulbar" }, { "href": "http://oconnell-spinka.example/anya_wehner", "label": "Boar of Everholt" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "c27efc00-bb01-4164-9750-edfe43e7ed2b", "type": "rule", "remediation_issue_id": null } ], "meta": { "total": 25, "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/security_guides/11994f4d-8b3b-4cd0-aa88-140a545f4dea/profiles/59ff2a1f-e8de-4638-a744-9543e13df777/rules?limit=10&offset=0", "last": "/api/compliance/v2/security_guides/11994f4d-8b3b-4cd0-aa88-140a545f4dea/profiles/59ff2a1f-e8de-4638-a744-9543e13df777/rules?limit=10&offset=20", "next": "/api/compliance/v2/security_guides/11994f4d-8b3b-4cd0-aa88-140a545f4dea/profiles/59ff2a1f-e8de-4638-a744-9543e13df777/rules?limit=10&offset=10" } }, "summary": "", "description": "" }, "List of Rules sorted by \"precedence:asc\"": { "value": { "data": [ { "id": "1b123cf2-e844-47ed-9bf3-f8d3672e7a01", "ref_id": "xccdf_org.ssgproject.content_rule_2528aef3862e96e6e52b4816b5f732e3", "title": "Assumenda aut eveniet quasi.", "rationale": "Provident saepe nostrum. Voluptate aut quia. Adipisci numquam nemo.", "description": "Explicabo quisquam eos. Recusandae voluptates voluptatum. Ut quibusdam aliquam.", "severity": "medium", "precedence": 489, "identifier": { "href": "http://auer.test/kecia_wuckert", "label": "Lily Baggins" }, "references": [ { "href": "http://ullrich.test/carter", "label": "Griffo Boffin" }, { "href": "http://wisozk.example/wilmer", "label": "Marmadoc Brandybuck" }, { "href": "http://schowalter-renner.example/mitsue", "label": "Araphant" }, { "href": "http://hoeger.test/zena", "label": "Tar-Míriel" }, { "href": "http://beahan.test/coralee", "label": "Gléowine" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "c71b6a57-821b-477d-8216-6c2d72234f75", "type": "rule", "remediation_issue_id": null }, { "id": "7ef57e12-9b4e-44e6-8aee-da2458952090", "ref_id": "xccdf_org.ssgproject.content_rule_70167a7d1579dd49480f0ff818e3ae12", "title": "Vel pariatur adipisci consequatur.", "rationale": "Et illo in. Officia asperiores ab. Dignissimos dolores aspernatur.", "description": "Ut ratione enim. Molestiae ut qui. Sint labore consequuntur.", "severity": "medium", "precedence": 806, "identifier": { "href": "http://schimmel-rempel.test/sherry", "label": "Marigold Gamgee" }, "references": [ { "href": "http://hilpert.test/justin", "label": "Narvi" }, { "href": "http://kub-hodkiewicz.test/donte.murray", "label": "Lothíriel" }, { "href": "http://mayer-hermann.example/leonard_bahringer", "label": "Thengel" }, { "href": "http://heathcote.example/idalia", "label": "Elendur" }, { "href": "http://gleichner.example/valeri_bartell", "label": "Minardil" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "fbb5a41c-94d8-4978-99a8-bbad0ed55c29", "type": "rule", "remediation_issue_id": null }, { "id": "095aad9d-c00f-4c88-9342-5ec2cfc64535", "ref_id": "xccdf_org.ssgproject.content_rule_5d109f70f97e1419a3d3bf980913e159", "title": "Magnam qui quia quidem.", "rationale": "Occaecati provident tempora. Vel et dolorum. Mollitia culpa rem.", "description": "Itaque consequatur nihil. Perferendis iure dolore. Id rerum perferendis.", "severity": "low", "precedence": 1580, "identifier": { "href": "http://leuschke.example/jacklyn.towne", "label": "Alphros" }, "references": [ { "href": "http://mayer-hilpert.example/leopoldo_crona", "label": "Írildë" }, { "href": "http://nolan-zemlak.test/jeanie.nicolas", "label": "Bolg" }, { "href": "http://hayes.test/lena", "label": "Dírhael" }, { "href": "http://kub-altenwerth.example/christoper_wolff", "label": "Gálmód" }, { "href": "http://walter-cronin.test/hiram", "label": "Mimosa Bunce" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "f8abb1c7-43a0-4053-a22d-08013de06df1", "type": "rule", "remediation_issue_id": null }, { "id": "4ec7a30f-c9e2-4bf0-aa52-8ca7a5cf39e1", "ref_id": "xccdf_org.ssgproject.content_rule_fed04d6d36679c4095f9a14caf66886f", "title": "Asperiores eaque est voluptates.", "rationale": "Ut et vitae. Consequuntur iure magni. Culpa quo vero.", "description": "Laudantium labore et. Cupiditate veniam asperiores. Eius accusantium beatae.", "severity": "medium", "precedence": 1910, "identifier": { "href": "http://hudson.test/charley_konopelski", "label": "Lofar" }, "references": [ { "href": "http://upton.example/samual_leannon", "label": "Hildibrand Took" }, { "href": "http://bayer.example/nicol.schmidt", "label": "Dís" }, { "href": "http://ohara-davis.example/irwin", "label": "Calimehtar" }, { "href": "http://bartoletti.test/buster.lemke", "label": "Togo Goodbody" }, { "href": "http://lind.test/amado_goyette", "label": "Radagast" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "a26b0417-fbbb-4c7f-b827-c5c24a4ed4d8", "type": "rule", "remediation_issue_id": null }, { "id": "3b7c8868-371f-40e7-a052-e923113d31c3", "ref_id": "xccdf_org.ssgproject.content_rule_beb59f7713bd6f6a89bbc83f196975e5", "title": "Quasi ducimus voluptatibus quisquam.", "rationale": "Cum dolores est. Iure blanditiis cupiditate. Eos non et.", "description": "Error cupiditate qui. Sit sequi ea. Deleniti doloremque architecto.", "severity": "medium", "precedence": 2093, "identifier": { "href": "http://padberg-cole.example/agustin.mccullough", "label": "Silmariën" }, "references": [ { "href": "http://heidenreich-graham.test/sydney", "label": "Elboron" }, { "href": "http://kunze-kerluke.test/louis_kovacek", "label": "Mouth of Sauron" }, { "href": "http://goodwin.test/deb", "label": "Polo Baggins" }, { "href": "http://jaskolski-hegmann.test/france_schmeler", "label": "King of the Dead" }, { "href": "http://purdy-nicolas.test/bernard_veum", "label": "Círdan" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "da1118b8-ad45-40bc-bc4a-df8a8178fa33", "type": "rule", "remediation_issue_id": null }, { "id": "41d6a1ca-0fcc-4bd0-a963-95abc47149b6", "ref_id": "xccdf_org.ssgproject.content_rule_22dd566b9418cab38e65d49aa208e775", "title": "Excepturi qui porro tempore.", "rationale": "Eos dolore ut. Quod molestiae veritatis. Excepturi est tempora.", "description": "Enim doloribus unde. Dolorem eligendi pariatur. Corrupti qui nihil.", "severity": "high", "precedence": 4081, "identifier": { "href": "http://ortiz.test/tad", "label": "Lenwë" }, "references": [ { "href": "http://kreiger-rice.example/marry_damore", "label": "Halbarad" }, { "href": "http://ullrich.test/rufus.corwin", "label": "Fíli" }, { "href": "http://oconner.example/lenard", "label": "Fimbrethil" }, { "href": "http://cole-littel.example/jefferey_cummerata", "label": "Boar of Everholt" }, { "href": "http://bergnaum.test/somer.vandervort", "label": "Sador" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "6e950eec-a8dc-4283-91ec-2986464381cc", "type": "rule", "remediation_issue_id": null }, { "id": "0232bf49-af98-4dba-97b9-b486db803274", "ref_id": "xccdf_org.ssgproject.content_rule_26e65d5a834a4b0d246906d82fd21df6", "title": "Perspiciatis nihil sint in.", "rationale": "Corrupti repellat dignissimos. Voluptate facilis sint. Inventore eius excepturi.", "description": "Deserunt doloremque nobis. Dolore iste recusandae. Temporibus illum placeat.", "severity": "high", "precedence": 4165, "identifier": { "href": "http://adams.test/tequila", "label": "Borthand" }, "references": [ { "href": "http://hermiston.example/tena_kessler", "label": "Bill Ferny" }, { "href": "http://hessel-kilback.example/ezequiel", "label": "Saeros" }, { "href": "http://carter.test/freda", "label": "Daisy Baggins" }, { "href": "http://wyman.example/wally_west", "label": "Chica Chubb" }, { "href": "http://jast-smith.example/emilio.spencer", "label": "Bëor" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "ca4eebbd-deea-4173-8db5-329e39b96082", "type": "rule", "remediation_issue_id": null }, { "id": "94495e4c-ca5a-4760-a7f3-2246b8f547d9", "ref_id": "xccdf_org.ssgproject.content_rule_18f5a1283e462e30757505120c8f87f4", "title": "Ratione dolorem id laborum.", "rationale": "Facere soluta sapiente. Et perferendis velit. Nulla sequi animi.", "description": "Debitis minus dolores. Qui aut quos. Quasi temporibus libero.", "severity": "low", "precedence": 4560, "identifier": { "href": "http://mclaughlin.example/nathaniel_casper", "label": "Idis" }, "references": [ { "href": "http://hagenes-dooley.test/simon_bernhard", "label": "Ancalagon" }, { "href": "http://runte-kuhic.example/bernardine", "label": "Ban" }, { "href": "http://mosciski.test/eugena", "label": "Lugdush" }, { "href": "http://ritchie.test/lon", "label": "Siriondil" }, { "href": "http://kutch.test/numbers", "label": "Almáriel" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "9a9773b3-1c94-4003-8826-1a49c1ec2fd4", "type": "rule", "remediation_issue_id": null }, { "id": "a382619b-89e0-42b0-b259-0ab930ada70b", "ref_id": "xccdf_org.ssgproject.content_rule_f0dc8abe8d6fd3c69921073c9fcf8e2a", "title": "Quia necessitatibus neque et.", "rationale": "Omnis fugit veritatis. Adipisci architecto iste. Sunt aperiam ex.", "description": "Laborum pariatur id. Beatae qui et. Numquam aut veniam.", "severity": "medium", "precedence": 4642, "identifier": { "href": "http://pfannerstill-heathcote.example/kory", "label": "Prisca Baggins" }, "references": [ { "href": "http://jacobi-howell.example/micheal", "label": "Wiseman Gamwich" }, { "href": "http://balistreri.test/gary_farrell", "label": "Moro Burrows" }, { "href": "http://heaney.example/santos", "label": "Rúmil" }, { "href": "http://wiegand-kovacek.example/marybelle_lind", "label": "Elfwine" }, { "href": "http://lesch.test/synthia", "label": "Gormadoc Brandybuck" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "d20b807b-c4c7-4495-9b42-082bc7940ca8", "type": "rule", "remediation_issue_id": null }, { "id": "6d1669dd-cc37-4e8d-9086-2db0a55b4ebf", "ref_id": "xccdf_org.ssgproject.content_rule_7eeb1338c18f7d143007486a229d6f5e", "title": "Necessitatibus beatae in dolores.", "rationale": "Laudantium placeat quasi. Provident quisquam officia. Consequatur non delectus.", "description": "Eum neque incidunt. Reprehenderit aut sequi. Ut temporibus eos.", "severity": "medium", "precedence": 5025, "identifier": { "href": "http://ohara-leannon.test/jovita", "label": "Argeleb" }, "references": [ { "href": "http://turner.test/rosamond_wintheiser", "label": "Nienor" }, { "href": "http://bartoletti.example/my.torp", "label": "Bain" }, { "href": "http://heaney.test/desmond_batz", "label": "Ivorwen" }, { "href": "http://kohler-vandervort.test/myrle", "label": "Tom Pickthorn" }, { "href": "http://weimann.test/jarred", "label": "Annael" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "74a9627c-2656-44c7-a938-76afc13d7c2f", "type": "rule", "remediation_issue_id": null } ], "meta": { "total": 25, "limit": 10, "offset": 0, "sort_by": "precedence" }, "links": { "first": "/api/compliance/v2/security_guides/f4d31abf-21a2-4a4b-9e9d-88497fe5a632/profiles/2ea9133a-8e68-4d1a-9303-3ebccd2b3491/rules?limit=10&offset=0&sort_by=precedence", "last": "/api/compliance/v2/security_guides/f4d31abf-21a2-4a4b-9e9d-88497fe5a632/profiles/2ea9133a-8e68-4d1a-9303-3ebccd2b3491/rules?limit=10&offset=20&sort_by=precedence", "next": "/api/compliance/v2/security_guides/f4d31abf-21a2-4a4b-9e9d-88497fe5a632/profiles/2ea9133a-8e68-4d1a-9303-3ebccd2b3491/rules?limit=10&offset=10&sort_by=precedence" } }, "summary": "", "description": "" } }, "schema": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/metadata" }, "links": { "$ref": "#/components/schemas/links" }, "data": { "type": "array", "items": { "properties": { "schema": { "$ref": "#/components/schemas/rule" } } } } } } } } }, "422": { "description": "Returns with Unprocessable Content", "content": { "application/vnd.api+json": { "examples": { "Description of an error when sorting by incorrect parameter": { "value": { "errors": [ "Result cannot be sorted by the 'description' column." ] }, "summary": "", "description": "" }, "Description of an error when requesting higher limit than supported": { "value": { "errors": [ "Invalid parameter: limit must be less than or equal to 100" ] }, "summary": "", "description": "" } }, "schema": { "$ref": "#/components/schemas/errors" } } } } } } }, "/security_guides/{security_guide_id}/profiles/{profile_id}/rules/{rule_id}": { "get": { "summary": "Request a Rule assigned to a Profile", "parameters": [ { "name": "X-RH-IDENTITY", "in": "header", "schema": { "type": "string" }, "description": "For internal use only" }, { "name": "security_guide_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "profile_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "rule_id", "in": "path", "required": true, "description": "UUID or a ref_id with '.' characters replaced with '-'", "schema": { "type": "string" } } ], "tags": [ "Content" ], "description": "Retrieve a specific security guide rule for a specific profile.", "operationId": "ProfileRule", "responses": { "200": { "description": "Returns a Rule assigned to a Profile", "content": { "application/vnd.api+json": { "examples": { "Returns a Rule": { "value": { "data": { "id": "cd76db34-697e-41ad-913f-97b4cab6a7d3", "ref_id": "xccdf_org.ssgproject.content_rule_2aa2e06651df554d9c5d4b38c1a44da4", "title": "Ullam est sint velit.", "rationale": "Est maiores nobis. Repellendus est et. Id necessitatibus accusantium.", "description": "Voluptas qui aspernatur. Et qui commodi. Animi facilis vel.", "severity": "high", "precedence": 6728, "identifier": { "href": "http://bins-hane.example/guadalupe", "label": "Baldor" }, "references": [ { "href": "http://durgan-hansen.example/vannessa", "label": "Pansy Baggins" }, { "href": "http://stark.example/wilhemina.pfannerstill", "label": "Khîm" }, { "href": "http://von-carter.test/arden.klein", "label": "Elrond" }, { "href": "http://anderson.example/moshe.connelly", "label": "Folca" }, { "href": "http://schmidt-ryan.example/normand.klein", "label": "Arwen" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "218bbf0b-596c-45c7-a0a5-12fa363cb662", "type": "rule", "remediation_issue_id": null } }, "summary": "", "description": "" } }, "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/rule" } } } } } } } }, "404": { "description": "Returns with Not Found", "content": { "application/vnd.api+json": { "examples": { "Description of an error when requesting a non-existing Rule": { "value": { "errors": [ "V2::Rule not found with ID 4db31492-ba17-4054-85b1-0644fe79a1d7" ] }, "summary": "", "description": "" } }, "schema": { "$ref": "#/components/schemas/errors" } } } } } } }, "/policies/{policy_id}/tailorings/{tailoring_id}/rules": { "get": { "summary": "Request Rules assigned to a Tailoring", "parameters": [ { "name": "X-RH-IDENTITY", "in": "header", "schema": { "type": "string" }, "description": "For internal use only" }, { "name": "limit", "in": "query", "required": false, "description": "Number of items to return per page", "schema": { "type": "number", "maximum": 100, "minimum": 1, "default": 10 } }, { "name": "offset", "in": "query", "required": false, "description": "Offset of first item of paginated response", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "ids_only", "in": "query", "required": false, "description": "Indicates whether to return only resource IDs.", "schema": { "type": "boolean" } }, { "name": "sort_by", "in": "query", "required": false, "description": "Attribute and direction to sort the items by. Represented by an array of fields with an optional direction (`:asc` or `:desc`).

If no direction is selected, `:asc` is used by default.", "schema": { "type": "array", "items": { "enum": [ "title", "severity", "precedence", "remediation_available", "title:asc", "title:desc", "severity:asc", "severity:desc", "precedence:asc", "precedence:desc", "remediation_available:asc", "remediation_available:desc" ] } } }, { "name": "filter", "in": "query", "required": false, "description": "Query string to filter items by their attributes. Compliant with scoped_search query language. However, only `=` or `!=` (resp. `<>`) operators are supported.

Rules are searchable using attributes `title`, `severity`, `remediation_available`, `rule_group_id`, and `identifier_label`

(e.g.: `(field_1=something AND field_2!=\"something else\") OR field_3>40`)", "schema": { "type": "string" } }, { "name": "policy_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tailoring_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "Policies" ], "description": "Retrieve a list of rules relating to specific tailorings.", "operationId": "TailoringRules", "responses": { "200": { "description": "Lists Rules assigned to a Tailoring", "content": { "application/vnd.api+json": { "examples": { "List of Rules": { "value": { "data": [ { "id": "11943b85-77dd-4710-98b8-87634764ce6f", "ref_id": "xccdf_org.ssgproject.content_rule_f93579045a1b8fce86982b49c9918b0e", "title": "Deleniti sint laboriosam eum.", "rationale": "Quasi dolorem rem. Deserunt qui ut. Iusto amet quod.", "description": "Rerum eligendi nulla. Et id molestiae. Est quia voluptatem.", "severity": "high", "precedence": 3197, "identifier": { "href": "http://pfannerstill.test/sang", "label": "Idril" }, "references": [ { "href": "http://zieme.example/robyn", "label": "Odo Proudfoot" }, { "href": "http://smitham.example/lawrence", "label": "Ingold" }, { "href": "http://abernathy.example/tasha.weber", "label": "Araglas" }, { "href": "http://runolfsson.example/waldo", "label": "Ivriniel" }, { "href": "http://bahringer-schroeder.example/kyong", "label": "Mauhúr" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "c43a4c77-3c81-479b-af10-83701655f438", "type": "rule" } ], "meta": { "total": 1, "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/policies/81656bde-c37a-47d4-9832-79c91ef830ef/tailorings/fd45fe6f-8c94-4bcf-81e3-5cd843996e84/rules?limit=10&offset=0", "last": "/api/compliance/v2/policies/81656bde-c37a-47d4-9832-79c91ef830ef/tailorings/fd45fe6f-8c94-4bcf-81e3-5cd843996e84/rules?limit=10&offset=0" } }, "summary": "", "description": "" }, "List of Rules sorted by \"precedence:asc\"": { "value": { "data": [ { "id": "a444dd0a-3b4e-4516-ba87-6d102127b3f0", "ref_id": "xccdf_org.ssgproject.content_rule_ab75fc195c35c89f3f15332e694a1351", "title": "Blanditiis sint consequatur ullam.", "rationale": "Laborum vitae quis. Voluptatibus sed totam. Animi eligendi qui.", "description": "Laborum repudiandae fugiat. Est sed tempore. Quaerat accusantium repudiandae.", "severity": "high", "precedence": 5666, "identifier": { "href": "http://parker.test/abel_wilderman", "label": "Milo Burrows" }, "references": [ { "href": "http://price.test/sung", "label": "Rowlie Appledore" }, { "href": "http://zemlak.example/stefani", "label": "Glóredhel" }, { "href": "http://marquardt-spencer.example/noel", "label": "Gilly Brownlock" }, { "href": "http://boyle.example/florencio", "label": "Gimilzagar" }, { "href": "http://jaskolski.example/stephane.windler", "label": "Indis" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "cc3bbd66-714b-483b-815e-d8356d9992ae", "type": "rule" } ], "meta": { "total": 1, "limit": 10, "offset": 0, "sort_by": "precedence" }, "links": { "first": "/api/compliance/v2/policies/1d4c19c0-1f6a-4806-a8e5-811e3c68fdf0/tailorings/cd4a7608-6c2d-4ce9-9624-be0db1034371/rules?limit=10&offset=0&sort_by=precedence", "last": "/api/compliance/v2/policies/1d4c19c0-1f6a-4806-a8e5-811e3c68fdf0/tailorings/cd4a7608-6c2d-4ce9-9624-be0db1034371/rules?limit=10&offset=0&sort_by=precedence" } }, "summary": "", "description": "" } }, "schema": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/metadata" }, "links": { "$ref": "#/components/schemas/links" }, "data": { "type": "array", "items": { "properties": { "schema": { "$ref": "#/components/schemas/rule" } } } } } } } } }, "422": { "description": "Returns with Unprocessable Content", "content": { "application/vnd.api+json": { "examples": { "Description of an error when sorting by incorrect parameter": { "value": { "errors": [ "Result cannot be sorted by the 'description' column." ] }, "summary": "", "description": "" }, "Description of an error when requesting higher limit than supported": { "value": { "errors": [ "Invalid parameter: limit must be less than or equal to 100" ] }, "summary": "", "description": "" } }, "schema": { "$ref": "#/components/schemas/errors" } } } } } }, "post": { "summary": "Bulk assign Rules to a Tailoring", "parameters": [ { "name": "X-RH-IDENTITY", "in": "header", "schema": { "type": "string" }, "description": "For internal use only" }, { "name": "policy_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tailoring_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "Policies" ], "description": "This feature is exclusively used by the frontend", "deprecated": true, "operationId": "AssignRules", "responses": { "202": { "description": "Assigns all specified rules and unassigns the rest", "content": { "application/vnd.api+json": { "examples": { "List of assigned Rules": { "value": { "data": [ { "id": "07c6e394-8942-46a9-9dbb-63daac5acded", "ref_id": "xccdf_org.ssgproject.content_rule_6b656f7725cdacbcc443810e208df064", "title": "Numquam error ipsum nesciunt.", "rationale": "Animi delectus nostrum. Hic voluptatem officia. Voluptatem id cupiditate.", "description": "Aspernatur placeat illo. Atque est laudantium. Sed ex nobis.", "severity": "medium", "precedence": 2523, "identifier": { "href": "http://gerlach.test/blake", "label": "Gilmith" }, "references": [ { "href": "http://rath.example/stepanie", "label": "Tar-Telperiën" }, { "href": "http://murray.test/elina_casper", "label": "Anairë" }, { "href": "http://spinka.example/genesis_watsica", "label": "Nellas" }, { "href": "http://hudson.example/troy", "label": "Hanna Goldworthy" }, { "href": "http://jacobson-mayert.example/dwayne", "label": "Horn" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "f9ec3ff1-8a57-4ca0-8254-fa50fde4eae3", "type": "rule" }, { "id": "11057a8c-aff4-4804-b1e4-3dd5c75c4dd5", "ref_id": "xccdf_org.ssgproject.content_rule_54e5bd607c47065cc3e4dc2778fb06b1", "title": "Repudiandae aperiam illo ut.", "rationale": "Qui commodi consequatur. Esse nesciunt fuga. Illo alias qui.", "description": "Consequatur soluta qui. Saepe ad culpa. Id voluptatem voluptate.", "severity": "medium", "precedence": 6225, "identifier": { "href": "http://kilback.test/alysia.olson", "label": "Forweg" }, "references": [ { "href": "http://cassin.example/barry", "label": "Longo Baggins" }, { "href": "http://lehner.example/donn", "label": "Fundin" }, { "href": "http://friesen.example/vikki_crooks", "label": "Aegnor" }, { "href": "http://lowe.example/robby_bruen", "label": "Dina Diggle" }, { "href": "http://witting.test/vikki", "label": "Carcharoth" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "6bd148c8-6610-4424-b26f-203f824542c4", "type": "rule" }, { "id": "2b4a9390-0b3f-4272-aaf5-13e805c916da", "ref_id": "xccdf_org.ssgproject.content_rule_013d9a9bad46a9c30573efee2f34d383", "title": "Voluptas nihil est quis.", "rationale": "Rerum voluptatem ullam. Voluptatum error consectetur. Et magni eligendi.", "description": "Unde voluptatem officia. Aliquam est nesciunt. Accusamus rerum nobis.", "severity": "high", "precedence": 3079, "identifier": { "href": "http://wuckert.test/colin_purdy", "label": "Haldan" }, "references": [ { "href": "http://weber-hackett.test/mckenzie_sporer", "label": "Ferumbras Took" }, { "href": "http://zboncak.example/sylvester", "label": "Lugdush" }, { "href": "http://bartoletti.example/dion_collins", "label": "Almáriel" }, { "href": "http://nitzsche-larkin.example/felton", "label": "Ailinel" }, { "href": "http://walsh.test/blanch_donnelly", "label": "Borlad" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "50b62a44-1408-439b-9f86-3eabecf27179", "type": "rule" }, { "id": "3b417db7-b98c-4510-9c58-95ed8b9896d1", "ref_id": "xccdf_org.ssgproject.content_rule_83efb829f3848e6162af6c3dca672d27", "title": "Nesciunt aut possimus ipsa.", "rationale": "Nemo harum et. Error facilis eos. Autem voluptas commodi.", "description": "A omnis incidunt. Perspiciatis culpa cumque. Rerum dolorum eius.", "severity": "high", "precedence": 6395, "identifier": { "href": "http://borer.example/hanna", "label": "Ornil" }, "references": [ { "href": "http://schumm.example/leontine_satterfield", "label": "Fortinbras Took" }, { "href": "http://reynolds.example/kaleigh", "label": "Hirluin" }, { "href": "http://hamill.test/shanae_langosh", "label": "Bruno Bracegirdle" }, { "href": "http://becker.example/colton.pollich", "label": "Adalgar Bolger" }, { "href": "http://cummerata.example/rosalyn", "label": "Fastolph Bolger" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "e19f8f83-2712-4619-813f-a7e45c772d39", "type": "rule" }, { "id": "422e6ba6-70e3-413f-9623-891f2697ba8b", "ref_id": "xccdf_org.ssgproject.content_rule_f01ae86c54adbfd32501602c58b696fb", "title": "Illo voluptatem et id.", "rationale": "Tempora nostrum earum. Fuga expedita vel. Et itaque nihil.", "description": "Numquam voluptatum eos. Rerum dolorem exercitationem. Culpa asperiores nisi.", "severity": "high", "precedence": 156, "identifier": { "href": "http://hirthe-corwin.example/leota.murazik", "label": "Gléowine" }, "references": [ { "href": "http://prohaska-mclaughlin.example/tera", "label": "Lorgan" }, { "href": "http://gutmann-wolff.example/ahmed", "label": "Ragnor" }, { "href": "http://kunze.test/freddy", "label": "Berúthiel" }, { "href": "http://blanda-zboncak.test/bella", "label": "Amandil" }, { "href": "http://tromp-robel.test/mabelle_abshire", "label": "Herugar Bolger" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "bf54d5e5-dfad-4f46-997f-b884c8d9fe32", "type": "rule" }, { "id": "42a6e577-66e0-4dc2-8d59-277fddd340f1", "ref_id": "xccdf_org.ssgproject.content_rule_ea149f858383bebbef203dedf5d36a48", "title": "Quia nostrum tempore aut.", "rationale": "Corporis sed accusantium. Aut temporibus qui. Dolor voluptates distinctio.", "description": "Necessitatibus corporis magni. Dicta optio doloribus. Sed fugit et.", "severity": "low", "precedence": 8194, "identifier": { "href": "http://bayer.example/concetta", "label": "Elphir" }, "references": [ { "href": "http://swaniawski-dicki.example/hyman.bruen", "label": "Tom Bombadil" }, { "href": "http://hartmann.example/johnny.hamill", "label": "Madoc Brandybuck" }, { "href": "http://torp.test/margret_pfeffer", "label": "Daisy Gamgee" }, { "href": "http://kiehn.example/ricky_nikolaus", "label": "Curufin" }, { "href": "http://lind.test/bess", "label": "Tar-Aldarion" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "78a650f2-4fc8-4509-8ca3-ad71905ea6b3", "type": "rule" }, { "id": "5284750e-3fff-4437-98db-39881c356ff0", "ref_id": "xccdf_org.ssgproject.content_rule_1e4eff23ab8e847286e77b287cf75e8e", "title": "Occaecati consequuntur inventore quia.", "rationale": "Quia voluptas suscipit. Temporibus voluptatem fuga. Non laudantium explicabo.", "description": "Neque a corporis. Dolor impedit tempora. Tempore in nihil.", "severity": "medium", "precedence": 1074, "identifier": { "href": "http://bartell-lynch.example/stanley.krajcik", "label": "Frár" }, "references": [ { "href": "http://kessler.example/kelvin_prohaska", "label": "Beechbone" }, { "href": "http://herzog-baumbach.test/leeanne", "label": "Tarannon Falastur" }, { "href": "http://zboncak.example/earnest_kuhic", "label": "Khamûl" }, { "href": "http://donnelly.example/robert", "label": "Bandobras Took" }, { "href": "http://ledner.example/donella", "label": "Elboron" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "8076563e-864f-443e-af83-ed2dab57119b", "type": "rule" }, { "id": "56013f73-a607-4add-a26c-599129f250c9", "ref_id": "xccdf_org.ssgproject.content_rule_725c0f4527ec89d6547279be0fc2400b", "title": "Voluptas eaque ea eum.", "rationale": "Aut quo magni. Voluptatem dolorem quos. Dolorum quia explicabo.", "description": "Cumque vero voluptas. Quo qui et. Non velit provident.", "severity": "low", "precedence": 4757, "identifier": { "href": "http://predovic.test/donte_stoltenberg", "label": "Narmacil" }, "references": [ { "href": "http://hodkiewicz-miller.example/bess_schuppe", "label": "Arahad" }, { "href": "http://strosin-kub.test/felecia_ritchie", "label": "Adelard Took" }, { "href": "http://hickle.example/mike.runolfsdottir", "label": "Lorgan" }, { "href": "http://streich.test/rachal_kuvalis", "label": "Beregond" }, { "href": "http://schmitt.test/thomas", "label": "Fimbrethil" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "8870bc1a-82a7-4046-9f25-fc7752e71ad6", "type": "rule" }, { "id": "6532d4aa-a741-4081-aec5-9f9e600902e1", "ref_id": "xccdf_org.ssgproject.content_rule_ea8596ce7693112508885c938f517978", "title": "Corrupti mollitia quaerat sunt.", "rationale": "Sit culpa nihil. Aliquid doloremque vel. Sint dolore quo.", "description": "Ratione voluptatem corrupti. Quae est voluptas. A sint ut.", "severity": "low", "precedence": 7159, "identifier": { "href": "http://raynor-koepp.example/adan_kuhn", "label": "Aragorn" }, "references": [ { "href": "http://dach.example/garrett", "label": "Dior" }, { "href": "http://vandervort.example/scottie.kuvalis", "label": "Eradan" }, { "href": "http://oconnell.example/man.weber", "label": "Dúnhere" }, { "href": "http://pfeffer.test/agripina", "label": "Hallacar" }, { "href": "http://heaney.example/eldridge_brekke", "label": "Gamling" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "4b31f63e-baa0-4587-a77f-d851d1a7ff08", "type": "rule" }, { "id": "6b9beebb-f5a1-4a3c-a6d7-413c2a8c709c", "ref_id": "xccdf_org.ssgproject.content_rule_fdf3a167049bcc4c2b7985cbad808bae", "title": "Et corrupti laudantium eos.", "rationale": "Quisquam expedita iure. Quasi non est. Omnis alias ipsum.", "description": "In eaque amet. Quasi vero accusamus. Consequuntur ut tenetur.", "severity": "medium", "precedence": 1507, "identifier": { "href": "http://volkman.example/marquetta", "label": "Belecthor" }, "references": [ { "href": "http://toy.example/marcelino_dickinson", "label": "Herubrand" }, { "href": "http://herman.test/shila.sporer", "label": "Herendil" }, { "href": "http://emmerich.test/merrill_dach", "label": "Mosco Burrows" }, { "href": "http://mueller.example/karissa", "label": "Isilmë" }, { "href": "http://cummerata-runolfsdottir.test/rocco", "label": "Malach" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "e9ede968-4215-4cb3-8857-8b953421e47d", "type": "rule" } ], "meta": { "total": 25, "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/policies/b48b29da-2a23-4a74-a627-f276370bd8dc/tailorings/5373830d-6661-4ea9-b82a-784d652d126f/rules?limit=10&offset=0", "last": "/api/compliance/v2/policies/b48b29da-2a23-4a74-a627-f276370bd8dc/tailorings/5373830d-6661-4ea9-b82a-784d652d126f/rules?limit=10&offset=20", "next": "/api/compliance/v2/policies/b48b29da-2a23-4a74-a627-f276370bd8dc/tailorings/5373830d-6661-4ea9-b82a-784d652d126f/rules?limit=10&offset=10" } }, "summary": "", "description": "" } }, "schema": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/metadata" }, "links": { "$ref": "#/components/schemas/links" }, "data": { "type": "array", "items": { "properties": { "schema": { "$ref": "#/components/schemas/rule" } } } } } } } } } }, "requestBody": { "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" } } } } } } } } }, "/policies/{policy_id}/tailorings/{tailoring_id}/rules/{rule_id}": { "patch": { "summary": "Assign a Rule to a Tailoring", "parameters": [ { "name": "X-RH-IDENTITY", "in": "header", "schema": { "type": "string" }, "description": "For internal use only" }, { "name": "policy_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tailoring_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "rule_id", "in": "path", "required": true, "description": "UUID or a ref_id with '.' characters replaced with '-'", "schema": { "type": "string" } } ], "tags": [ "Policies" ], "description": "Add a rule to a specific tailoring.", "operationId": "AssignRule", "responses": { "202": { "description": "Assigns a Rule to a Tailoring", "content": { "application/vnd.api+json": { "examples": { "Assigns a Rule to a Tailoring": { "value": { "data": { "id": "a6a398a9-7520-42cd-b36e-7659aee65148", "ref_id": "xccdf_org.ssgproject.content_rule_e7757e4689848e3ae5d11afffa789f2a", "title": "Voluptatum quia sunt doloribus.", "rationale": "Autem numquam ut. Accusantium voluptates et. Consequuntur sit eveniet.", "description": "Neque at et. Et asperiores sunt. Pariatur quo fugit.", "severity": "high", "precedence": 2873, "identifier": { "href": "http://denesik.test/ghislaine.pfannerstill", "label": "Huor" }, "references": [ { "href": "http://west.example/travis", "label": "Moro Burrows" }, { "href": "http://balistreri.test/solange_pouros", "label": "Andróg" }, { "href": "http://moore.example/karena_pacocha", "label": "Fingon" }, { "href": "http://terry.example/jimmy.mayer", "label": "Adalgar Bolger" }, { "href": "http://altenwerth-schinner.test/royce_hayes", "label": "Araglas" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "4fb3d17b-eb35-4f33-86b6-6f3eae791300", "type": "rule" } }, "summary": "", "description": "" } } } } }, "404": { "description": "Returns with Not found", "content": { "application/vnd.api+json": { "examples": { "Returns with Not found": { "value": { "errors": [ "V2::Rule not found with ID 576bd498-4a97-4f6e-80dc-fb699e8b6ddc" ] }, "summary": "", "description": "" } } } } } } }, "delete": { "summary": "Unassign a Rule from a Tailoring", "parameters": [ { "name": "X-RH-IDENTITY", "in": "header", "schema": { "type": "string" }, "description": "For internal use only" }, { "name": "policy_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tailoring_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "rule_id", "in": "path", "required": true, "description": "UUID or a ref_id with '.' characters replaced with '-'", "schema": { "type": "string" } } ], "tags": [ "Policies" ], "description": "Use this to remove a rule from your tailoring.", "operationId": "UnassignRule", "responses": { "202": { "description": "Unassigns a Rule from a Tailoring", "content": { "application/vnd.api+json": { "examples": { "Unassigns a Rule from a Tailoring": { "value": { "data": { "id": "7dbec2a6-c971-41c4-aa0c-b99824292c35", "ref_id": "xccdf_org.ssgproject.content_rule_736df25e9d3eaacc53139df6b7f9aa3a", "title": "Quia fugiat eaque delectus.", "rationale": "Ullam facere quasi. Modi id inventore. Culpa dolor ullam.", "description": "Et in illo. Facere sint aut. Qui optio iure.", "severity": "medium", "precedence": 6061, "identifier": { "href": "http://prohaska.example/julio", "label": "Ragnor" }, "references": [ { "href": "http://rath.example/ervin", "label": "Lonely Troll" }, { "href": "http://denesik.example/valencia_williamson", "label": "Holfast Gardner" }, { "href": "http://schiller.example/rheba_aufderhar", "label": "Mithrellas" }, { "href": "http://rolfson-sawayn.test/allyson", "label": "Gamil Zirak" }, { "href": "http://koelpin.test/cristopher_kassulke", "label": "Grishnákh" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "46501fbb-7183-418c-be75-a48566328f0a", "type": "rule" } }, "summary": "", "description": "" } } } } }, "404": { "description": "Returns with Not found", "content": { "application/vnd.api+json": { "examples": { "Description of an error when unassigning a non-existing Rule": { "value": { "errors": [ "V2::Rule not found with ID 4a210c69-93b8-4a2a-b071-cd511d549ab3" ] }, "summary": "", "description": "" } } } } } } } }, "/security_guides": { "get": { "summary": "Request Security Guides", "parameters": [ { "name": "X-RH-IDENTITY", "in": "header", "schema": { "type": "string" }, "description": "For internal use only" }, { "name": "limit", "in": "query", "required": false, "description": "Number of items to return per page", "schema": { "type": "number", "maximum": 100, "minimum": 1, "default": 10 } }, { "name": "offset", "in": "query", "required": false, "description": "Offset of first item of paginated response", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "ids_only", "in": "query", "required": false, "description": "Indicates whether to return only resource IDs.", "schema": { "type": "boolean" } }, { "name": "sort_by", "in": "query", "required": false, "description": "Attribute and direction to sort the items by. Represented by an array of fields with an optional direction (`:asc` or `:desc`).

If no direction is selected, `:asc` is used by default.", "schema": { "type": "array", "items": { "enum": [ "title", "version", "os_major_version", "title:asc", "title:desc", "version:asc", "version:desc", "os_major_version:asc", "os_major_version:desc" ] } } }, { "name": "filter", "in": "query", "required": false, "description": "Query string to filter items by their attributes. Compliant with scoped_search query language. However, only `=` or `!=` (resp. `<>`) operators are supported.

Security Guides are searchable using attributes `title`, `version`, `ref_id`, `os_major_version`, `profile_ref_id`, and `supported_profile`

(e.g.: `(field_1=something AND field_2!=\"something else\") OR field_3>40`)", "schema": { "type": "string" } } ], "tags": [ "Content" ], "description": "Retrieve a list of all SCAP security guides.", "operationId": "SecurityGuides", "responses": { "200": { "description": "Lists Security Guides", "content": { "application/vnd.api+json": { "examples": { "List of Security Guides": { "value": { "data": [ { "id": "00e7fa01-d497-4734-8669-008a3d0ee0ac", "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", "title": "A deserunt quia et.", "version": "100.82.26", "description": "Dicta maxime quaerat. Minus odio eius. Expedita in voluptas.", "os_major_version": 7, "type": "security_guide" }, { "id": "134d7529-7f89-413c-ac32-a5eaf238a83b", "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", "title": "Reiciendis qui sint quia.", "version": "100.82.19", "description": "Neque impedit modi. Non et repellat. Quo nulla cum.", "os_major_version": 7, "type": "security_guide" }, { "id": "27bba227-91ec-413d-8352-a59ddb7251fb", "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", "title": "Iure ut est assumenda.", "version": "100.82.22", "description": "Architecto id laborum. Quia tenetur harum. Natus molestiae quae.", "os_major_version": 7, "type": "security_guide" }, { "id": "2c142ba4-a8d5-458e-9b4e-565d764dd3ce", "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", "title": "Excepturi fuga dolore id.", "version": "100.82.24", "description": "Id omnis eos. Aut nulla dolorem. Et eos maiores.", "os_major_version": 7, "type": "security_guide" }, { "id": "2d328723-b5f2-41e7-a8f6-1d2d76d09b4b", "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", "title": "Officiis sit tempore et.", "version": "100.82.40", "description": "Quaerat cumque sed. Dolores ullam commodi. Minus voluptatibus quia.", "os_major_version": 7, "type": "security_guide" }, { "id": "3e53bf48-8f6d-49b1-be5f-ed09bd62dae6", "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", "title": "Expedita error quis ratione.", "version": "100.82.36", "description": "Tempore cupiditate excepturi. Culpa odio fugit. Et blanditiis omnis.", "os_major_version": 7, "type": "security_guide" }, { "id": "4172b474-05ba-4af6-9923-6730e9c10150", "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", "title": "Sint numquam exercitationem sunt.", "version": "100.82.28", "description": "Ipsum aperiam tenetur. Velit quam sapiente. Saepe modi rem.", "os_major_version": 7, "type": "security_guide" }, { "id": "4248be74-1ff2-49a3-9045-cfdd09d40a58", "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", "title": "Non facere omnis pariatur.", "version": "100.82.32", "description": "Voluptatem ut in. Error et aspernatur. Praesentium et quia.", "os_major_version": 7, "type": "security_guide" }, { "id": "578600c3-895d-4143-8a8c-f7c3fa7c7fa9", "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", "title": "Asperiores quas voluptates consequatur.", "version": "100.82.38", "description": "Rerum hic voluptates. Nihil modi nisi. Vel perspiciatis nobis.", "os_major_version": 7, "type": "security_guide" }, { "id": "5889766b-eb44-4004-8def-2ba8bd130880", "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", "title": "Et doloremque officiis tempore.", "version": "100.82.18", "description": "Doloremque voluptates voluptate. Debitis illo numquam. Aut dolore fuga.", "os_major_version": 7, "type": "security_guide" } ], "meta": { "total": 25, "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/security_guides?limit=10&offset=0", "last": "/api/compliance/v2/security_guides?limit=10&offset=20", "next": "/api/compliance/v2/security_guides?limit=10&offset=10" } }, "summary": "", "description": "" }, "List of Security Guides sorted by \"os_major_version:asc\"": { "value": { "data": [ { "id": "0c9be721-6285-40b3-9c28-9e01a44e5374", "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", "title": "Cumque voluptatum odit veniam.", "version": "100.83.9", "description": "Occaecati consequatur inventore. Voluptatum vero et. Asperiores qui soluta.", "os_major_version": 7, "type": "security_guide" }, { "id": "0ea288ac-f977-4542-b188-fcda29a2f8d7", "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", "title": "Quas nihil veniam cum.", "version": "100.83.12", "description": "Nulla ut et. Ut aliquam omnis. Magnam blanditiis facilis.", "os_major_version": 7, "type": "security_guide" }, { "id": "15e58b2a-45d6-4fc7-8555-01a3c45e1bdf", "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", "title": "Aut facilis voluptate veritatis.", "version": "100.82.48", "description": "Consequatur molestias ad. Soluta dolor rem. Autem esse et.", "os_major_version": 7, "type": "security_guide" }, { "id": "19adb44f-7dfc-4d59-aa58-5ec9619facd8", "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", "title": "Voluptatem deleniti perferendis qui.", "version": "100.83.14", "description": "Quisquam id ex. Voluptatem et qui. Impedit non mollitia.", "os_major_version": 7, "type": "security_guide" }, { "id": "1db930d1-8b60-4134-9d9f-bebabeb5763e", "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", "title": "Assumenda suscipit asperiores tempora.", "version": "100.82.47", "description": "Fugit aut ad. Voluptatem commodi ducimus. Maxime ullam et.", "os_major_version": 7, "type": "security_guide" }, { "id": "22a02a23-69d3-486e-b27e-61aec019eb53", "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", "title": "Tempora ipsa neque et.", "version": "100.82.45", "description": "Similique dolores eos. Sequi est aut. Doloremque voluptatem quos.", "os_major_version": 7, "type": "security_guide" }, { "id": "244b3374-fe0e-4487-bbae-500ba9044402", "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", "title": "Eum ratione id excepturi.", "version": "100.82.49", "description": "Id debitis et. Vero quos inventore. Omnis sit ab.", "os_major_version": 7, "type": "security_guide" }, { "id": "275c7fc1-c997-45e2-8a73-e9f9913ce20e", "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", "title": "Iste sed tempora suscipit.", "version": "100.83.0", "description": "Cumque velit atque. Eveniet et provident. Quo voluptatem ratione.", "os_major_version": 7, "type": "security_guide" }, { "id": "2be7c6b8-b46b-4e4a-bcfb-b87aa0e15cd6", "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", "title": "Nemo voluptas architecto harum.", "version": "100.83.1", "description": "Assumenda dolores ad. Officia at magni. Id voluptas minima.", "os_major_version": 7, "type": "security_guide" }, { "id": "2cf84c5d-afb3-4461-92dc-3dd94aa96fad", "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", "title": "In reprehenderit dolorum necessitatibus.", "version": "100.83.15", "description": "Voluptatum deserunt recusandae. Dicta sapiente porro. Enim esse fugiat.", "os_major_version": 7, "type": "security_guide" } ], "meta": { "total": 25, "limit": 10, "offset": 0, "sort_by": "os_major_version" }, "links": { "first": "/api/compliance/v2/security_guides?limit=10&offset=0&sort_by=os_major_version", "last": "/api/compliance/v2/security_guides?limit=10&offset=20&sort_by=os_major_version", "next": "/api/compliance/v2/security_guides?limit=10&offset=10&sort_by=os_major_version" } }, "summary": "", "description": "" }, "List of Security Guides filtered by \"(os_major_version=8)\"": { "value": { "data": [], "meta": { "total": 0, "filter": "(os_major_version=8)", "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/security_guides?filter=%28os_major_version%3D8%29&limit=10&offset=0", "last": "/api/compliance/v2/security_guides?filter=%28os_major_version%3D8%29&limit=10&offset=0" } }, "summary": "", "description": "" } }, "schema": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/metadata" }, "links": { "$ref": "#/components/schemas/links" }, "data": { "type": "array", "items": { "properties": { "schema": { "$ref": "#/components/schemas/security_guide" } } } } } } } } }, "422": { "description": "Returns with Unprocessable Content", "content": { "application/vnd.api+json": { "examples": { "Description of an error when sorting by incorrect parameter": { "value": { "errors": [ "Result cannot be sorted by the 'description' column." ] }, "summary": "", "description": "" }, "Description of an error when requesting higher limit than supported": { "value": { "errors": [ "Invalid parameter: limit must be less than or equal to 100" ] }, "summary": "", "description": "" } }, "schema": { "$ref": "#/components/schemas/errors" } } } } } } }, "/security_guides/os_versions": { "get": { "summary": "Request the list of available OS versions", "parameters": [ { "name": "X-RH-IDENTITY", "in": "header", "schema": { "type": "string" }, "description": "For internal use only" }, { "name": "filter", "in": "query", "required": false, "description": "Query string to filter items by their attributes. Compliant with scoped_search query language. However, only `=` or `!=` (resp. `<>`) operators are supported.

Systems are searchable using attributes `display_name`, `os_version`, `os_major_version`, `os_minor_version`, `assigned_or_scanned`, `never_reported`, `group_name`, `group_id`, `policies`, and `profile_ref_id`

(e.g.: `(field_1=something AND field_2!=\"something else\") OR field_3>40`)", "schema": { "type": "string" } } ], "tags": [ "Content" ], "description": "This feature is exclusively used by the frontend", "operationId": "SecurityGuidesOS", "deprecated": true, "responses": { "200": { "description": "Lists available OS versions", "content": { "application/vnd.api+json": { "examples": { "List of available OS versions": { "value": [ 7 ], "summary": "", "description": "" } }, "schema": { "type": "array", "items": { "type": "integer" } } } } } } } }, "/security_guides/{security_guide_id}": { "get": { "summary": "Request a Security Guide", "parameters": [ { "name": "X-RH-IDENTITY", "in": "header", "schema": { "type": "string" }, "description": "For internal use only" }, { "name": "security_guide_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "Content" ], "description": "Retrieve a specific security guide.", "operationId": "SecurityGuide", "responses": { "200": { "description": "Returns a Security Guide", "content": { "application/vnd.api+json": { "examples": { "Returns a Security Guide": { "value": { "data": { "id": "059c1847-e2cc-4544-8199-0352c5266d4c", "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", "title": "Qui dolore aut impedit.", "version": "100.85.17", "description": "Officiis voluptas et. Ea autem aliquam. Voluptatum qui amet.", "os_major_version": 7, "type": "security_guide" } }, "summary": "", "description": "" } }, "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/security_guide" } } } } } } } }, "404": { "description": "Returns with Not Found", "content": { "application/vnd.api+json": { "examples": { "Description of an error when requesting a non-existing Security Guide": { "value": { "errors": [ "V2::SecurityGuide not found with ID 0d1d869a-c106-4bf5-ab88-7acbffcecb71" ] }, "summary": "", "description": "" } }, "schema": { "$ref": "#/components/schemas/errors" } } } } } } }, "/security_guides/{security_guide_id}/rule_tree": { "get": { "summary": "Request the Rule Tree of a Security Guide", "parameters": [ { "name": "X-RH-IDENTITY", "in": "header", "schema": { "type": "string" }, "description": "For internal use only" }, { "name": "security_guide_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "Content" ], "description": "Returns rule tree of a security guide.", "operationId": "SecurityGuideRuleTree", "deprecated": true, "responses": { "200": { "description": "Returns the Rule Tree of a Security Guide", "content": { "application/vnd.api+json": { "examples": { "Returns the Rule Tree of a Security Guide": { "value": [ { "id": "3c90afca-a891-4f52-807f-6de588e6209e", "type": "rule_group", "children": [ { "id": "3fee52a4-6d91-4cd7-af01-8a9549ea1f33", "type": "rule" } ] }, { "id": "138fff8a-9240-4713-a646-207853e06199", "type": "rule_group", "children": [ { "id": "a823971a-81a6-428a-8091-e9c2210d92a6", "type": "rule" } ] }, { "id": "96d7209c-a09d-4da4-8f35-e3b490a0fe07", "type": "rule_group", "children": [ { "id": "7102fac9-5625-4b61-b86d-91f65820c513", "type": "rule" } ] }, { "id": "5763a526-c0f5-47ef-9fa4-7471dc846a44", "type": "rule_group", "children": [ { "id": "485b11a0-0ca9-484a-9696-7334b6cf2a27", "type": "rule" } ] }, { "id": "71a38235-3c92-4817-bd18-33d79d287a67", "type": "rule_group", "children": [ { "id": "fff6e68d-2438-44a1-9368-d7675bcab29c", "type": "rule" } ] }, { "id": "42ba14d2-2da0-473d-b03c-bf7704c2f67d", "type": "rule_group", "children": [ { "id": "9fe247ca-67ae-49af-a99b-e6f8b7b34359", "type": "rule" } ] }, { "id": "ea9b9dfd-5c33-4e8d-b5eb-d83520e929fe", "type": "rule_group", "children": [ { "id": "961beaab-480d-4f0b-a1b3-5e1c1b0e2229", "type": "rule" } ] }, { "id": "c0cc909f-508f-4577-9a6f-97e76578e2f4", "type": "rule_group", "children": [ { "id": "5412e73b-dd7c-4554-873d-5121e0b6e9bb", "type": "rule" } ] }, { "id": "aeba8e00-4346-4fa2-bed4-6176e768c77d", "type": "rule_group", "children": [ { "id": "9539b0d2-c1b2-4ebb-961d-f54ad863b1f1", "type": "rule" } ] }, { "id": "beb334cd-4eb9-4d7d-ba19-2dffdbfa02e0", "type": "rule_group", "children": [ { "id": "494be4bb-dcef-4ac3-85b6-29ef41699df3", "type": "rule" } ] } ], "summary": "", "description": "" } }, "schema": { "$ref": "#/components/schemas/rule_tree" } } } }, "404": { "description": "Returns with Not Found", "content": { "application/vnd.api+json": { "examples": { "Description of an error when requesting a non-existing Security Guide": { "value": { "errors": [ "V2::SecurityGuide not found with ID 9e0eff47-fea9-4a36-932b-d2874e278a5c" ] }, "summary": "", "description": "" } }, "schema": { "$ref": "#/components/schemas/errors" } } } } } } }, "/status": { "get": { "summary": "status", "tags": [ "status" ], "description": "Display Compliance status", "operationId": "Status", "responses": { "200": { "description": "successful status", "content": { "application/vnd.api+json": { "examples": { "Response example": { "value": { "data": { "api": true } }, "summary": "", "description": "" } }, "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/status" } } } } } }, "500": { "description": "unsuccessful status", "content": { "application/vnd.api+json": { "examples": { "Response example": { "value": { "data": { "api": false } }, "summary": "", "description": "" } }, "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/status" } } } } } } } } }, "/security_guides/supported_profiles": { "get": { "summary": "Request Supported Profiles", "parameters": [ { "name": "X-RH-IDENTITY", "in": "header", "schema": { "type": "string" }, "description": "For internal use only" }, { "name": "limit", "in": "query", "required": false, "description": "Number of items to return per page", "schema": { "type": "number", "maximum": 100, "minimum": 1, "default": 10 } }, { "name": "offset", "in": "query", "required": false, "description": "Offset of first item of paginated response", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "ids_only", "in": "query", "required": false, "description": "Indicates whether to return only resource IDs.", "schema": { "type": "boolean" } }, { "name": "sort_by", "in": "query", "required": false, "description": "Attribute and direction to sort the items by. Represented by an array of fields with an optional direction (`:asc` or `:desc`).

If no direction is selected, `:asc` is used by default.", "schema": { "type": "array", "items": { "enum": [ "title", "os_major_version", "os_minor_versions", "title:asc", "title:desc", "os_major_version:asc", "os_major_version:desc", "os_minor_versions:asc", "os_minor_versions:desc" ] } } }, { "name": "filter", "in": "query", "required": false, "description": "Query string to filter items by their attributes. Compliant with scoped_search query language. However, only `=` or `!=` (resp. `<>`) operators are supported.

Supported Profiles are searchable using attributes `os_major_version`, `title`, and `ref_id`

(e.g.: `(field_1=something AND field_2!=\"something else\") OR field_3>40`)", "schema": { "type": "string" } } ], "tags": [ "Content" ], "description": "Retrieve the list of profiles supported by particular RHEL versions.", "operationId": "SupportedProfiles", "responses": { "200": { "description": "Lists Supported Profiles", "content": { "application/vnd.api+json": { "examples": { "List of Supported Profiles": { "value": { "data": [ { "id": "436c9b85-d6b4-4408-ace9-4cd38bd60df2", "title": "Blanditiis qui in aliquam.", "description": "Eveniet voluptas rerum. Quo sed doloribus. Officiis quia magni.", "ref_id": "xccdf_org.ssgproject.content_profile_40be0e7ef683147f2fc649e07e2f6137", "security_guide_id": "dad86de4-7f9d-4b9a-884a-7a073118a70b", "security_guide_version": "100.86.2", "os_major_version": 7, "os_minor_versions": [ 3, 2, 1 ], "type": "supported_profile" } ], "meta": { "total": 1, "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/security_guides/supported_profiles?limit=10&offset=0", "last": "/api/compliance/v2/security_guides/supported_profiles?limit=10&offset=0" } }, "summary": "", "description": "" }, "List of Supported Profiles sorted by \"os_major_version:asc\"": { "value": { "data": [ { "id": "661effa5-7add-4085-ad6a-1463c31eabd2", "title": "Et consectetur ipsum eveniet.", "description": "Et natus atque. Sed ut occaecati. Quam molestiae expedita.", "ref_id": "xccdf_org.ssgproject.content_profile_5099b2a2c4bc530f36b3ad7d42f921f3", "security_guide_id": "6ca0be86-f02b-4f3f-ac23-b4206a427e1a", "security_guide_version": "100.86.3", "os_major_version": 7, "os_minor_versions": [ 3, 2, 1 ], "type": "supported_profile" } ], "meta": { "total": 1, "limit": 10, "offset": 0, "sort_by": "os_major_version" }, "links": { "first": "/api/compliance/v2/security_guides/supported_profiles?limit=10&offset=0&sort_by=os_major_version", "last": "/api/compliance/v2/security_guides/supported_profiles?limit=10&offset=0&sort_by=os_major_version" } }, "summary": "", "description": "" }, "List of Supported Profiles filtered by \"(os_major_version=8)\"": { "value": { "data": [], "meta": { "total": 0, "filter": "(os_major_version=8)", "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/security_guides/supported_profiles?filter=%28os_major_version%3D8%29&limit=10&offset=0", "last": "/api/compliance/v2/security_guides/supported_profiles?filter=%28os_major_version%3D8%29&limit=10&offset=0" } }, "summary": "", "description": "" } }, "schema": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/metadata" }, "links": { "$ref": "#/components/schemas/links" }, "data": { "type": "array", "items": { "properties": { "schema": { "$ref": "#/components/schemas/supported_profile" } } } } } } } } }, "422": { "description": "Returns with Unprocessable Content", "content": { "application/vnd.api+json": { "examples": { "Description of an error when sorting by incorrect parameter": { "value": { "errors": [ "Result cannot be sorted by the 'description' column." ] }, "summary": "", "description": "" }, "Description of an error when requesting higher limit than supported": { "value": { "errors": [ "Invalid parameter: limit must be less than or equal to 100" ] }, "summary": "", "description": "" } }, "schema": { "$ref": "#/components/schemas/errors" } } } } } } }, "/systems": { "get": { "summary": "Request Systems", "parameters": [ { "name": "X-RH-IDENTITY", "in": "header", "schema": { "type": "string" }, "description": "For internal use only" }, { "name": "tags", "in": "query", "required": false, "description": "An array of tags to narrow down the search results. In case the value contains symbols used for separators (`/` or `=`), they need to be encoded.
e.g.: `namespace/key=value`, `insights-client/selinux-config=SELINUX%3Denforcing`", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "limit", "in": "query", "required": false, "description": "Number of items to return per page", "schema": { "type": "number", "maximum": 100, "minimum": 1, "default": 10 } }, { "name": "offset", "in": "query", "required": false, "description": "Offset of first item of paginated response", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "ids_only", "in": "query", "required": false, "description": "Indicates whether to return only resource IDs.", "schema": { "type": "boolean" } }, { "name": "sort_by", "in": "query", "required": false, "description": "Attribute and direction to sort the items by. Represented by an array of fields with an optional direction (`:asc` or `:desc`).

If no direction is selected, `:asc` is used by default.", "schema": { "type": "array", "items": { "enum": [ "display_name", "os_major_version", "os_minor_version", "os_version", "groups", "display_name:asc", "display_name:desc", "os_major_version:asc", "os_major_version:desc", "os_minor_version:asc", "os_minor_version:desc", "os_version:asc", "os_version:desc", "groups:asc", "groups:desc" ] } } }, { "name": "filter", "in": "query", "required": false, "description": "Query string to filter items by their attributes. Compliant with scoped_search query language. However, only `=` or `!=` (resp. `<>`) operators are supported.

Systems are searchable using attributes `display_name`, `os_major_version`, `os_minor_version`, `assigned_or_scanned`, `group_name`, `group_id`, `policies`, and `profile_ref_id`

(e.g.: `(field_1=something AND field_2!=\"something else\") OR field_3>40`)", "schema": { "type": "string" } } ], "tags": [ "Systems" ], "description": "List all systems that are accessible when you are logged into your account.", "operationId": "Systems", "responses": { "200": { "description": "Lists Systems", "content": { "application/vnd.api+json": { "examples": { "List of Systems": { "value": { "data": [ { "id": "1dcfe85d-6206-4ad3-a88c-e16a09cf0027", "display_name": "von.test", "groups": [], "culled_timestamp": "2036-06-09T10:20:58.203Z", "last_check_in": "2036-06-03T10:20:58.203Z", "stale_timestamp": "2036-05-26T10:20:58.203Z", "stale_warning_timestamp": "2036-06-02T10:20:58.203Z", "updated": "2026-05-26T10:20:58.203Z", "insights_id": null, "tags": [ { "key": "panel", "value": "open-source", "namespace": "hacking" }, { "key": "program", "value": "1080p", "namespace": "compressing" }, { "key": "pixel", "value": "multi-byte", "namespace": "overriding" }, { "key": "alarm", "value": "solid state", "namespace": "indexing" }, { "key": "interface", "value": "multi-byte", "namespace": "navigating" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "2017283c-00d4-42e4-bcd4-0d6811e90c7f", "display_name": "rath.test", "groups": [], "culled_timestamp": "2036-06-09T10:20:58.217Z", "last_check_in": "2036-06-03T10:20:58.217Z", "stale_timestamp": "2036-05-26T10:20:58.217Z", "stale_warning_timestamp": "2036-06-02T10:20:58.217Z", "updated": "2026-05-26T10:20:58.217Z", "insights_id": null, "tags": [ { "key": "pixel", "value": "cross-platform", "namespace": "synthesizing" }, { "key": "firewall", "value": "multi-byte", "namespace": "backing up" }, { "key": "bandwidth", "value": "1080p", "namespace": "backing up" }, { "key": "panel", "value": "solid state", "namespace": "synthesizing" }, { "key": "application", "value": "redundant", "namespace": "navigating" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "29bd4fc6-1d44-41c1-a772-6bb1069b364a", "display_name": "rice.test", "groups": [], "culled_timestamp": "2036-06-09T10:20:58.202Z", "last_check_in": "2036-06-03T10:20:58.202Z", "stale_timestamp": "2036-05-26T10:20:58.202Z", "stale_warning_timestamp": "2036-06-02T10:20:58.202Z", "updated": "2026-05-26T10:20:58.202Z", "insights_id": null, "tags": [ { "key": "sensor", "value": "online", "namespace": "calculating" }, { "key": "bandwidth", "value": "neural", "namespace": "transmitting" }, { "key": "program", "value": "back-end", "namespace": "compressing" }, { "key": "protocol", "value": "wireless", "namespace": "backing up" }, { "key": "bandwidth", "value": "auxiliary", "namespace": "synthesizing" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "2af24d2e-5986-4ee4-a227-6346de7478de", "display_name": "gottlieb-berge.test", "groups": [], "culled_timestamp": "2036-06-09T10:20:58.210Z", "last_check_in": "2036-06-03T10:20:58.210Z", "stale_timestamp": "2036-05-26T10:20:58.210Z", "stale_warning_timestamp": "2036-06-02T10:20:58.210Z", "updated": "2026-05-26T10:20:58.210Z", "insights_id": null, "tags": [ { "key": "capacitor", "value": "digital", "namespace": "generating" }, { "key": "application", "value": "digital", "namespace": "copying" }, { "key": "application", "value": "redundant", "namespace": "transmitting" }, { "key": "sensor", "value": "digital", "namespace": "quantifying" }, { "key": "bus", "value": "virtual", "namespace": "bypassing" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "36b8dbc6-ae82-4d9a-9e76-2c651f9990d8", "display_name": "tillman.example", "groups": [], "culled_timestamp": "2036-06-09T10:20:58.206Z", "last_check_in": "2036-06-03T10:20:58.206Z", "stale_timestamp": "2036-05-26T10:20:58.206Z", "stale_warning_timestamp": "2036-06-02T10:20:58.206Z", "updated": "2026-05-26T10:20:58.206Z", "insights_id": null, "tags": [ { "key": "firewall", "value": "neural", "namespace": "overriding" }, { "key": "transmitter", "value": "wireless", "namespace": "quantifying" }, { "key": "matrix", "value": "primary", "namespace": "indexing" }, { "key": "circuit", "value": "bluetooth", "namespace": "backing up" }, { "key": "port", "value": "auxiliary", "namespace": "programming" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "544fe885-6bc5-44e4-89d3-c9f7a9bb95ff", "display_name": "fay.example", "groups": [], "culled_timestamp": "2036-06-09T10:20:58.219Z", "last_check_in": "2036-06-03T10:20:58.219Z", "stale_timestamp": "2036-05-26T10:20:58.219Z", "stale_warning_timestamp": "2036-06-02T10:20:58.219Z", "updated": "2026-05-26T10:20:58.219Z", "insights_id": null, "tags": [ { "key": "feed", "value": "neural", "namespace": "backing up" }, { "key": "driver", "value": "back-end", "namespace": "navigating" }, { "key": "bandwidth", "value": "primary", "namespace": "backing up" }, { "key": "bandwidth", "value": "virtual", "namespace": "calculating" }, { "key": "bandwidth", "value": "optical", "namespace": "calculating" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "54f7e122-efd3-420e-9b87-4f694d64fd64", "display_name": "hoppe.example", "groups": [], "culled_timestamp": "2036-06-09T10:20:58.205Z", "last_check_in": "2036-06-03T10:20:58.205Z", "stale_timestamp": "2036-05-26T10:20:58.205Z", "stale_warning_timestamp": "2036-06-02T10:20:58.205Z", "updated": "2026-05-26T10:20:58.205Z", "insights_id": null, "tags": [ { "key": "interface", "value": "neural", "namespace": "overriding" }, { "key": "feed", "value": "mobile", "namespace": "parsing" }, { "key": "card", "value": "multi-byte", "namespace": "hacking" }, { "key": "microchip", "value": "cross-platform", "namespace": "bypassing" }, { "key": "alarm", "value": "back-end", "namespace": "compressing" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "605a38f3-1bfd-4090-bd16-1080ef84b98f", "display_name": "hessel-mccullough.example", "groups": [], "culled_timestamp": "2036-06-09T10:20:58.196Z", "last_check_in": "2036-06-03T10:20:58.196Z", "stale_timestamp": "2036-05-26T10:20:58.196Z", "stale_warning_timestamp": "2036-06-02T10:20:58.196Z", "updated": "2026-05-26T10:20:58.196Z", "insights_id": null, "tags": [ { "key": "hard drive", "value": "haptic", "namespace": "copying" }, { "key": "transmitter", "value": "redundant", "namespace": "compressing" }, { "key": "sensor", "value": "cross-platform", "namespace": "synthesizing" }, { "key": "program", "value": "redundant", "namespace": "compressing" }, { "key": "port", "value": "online", "namespace": "navigating" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "6a604803-fef1-415c-bf14-3d00ed8a6d67", "display_name": "jacobson-heidenreich.test", "groups": [], "culled_timestamp": "2036-06-09T10:20:58.191Z", "last_check_in": "2036-06-03T10:20:58.191Z", "stale_timestamp": "2036-05-26T10:20:58.191Z", "stale_warning_timestamp": "2036-06-02T10:20:58.191Z", "updated": "2026-05-26T10:20:58.191Z", "insights_id": null, "tags": [ { "key": "sensor", "value": "neural", "namespace": "programming" }, { "key": "microchip", "value": "haptic", "namespace": "parsing" }, { "key": "panel", "value": "haptic", "namespace": "parsing" }, { "key": "hard drive", "value": "haptic", "namespace": "overriding" }, { "key": "system", "value": "digital", "namespace": "navigating" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "6ab1c556-4909-48ad-b091-ff0c6f76739c", "display_name": "schiller.example", "groups": [], "culled_timestamp": "2036-06-09T10:20:58.216Z", "last_check_in": "2036-06-03T10:20:58.216Z", "stale_timestamp": "2036-05-26T10:20:58.216Z", "stale_warning_timestamp": "2036-06-02T10:20:58.216Z", "updated": "2026-05-26T10:20:58.216Z", "insights_id": null, "tags": [ { "key": "firewall", "value": "cross-platform", "namespace": "backing up" }, { "key": "feed", "value": "mobile", "namespace": "generating" }, { "key": "matrix", "value": "mobile", "namespace": "quantifying" }, { "key": "monitor", "value": "wireless", "namespace": "calculating" }, { "key": "interface", "value": "auxiliary", "namespace": "indexing" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] } ], "meta": { "total": 25, "tags": [], "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/systems?limit=10&offset=0", "last": "/api/compliance/v2/systems?limit=10&offset=20", "next": "/api/compliance/v2/systems?limit=10&offset=10" } }, "summary": "", "description": "" }, "List of Systems sorted by \"os_major_version:asc\"": { "value": { "data": [ { "id": "0013255d-7b7b-417d-82c7-a1901070eed9", "display_name": "pagac-wunsch.test", "groups": [], "culled_timestamp": "2036-06-09T10:20:58.278Z", "last_check_in": "2036-06-03T10:20:58.278Z", "stale_timestamp": "2036-05-26T10:20:58.278Z", "stale_warning_timestamp": "2036-06-02T10:20:58.278Z", "updated": "2026-05-26T10:20:58.278Z", "insights_id": null, "tags": [ { "key": "monitor", "value": "auxiliary", "namespace": "navigating" }, { "key": "pixel", "value": "solid state", "namespace": "navigating" }, { "key": "panel", "value": "solid state", "namespace": "indexing" }, { "key": "monitor", "value": "optical", "namespace": "bypassing" }, { "key": "array", "value": "primary", "namespace": "hacking" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "0042312a-5faa-456e-967e-be0c7a93580e", "display_name": "denesik.example", "groups": [], "culled_timestamp": "2036-06-09T10:20:58.295Z", "last_check_in": "2036-06-03T10:20:58.295Z", "stale_timestamp": "2036-05-26T10:20:58.295Z", "stale_warning_timestamp": "2036-06-02T10:20:58.295Z", "updated": "2026-05-26T10:20:58.295Z", "insights_id": null, "tags": [ { "key": "port", "value": "back-end", "namespace": "programming" }, { "key": "circuit", "value": "redundant", "namespace": "quantifying" }, { "key": "hard drive", "value": "virtual", "namespace": "navigating" }, { "key": "interface", "value": "mobile", "namespace": "backing up" }, { "key": "firewall", "value": "online", "namespace": "parsing" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "00ec9334-dc41-4c1c-bc69-392005851b76", "display_name": "gleichner.test", "groups": [], "culled_timestamp": "2036-06-09T10:20:58.286Z", "last_check_in": "2036-06-03T10:20:58.286Z", "stale_timestamp": "2036-05-26T10:20:58.286Z", "stale_warning_timestamp": "2036-06-02T10:20:58.286Z", "updated": "2026-05-26T10:20:58.286Z", "insights_id": null, "tags": [ { "key": "interface", "value": "back-end", "namespace": "quantifying" }, { "key": "driver", "value": "redundant", "namespace": "overriding" }, { "key": "protocol", "value": "solid state", "namespace": "compressing" }, { "key": "hard drive", "value": "virtual", "namespace": "hacking" }, { "key": "port", "value": "neural", "namespace": "generating" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "05c33347-bc3a-4cf2-bf96-8e0d49357d59", "display_name": "doyle.example", "groups": [], "culled_timestamp": "2036-06-09T10:20:58.284Z", "last_check_in": "2036-06-03T10:20:58.284Z", "stale_timestamp": "2036-05-26T10:20:58.284Z", "stale_warning_timestamp": "2036-06-02T10:20:58.284Z", "updated": "2026-05-26T10:20:58.284Z", "insights_id": null, "tags": [ { "key": "port", "value": "open-source", "namespace": "copying" }, { "key": "system", "value": "cross-platform", "namespace": "navigating" }, { "key": "array", "value": "solid state", "namespace": "bypassing" }, { "key": "matrix", "value": "bluetooth", "namespace": "indexing" }, { "key": "capacitor", "value": "bluetooth", "namespace": "programming" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "0b061237-8860-4fd4-91bd-d6c6586d1877", "display_name": "purdy.example", "groups": [], "culled_timestamp": "2036-06-09T10:20:58.296Z", "last_check_in": "2036-06-03T10:20:58.296Z", "stale_timestamp": "2036-05-26T10:20:58.296Z", "stale_warning_timestamp": "2036-06-02T10:20:58.296Z", "updated": "2026-05-26T10:20:58.296Z", "insights_id": null, "tags": [ { "key": "port", "value": "digital", "namespace": "copying" }, { "key": "sensor", "value": "optical", "namespace": "parsing" }, { "key": "alarm", "value": "digital", "namespace": "copying" }, { "key": "card", "value": "back-end", "namespace": "copying" }, { "key": "port", "value": "1080p", "namespace": "copying" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "0fb7f742-0d53-42cf-91c1-97f51288e846", "display_name": "von.example", "groups": [], "culled_timestamp": "2036-06-09T10:20:58.289Z", "last_check_in": "2036-06-03T10:20:58.289Z", "stale_timestamp": "2036-05-26T10:20:58.289Z", "stale_warning_timestamp": "2036-06-02T10:20:58.289Z", "updated": "2026-05-26T10:20:58.289Z", "insights_id": null, "tags": [ { "key": "program", "value": "bluetooth", "namespace": "generating" }, { "key": "card", "value": "online", "namespace": "overriding" }, { "key": "driver", "value": "redundant", "namespace": "programming" }, { "key": "bandwidth", "value": "haptic", "namespace": "programming" }, { "key": "array", "value": "bluetooth", "namespace": "parsing" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "1d2c8508-d7e7-4814-ba81-06ebe5732b03", "display_name": "hammes-leuschke.test", "groups": [], "culled_timestamp": "2036-06-09T10:20:58.271Z", "last_check_in": "2036-06-03T10:20:58.271Z", "stale_timestamp": "2036-05-26T10:20:58.271Z", "stale_warning_timestamp": "2036-06-02T10:20:58.271Z", "updated": "2026-05-26T10:20:58.271Z", "insights_id": null, "tags": [ { "key": "interface", "value": "bluetooth", "namespace": "compressing" }, { "key": "alarm", "value": "digital", "namespace": "navigating" }, { "key": "driver", "value": "open-source", "namespace": "backing up" }, { "key": "protocol", "value": "digital", "namespace": "programming" }, { "key": "protocol", "value": "multi-byte", "namespace": "connecting" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "1e68fc8a-a9d3-4d8e-92e1-031354838b71", "display_name": "senger-witting.example", "groups": [], "culled_timestamp": "2036-06-09T10:20:58.292Z", "last_check_in": "2036-06-03T10:20:58.292Z", "stale_timestamp": "2036-05-26T10:20:58.292Z", "stale_warning_timestamp": "2036-06-02T10:20:58.292Z", "updated": "2026-05-26T10:20:58.292Z", "insights_id": null, "tags": [ { "key": "monitor", "value": "virtual", "namespace": "generating" }, { "key": "capacitor", "value": "virtual", "namespace": "hacking" }, { "key": "matrix", "value": "multi-byte", "namespace": "transmitting" }, { "key": "sensor", "value": "redundant", "namespace": "generating" }, { "key": "circuit", "value": "optical", "namespace": "navigating" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "2026ac44-7b8f-4023-af5d-9fcaf895bd06", "display_name": "bauch-pollich.example", "groups": [], "culled_timestamp": "2036-06-09T10:20:58.277Z", "last_check_in": "2036-06-03T10:20:58.277Z", "stale_timestamp": "2036-05-26T10:20:58.277Z", "stale_warning_timestamp": "2036-06-02T10:20:58.277Z", "updated": "2026-05-26T10:20:58.277Z", "insights_id": null, "tags": [ { "key": "sensor", "value": "wireless", "namespace": "navigating" }, { "key": "circuit", "value": "primary", "namespace": "indexing" }, { "key": "card", "value": "multi-byte", "namespace": "copying" }, { "key": "sensor", "value": "neural", "namespace": "overriding" }, { "key": "program", "value": "online", "namespace": "synthesizing" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "25be9ce7-cf2c-4860-b3bc-2030a309ba5e", "display_name": "dare.example", "groups": [], "culled_timestamp": "2036-06-09T10:20:58.300Z", "last_check_in": "2036-06-03T10:20:58.300Z", "stale_timestamp": "2036-05-26T10:20:58.300Z", "stale_warning_timestamp": "2036-06-02T10:20:58.300Z", "updated": "2026-05-26T10:20:58.300Z", "insights_id": null, "tags": [ { "key": "transmitter", "value": "multi-byte", "namespace": "bypassing" }, { "key": "driver", "value": "optical", "namespace": "navigating" }, { "key": "sensor", "value": "multi-byte", "namespace": "compressing" }, { "key": "array", "value": "1080p", "namespace": "synthesizing" }, { "key": "microchip", "value": "wireless", "namespace": "transmitting" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] } ], "meta": { "total": 25, "tags": [], "limit": 10, "offset": 0, "sort_by": "os_major_version" }, "links": { "first": "/api/compliance/v2/systems?limit=10&offset=0&sort_by=os_major_version", "last": "/api/compliance/v2/systems?limit=10&offset=20&sort_by=os_major_version", "next": "/api/compliance/v2/systems?limit=10&offset=10&sort_by=os_major_version" } }, "summary": "", "description": "" }, "List of Systems filtered by \"(os_major_version=8)\"": { "value": { "data": [ { "id": "0c387078-4f1f-4666-9cb2-33a8abddba42", "display_name": "bergstrom.example", "groups": [], "culled_timestamp": "2036-06-09T10:20:58.350Z", "last_check_in": "2036-06-03T10:20:58.350Z", "stale_timestamp": "2036-05-26T10:20:58.350Z", "stale_warning_timestamp": "2036-06-02T10:20:58.350Z", "updated": "2026-05-26T10:20:58.350Z", "insights_id": null, "tags": [ { "key": "protocol", "value": "solid state", "namespace": "bypassing" }, { "key": "bus", "value": "haptic", "namespace": "backing up" }, { "key": "driver", "value": "redundant", "namespace": "calculating" }, { "key": "alarm", "value": "1080p", "namespace": "generating" }, { "key": "bus", "value": "bluetooth", "namespace": "quantifying" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "18706577-4e06-4337-8a12-353190421187", "display_name": "funk.example", "groups": [], "culled_timestamp": "2036-06-09T10:20:58.346Z", "last_check_in": "2036-06-03T10:20:58.346Z", "stale_timestamp": "2036-05-26T10:20:58.346Z", "stale_warning_timestamp": "2036-06-02T10:20:58.346Z", "updated": "2026-05-26T10:20:58.346Z", "insights_id": null, "tags": [ { "key": "capacitor", "value": "1080p", "namespace": "programming" }, { "key": "interface", "value": "cross-platform", "namespace": "synthesizing" }, { "key": "bandwidth", "value": "solid state", "namespace": "indexing" }, { "key": "monitor", "value": "virtual", "namespace": "backing up" }, { "key": "application", "value": "neural", "namespace": "overriding" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "2676c96c-d30f-4123-a005-0f97565c36aa", "display_name": "kirlin.test", "groups": [], "culled_timestamp": "2036-06-09T10:20:58.379Z", "last_check_in": "2036-06-03T10:20:58.379Z", "stale_timestamp": "2036-05-26T10:20:58.379Z", "stale_warning_timestamp": "2036-06-02T10:20:58.379Z", "updated": "2026-05-26T10:20:58.379Z", "insights_id": null, "tags": [ { "key": "sensor", "value": "cross-platform", "namespace": "generating" }, { "key": "driver", "value": "wireless", "namespace": "quantifying" }, { "key": "application", "value": "1080p", "namespace": "compressing" }, { "key": "firewall", "value": "neural", "namespace": "synthesizing" }, { "key": "program", "value": "solid state", "namespace": "bypassing" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "2c0f8b58-39b1-41f7-9ede-c7ac29fcca3c", "display_name": "langworth-weissnat.example", "groups": [], "culled_timestamp": "2036-06-09T10:20:58.353Z", "last_check_in": "2036-06-03T10:20:58.353Z", "stale_timestamp": "2036-05-26T10:20:58.353Z", "stale_warning_timestamp": "2036-06-02T10:20:58.353Z", "updated": "2026-05-26T10:20:58.353Z", "insights_id": null, "tags": [ { "key": "sensor", "value": "neural", "namespace": "copying" }, { "key": "panel", "value": "virtual", "namespace": "hacking" }, { "key": "interface", "value": "digital", "namespace": "transmitting" }, { "key": "protocol", "value": "optical", "namespace": "bypassing" }, { "key": "bandwidth", "value": "digital", "namespace": "bypassing" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "2de225b1-60ad-43bf-be61-7a5d9a607621", "display_name": "shanahan.test", "groups": [], "culled_timestamp": "2036-06-09T10:20:58.358Z", "last_check_in": "2036-06-03T10:20:58.358Z", "stale_timestamp": "2036-05-26T10:20:58.358Z", "stale_warning_timestamp": "2036-06-02T10:20:58.358Z", "updated": "2026-05-26T10:20:58.358Z", "insights_id": null, "tags": [ { "key": "interface", "value": "bluetooth", "namespace": "programming" }, { "key": "sensor", "value": "bluetooth", "namespace": "transmitting" }, { "key": "protocol", "value": "online", "namespace": "generating" }, { "key": "interface", "value": "1080p", "namespace": "indexing" }, { "key": "monitor", "value": "neural", "namespace": "copying" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "33ca2eeb-4272-4f93-95a4-1c25fda88c3c", "display_name": "howe.example", "groups": [], "culled_timestamp": "2036-06-09T10:20:58.354Z", "last_check_in": "2036-06-03T10:20:58.354Z", "stale_timestamp": "2036-05-26T10:20:58.354Z", "stale_warning_timestamp": "2036-06-02T10:20:58.354Z", "updated": "2026-05-26T10:20:58.354Z", "insights_id": null, "tags": [ { "key": "sensor", "value": "open-source", "namespace": "overriding" }, { "key": "interface", "value": "solid state", "namespace": "hacking" }, { "key": "panel", "value": "haptic", "namespace": "parsing" }, { "key": "monitor", "value": "virtual", "namespace": "synthesizing" }, { "key": "monitor", "value": "cross-platform", "namespace": "transmitting" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "4073ac49-44f3-4838-ae02-edae42d94e10", "display_name": "rau.example", "groups": [], "culled_timestamp": "2036-06-09T10:20:58.348Z", "last_check_in": "2036-06-03T10:20:58.348Z", "stale_timestamp": "2036-05-26T10:20:58.348Z", "stale_warning_timestamp": "2036-06-02T10:20:58.348Z", "updated": "2026-05-26T10:20:58.348Z", "insights_id": null, "tags": [ { "key": "driver", "value": "wireless", "namespace": "generating" }, { "key": "port", "value": "online", "namespace": "indexing" }, { "key": "microchip", "value": "open-source", "namespace": "copying" }, { "key": "transmitter", "value": "digital", "namespace": "navigating" }, { "key": "application", "value": "cross-platform", "namespace": "hacking" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "465d63df-9e9a-4aa2-8020-0cf8d9f2f017", "display_name": "durgan.example", "groups": [], "culled_timestamp": "2036-06-09T10:20:58.364Z", "last_check_in": "2036-06-03T10:20:58.364Z", "stale_timestamp": "2036-05-26T10:20:58.364Z", "stale_warning_timestamp": "2036-06-02T10:20:58.364Z", "updated": "2026-05-26T10:20:58.364Z", "insights_id": null, "tags": [ { "key": "feed", "value": "neural", "namespace": "calculating" }, { "key": "program", "value": "solid state", "namespace": "indexing" }, { "key": "driver", "value": "mobile", "namespace": "compressing" }, { "key": "bus", "value": "wireless", "namespace": "bypassing" }, { "key": "circuit", "value": "online", "namespace": "hacking" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "48e5c248-fd04-4bcf-8c61-7e94cfe0da91", "display_name": "senger-crooks.test", "groups": [], "culled_timestamp": "2036-06-09T10:20:58.365Z", "last_check_in": "2036-06-03T10:20:58.365Z", "stale_timestamp": "2036-05-26T10:20:58.365Z", "stale_warning_timestamp": "2036-06-02T10:20:58.365Z", "updated": "2026-05-26T10:20:58.365Z", "insights_id": null, "tags": [ { "key": "matrix", "value": "online", "namespace": "connecting" }, { "key": "pixel", "value": "cross-platform", "namespace": "connecting" }, { "key": "port", "value": "redundant", "namespace": "generating" }, { "key": "pixel", "value": "optical", "namespace": "parsing" }, { "key": "matrix", "value": "back-end", "namespace": "connecting" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "4f549368-9a61-42a6-81df-287eb583e591", "display_name": "howell.test", "groups": [], "culled_timestamp": "2036-06-09T10:20:58.372Z", "last_check_in": "2036-06-03T10:20:58.372Z", "stale_timestamp": "2036-05-26T10:20:58.372Z", "stale_warning_timestamp": "2036-06-02T10:20:58.372Z", "updated": "2026-05-26T10:20:58.372Z", "insights_id": null, "tags": [ { "key": "feed", "value": "multi-byte", "namespace": "bypassing" }, { "key": "matrix", "value": "multi-byte", "namespace": "generating" }, { "key": "protocol", "value": "optical", "namespace": "calculating" }, { "key": "circuit", "value": "mobile", "namespace": "calculating" }, { "key": "feed", "value": "online", "namespace": "parsing" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] } ], "meta": { "total": 25, "filter": "(os_major_version=8)", "tags": [], "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/systems?filter=%28os_major_version%3D8%29&limit=10&offset=0", "last": "/api/compliance/v2/systems?filter=%28os_major_version%3D8%29&limit=10&offset=20", "next": "/api/compliance/v2/systems?filter=%28os_major_version%3D8%29&limit=10&offset=10" } }, "summary": "", "description": "" } }, "schema": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/metadata" }, "links": { "$ref": "#/components/schemas/links" }, "data": { "type": "array", "items": { "properties": { "schema": { "$ref": "#/components/schemas/system" } } } } } } } } }, "422": { "description": "Returns with Unprocessable Content", "content": { "application/vnd.api+json": { "examples": { "Description of an error when sorting by incorrect parameter": { "value": { "errors": [ "Result cannot be sorted by the 'description' column." ] }, "summary": "", "description": "" }, "Description of an error when requesting higher limit than supported": { "value": { "errors": [ "Invalid parameter: limit must be less than or equal to 100" ] }, "summary": "", "description": "" } }, "schema": { "$ref": "#/components/schemas/errors" } } } } } } }, "/systems/os_versions": { "get": { "summary": "Request the list of available OS versions", "parameters": [ { "name": "X-RH-IDENTITY", "in": "header", "schema": { "type": "string" }, "description": "For internal use only" }, { "name": "filter", "in": "query", "required": false, "description": "Query string to filter items by their attributes. Compliant with scoped_search query language. However, only `=` or `!=` (resp. `<>`) operators are supported.

Systems are searchable using attributes `display_name`, `os_version`, `os_major_version`, `os_minor_version`, `assigned_or_scanned`, `never_reported`, `group_name`, `group_id`, `policies`, and `profile_ref_id`

(e.g.: `(field_1=something AND field_2!=\"something else\") OR field_3>40`)", "schema": { "type": "string" } } ], "tags": [ "Systems" ], "description": "This feature is exclusively used by the frontend.", "operationId": "SystemsOS", "deprecated": true, "responses": { "200": { "description": "Lists available OS versions", "content": { "application/vnd.api+json": { "examples": { "List of available OS versions": { "value": [ "8.0" ], "summary": "", "description": "" } }, "schema": { "type": "array", "items": { "type": "string" } } } } } } } }, "/systems/{system_id}": { "get": { "summary": "Request a System", "parameters": [ { "name": "X-RH-IDENTITY", "in": "header", "schema": { "type": "string" }, "description": "For internal use only" }, { "name": "system_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "Systems" ], "description": "Get information about one specific system.", "operationId": "System", "responses": { "200": { "description": "Returns a System", "content": { "application/vnd.api+json": { "examples": { "Returns a System": { "value": { "data": { "id": "a2a86cb5-f288-4d2f-80f2-d7011b2afa0e", "display_name": "stroman.example", "groups": [], "culled_timestamp": "2036-06-09T10:20:58.704Z", "last_check_in": "2036-06-03T10:20:58.704Z", "stale_timestamp": "2036-05-26T10:20:58.704Z", "stale_warning_timestamp": "2036-06-02T10:20:58.704Z", "updated": "2026-05-26T10:20:58.704Z", "insights_id": null, "tags": [ { "key": "transmitter", "value": "1080p", "namespace": "synthesizing" }, { "key": "card", "value": "cross-platform", "namespace": "overriding" }, { "key": "transmitter", "value": "digital", "namespace": "navigating" }, { "key": "alarm", "value": "haptic", "namespace": "copying" }, { "key": "firewall", "value": "1080p", "namespace": "navigating" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] } }, "summary": "", "description": "" } }, "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/system" } } } } } } } }, "404": { "description": "Returns with Not Found", "content": { "application/vnd.api+json": { "examples": { "Description of an error when requesting a non-existing System": { "value": { "errors": [ "V2::System not found with ID e6246868-faf0-41dc-82ea-d27b36ac27da" ] }, "summary": "", "description": "" } }, "schema": { "$ref": "#/components/schemas/errors" } } } } } } }, "/policies/{policy_id}/systems": { "get": { "summary": "Request Systems assigned to a Policy", "parameters": [ { "name": "X-RH-IDENTITY", "in": "header", "schema": { "type": "string" }, "description": "For internal use only" }, { "name": "tags", "in": "query", "required": false, "description": "An array of tags to narrow down the search results. In case the value contains symbols used for separators (`/` or `=`), they need to be encoded.
e.g.: `namespace/key=value`, `insights-client/selinux-config=SELINUX%3Denforcing`", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "limit", "in": "query", "required": false, "description": "Number of items to return per page", "schema": { "type": "number", "maximum": 100, "minimum": 1, "default": 10 } }, { "name": "offset", "in": "query", "required": false, "description": "Offset of first item of paginated response", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "ids_only", "in": "query", "required": false, "description": "Indicates whether to return only resource IDs.", "schema": { "type": "boolean" } }, { "name": "sort_by", "in": "query", "required": false, "description": "Attribute and direction to sort the items by. Represented by an array of fields with an optional direction (`:asc` or `:desc`).

If no direction is selected, `:asc` is used by default.", "schema": { "type": "array", "items": { "enum": [ "display_name", "os_minor_version", "os_version", "groups", "display_name:asc", "display_name:desc", "os_minor_version:asc", "os_minor_version:desc", "os_version:asc", "os_version:desc", "groups:asc", "groups:desc" ] } } }, { "name": "filter", "in": "query", "required": false, "description": "Query string to filter items by their attributes. Compliant with scoped_search query language. However, only `=` or `!=` (resp. `<>`) operators are supported.

Systems are searchable using attributes `display_name`, `os_minor_version`, `group_name`, and `group_id`

(e.g.: `(field_1=something AND field_2!=\"something else\") OR field_3>40`)", "schema": { "type": "string" } }, { "name": "policy_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "Policies" ], "description": "Retrieve all of the systems assigned to a specific policy.", "operationId": "PolicySystems", "responses": { "200": { "description": "Lists Systems assigned to a Policy", "content": { "application/vnd.api+json": { "examples": { "List of Systems": { "value": { "data": [ { "id": "0706e1b7-474d-4810-9020-0ac79beb6d47", "display_name": "renner.test", "groups": [], "culled_timestamp": "2036-06-09T10:20:58.970Z", "last_check_in": "2036-06-03T10:20:58.970Z", "stale_timestamp": "2036-05-26T10:20:58.970Z", "stale_warning_timestamp": "2036-06-02T10:20:58.970Z", "updated": "2026-05-26T10:20:58.970Z", "insights_id": null, "tags": [ { "key": "bandwidth", "value": "bluetooth", "namespace": "navigating" }, { "key": "program", "value": "haptic", "namespace": "calculating" }, { "key": "port", "value": "online", "namespace": "connecting" }, { "key": "interface", "value": "1080p", "namespace": "bypassing" }, { "key": "bandwidth", "value": "haptic", "namespace": "quantifying" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "098bc9d6-5145-4fa4-b16a-76d3993e5617", "display_name": "schultz.test", "groups": [], "culled_timestamp": "2036-06-09T10:20:58.885Z", "last_check_in": "2036-06-03T10:20:58.885Z", "stale_timestamp": "2036-05-26T10:20:58.885Z", "stale_warning_timestamp": "2036-06-02T10:20:58.885Z", "updated": "2026-05-26T10:20:58.885Z", "insights_id": null, "tags": [ { "key": "card", "value": "solid state", "namespace": "navigating" }, { "key": "panel", "value": "back-end", "namespace": "backing up" }, { "key": "card", "value": "1080p", "namespace": "copying" }, { "key": "interface", "value": "solid state", "namespace": "connecting" }, { "key": "driver", "value": "online", "namespace": "backing up" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "10cbf5e9-89d5-45da-91f4-995437f5408b", "display_name": "dickinson.example", "groups": [], "culled_timestamp": "2036-06-09T10:20:58.822Z", "last_check_in": "2036-06-03T10:20:58.822Z", "stale_timestamp": "2036-05-26T10:20:58.822Z", "stale_warning_timestamp": "2036-06-02T10:20:58.822Z", "updated": "2026-05-26T10:20:58.822Z", "insights_id": null, "tags": [ { "key": "pixel", "value": "primary", "namespace": "parsing" }, { "key": "application", "value": "cross-platform", "namespace": "bypassing" }, { "key": "array", "value": "1080p", "namespace": "quantifying" }, { "key": "card", "value": "cross-platform", "namespace": "navigating" }, { "key": "driver", "value": "wireless", "namespace": "synthesizing" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "249fb2db-aa27-4213-b13a-2154f1fee3b7", "display_name": "greenfelder.test", "groups": [], "culled_timestamp": "2036-06-09T10:20:58.960Z", "last_check_in": "2036-06-03T10:20:58.960Z", "stale_timestamp": "2036-05-26T10:20:58.960Z", "stale_warning_timestamp": "2036-06-02T10:20:58.960Z", "updated": "2026-05-26T10:20:58.960Z", "insights_id": null, "tags": [ { "key": "feed", "value": "primary", "namespace": "hacking" }, { "key": "hard drive", "value": "online", "namespace": "compressing" }, { "key": "monitor", "value": "virtual", "namespace": "quantifying" }, { "key": "capacitor", "value": "solid state", "namespace": "generating" }, { "key": "transmitter", "value": "haptic", "namespace": "programming" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "2993570c-602f-4df5-a1d8-73e115686bed", "display_name": "homenick.test", "groups": [], "culled_timestamp": "2036-06-09T10:20:59.011Z", "last_check_in": "2036-06-03T10:20:59.011Z", "stale_timestamp": "2036-05-26T10:20:59.011Z", "stale_warning_timestamp": "2036-06-02T10:20:59.011Z", "updated": "2026-05-26T10:20:59.012Z", "insights_id": null, "tags": [ { "key": "capacitor", "value": "primary", "namespace": "overriding" }, { "key": "program", "value": "redundant", "namespace": "parsing" }, { "key": "panel", "value": "1080p", "namespace": "connecting" }, { "key": "firewall", "value": "digital", "namespace": "programming" }, { "key": "monitor", "value": "open-source", "namespace": "indexing" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "2c7c37f4-67b0-4f54-9752-29065e614af6", "display_name": "hegmann-nader.example", "groups": [], "culled_timestamp": "2036-06-09T10:20:58.915Z", "last_check_in": "2036-06-03T10:20:58.915Z", "stale_timestamp": "2036-05-26T10:20:58.915Z", "stale_warning_timestamp": "2036-06-02T10:20:58.915Z", "updated": "2026-05-26T10:20:58.915Z", "insights_id": null, "tags": [ { "key": "capacitor", "value": "redundant", "namespace": "compressing" }, { "key": "capacitor", "value": "bluetooth", "namespace": "navigating" }, { "key": "driver", "value": "cross-platform", "namespace": "overriding" }, { "key": "capacitor", "value": "mobile", "namespace": "programming" }, { "key": "microchip", "value": "virtual", "namespace": "transmitting" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "35ef490c-e148-41b0-b94b-9b145ccaaa7e", "display_name": "kautzer-reilly.test", "groups": [], "culled_timestamp": "2036-06-09T10:20:58.785Z", "last_check_in": "2036-06-03T10:20:58.785Z", "stale_timestamp": "2036-05-26T10:20:58.785Z", "stale_warning_timestamp": "2036-06-02T10:20:58.785Z", "updated": "2026-05-26T10:20:58.785Z", "insights_id": null, "tags": [ { "key": "monitor", "value": "1080p", "namespace": "backing up" }, { "key": "panel", "value": "1080p", "namespace": "overriding" }, { "key": "interface", "value": "virtual", "namespace": "hacking" }, { "key": "application", "value": "digital", "namespace": "hacking" }, { "key": "sensor", "value": "multi-byte", "namespace": "overriding" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "400ae832-60a2-416a-b422-c9920ebc00f8", "display_name": "ohara.test", "groups": [], "culled_timestamp": "2036-06-09T10:20:58.980Z", "last_check_in": "2036-06-03T10:20:58.980Z", "stale_timestamp": "2036-05-26T10:20:58.980Z", "stale_warning_timestamp": "2036-06-02T10:20:58.980Z", "updated": "2026-05-26T10:20:58.980Z", "insights_id": null, "tags": [ { "key": "driver", "value": "bluetooth", "namespace": "compressing" }, { "key": "driver", "value": "redundant", "namespace": "bypassing" }, { "key": "array", "value": "digital", "namespace": "synthesizing" }, { "key": "transmitter", "value": "solid state", "namespace": "backing up" }, { "key": "program", "value": "bluetooth", "namespace": "indexing" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "58ea4d67-3752-4e32-b76f-4472a96783d5", "display_name": "gerhold.test", "groups": [], "culled_timestamp": "2036-06-09T10:20:59.021Z", "last_check_in": "2036-06-03T10:20:59.021Z", "stale_timestamp": "2036-05-26T10:20:59.021Z", "stale_warning_timestamp": "2036-06-02T10:20:59.021Z", "updated": "2026-05-26T10:20:59.021Z", "insights_id": null, "tags": [ { "key": "interface", "value": "mobile", "namespace": "quantifying" }, { "key": "protocol", "value": "auxiliary", "namespace": "calculating" }, { "key": "matrix", "value": "redundant", "namespace": "parsing" }, { "key": "driver", "value": "haptic", "namespace": "overriding" }, { "key": "hard drive", "value": "digital", "namespace": "hacking" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "66ffcb4a-4db1-4362-a4f8-8b17fed6e647", "display_name": "dach.test", "groups": [], "culled_timestamp": "2036-06-09T10:20:58.794Z", "last_check_in": "2036-06-03T10:20:58.794Z", "stale_timestamp": "2036-05-26T10:20:58.794Z", "stale_warning_timestamp": "2036-06-02T10:20:58.794Z", "updated": "2026-05-26T10:20:58.794Z", "insights_id": null, "tags": [ { "key": "alarm", "value": "virtual", "namespace": "overriding" }, { "key": "monitor", "value": "optical", "namespace": "synthesizing" }, { "key": "firewall", "value": "mobile", "namespace": "connecting" }, { "key": "driver", "value": "digital", "namespace": "backing up" }, { "key": "alarm", "value": "virtual", "namespace": "quantifying" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 } ], "meta": { "total": 25, "tags": [], "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/policies/bf74e612-c0b8-4921-ab7d-6d9647b87916/systems?limit=10&offset=0", "last": "/api/compliance/v2/policies/bf74e612-c0b8-4921-ab7d-6d9647b87916/systems?limit=10&offset=20", "next": "/api/compliance/v2/policies/bf74e612-c0b8-4921-ab7d-6d9647b87916/systems?limit=10&offset=10" } }, "summary": "", "description": "" }, "List of Systems sorted by \"os_minor_version:asc\"": { "value": { "data": [ { "id": "1ae9479c-30af-4fdc-87ac-0c6d006a9b36", "display_name": "russel-schultz.example", "groups": [], "culled_timestamp": "2036-06-09T10:20:59.192Z", "last_check_in": "2036-06-03T10:20:59.192Z", "stale_timestamp": "2036-05-26T10:20:59.192Z", "stale_warning_timestamp": "2036-06-02T10:20:59.192Z", "updated": "2026-05-26T10:20:59.192Z", "insights_id": null, "tags": [ { "key": "interface", "value": "wireless", "namespace": "navigating" }, { "key": "bandwidth", "value": "bluetooth", "namespace": "generating" }, { "key": "panel", "value": "neural", "namespace": "transmitting" }, { "key": "hard drive", "value": "digital", "namespace": "overriding" }, { "key": "bandwidth", "value": "virtual", "namespace": "navigating" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "1c0f3f13-8bd4-4226-a651-07c138ca552f", "display_name": "sauer-gutmann.test", "groups": [], "culled_timestamp": "2036-06-09T10:20:59.287Z", "last_check_in": "2036-06-03T10:20:59.287Z", "stale_timestamp": "2036-05-26T10:20:59.287Z", "stale_warning_timestamp": "2036-06-02T10:20:59.287Z", "updated": "2026-05-26T10:20:59.287Z", "insights_id": null, "tags": [ { "key": "protocol", "value": "virtual", "namespace": "synthesizing" }, { "key": "protocol", "value": "back-end", "namespace": "hacking" }, { "key": "circuit", "value": "open-source", "namespace": "synthesizing" }, { "key": "matrix", "value": "haptic", "namespace": "compressing" }, { "key": "array", "value": "cross-platform", "namespace": "generating" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "2174b57c-7a81-4e32-b53b-a1ec2286de25", "display_name": "cummings.test", "groups": [], "culled_timestamp": "2036-06-09T10:20:59.319Z", "last_check_in": "2036-06-03T10:20:59.319Z", "stale_timestamp": "2036-05-26T10:20:59.319Z", "stale_warning_timestamp": "2036-06-02T10:20:59.319Z", "updated": "2026-05-26T10:20:59.319Z", "insights_id": null, "tags": [ { "key": "sensor", "value": "neural", "namespace": "connecting" }, { "key": "card", "value": "digital", "namespace": "overriding" }, { "key": "circuit", "value": "neural", "namespace": "synthesizing" }, { "key": "port", "value": "solid state", "namespace": "indexing" }, { "key": "bandwidth", "value": "optical", "namespace": "overriding" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "2aa5a809-0932-4921-80d1-a170b6ef7201", "display_name": "mertz.example", "groups": [], "culled_timestamp": "2036-06-09T10:20:59.139Z", "last_check_in": "2036-06-03T10:20:59.139Z", "stale_timestamp": "2036-05-26T10:20:59.139Z", "stale_warning_timestamp": "2036-06-02T10:20:59.139Z", "updated": "2026-05-26T10:20:59.139Z", "insights_id": null, "tags": [ { "key": "bus", "value": "neural", "namespace": "generating" }, { "key": "firewall", "value": "haptic", "namespace": "generating" }, { "key": "protocol", "value": "auxiliary", "namespace": "bypassing" }, { "key": "sensor", "value": "1080p", "namespace": "programming" }, { "key": "alarm", "value": "wireless", "namespace": "compressing" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "2af2d150-8137-4974-81f8-f9d1cb8193c4", "display_name": "graham-zulauf.test", "groups": [], "culled_timestamp": "2036-06-09T10:20:59.276Z", "last_check_in": "2036-06-03T10:20:59.276Z", "stale_timestamp": "2036-05-26T10:20:59.276Z", "stale_warning_timestamp": "2036-06-02T10:20:59.276Z", "updated": "2026-05-26T10:20:59.276Z", "insights_id": null, "tags": [ { "key": "matrix", "value": "digital", "namespace": "navigating" }, { "key": "capacitor", "value": "optical", "namespace": "transmitting" }, { "key": "circuit", "value": "bluetooth", "namespace": "synthesizing" }, { "key": "capacitor", "value": "virtual", "namespace": "calculating" }, { "key": "hard drive", "value": "wireless", "namespace": "generating" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "2ed86f13-b25d-42ca-9bd0-22f5b2d31cb8", "display_name": "fadel.example", "groups": [], "culled_timestamp": "2036-06-09T10:20:59.074Z", "last_check_in": "2036-06-03T10:20:59.074Z", "stale_timestamp": "2036-05-26T10:20:59.074Z", "stale_warning_timestamp": "2036-06-02T10:20:59.074Z", "updated": "2026-05-26T10:20:59.074Z", "insights_id": null, "tags": [ { "key": "panel", "value": "open-source", "namespace": "compressing" }, { "key": "pixel", "value": "wireless", "namespace": "copying" }, { "key": "bus", "value": "mobile", "namespace": "synthesizing" }, { "key": "feed", "value": "solid state", "namespace": "parsing" }, { "key": "protocol", "value": "digital", "namespace": "backing up" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "31f01f04-5590-4f1b-8056-0db791ed8252", "display_name": "moore.example", "groups": [], "culled_timestamp": "2036-06-09T10:20:59.171Z", "last_check_in": "2036-06-03T10:20:59.171Z", "stale_timestamp": "2036-05-26T10:20:59.171Z", "stale_warning_timestamp": "2036-06-02T10:20:59.171Z", "updated": "2026-05-26T10:20:59.171Z", "insights_id": null, "tags": [ { "key": "microchip", "value": "redundant", "namespace": "parsing" }, { "key": "pixel", "value": "back-end", "namespace": "navigating" }, { "key": "panel", "value": "digital", "namespace": "parsing" }, { "key": "interface", "value": "optical", "namespace": "synthesizing" }, { "key": "bandwidth", "value": "optical", "namespace": "compressing" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "4383a007-bb0c-421c-b3e2-5841bf4bc888", "display_name": "kub-thompson.test", "groups": [], "culled_timestamp": "2036-06-09T10:20:59.223Z", "last_check_in": "2036-06-03T10:20:59.223Z", "stale_timestamp": "2036-05-26T10:20:59.223Z", "stale_warning_timestamp": "2036-06-02T10:20:59.223Z", "updated": "2026-05-26T10:20:59.223Z", "insights_id": null, "tags": [ { "key": "microchip", "value": "solid state", "namespace": "backing up" }, { "key": "hard drive", "value": "cross-platform", "namespace": "parsing" }, { "key": "hard drive", "value": "neural", "namespace": "indexing" }, { "key": "card", "value": "optical", "namespace": "programming" }, { "key": "driver", "value": "wireless", "namespace": "programming" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "5a91cb09-3487-4cb6-9ac8-c8a00fc847ab", "display_name": "legros.test", "groups": [], "culled_timestamp": "2036-06-09T10:20:59.151Z", "last_check_in": "2036-06-03T10:20:59.151Z", "stale_timestamp": "2036-05-26T10:20:59.151Z", "stale_warning_timestamp": "2036-06-02T10:20:59.151Z", "updated": "2026-05-26T10:20:59.151Z", "insights_id": null, "tags": [ { "key": "driver", "value": "bluetooth", "namespace": "backing up" }, { "key": "card", "value": "multi-byte", "namespace": "copying" }, { "key": "transmitter", "value": "cross-platform", "namespace": "programming" }, { "key": "panel", "value": "primary", "namespace": "bypassing" }, { "key": "port", "value": "open-source", "namespace": "programming" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "6e121a4c-f6f3-4362-bbdf-baa49165eded", "display_name": "gibson.example", "groups": [], "culled_timestamp": "2036-06-09T10:20:59.161Z", "last_check_in": "2036-06-03T10:20:59.161Z", "stale_timestamp": "2036-05-26T10:20:59.161Z", "stale_warning_timestamp": "2036-06-02T10:20:59.161Z", "updated": "2026-05-26T10:20:59.161Z", "insights_id": null, "tags": [ { "key": "bus", "value": "solid state", "namespace": "transmitting" }, { "key": "matrix", "value": "primary", "namespace": "parsing" }, { "key": "protocol", "value": "1080p", "namespace": "navigating" }, { "key": "system", "value": "neural", "namespace": "connecting" }, { "key": "capacitor", "value": "solid state", "namespace": "bypassing" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 } ], "meta": { "total": 25, "tags": [], "limit": 10, "offset": 0, "sort_by": "os_minor_version" }, "links": { "first": "/api/compliance/v2/policies/775b1500-a751-49c5-832c-a91f76681376/systems?limit=10&offset=0&sort_by=os_minor_version", "last": "/api/compliance/v2/policies/775b1500-a751-49c5-832c-a91f76681376/systems?limit=10&offset=20&sort_by=os_minor_version", "next": "/api/compliance/v2/policies/775b1500-a751-49c5-832c-a91f76681376/systems?limit=10&offset=10&sort_by=os_minor_version" } }, "summary": "", "description": "" }, "List of Systems filtered by \"(os_minor_version=0)\"": { "value": { "data": [ { "id": "021fe975-f0fc-4266-a2b4-39e6c09ef66a", "display_name": "wilderman.example", "groups": [], "culled_timestamp": "2036-06-09T10:20:59.675Z", "last_check_in": "2036-06-03T10:20:59.675Z", "stale_timestamp": "2036-05-26T10:20:59.675Z", "stale_warning_timestamp": "2036-06-02T10:20:59.675Z", "updated": "2026-05-26T10:20:59.676Z", "insights_id": null, "tags": [ { "key": "bus", "value": "1080p", "namespace": "transmitting" }, { "key": "card", "value": "primary", "namespace": "parsing" }, { "key": "system", "value": "cross-platform", "namespace": "connecting" }, { "key": "bandwidth", "value": "mobile", "namespace": "generating" }, { "key": "protocol", "value": "online", "namespace": "indexing" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "1159caae-8fd7-474a-bd4f-a1d267c8211d", "display_name": "ullrich.example", "groups": [], "culled_timestamp": "2036-06-09T10:20:59.396Z", "last_check_in": "2036-06-03T10:20:59.396Z", "stale_timestamp": "2036-05-26T10:20:59.396Z", "stale_warning_timestamp": "2036-06-02T10:20:59.396Z", "updated": "2026-05-26T10:20:59.397Z", "insights_id": null, "tags": [ { "key": "protocol", "value": "bluetooth", "namespace": "calculating" }, { "key": "microchip", "value": "virtual", "namespace": "navigating" }, { "key": "program", "value": "haptic", "namespace": "programming" }, { "key": "card", "value": "online", "namespace": "transmitting" }, { "key": "transmitter", "value": "neural", "namespace": "parsing" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "12f7b11f-6e68-4ddf-8f83-a681ef3f298c", "display_name": "gutmann.test", "groups": [], "culled_timestamp": "2036-06-09T10:20:59.625Z", "last_check_in": "2036-06-03T10:20:59.625Z", "stale_timestamp": "2036-05-26T10:20:59.625Z", "stale_warning_timestamp": "2036-06-02T10:20:59.625Z", "updated": "2026-05-26T10:20:59.625Z", "insights_id": null, "tags": [ { "key": "protocol", "value": "redundant", "namespace": "generating" }, { "key": "hard drive", "value": "back-end", "namespace": "generating" }, { "key": "port", "value": "digital", "namespace": "quantifying" }, { "key": "array", "value": "optical", "namespace": "connecting" }, { "key": "firewall", "value": "wireless", "namespace": "connecting" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "14a5b0f3-4f30-4d2f-b333-f3dee1a4bd7d", "display_name": "daugherty.example", "groups": [], "culled_timestamp": "2036-06-09T10:20:59.458Z", "last_check_in": "2036-06-03T10:20:59.458Z", "stale_timestamp": "2036-05-26T10:20:59.458Z", "stale_warning_timestamp": "2036-06-02T10:20:59.458Z", "updated": "2026-05-26T10:20:59.458Z", "insights_id": null, "tags": [ { "key": "feed", "value": "mobile", "namespace": "overriding" }, { "key": "sensor", "value": "multi-byte", "namespace": "generating" }, { "key": "capacitor", "value": "back-end", "namespace": "synthesizing" }, { "key": "system", "value": "back-end", "namespace": "copying" }, { "key": "transmitter", "value": "cross-platform", "namespace": "synthesizing" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "16d7f2d3-7048-42f5-af0f-71ee1c3b4238", "display_name": "lehner-witting.test", "groups": [], "culled_timestamp": "2036-06-09T10:20:59.410Z", "last_check_in": "2036-06-03T10:20:59.410Z", "stale_timestamp": "2036-05-26T10:20:59.410Z", "stale_warning_timestamp": "2036-06-02T10:20:59.410Z", "updated": "2026-05-26T10:20:59.410Z", "insights_id": null, "tags": [ { "key": "protocol", "value": "wireless", "namespace": "navigating" }, { "key": "port", "value": "primary", "namespace": "connecting" }, { "key": "capacitor", "value": "open-source", "namespace": "indexing" }, { "key": "protocol", "value": "mobile", "namespace": "hacking" }, { "key": "circuit", "value": "optical", "namespace": "copying" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "210bef1d-0c9f-4cd2-8a25-d52d9e0432dd", "display_name": "wisozk-hackett.test", "groups": [], "culled_timestamp": "2036-06-09T10:20:59.473Z", "last_check_in": "2036-06-03T10:20:59.473Z", "stale_timestamp": "2036-05-26T10:20:59.473Z", "stale_warning_timestamp": "2036-06-02T10:20:59.473Z", "updated": "2026-05-26T10:20:59.473Z", "insights_id": null, "tags": [ { "key": "driver", "value": "virtual", "namespace": "calculating" }, { "key": "system", "value": "redundant", "namespace": "overriding" }, { "key": "alarm", "value": "digital", "namespace": "generating" }, { "key": "firewall", "value": "back-end", "namespace": "navigating" }, { "key": "firewall", "value": "auxiliary", "namespace": "copying" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "24c12e00-1ef7-46ab-a0c4-41dcd8dd82e1", "display_name": "rohan.example", "groups": [], "culled_timestamp": "2036-06-09T10:20:59.558Z", "last_check_in": "2036-06-03T10:20:59.558Z", "stale_timestamp": "2036-05-26T10:20:59.558Z", "stale_warning_timestamp": "2036-06-02T10:20:59.558Z", "updated": "2026-05-26T10:20:59.558Z", "insights_id": null, "tags": [ { "key": "capacitor", "value": "haptic", "namespace": "hacking" }, { "key": "microchip", "value": "neural", "namespace": "generating" }, { "key": "system", "value": "primary", "namespace": "calculating" }, { "key": "capacitor", "value": "cross-platform", "namespace": "calculating" }, { "key": "feed", "value": "auxiliary", "namespace": "quantifying" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "2c75af7e-83ac-4fc6-844f-9a6bd55c7d1e", "display_name": "feeney.test", "groups": [], "culled_timestamp": "2036-06-09T10:20:59.657Z", "last_check_in": "2036-06-03T10:20:59.657Z", "stale_timestamp": "2036-05-26T10:20:59.657Z", "stale_warning_timestamp": "2036-06-02T10:20:59.657Z", "updated": "2026-05-26T10:20:59.657Z", "insights_id": null, "tags": [ { "key": "monitor", "value": "haptic", "namespace": "hacking" }, { "key": "program", "value": "redundant", "namespace": "indexing" }, { "key": "alarm", "value": "cross-platform", "namespace": "synthesizing" }, { "key": "microchip", "value": "digital", "namespace": "transmitting" }, { "key": "system", "value": "neural", "namespace": "generating" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "3f59f684-df65-442c-b597-b369396f49b7", "display_name": "christiansen.example", "groups": [], "culled_timestamp": "2036-06-09T10:20:59.637Z", "last_check_in": "2036-06-03T10:20:59.637Z", "stale_timestamp": "2036-05-26T10:20:59.637Z", "stale_warning_timestamp": "2036-06-02T10:20:59.637Z", "updated": "2026-05-26T10:20:59.637Z", "insights_id": null, "tags": [ { "key": "capacitor", "value": "redundant", "namespace": "programming" }, { "key": "hard drive", "value": "cross-platform", "namespace": "parsing" }, { "key": "system", "value": "1080p", "namespace": "calculating" }, { "key": "port", "value": "bluetooth", "namespace": "hacking" }, { "key": "array", "value": "optical", "namespace": "navigating" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "45b71a41-ae55-4118-9e21-b9f516b0e41c", "display_name": "feil.example", "groups": [], "culled_timestamp": "2036-06-09T10:20:59.443Z", "last_check_in": "2036-06-03T10:20:59.443Z", "stale_timestamp": "2036-05-26T10:20:59.443Z", "stale_warning_timestamp": "2036-06-02T10:20:59.443Z", "updated": "2026-05-26T10:20:59.443Z", "insights_id": null, "tags": [ { "key": "bandwidth", "value": "wireless", "namespace": "hacking" }, { "key": "monitor", "value": "wireless", "namespace": "generating" }, { "key": "hard drive", "value": "mobile", "namespace": "programming" }, { "key": "card", "value": "haptic", "namespace": "bypassing" }, { "key": "driver", "value": "optical", "namespace": "generating" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 } ], "meta": { "total": 25, "filter": "(os_minor_version=0)", "tags": [], "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/policies/7e25fef8-90d0-4334-8b33-c58316fc35a8/systems?filter=%28os_minor_version%3D0%29&limit=10&offset=0", "last": "/api/compliance/v2/policies/7e25fef8-90d0-4334-8b33-c58316fc35a8/systems?filter=%28os_minor_version%3D0%29&limit=10&offset=20", "next": "/api/compliance/v2/policies/7e25fef8-90d0-4334-8b33-c58316fc35a8/systems?filter=%28os_minor_version%3D0%29&limit=10&offset=10" } }, "summary": "", "description": "" } }, "schema": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/metadata" }, "links": { "$ref": "#/components/schemas/links" }, "data": { "type": "array", "items": { "properties": { "schema": { "$ref": "#/components/schemas/system" } } } } } } } } }, "422": { "description": "Returns with Unprocessable Content", "content": { "application/vnd.api+json": { "examples": { "Description of an error when sorting by incorrect parameter": { "value": { "errors": [ "Result cannot be sorted by the 'description' column." ] }, "summary": "", "description": "" }, "Description of an error when requesting higher limit than supported": { "value": { "errors": [ "Invalid parameter: limit must be less than or equal to 100" ] }, "summary": "", "description": "" } }, "schema": { "$ref": "#/components/schemas/errors" } } } } } }, "post": { "summary": "Bulk assign Systems to a Policy", "parameters": [ { "name": "X-RH-IDENTITY", "in": "header", "schema": { "type": "string" }, "description": "For internal use only" }, { "name": "policy_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "Policies" ], "description": "This feature is exclusively used by the frontend", "deprecated": true, "operationId": "AssignSystems", "responses": { "202": { "description": "Assigns all specified systems and unassigns the rest", "content": { "application/vnd.api+json": { "examples": { "List of assigned Systems": { "value": { "data": [ { "id": "2bb7d891-1d21-4644-9cea-72354a5f9007", "display_name": "gislason.example", "groups": [], "culled_timestamp": "2036-06-09T10:21:00.574Z", "last_check_in": "2036-06-03T10:21:00.574Z", "stale_timestamp": "2036-05-26T10:21:00.574Z", "stale_warning_timestamp": "2036-06-02T10:21:00.574Z", "updated": "2026-05-26T10:21:00.574Z", "insights_id": null, "tags": [ { "key": "circuit", "value": "primary", "namespace": "programming" }, { "key": "array", "value": "1080p", "namespace": "transmitting" }, { "key": "sensor", "value": "auxiliary", "namespace": "quantifying" }, { "key": "panel", "value": "virtual", "namespace": "indexing" }, { "key": "array", "value": "back-end", "namespace": "programming" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "40166233-efda-45da-b404-f96ec11178d1", "display_name": "boehm.test", "groups": [], "culled_timestamp": "2036-06-09T10:21:00.569Z", "last_check_in": "2036-06-03T10:21:00.569Z", "stale_timestamp": "2036-05-26T10:21:00.569Z", "stale_warning_timestamp": "2036-06-02T10:21:00.569Z", "updated": "2026-05-26T10:21:00.569Z", "insights_id": null, "tags": [ { "key": "feed", "value": "back-end", "namespace": "connecting" }, { "key": "driver", "value": "haptic", "namespace": "hacking" }, { "key": "pixel", "value": "redundant", "namespace": "connecting" }, { "key": "driver", "value": "primary", "namespace": "programming" }, { "key": "protocol", "value": "wireless", "namespace": "programming" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "4a93c496-5705-4e86-a36c-286a372f46fc", "display_name": "daniel-hand.test", "groups": [], "culled_timestamp": "2036-06-09T10:21:00.559Z", "last_check_in": "2036-06-03T10:21:00.559Z", "stale_timestamp": "2036-05-26T10:21:00.559Z", "stale_warning_timestamp": "2036-06-02T10:21:00.559Z", "updated": "2026-05-26T10:21:00.559Z", "insights_id": null, "tags": [ { "key": "firewall", "value": "solid state", "namespace": "indexing" }, { "key": "protocol", "value": "mobile", "namespace": "parsing" }, { "key": "system", "value": "wireless", "namespace": "overriding" }, { "key": "microchip", "value": "bluetooth", "namespace": "quantifying" }, { "key": "matrix", "value": "auxiliary", "namespace": "bypassing" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "4fe2fa4d-93f5-472c-8967-6c67b1e9615b", "display_name": "braun-johnson.example", "groups": [], "culled_timestamp": "2036-06-09T10:21:00.572Z", "last_check_in": "2036-06-03T10:21:00.572Z", "stale_timestamp": "2036-05-26T10:21:00.572Z", "stale_warning_timestamp": "2036-06-02T10:21:00.572Z", "updated": "2026-05-26T10:21:00.572Z", "insights_id": null, "tags": [ { "key": "array", "value": "online", "namespace": "calculating" }, { "key": "application", "value": "open-source", "namespace": "indexing" }, { "key": "application", "value": "digital", "namespace": "parsing" }, { "key": "pixel", "value": "mobile", "namespace": "hacking" }, { "key": "sensor", "value": "optical", "namespace": "quantifying" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "6648d631-c221-415b-a1b8-1f713a3ff6e3", "display_name": "grant.test", "groups": [], "culled_timestamp": "2036-06-09T10:21:00.562Z", "last_check_in": "2036-06-03T10:21:00.562Z", "stale_timestamp": "2036-05-26T10:21:00.562Z", "stale_warning_timestamp": "2036-06-02T10:21:00.562Z", "updated": "2026-05-26T10:21:00.562Z", "insights_id": null, "tags": [ { "key": "monitor", "value": "haptic", "namespace": "hacking" }, { "key": "capacitor", "value": "back-end", "namespace": "backing up" }, { "key": "card", "value": "redundant", "namespace": "transmitting" }, { "key": "monitor", "value": "cross-platform", "namespace": "backing up" }, { "key": "card", "value": "mobile", "namespace": "hacking" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "6976d5cb-e596-4e25-a1d6-6500c714ca7e", "display_name": "windler.test", "groups": [], "culled_timestamp": "2036-06-09T10:21:00.563Z", "last_check_in": "2036-06-03T10:21:00.563Z", "stale_timestamp": "2036-05-26T10:21:00.563Z", "stale_warning_timestamp": "2036-06-02T10:21:00.563Z", "updated": "2026-05-26T10:21:00.563Z", "insights_id": null, "tags": [ { "key": "card", "value": "bluetooth", "namespace": "backing up" }, { "key": "pixel", "value": "mobile", "namespace": "backing up" }, { "key": "driver", "value": "bluetooth", "namespace": "parsing" }, { "key": "pixel", "value": "open-source", "namespace": "quantifying" }, { "key": "interface", "value": "solid state", "namespace": "connecting" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "6c17d2d3-ff5a-4ee5-9834-f96dd7991878", "display_name": "oreilly.test", "groups": [], "culled_timestamp": "2036-06-09T10:21:00.544Z", "last_check_in": "2036-06-03T10:21:00.544Z", "stale_timestamp": "2036-05-26T10:21:00.544Z", "stale_warning_timestamp": "2036-06-02T10:21:00.544Z", "updated": "2026-05-26T10:21:00.544Z", "insights_id": null, "tags": [ { "key": "firewall", "value": "virtual", "namespace": "compressing" }, { "key": "pixel", "value": "auxiliary", "namespace": "indexing" }, { "key": "program", "value": "open-source", "namespace": "hacking" }, { "key": "matrix", "value": "online", "namespace": "compressing" }, { "key": "driver", "value": "1080p", "namespace": "backing up" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "70cb1cbf-1bf4-4cfb-8215-a76d352be0c9", "display_name": "johns-pouros.test", "groups": [], "culled_timestamp": "2036-06-09T10:21:00.543Z", "last_check_in": "2036-06-03T10:21:00.543Z", "stale_timestamp": "2036-05-26T10:21:00.543Z", "stale_warning_timestamp": "2036-06-02T10:21:00.543Z", "updated": "2026-05-26T10:21:00.543Z", "insights_id": null, "tags": [ { "key": "firewall", "value": "online", "namespace": "overriding" }, { "key": "transmitter", "value": "wireless", "namespace": "hacking" }, { "key": "microchip", "value": "redundant", "namespace": "overriding" }, { "key": "pixel", "value": "back-end", "namespace": "programming" }, { "key": "monitor", "value": "redundant", "namespace": "calculating" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "7b8b50f8-7821-437c-85b1-e19d2360b157", "display_name": "bradtke.example", "groups": [], "culled_timestamp": "2036-06-09T10:21:00.552Z", "last_check_in": "2036-06-03T10:21:00.552Z", "stale_timestamp": "2036-05-26T10:21:00.552Z", "stale_warning_timestamp": "2036-06-02T10:21:00.552Z", "updated": "2026-05-26T10:21:00.552Z", "insights_id": null, "tags": [ { "key": "interface", "value": "neural", "namespace": "parsing" }, { "key": "system", "value": "haptic", "namespace": "programming" }, { "key": "hard drive", "value": "open-source", "namespace": "synthesizing" }, { "key": "matrix", "value": "online", "namespace": "connecting" }, { "key": "interface", "value": "cross-platform", "namespace": "navigating" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "83d23e71-c025-41c3-9814-4475a44412ac", "display_name": "murray.test", "groups": [], "culled_timestamp": "2036-06-09T10:21:00.546Z", "last_check_in": "2036-06-03T10:21:00.546Z", "stale_timestamp": "2036-05-26T10:21:00.546Z", "stale_warning_timestamp": "2036-06-02T10:21:00.546Z", "updated": "2026-05-26T10:21:00.546Z", "insights_id": null, "tags": [ { "key": "system", "value": "neural", "namespace": "transmitting" }, { "key": "pixel", "value": "online", "namespace": "copying" }, { "key": "panel", "value": "wireless", "namespace": "parsing" }, { "key": "array", "value": "multi-byte", "namespace": "copying" }, { "key": "protocol", "value": "mobile", "namespace": "transmitting" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 } ], "meta": { "total": 25, "tags": [], "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/policies/b8526fec-569b-4108-8399-3dc33cf8e575/systems?limit=10&offset=0", "last": "/api/compliance/v2/policies/b8526fec-569b-4108-8399-3dc33cf8e575/systems?limit=10&offset=20", "next": "/api/compliance/v2/policies/b8526fec-569b-4108-8399-3dc33cf8e575/systems?limit=10&offset=10" } }, "summary": "", "description": "" } }, "schema": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/metadata" }, "links": { "$ref": "#/components/schemas/links" }, "data": { "type": "array", "items": { "properties": { "schema": { "$ref": "#/components/schemas/system" } } } } } } } } } }, "requestBody": { "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "examples": [ "fe26cc2c-b53d-4a0c-b2c9-09e53df95018" ] } } } } } } } } }, "/policies/{policy_id}/systems/os_versions": { "get": { "summary": "Request the list of available OS versions", "parameters": [ { "name": "X-RH-IDENTITY", "in": "header", "schema": { "type": "string" }, "description": "For internal use only" }, { "name": "filter", "in": "query", "required": false, "description": "Query string to filter items by their attributes. Compliant with scoped_search query language. However, only `=` or `!=` (resp. `<>`) operators are supported.

Systems are searchable using attributes `display_name`, `os_version`, `os_major_version`, `os_minor_version`, `assigned_or_scanned`, `never_reported`, `group_name`, `group_id`, `policies`, and `profile_ref_id`

(e.g.: `(field_1=something AND field_2!=\"something else\") OR field_3>40`)", "schema": { "type": "string" } }, { "name": "policy_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "Systems" ], "description": "This feature is exclusively used by the frontend", "operationId": "PolicySystemsOS", "deprecated": true, "responses": { "200": { "description": "Lists available OS versions", "content": { "application/vnd.api+json": { "examples": { "List of available OS versions": { "value": [ "8.0" ], "summary": "", "description": "" } }, "schema": { "type": "array", "items": { "type": "string" } } } } } } } }, "/policies/{policy_id}/systems/{system_id}": { "patch": { "summary": "Assign a System to a Policy", "parameters": [ { "name": "X-RH-IDENTITY", "in": "header", "schema": { "type": "string" }, "description": "For internal use only" }, { "name": "system_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "policy_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "Policies" ], "description": "Assign a specific system to a specific policy.", "operationId": "AssignSystem", "responses": { "202": { "description": "Assigns a System to a Policy", "content": { "application/vnd.api+json": { "examples": { "Assigns a System to a Policy": { "value": { "data": { "id": "6b610420-a3b5-4a25-b3fb-5db0169cda80", "display_name": "connelly-wintheiser.test", "groups": [], "culled_timestamp": "2036-06-09T10:21:01.407Z", "last_check_in": "2036-06-03T10:21:01.407Z", "stale_timestamp": "2036-05-26T10:21:01.407Z", "stale_warning_timestamp": "2036-06-02T10:21:01.407Z", "updated": "2026-05-26T10:21:01.407Z", "insights_id": null, "tags": [ { "key": "interface", "value": "haptic", "namespace": "compressing" }, { "key": "application", "value": "auxiliary", "namespace": "hacking" }, { "key": "monitor", "value": "redundant", "namespace": "calculating" }, { "key": "pixel", "value": "auxiliary", "namespace": "overriding" }, { "key": "interface", "value": "back-end", "namespace": "hacking" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 } }, "summary": "", "description": "" } }, "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/system" } } } } } } } }, "404": { "description": "Returns with Not Found", "content": { "application/vnd.api+json": { "examples": { "Assigns a System to a Policy": { "value": { "errors": [ "V2::System not found with ID bca05284-d12c-446f-9718-8ef8dcbb10f7" ] }, "summary": "", "description": "" } }, "schema": { "$ref": "#/components/schemas/errors" } } } } } }, "delete": { "summary": "Unassign a System from a Policy", "parameters": [ { "name": "X-RH-IDENTITY", "in": "header", "schema": { "type": "string" }, "description": "For internal use only" }, { "name": "system_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "policy_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "Policies" ], "description": "Remove a specific system from a specific policy.", "operationId": "UnassignSystem", "responses": { "202": { "description": "Unassigns a System from a Policy", "content": { "application/vnd.api+json": { "examples": { "Unassigns a System from a Policy": { "value": { "data": { "id": "aff3860d-4c72-4141-98bc-25081de71e81", "display_name": "schaefer.example", "groups": [], "culled_timestamp": "2036-06-09T10:21:01.525Z", "last_check_in": "2036-06-03T10:21:01.525Z", "stale_timestamp": "2036-05-26T10:21:01.525Z", "stale_warning_timestamp": "2036-06-02T10:21:01.525Z", "updated": "2026-05-26T10:21:01.525Z", "insights_id": null, "tags": [ { "key": "monitor", "value": "online", "namespace": "parsing" }, { "key": "card", "value": "open-source", "namespace": "hacking" }, { "key": "transmitter", "value": "multi-byte", "namespace": "connecting" }, { "key": "hard drive", "value": "wireless", "namespace": "backing up" }, { "key": "transmitter", "value": "bluetooth", "namespace": "calculating" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 } }, "summary": "", "description": "" } }, "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/system" } } } } } } } }, "404": { "description": "Returns with Not Found", "content": { "application/vnd.api+json": { "examples": { "Description of an error when unassigning a non-existing System": { "value": { "errors": [ "V2::System not found with ID fd3f1dc5-a2a7-4fa3-9ad5-3244d9cbd0f4" ] }, "summary": "", "description": "" } }, "schema": { "$ref": "#/components/schemas/errors" } } } } } } }, "/reports/{report_id}/systems": { "get": { "summary": "Request Systems assigned to a Report", "parameters": [ { "name": "X-RH-IDENTITY", "in": "header", "schema": { "type": "string" }, "description": "For internal use only" }, { "name": "tags", "in": "query", "required": false, "description": "An array of tags to narrow down the search results. In case the value contains symbols used for separators (`/` or `=`), they need to be encoded.
e.g.: `namespace/key=value`, `insights-client/selinux-config=SELINUX%3Denforcing`", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "limit", "in": "query", "required": false, "description": "Number of items to return per page", "schema": { "type": "number", "maximum": 100, "minimum": 1, "default": 10 } }, { "name": "offset", "in": "query", "required": false, "description": "Offset of first item of paginated response", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "ids_only", "in": "query", "required": false, "description": "Indicates whether to return only resource IDs.", "schema": { "type": "boolean" } }, { "name": "sort_by", "in": "query", "required": false, "description": "Attribute and direction to sort the items by. Represented by an array of fields with an optional direction (`:asc` or `:desc`).

If no direction is selected, `:asc` is used by default.", "schema": { "type": "array", "items": { "enum": [ "display_name", "os_minor_version", "os_version", "groups", "display_name:asc", "display_name:desc", "os_minor_version:asc", "os_minor_version:desc", "os_version:asc", "os_version:desc", "groups:asc", "groups:desc" ] } } }, { "name": "filter", "in": "query", "required": false, "description": "Query string to filter items by their attributes. Compliant with scoped_search query language. However, only `=` or `!=` (resp. `<>`) operators are supported.

Systems are searchable using attributes `display_name`, `os_minor_version`, `never_reported`, `group_name`, and `group_id`

(e.g.: `(field_1=something AND field_2!=\"something else\") OR field_3>40`)", "schema": { "type": "string" } }, { "name": "report_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "Reports" ], "description": "Retrieve all of the systems for a specific report.", "operationId": "ReportSystems", "responses": { "200": { "description": "Lists Systems assigned to a Report", "content": { "application/vnd.api+json": { "examples": { "List of Systems": { "value": { "data": [ { "id": "0abb08af-e564-4f22-8477-e824d1939f15", "display_name": "rowe.example", "groups": [], "culled_timestamp": "2036-06-09T10:21:02.179Z", "last_check_in": "2036-06-03T10:21:02.179Z", "stale_timestamp": "2036-05-26T10:21:02.179Z", "stale_warning_timestamp": "2036-06-02T10:21:02.179Z", "updated": "2026-05-26T10:21:02.179Z", "insights_id": null, "tags": [ { "key": "pixel", "value": "haptic", "namespace": "bypassing" }, { "key": "port", "value": "online", "namespace": "quantifying" }, { "key": "array", "value": "1080p", "namespace": "overriding" }, { "key": "matrix", "value": "haptic", "namespace": "copying" }, { "key": "bus", "value": "wireless", "namespace": "calculating" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "589e9eaf-f71a-464e-99d1-3c10a20a7f55", "title": "Totam autem expedita non." } ] }, { "id": "0ce6f06b-2760-499d-8327-4f0c6b960cbf", "display_name": "greenholt.example", "groups": [], "culled_timestamp": "2036-06-09T10:21:02.248Z", "last_check_in": "2036-06-03T10:21:02.248Z", "stale_timestamp": "2036-05-26T10:21:02.248Z", "stale_warning_timestamp": "2036-06-02T10:21:02.248Z", "updated": "2026-05-26T10:21:02.249Z", "insights_id": null, "tags": [ { "key": "program", "value": "optical", "namespace": "quantifying" }, { "key": "driver", "value": "1080p", "namespace": "navigating" }, { "key": "monitor", "value": "wireless", "namespace": "transmitting" }, { "key": "matrix", "value": "virtual", "namespace": "bypassing" }, { "key": "bandwidth", "value": "redundant", "namespace": "programming" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "589e9eaf-f71a-464e-99d1-3c10a20a7f55", "title": "Totam autem expedita non." } ] }, { "id": "0fdbe4cf-6848-46ae-ad32-824ac828e2e9", "display_name": "schmitt-rodriguez.test", "groups": [], "culled_timestamp": "2036-06-09T10:21:02.189Z", "last_check_in": "2036-06-03T10:21:02.189Z", "stale_timestamp": "2036-05-26T10:21:02.189Z", "stale_warning_timestamp": "2036-06-02T10:21:02.189Z", "updated": "2026-05-26T10:21:02.189Z", "insights_id": null, "tags": [ { "key": "capacitor", "value": "1080p", "namespace": "hacking" }, { "key": "program", "value": "haptic", "namespace": "transmitting" }, { "key": "panel", "value": "back-end", "namespace": "navigating" }, { "key": "application", "value": "optical", "namespace": "compressing" }, { "key": "array", "value": "online", "namespace": "navigating" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "589e9eaf-f71a-464e-99d1-3c10a20a7f55", "title": "Totam autem expedita non." } ] }, { "id": "1f63ce7c-ab04-4115-acd2-4ba480ad3276", "display_name": "jacobson.test", "groups": [], "culled_timestamp": "2036-06-09T10:21:02.099Z", "last_check_in": "2036-06-03T10:21:02.099Z", "stale_timestamp": "2036-05-26T10:21:02.099Z", "stale_warning_timestamp": "2036-06-02T10:21:02.099Z", "updated": "2026-05-26T10:21:02.099Z", "insights_id": null, "tags": [ { "key": "array", "value": "virtual", "namespace": "bypassing" }, { "key": "circuit", "value": "bluetooth", "namespace": "copying" }, { "key": "circuit", "value": "neural", "namespace": "generating" }, { "key": "bus", "value": "online", "namespace": "transmitting" }, { "key": "driver", "value": "auxiliary", "namespace": "compressing" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "589e9eaf-f71a-464e-99d1-3c10a20a7f55", "title": "Totam autem expedita non." } ] }, { "id": "2f1b2f77-f458-426b-943e-d3d10b5379b7", "display_name": "lemke.example", "groups": [], "culled_timestamp": "2036-06-09T10:21:02.108Z", "last_check_in": "2036-06-03T10:21:02.108Z", "stale_timestamp": "2036-05-26T10:21:02.108Z", "stale_warning_timestamp": "2036-06-02T10:21:02.108Z", "updated": "2026-05-26T10:21:02.108Z", "insights_id": null, "tags": [ { "key": "array", "value": "open-source", "namespace": "indexing" }, { "key": "card", "value": "virtual", "namespace": "indexing" }, { "key": "port", "value": "redundant", "namespace": "bypassing" }, { "key": "interface", "value": "optical", "namespace": "synthesizing" }, { "key": "interface", "value": "multi-byte", "namespace": "backing up" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "589e9eaf-f71a-464e-99d1-3c10a20a7f55", "title": "Totam autem expedita non." } ] }, { "id": "4066aab1-9c1a-4198-ac2e-5d14f8c69ba0", "display_name": "mills.test", "groups": [], "culled_timestamp": "2036-06-09T10:21:02.307Z", "last_check_in": "2036-06-03T10:21:02.307Z", "stale_timestamp": "2036-05-26T10:21:02.307Z", "stale_warning_timestamp": "2036-06-02T10:21:02.307Z", "updated": "2026-05-26T10:21:02.307Z", "insights_id": null, "tags": [ { "key": "system", "value": "1080p", "namespace": "compressing" }, { "key": "program", "value": "back-end", "namespace": "navigating" }, { "key": "panel", "value": "primary", "namespace": "hacking" }, { "key": "matrix", "value": "neural", "namespace": "connecting" }, { "key": "program", "value": "haptic", "namespace": "backing up" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "589e9eaf-f71a-464e-99d1-3c10a20a7f55", "title": "Totam autem expedita non." } ] }, { "id": "43ab99f7-77f3-4b4b-978b-86a714a0a2bf", "display_name": "hermann.example", "groups": [], "culled_timestamp": "2036-06-09T10:21:02.087Z", "last_check_in": "2036-06-03T10:21:02.087Z", "stale_timestamp": "2036-05-26T10:21:02.087Z", "stale_warning_timestamp": "2036-06-02T10:21:02.087Z", "updated": "2026-05-26T10:21:02.087Z", "insights_id": null, "tags": [ { "key": "driver", "value": "back-end", "namespace": "navigating" }, { "key": "matrix", "value": "online", "namespace": "transmitting" }, { "key": "feed", "value": "mobile", "namespace": "calculating" }, { "key": "program", "value": "solid state", "namespace": "programming" }, { "key": "interface", "value": "bluetooth", "namespace": "parsing" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "589e9eaf-f71a-464e-99d1-3c10a20a7f55", "title": "Totam autem expedita non." } ] }, { "id": "440f1dd3-19b3-4cfa-9baf-1661422185d0", "display_name": "hegmann-schultz.test", "groups": [], "culled_timestamp": "2036-06-09T10:21:02.297Z", "last_check_in": "2036-06-03T10:21:02.297Z", "stale_timestamp": "2036-05-26T10:21:02.297Z", "stale_warning_timestamp": "2036-06-02T10:21:02.297Z", "updated": "2026-05-26T10:21:02.297Z", "insights_id": null, "tags": [ { "key": "firewall", "value": "neural", "namespace": "calculating" }, { "key": "array", "value": "bluetooth", "namespace": "backing up" }, { "key": "microchip", "value": "auxiliary", "namespace": "bypassing" }, { "key": "bus", "value": "bluetooth", "namespace": "connecting" }, { "key": "microchip", "value": "wireless", "namespace": "overriding" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "589e9eaf-f71a-464e-99d1-3c10a20a7f55", "title": "Totam autem expedita non." } ] }, { "id": "47f86c8f-93a1-4e16-98f0-c42fc6809426", "display_name": "cummings.example", "groups": [], "culled_timestamp": "2036-06-09T10:21:02.198Z", "last_check_in": "2036-06-03T10:21:02.198Z", "stale_timestamp": "2036-05-26T10:21:02.198Z", "stale_warning_timestamp": "2036-06-02T10:21:02.198Z", "updated": "2026-05-26T10:21:02.198Z", "insights_id": null, "tags": [ { "key": "array", "value": "auxiliary", "namespace": "synthesizing" }, { "key": "panel", "value": "cross-platform", "namespace": "calculating" }, { "key": "bandwidth", "value": "back-end", "namespace": "synthesizing" }, { "key": "card", "value": "optical", "namespace": "generating" }, { "key": "array", "value": "redundant", "namespace": "indexing" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "589e9eaf-f71a-464e-99d1-3c10a20a7f55", "title": "Totam autem expedita non." } ] }, { "id": "51dd2d53-4e40-4507-8b78-40aaeb6d2776", "display_name": "carroll.test", "groups": [], "culled_timestamp": "2036-06-09T10:21:02.078Z", "last_check_in": "2036-06-03T10:21:02.078Z", "stale_timestamp": "2036-05-26T10:21:02.078Z", "stale_warning_timestamp": "2036-06-02T10:21:02.078Z", "updated": "2026-05-26T10:21:02.078Z", "insights_id": null, "tags": [ { "key": "matrix", "value": "mobile", "namespace": "overriding" }, { "key": "matrix", "value": "multi-byte", "namespace": "indexing" }, { "key": "system", "value": "haptic", "namespace": "backing up" }, { "key": "alarm", "value": "solid state", "namespace": "synthesizing" }, { "key": "port", "value": "haptic", "namespace": "synthesizing" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "589e9eaf-f71a-464e-99d1-3c10a20a7f55", "title": "Totam autem expedita non." } ] } ], "meta": { "total": 25, "tags": [], "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/reports/589e9eaf-f71a-464e-99d1-3c10a20a7f55/systems?limit=10&offset=0", "last": "/api/compliance/v2/reports/589e9eaf-f71a-464e-99d1-3c10a20a7f55/systems?limit=10&offset=20", "next": "/api/compliance/v2/reports/589e9eaf-f71a-464e-99d1-3c10a20a7f55/systems?limit=10&offset=10" } }, "summary": "", "description": "" }, "List of Systems sorted by \"os_minor_version:asc\"": { "value": { "data": [ { "id": "100c680e-73a6-4b57-9b43-f41d9be0cc36", "display_name": "robel.test", "groups": [], "culled_timestamp": "2036-06-09T10:21:02.779Z", "last_check_in": "2036-06-03T10:21:02.779Z", "stale_timestamp": "2036-05-26T10:21:02.779Z", "stale_warning_timestamp": "2036-06-02T10:21:02.779Z", "updated": "2026-05-26T10:21:02.779Z", "insights_id": null, "tags": [ { "key": "alarm", "value": "mobile", "namespace": "connecting" }, { "key": "circuit", "value": "solid state", "namespace": "parsing" }, { "key": "hard drive", "value": "open-source", "namespace": "programming" }, { "key": "hard drive", "value": "digital", "namespace": "navigating" }, { "key": "hard drive", "value": "back-end", "namespace": "transmitting" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "f3ceb2a1-7ee1-4c60-a1dd-f37eb38157fa", "title": "Cupiditate dolorem laboriosam impedit." } ] }, { "id": "1048a9ff-c979-4307-b8e6-a86823c95c5e", "display_name": "jones.test", "groups": [], "culled_timestamp": "2036-06-09T10:21:02.934Z", "last_check_in": "2036-06-03T10:21:02.934Z", "stale_timestamp": "2036-05-26T10:21:02.934Z", "stale_warning_timestamp": "2036-06-02T10:21:02.934Z", "updated": "2026-05-26T10:21:02.934Z", "insights_id": null, "tags": [ { "key": "interface", "value": "wireless", "namespace": "hacking" }, { "key": "bandwidth", "value": "primary", "namespace": "connecting" }, { "key": "alarm", "value": "back-end", "namespace": "overriding" }, { "key": "system", "value": "solid state", "namespace": "bypassing" }, { "key": "system", "value": "primary", "namespace": "backing up" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "f3ceb2a1-7ee1-4c60-a1dd-f37eb38157fa", "title": "Cupiditate dolorem laboriosam impedit." } ] }, { "id": "13a07180-c11f-403e-b1e1-29b73a6e3df0", "display_name": "hickle-graham.example", "groups": [], "culled_timestamp": "2036-06-09T10:21:02.726Z", "last_check_in": "2036-06-03T10:21:02.726Z", "stale_timestamp": "2036-05-26T10:21:02.726Z", "stale_warning_timestamp": "2036-06-02T10:21:02.726Z", "updated": "2026-05-26T10:21:02.726Z", "insights_id": null, "tags": [ { "key": "bandwidth", "value": "open-source", "namespace": "generating" }, { "key": "sensor", "value": "solid state", "namespace": "programming" }, { "key": "bus", "value": "digital", "namespace": "copying" }, { "key": "matrix", "value": "auxiliary", "namespace": "generating" }, { "key": "card", "value": "multi-byte", "namespace": "backing up" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "f3ceb2a1-7ee1-4c60-a1dd-f37eb38157fa", "title": "Cupiditate dolorem laboriosam impedit." } ] }, { "id": "17e16db8-3ac1-4c51-aedc-a2cd72f0ed35", "display_name": "jast-konopelski.test", "groups": [], "culled_timestamp": "2036-06-09T10:21:02.788Z", "last_check_in": "2036-06-03T10:21:02.788Z", "stale_timestamp": "2036-05-26T10:21:02.788Z", "stale_warning_timestamp": "2036-06-02T10:21:02.788Z", "updated": "2026-05-26T10:21:02.788Z", "insights_id": null, "tags": [ { "key": "capacitor", "value": "primary", "namespace": "overriding" }, { "key": "sensor", "value": "digital", "namespace": "copying" }, { "key": "card", "value": "1080p", "namespace": "navigating" }, { "key": "application", "value": "neural", "namespace": "indexing" }, { "key": "matrix", "value": "haptic", "namespace": "synthesizing" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "f3ceb2a1-7ee1-4c60-a1dd-f37eb38157fa", "title": "Cupiditate dolorem laboriosam impedit." } ] }, { "id": "1a939c26-8370-4422-812a-7f4f3381bf0f", "display_name": "schoen-bergnaum.test", "groups": [], "culled_timestamp": "2036-06-09T10:21:02.801Z", "last_check_in": "2036-06-03T10:21:02.801Z", "stale_timestamp": "2036-05-26T10:21:02.801Z", "stale_warning_timestamp": "2036-06-02T10:21:02.801Z", "updated": "2026-05-26T10:21:02.801Z", "insights_id": null, "tags": [ { "key": "card", "value": "auxiliary", "namespace": "synthesizing" }, { "key": "system", "value": "open-source", "namespace": "calculating" }, { "key": "application", "value": "haptic", "namespace": "navigating" }, { "key": "card", "value": "bluetooth", "namespace": "hacking" }, { "key": "card", "value": "cross-platform", "namespace": "quantifying" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "f3ceb2a1-7ee1-4c60-a1dd-f37eb38157fa", "title": "Cupiditate dolorem laboriosam impedit." } ] }, { "id": "1dcfa08c-cbc4-4c4d-8801-e044bb6e4dc6", "display_name": "mckenzie.example", "groups": [], "culled_timestamp": "2036-06-09T10:21:02.831Z", "last_check_in": "2036-06-03T10:21:02.831Z", "stale_timestamp": "2036-05-26T10:21:02.831Z", "stale_warning_timestamp": "2036-06-02T10:21:02.831Z", "updated": "2026-05-26T10:21:02.831Z", "insights_id": null, "tags": [ { "key": "transmitter", "value": "online", "namespace": "navigating" }, { "key": "protocol", "value": "neural", "namespace": "synthesizing" }, { "key": "firewall", "value": "1080p", "namespace": "bypassing" }, { "key": "capacitor", "value": "primary", "namespace": "backing up" }, { "key": "microchip", "value": "digital", "namespace": "indexing" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "f3ceb2a1-7ee1-4c60-a1dd-f37eb38157fa", "title": "Cupiditate dolorem laboriosam impedit." } ] }, { "id": "3d935013-87f9-44fa-bb18-a52da7d3e10b", "display_name": "schowalter.example", "groups": [], "culled_timestamp": "2036-06-09T10:21:02.861Z", "last_check_in": "2036-06-03T10:21:02.861Z", "stale_timestamp": "2036-05-26T10:21:02.861Z", "stale_warning_timestamp": "2036-06-02T10:21:02.861Z", "updated": "2026-05-26T10:21:02.861Z", "insights_id": null, "tags": [ { "key": "array", "value": "auxiliary", "namespace": "bypassing" }, { "key": "pixel", "value": "virtual", "namespace": "quantifying" }, { "key": "feed", "value": "wireless", "namespace": "hacking" }, { "key": "program", "value": "auxiliary", "namespace": "backing up" }, { "key": "sensor", "value": "digital", "namespace": "backing up" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "f3ceb2a1-7ee1-4c60-a1dd-f37eb38157fa", "title": "Cupiditate dolorem laboriosam impedit." } ] }, { "id": "47938988-6992-4adc-aa15-e6f075e6a968", "display_name": "friesen.test", "groups": [], "culled_timestamp": "2036-06-09T10:21:02.915Z", "last_check_in": "2036-06-03T10:21:02.915Z", "stale_timestamp": "2036-05-26T10:21:02.915Z", "stale_warning_timestamp": "2036-06-02T10:21:02.915Z", "updated": "2026-05-26T10:21:02.915Z", "insights_id": null, "tags": [ { "key": "sensor", "value": "open-source", "namespace": "copying" }, { "key": "microchip", "value": "bluetooth", "namespace": "compressing" }, { "key": "sensor", "value": "online", "namespace": "backing up" }, { "key": "application", "value": "optical", "namespace": "transmitting" }, { "key": "monitor", "value": "bluetooth", "namespace": "parsing" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "f3ceb2a1-7ee1-4c60-a1dd-f37eb38157fa", "title": "Cupiditate dolorem laboriosam impedit." } ] }, { "id": "4912940d-35e2-4cc2-80f4-0d801926c23c", "display_name": "halvorson-beier.example", "groups": [], "culled_timestamp": "2036-06-09T10:21:02.924Z", "last_check_in": "2036-06-03T10:21:02.924Z", "stale_timestamp": "2036-05-26T10:21:02.924Z", "stale_warning_timestamp": "2036-06-02T10:21:02.924Z", "updated": "2026-05-26T10:21:02.924Z", "insights_id": null, "tags": [ { "key": "monitor", "value": "haptic", "namespace": "hacking" }, { "key": "alarm", "value": "back-end", "namespace": "navigating" }, { "key": "matrix", "value": "redundant", "namespace": "backing up" }, { "key": "matrix", "value": "digital", "namespace": "programming" }, { "key": "firewall", "value": "cross-platform", "namespace": "connecting" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "f3ceb2a1-7ee1-4c60-a1dd-f37eb38157fa", "title": "Cupiditate dolorem laboriosam impedit." } ] }, { "id": "50a682ff-98e9-4a29-a554-1425e03450ec", "display_name": "zulauf-mccullough.example", "groups": [], "culled_timestamp": "2036-06-09T10:21:02.812Z", "last_check_in": "2036-06-03T10:21:02.812Z", "stale_timestamp": "2036-05-26T10:21:02.812Z", "stale_warning_timestamp": "2036-06-02T10:21:02.812Z", "updated": "2026-05-26T10:21:02.812Z", "insights_id": null, "tags": [ { "key": "capacitor", "value": "auxiliary", "namespace": "backing up" }, { "key": "sensor", "value": "digital", "namespace": "generating" }, { "key": "matrix", "value": "wireless", "namespace": "bypassing" }, { "key": "alarm", "value": "wireless", "namespace": "navigating" }, { "key": "circuit", "value": "online", "namespace": "indexing" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "f3ceb2a1-7ee1-4c60-a1dd-f37eb38157fa", "title": "Cupiditate dolorem laboriosam impedit." } ] } ], "meta": { "total": 25, "tags": [], "limit": 10, "offset": 0, "sort_by": "os_minor_version" }, "links": { "first": "/api/compliance/v2/reports/f3ceb2a1-7ee1-4c60-a1dd-f37eb38157fa/systems?limit=10&offset=0&sort_by=os_minor_version", "last": "/api/compliance/v2/reports/f3ceb2a1-7ee1-4c60-a1dd-f37eb38157fa/systems?limit=10&offset=20&sort_by=os_minor_version", "next": "/api/compliance/v2/reports/f3ceb2a1-7ee1-4c60-a1dd-f37eb38157fa/systems?limit=10&offset=10&sort_by=os_minor_version" } }, "summary": "", "description": "" }, "List of Systems filtered by \"(os_minor_version=0)\"": { "value": { "data": [ { "id": "07685c96-4156-4511-9391-2f64d7650a61", "display_name": "stamm-baumbach.example", "groups": [], "culled_timestamp": "2036-06-09T10:21:03.476Z", "last_check_in": "2036-06-03T10:21:03.476Z", "stale_timestamp": "2036-05-26T10:21:03.476Z", "stale_warning_timestamp": "2036-06-02T10:21:03.476Z", "updated": "2026-05-26T10:21:03.476Z", "insights_id": null, "tags": [ { "key": "monitor", "value": "back-end", "namespace": "synthesizing" }, { "key": "program", "value": "multi-byte", "namespace": "connecting" }, { "key": "driver", "value": "cross-platform", "namespace": "parsing" }, { "key": "capacitor", "value": "1080p", "namespace": "transmitting" }, { "key": "port", "value": "cross-platform", "namespace": "connecting" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "533e98a3-6a59-4302-b5ba-df320067a581", "title": "Vel earum fugiat ipsum." } ] }, { "id": "13c927b1-5834-4abe-8def-57b34936d737", "display_name": "kreiger.test", "groups": [], "culled_timestamp": "2036-06-09T10:21:03.444Z", "last_check_in": "2036-06-03T10:21:03.444Z", "stale_timestamp": "2036-05-26T10:21:03.444Z", "stale_warning_timestamp": "2036-06-02T10:21:03.444Z", "updated": "2026-05-26T10:21:03.444Z", "insights_id": null, "tags": [ { "key": "circuit", "value": "primary", "namespace": "hacking" }, { "key": "firewall", "value": "haptic", "namespace": "synthesizing" }, { "key": "hard drive", "value": "bluetooth", "namespace": "transmitting" }, { "key": "circuit", "value": "virtual", "namespace": "quantifying" }, { "key": "feed", "value": "virtual", "namespace": "connecting" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "533e98a3-6a59-4302-b5ba-df320067a581", "title": "Vel earum fugiat ipsum." } ] }, { "id": "1813e707-710e-44de-92ca-513aa2a96e8f", "display_name": "buckridge.test", "groups": [], "culled_timestamp": "2036-06-09T10:21:03.364Z", "last_check_in": "2036-06-03T10:21:03.364Z", "stale_timestamp": "2036-05-26T10:21:03.364Z", "stale_warning_timestamp": "2036-06-02T10:21:03.364Z", "updated": "2026-05-26T10:21:03.364Z", "insights_id": null, "tags": [ { "key": "port", "value": "solid state", "namespace": "parsing" }, { "key": "hard drive", "value": "haptic", "namespace": "compressing" }, { "key": "interface", "value": "wireless", "namespace": "overriding" }, { "key": "bus", "value": "haptic", "namespace": "hacking" }, { "key": "circuit", "value": "digital", "namespace": "navigating" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "533e98a3-6a59-4302-b5ba-df320067a581", "title": "Vel earum fugiat ipsum." } ] }, { "id": "18ac1c55-a361-45d4-91ee-32b5477de0b6", "display_name": "predovic.test", "groups": [], "culled_timestamp": "2036-06-09T10:21:03.375Z", "last_check_in": "2036-06-03T10:21:03.375Z", "stale_timestamp": "2036-05-26T10:21:03.375Z", "stale_warning_timestamp": "2036-06-02T10:21:03.375Z", "updated": "2026-05-26T10:21:03.375Z", "insights_id": null, "tags": [ { "key": "circuit", "value": "wireless", "namespace": "indexing" }, { "key": "bandwidth", "value": "neural", "namespace": "quantifying" }, { "key": "panel", "value": "wireless", "namespace": "transmitting" }, { "key": "monitor", "value": "mobile", "namespace": "bypassing" }, { "key": "monitor", "value": "neural", "namespace": "parsing" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "533e98a3-6a59-4302-b5ba-df320067a581", "title": "Vel earum fugiat ipsum." } ] }, { "id": "1f6dbc36-28be-48ae-a14c-595c4b2d4aa9", "display_name": "erdman-fay.example", "groups": [], "culled_timestamp": "2036-06-09T10:21:03.489Z", "last_check_in": "2036-06-03T10:21:03.489Z", "stale_timestamp": "2036-05-26T10:21:03.489Z", "stale_warning_timestamp": "2036-06-02T10:21:03.489Z", "updated": "2026-05-26T10:21:03.489Z", "insights_id": null, "tags": [ { "key": "program", "value": "redundant", "namespace": "parsing" }, { "key": "program", "value": "haptic", "namespace": "overriding" }, { "key": "port", "value": "solid state", "namespace": "copying" }, { "key": "bandwidth", "value": "neural", "namespace": "indexing" }, { "key": "feed", "value": "open-source", "namespace": "navigating" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "533e98a3-6a59-4302-b5ba-df320067a581", "title": "Vel earum fugiat ipsum." } ] }, { "id": "22871f78-3852-4c6c-a59c-dcd8bef4eb84", "display_name": "batz.test", "groups": [], "culled_timestamp": "2036-06-09T10:21:03.330Z", "last_check_in": "2036-06-03T10:21:03.330Z", "stale_timestamp": "2036-05-26T10:21:03.330Z", "stale_warning_timestamp": "2036-06-02T10:21:03.330Z", "updated": "2026-05-26T10:21:03.331Z", "insights_id": null, "tags": [ { "key": "panel", "value": "primary", "namespace": "backing up" }, { "key": "system", "value": "virtual", "namespace": "copying" }, { "key": "sensor", "value": "bluetooth", "namespace": "navigating" }, { "key": "card", "value": "cross-platform", "namespace": "quantifying" }, { "key": "panel", "value": "digital", "namespace": "parsing" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "533e98a3-6a59-4302-b5ba-df320067a581", "title": "Vel earum fugiat ipsum." } ] }, { "id": "2bc28ab9-c779-4849-b20a-041782af6dab", "display_name": "blanda.example", "groups": [], "culled_timestamp": "2036-06-09T10:21:03.522Z", "last_check_in": "2036-06-03T10:21:03.522Z", "stale_timestamp": "2036-05-26T10:21:03.522Z", "stale_warning_timestamp": "2036-06-02T10:21:03.522Z", "updated": "2026-05-26T10:21:03.522Z", "insights_id": null, "tags": [ { "key": "firewall", "value": "wireless", "namespace": "quantifying" }, { "key": "card", "value": "haptic", "namespace": "copying" }, { "key": "pixel", "value": "wireless", "namespace": "connecting" }, { "key": "program", "value": "virtual", "namespace": "programming" }, { "key": "monitor", "value": "mobile", "namespace": "indexing" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "533e98a3-6a59-4302-b5ba-df320067a581", "title": "Vel earum fugiat ipsum." } ] }, { "id": "3277ac64-0611-443c-9060-4db7d9540030", "display_name": "bosco-marks.test", "groups": [], "culled_timestamp": "2036-06-09T10:21:03.553Z", "last_check_in": "2036-06-03T10:21:03.553Z", "stale_timestamp": "2036-05-26T10:21:03.553Z", "stale_warning_timestamp": "2036-06-02T10:21:03.553Z", "updated": "2026-05-26T10:21:03.553Z", "insights_id": null, "tags": [ { "key": "feed", "value": "cross-platform", "namespace": "programming" }, { "key": "protocol", "value": "neural", "namespace": "generating" }, { "key": "circuit", "value": "1080p", "namespace": "navigating" }, { "key": "interface", "value": "solid state", "namespace": "connecting" }, { "key": "port", "value": "open-source", "namespace": "copying" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "533e98a3-6a59-4302-b5ba-df320067a581", "title": "Vel earum fugiat ipsum." } ] }, { "id": "42524c19-9f6e-4cb5-8266-1683372b5644", "display_name": "ruecker.test", "groups": [], "culled_timestamp": "2036-06-09T10:21:03.422Z", "last_check_in": "2036-06-03T10:21:03.422Z", "stale_timestamp": "2036-05-26T10:21:03.422Z", "stale_warning_timestamp": "2036-06-02T10:21:03.422Z", "updated": "2026-05-26T10:21:03.422Z", "insights_id": null, "tags": [ { "key": "sensor", "value": "multi-byte", "namespace": "navigating" }, { "key": "panel", "value": "1080p", "namespace": "generating" }, { "key": "monitor", "value": "bluetooth", "namespace": "overriding" }, { "key": "circuit", "value": "wireless", "namespace": "parsing" }, { "key": "card", "value": "cross-platform", "namespace": "overriding" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "533e98a3-6a59-4302-b5ba-df320067a581", "title": "Vel earum fugiat ipsum." } ] }, { "id": "54be2acf-d74f-439d-bbc7-845cdfde2942", "display_name": "hilll.example", "groups": [], "culled_timestamp": "2036-06-09T10:21:03.433Z", "last_check_in": "2036-06-03T10:21:03.433Z", "stale_timestamp": "2036-05-26T10:21:03.433Z", "stale_warning_timestamp": "2036-06-02T10:21:03.433Z", "updated": "2026-05-26T10:21:03.433Z", "insights_id": null, "tags": [ { "key": "monitor", "value": "haptic", "namespace": "calculating" }, { "key": "port", "value": "bluetooth", "namespace": "copying" }, { "key": "bandwidth", "value": "cross-platform", "namespace": "calculating" }, { "key": "port", "value": "redundant", "namespace": "overriding" }, { "key": "monitor", "value": "multi-byte", "namespace": "programming" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "533e98a3-6a59-4302-b5ba-df320067a581", "title": "Vel earum fugiat ipsum." } ] } ], "meta": { "total": 25, "filter": "(os_minor_version=0)", "tags": [], "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/reports/533e98a3-6a59-4302-b5ba-df320067a581/systems?filter=%28os_minor_version%3D0%29&limit=10&offset=0", "last": "/api/compliance/v2/reports/533e98a3-6a59-4302-b5ba-df320067a581/systems?filter=%28os_minor_version%3D0%29&limit=10&offset=20", "next": "/api/compliance/v2/reports/533e98a3-6a59-4302-b5ba-df320067a581/systems?filter=%28os_minor_version%3D0%29&limit=10&offset=10" } }, "summary": "", "description": "" } }, "schema": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/metadata" }, "links": { "$ref": "#/components/schemas/links" }, "data": { "type": "array", "items": { "properties": { "schema": { "$ref": "#/components/schemas/system" } } } } } } } } }, "422": { "description": "Returns with Unprocessable Content", "content": { "application/vnd.api+json": { "examples": { "Description of an error when sorting by incorrect parameter": { "value": { "errors": [ "Result cannot be sorted by the 'description' column." ] }, "summary": "", "description": "" }, "Description of an error when requesting higher limit than supported": { "value": { "errors": [ "Invalid parameter: limit must be less than or equal to 100" ] }, "summary": "", "description": "" } }, "schema": { "$ref": "#/components/schemas/errors" } } } } } } }, "/reports/{report_id}/systems/os_versions": { "get": { "summary": "Request the list of available OS versions", "parameters": [ { "name": "X-RH-IDENTITY", "in": "header", "schema": { "type": "string" }, "description": "For internal use only" }, { "name": "filter", "in": "query", "required": false, "description": "Query string to filter items by their attributes. Compliant with scoped_search query language. However, only `=` or `!=` (resp. `<>`) operators are supported.

Systems are searchable using attributes `display_name`, `os_version`, `os_major_version`, `os_minor_version`, `assigned_or_scanned`, `never_reported`, `group_name`, `group_id`, `policies`, and `profile_ref_id`

(e.g.: `(field_1=something AND field_2!=\"something else\") OR field_3>40`)", "schema": { "type": "string" } }, { "name": "report_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "Systems" ], "description": "This feature is exclusively used by the frontend", "operationId": "ReportSystemsOS", "deprecated": true, "responses": { "200": { "description": "Lists available OS versions", "content": { "application/vnd.api+json": { "examples": { "List of available OS versions": { "value": [ "8.0" ], "summary": "", "description": "" } }, "schema": { "type": "array", "items": { "type": "string" } } } } } } } }, "/reports/{report_id}/systems/{system_id}": { "get": { "summary": "Request a System", "parameters": [ { "name": "X-RH-IDENTITY", "in": "header", "schema": { "type": "string" }, "description": "For internal use only" }, { "name": "system_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "report_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "Reports" ], "description": "Retrieve a specific system from a specific report.", "operationId": "ReportSystem", "responses": { "200": { "description": "Returns a System under a Report", "content": { "application/vnd.api+json": { "examples": { "Returns a System under a Report": { "value": { "data": { "id": "dceb9d11-817d-49c8-ab50-4b1af015f099", "display_name": "kling.example", "groups": [], "culled_timestamp": "2036-06-09T10:21:05.913Z", "last_check_in": "2036-06-03T10:21:05.913Z", "stale_timestamp": "2036-05-26T10:21:05.913Z", "stale_warning_timestamp": "2036-06-02T10:21:05.913Z", "updated": "2026-05-26T10:21:05.913Z", "insights_id": null, "tags": [ { "key": "panel", "value": "mobile", "namespace": "quantifying" }, { "key": "monitor", "value": "back-end", "namespace": "calculating" }, { "key": "panel", "value": "optical", "namespace": "generating" }, { "key": "interface", "value": "back-end", "namespace": "overriding" }, { "key": "circuit", "value": "auxiliary", "namespace": "programming" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "f82525f5-fbc8-49ad-b8a1-9530d56e23d6", "title": "Maiores cum accusamus autem." } ] } }, "summary": "", "description": "" } }, "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/system" } } } } } } } }, "404": { "description": "Returns with Not Found", "content": { "application/vnd.api+json": { "examples": { "Description of an error when requesting a non-existing System": { "value": { "errors": [ "V2::System not found with ID 29af754c-1953-46f1-8f28-e9d270f89383" ] }, "summary": "", "description": "" } }, "schema": { "$ref": "#/components/schemas/errors" } } } } } } }, "/policies/{policy_id}/tailorings": { "get": { "summary": "Request Tailorings", "parameters": [ { "name": "X-RH-IDENTITY", "in": "header", "schema": { "type": "string" }, "description": "For internal use only" }, { "name": "limit", "in": "query", "required": false, "description": "Number of items to return per page", "schema": { "type": "number", "maximum": 100, "minimum": 1, "default": 10 } }, { "name": "offset", "in": "query", "required": false, "description": "Offset of first item of paginated response", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "ids_only", "in": "query", "required": false, "description": "Indicates whether to return only resource IDs.", "schema": { "type": "boolean" } }, { "name": "sort_by", "in": "query", "required": false, "description": "Attribute and direction to sort the items by. Represented by an array of fields with an optional direction (`:asc` or `:desc`).

If no direction is selected, `:asc` is used by default.", "schema": { "type": "array", "items": { "enum": [ "os_minor_version", "os_minor_version:asc", "os_minor_version:desc" ] } } }, { "name": "filter", "in": "query", "required": false, "description": "Query string to filter items by their attributes. Compliant with scoped_search query language. However, only `=` or `!=` (resp. `<>`) operators are supported.

Tailorings are searchable using attributes `os_minor_version`

(e.g.: `(field_1=something AND field_2!=\"something else\") OR field_3>40`)", "schema": { "type": "string" } }, { "name": "policy_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "Policies" ], "description": "Retrieve a list of all tailorings.", "operationId": "Tailorings", "responses": { "200": { "description": "Lists Tailorings", "content": { "application/vnd.api+json": { "examples": { "List of Tailorings": { "value": { "data": [ { "id": "14ddc6de-27f2-423e-bc8e-2fc984b26b42", "profile_id": "7f494a12-3650-4510-b3f6-97e4850df2bf", "os_minor_version": 24, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "70ef3be1-6e2d-4e5e-b2ee-3184c39d7b41", "security_guide_version": "100.96.22" }, { "id": "19c51675-be9a-4d2b-a82b-c1884f4ca43e", "profile_id": "303a6d1a-54ce-4f7c-b2cf-9885953850d1", "os_minor_version": 18, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "15c9d4e7-ecb0-4b78-99d0-934d563c1cc0", "security_guide_version": "100.96.16" }, { "id": "1f46e25a-a9fb-4c4c-bb83-9f32f4bbf43e", "profile_id": "a6eb63f4-c42b-4b71-ad23-b3fd38f02260", "os_minor_version": 11, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "cb42bbb7-efe0-42c1-967a-bf7559edd5d0", "security_guide_version": "100.96.9" }, { "id": "2062f13e-78ee-4261-98b7-0e2fef4b51bf", "profile_id": "08723dff-4bef-4e95-a406-26f7d20db513", "os_minor_version": 21, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "842e87e9-08fc-4ac8-a1d3-257148d3c383", "security_guide_version": "100.96.19" }, { "id": "20cb5055-7f91-47b3-8fd1-6932d4908fd1", "profile_id": "c1b79b65-b41f-4c02-8994-3c8153dec86f", "os_minor_version": 23, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "5d77d29a-c39b-4a6b-8a5d-b45527c05499", "security_guide_version": "100.96.21" }, { "id": "235e5f19-fb4c-4e6c-8939-c7741c81c37e", "profile_id": "8e3e754e-a33a-4439-a100-a011359d3f76", "os_minor_version": 0, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "dd1d6249-193e-4fc0-a2b4-0ddb7f998484", "security_guide_version": "100.95.48" }, { "id": "254b8ac3-215f-4451-8287-32b75b5c8d02", "profile_id": "f75e970a-7edd-4cf8-bdf0-8c520d2362b4", "os_minor_version": 14, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "392b95b8-fc3c-440b-9ec6-465c97353f9b", "security_guide_version": "100.96.12" }, { "id": "3fc60bb6-1a48-48a2-afd3-093ffdfc6374", "profile_id": "c2391267-1b11-402b-93b5-2bc9be81f247", "os_minor_version": 5, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "46129ef4-82cf-4dc6-a92b-5cce6c5a9dd5", "security_guide_version": "100.96.3" }, { "id": "4b81a15d-821b-4982-8cb1-112934a3e8fe", "profile_id": "fdfac019-03df-4419-b1da-75978a94434f", "os_minor_version": 7, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "c2fa9e52-fc7f-4a22-abcb-f44743d3bcb4", "security_guide_version": "100.96.5" }, { "id": "51a2d206-f8bc-49e5-9c50-e23b9fb212dc", "profile_id": "e4a7e1a0-6e44-42fd-a240-61d8e6a8b36b", "os_minor_version": 19, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "78140cba-92dc-4629-bdaf-9f249ee3f41e", "security_guide_version": "100.96.17" } ], "meta": { "total": 25, "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/policies/1191c15a-95d8-46ce-86a8-1f3001e47b7a/tailorings?limit=10&offset=0", "last": "/api/compliance/v2/policies/1191c15a-95d8-46ce-86a8-1f3001e47b7a/tailorings?limit=10&offset=20", "next": "/api/compliance/v2/policies/1191c15a-95d8-46ce-86a8-1f3001e47b7a/tailorings?limit=10&offset=10" } }, "summary": "", "description": "" }, "List of Tailorings sorted by \"os_minor_version:asc\"": { "value": { "data": [ { "id": "f3dbb633-aa38-4439-9010-aaf898372d97", "profile_id": "1664b959-a92b-4e0b-b0b4-4b89755c00e9", "os_minor_version": 0, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "98a8fd06-1e7f-4132-8797-1fc92b873418", "security_guide_version": "100.96.23" }, { "id": "abaf8b1f-f2d9-4468-a3d9-07838bb3d68e", "profile_id": "533a6e14-b98b-42bb-b6af-3f9c9176a51a", "os_minor_version": 1, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "21ed9511-534e-42ec-b047-7174aea156ac", "security_guide_version": "100.96.24" }, { "id": "3e8a308b-912f-4166-9798-5a278e83c819", "profile_id": "a69c2301-9f23-4b65-af92-3e71ec185a25", "os_minor_version": 2, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "10b0d59d-f06c-47ab-9e44-6f029b86d603", "security_guide_version": "100.96.25" }, { "id": "81948f6f-6ba1-445e-9735-360c12e0a54c", "profile_id": "0fdb840c-72df-41ee-b601-ea3bd3465ff4", "os_minor_version": 3, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "ce7d759f-9d2d-422b-974b-fadc6d019fe1", "security_guide_version": "100.96.26" }, { "id": "27c9d21b-16cf-43b3-bded-4e6ebd0e34e0", "profile_id": "9e4b2422-461c-4a97-bc81-0d5ee0ebdd6a", "os_minor_version": 4, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "da0e2490-2ad5-405f-a355-b52d69eb3bf7", "security_guide_version": "100.96.27" }, { "id": "84d41a6b-ba23-499e-8b80-e99510a81fd3", "profile_id": "23c53a04-a0f9-41c2-95f4-97c0a6e972f4", "os_minor_version": 5, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "8843a300-bf55-4c4d-9fe9-cfc0dff9cfc3", "security_guide_version": "100.96.28" }, { "id": "8e111c72-5013-44f1-bef9-484d14e9ae67", "profile_id": "1cc1d84f-65a2-4410-988c-3c6df2acbe14", "os_minor_version": 6, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "bca753c2-b88c-43b9-b041-6fc3541b3319", "security_guide_version": "100.96.29" }, { "id": "345f730c-d607-4b0f-b745-58b40b9930d7", "profile_id": "0ee0e452-bfb8-41ba-823c-74c25efc0ff6", "os_minor_version": 7, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "65aaf23f-5bb1-40da-ae3f-780b1477417c", "security_guide_version": "100.96.30" }, { "id": "677ddaa1-29f5-4fc6-875c-5241de6a0926", "profile_id": "dd28d36e-8bd0-4475-864d-21f1cd3d7ccd", "os_minor_version": 8, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "b6ad1c0e-1d45-43e9-b4d5-bfd4881652c3", "security_guide_version": "100.96.31" }, { "id": "bedad8d2-e073-48dc-ae23-9255f5034ab6", "profile_id": "ccd71fc7-5c08-469d-a5df-67c12247a237", "os_minor_version": 9, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "777b130c-53e0-4d27-bddf-4d5870abfbe7", "security_guide_version": "100.96.32" } ], "meta": { "total": 25, "limit": 10, "offset": 0, "sort_by": "os_minor_version" }, "links": { "first": "/api/compliance/v2/policies/e6f006cb-6c46-4688-aa43-8926f59c8890/tailorings?limit=10&offset=0&sort_by=os_minor_version", "last": "/api/compliance/v2/policies/e6f006cb-6c46-4688-aa43-8926f59c8890/tailorings?limit=10&offset=20&sort_by=os_minor_version", "next": "/api/compliance/v2/policies/e6f006cb-6c46-4688-aa43-8926f59c8890/tailorings?limit=10&offset=10&sort_by=os_minor_version" } }, "summary": "", "description": "" }, "List of Tailorings filtered by '(os_minor_version=3)'": { "value": { "data": [ { "id": "11ea80fa-16b9-4717-8451-3fac6dc7536c", "profile_id": "5ece774f-09ef-436a-8483-ebe42b815589", "os_minor_version": 3, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "028c3361-13f7-408e-8b55-42418e187eb1", "security_guide_version": "100.97.1" } ], "meta": { "total": 1, "filter": "(os_minor_version=3)", "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/policies/33518020-6b26-4b62-acd3-0b20039ad470/tailorings?filter=%28os_minor_version%3D3%29&limit=10&offset=0", "last": "/api/compliance/v2/policies/33518020-6b26-4b62-acd3-0b20039ad470/tailorings?filter=%28os_minor_version%3D3%29&limit=10&offset=0" } }, "summary": "", "description": "" } }, "schema": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/metadata" }, "links": { "$ref": "#/components/schemas/links" }, "data": { "type": "array", "items": { "properties": { "schema": { "$ref": "#/components/schemas/tailoring" } } } } } } } } }, "422": { "description": "Returns with Unprocessable Content", "content": { "application/vnd.api+json": { "examples": { "Description of an error when sorting by incorrect parameter": { "value": { "errors": [ "Result cannot be sorted by the 'description' column." ] }, "summary": "", "description": "" }, "Description of an error when requesting higher limit than supported": { "value": { "errors": [ "Invalid parameter: limit must be less than or equal to 100" ] }, "summary": "", "description": "" } }, "schema": { "$ref": "#/components/schemas/errors" } } } } } }, "post": { "summary": "Create a Tailoring", "parameters": [ { "name": "X-RH-IDENTITY", "in": "header", "schema": { "type": "string" }, "description": "For internal use only" }, { "name": "policy_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "Policies" ], "description": "Create a Tailoring with the provided attributes (for ImageBuilder only)", "operationId": "CreateTailoring", "deprecated": true, "responses": { "201": { "description": "Creates a Tailoring", "content": { "application/vnd.api+json": { "examples": { "Response example": { "value": { "data": { "id": "4986d3e1-2bae-49c5-80c6-438b2e2a22be", "profile_id": "8b58dadb-0f23-4ae4-a7a3-08876d7cc20e", "os_minor_version": 1, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "ff05ea3f-1276-46ea-831e-88b260d93d5c", "security_guide_version": "100.98.23" } }, "summary": "", "description": "" } }, "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/tailoring" } } } } } } } } }, "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/tailoring_create" } } } } } }, "/policies/{policy_id}/tailorings/{tailoring_id}": { "get": { "summary": "Request a Tailoring", "parameters": [ { "name": "X-RH-IDENTITY", "in": "header", "schema": { "type": "string" }, "description": "For internal use only" }, { "name": "policy_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tailoring_id", "in": "path", "required": true, "description": "UUID **or** OS minor version number", "schema": { "type": "string" } } ], "tags": [ "Policies" ], "description": "Retrieve a specific tailoring.", "operationId": "Tailoring", "responses": { "200": { "description": "Returns a Tailoring", "content": { "application/vnd.api+json": { "examples": { "Returns a Tailoring": { "value": { "data": { "id": "8c94c41a-cf78-476a-a740-23e30c01f926", "profile_id": "915edc41-6076-409e-8a50-cfa4676cf385", "os_minor_version": 1, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "28edc935-da04-4a14-bd79-85aecd7033e8", "security_guide_version": "100.98.24" } }, "summary": "", "description": "" }, "Returns a Tailoring when using os_minor_version": { "value": { "data": { "id": "cf18d545-5601-4c7b-ae15-8f0d4100f89b", "profile_id": "59d2e266-6eff-4cac-820b-37af8d6df47a", "os_minor_version": 1, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "cd48df1a-0a7b-43cc-a002-64d0112d4e47", "security_guide_version": "100.98.25" } }, "summary": "", "description": "" } }, "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/tailoring" } } } } } } } }, "404": { "description": "Returns with Not Found", "content": { "application/vnd.api+json": { "examples": { "Description of an error when requesting a non-existing Tailoring": { "value": { "errors": [ "V2::Tailoring not found with ID 3715f3e4-e24e-4dd3-9df9-dca9b51214de" ] }, "summary": "", "description": "" } }, "schema": { "$ref": "#/components/schemas/errors" } } } } } }, "patch": { "summary": "Update a Tailoring", "parameters": [ { "name": "X-RH-IDENTITY", "in": "header", "schema": { "type": "string" }, "description": "For internal use only" }, { "name": "policy_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tailoring_id", "in": "path", "required": true, "description": "UUID **or** OS minor version number", "schema": { "type": "string" } } ], "tags": [ "Policies" ], "description": "Edit or update an existing tailoring.", "operationId": "UpdateTailoring", "responses": { "202": { "description": "Updates a Tailoring", "content": { "application/vnd.api+json": { "examples": { "Returns the updated Tailoring": { "value": { "data": { "id": "e71f3e59-e5ac-497e-a763-6a1e411f0239", "profile_id": "5fb92d8b-190a-494e-ac36-1899f1bdeebc", "os_minor_version": 1, "value_overrides": { "26f9f9fe-d838-44cc-8a06-970a9c6133fa": "123" }, "type": "tailoring", "os_major_version": 7, "security_guide_id": "1ed857c5-d0c3-41d4-a02a-d6f5a22bafe6", "security_guide_version": "100.98.26" } }, "summary": "", "description": "" }, "Returns the updated Tailoring when using os_minor_version": { "value": { "data": { "id": "1015e3b2-5bca-47ef-be13-2069ad480b09", "profile_id": "607c5a27-c1cb-4c64-acc8-4c5d42e9849e", "os_minor_version": 1, "value_overrides": { "66d95ba0-1f6e-4a17-8d8a-c519b0e4a178": "123" }, "type": "tailoring", "os_major_version": 7, "security_guide_id": "3f1d589f-f7ac-4e46-a81c-ea4c8178a20a", "security_guide_version": "100.98.27" } }, "summary": "", "description": "" } }, "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/tailoring" } } } } } } } } }, "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/tailoring" } } } } } }, "/policies/{policy_id}/tailorings/{tailoring_id}/rule_tree": { "get": { "summary": "Request the Rule Tree of a Tailoring", "parameters": [ { "name": "X-RH-IDENTITY", "in": "header", "schema": { "type": "string" }, "description": "For internal use only" }, { "name": "policy_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tailoring_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "Policies" ], "description": "Returns rule tree of a tailoring.", "operationId": "TailoringRuleTree", "deprecated": true, "responses": { "200": { "description": "Returns the Rule Tree of a Tailoring", "content": { "application/vnd.api+json": { "examples": { "Returns the Rule Tree of a Tailoring": { "value": [ { "id": "af06a11a-e72a-4bb1-9b40-9ccf02779a1a", "type": "rule_group", "children": [ { "id": "9a22abcc-ed03-4067-801b-d2da39a70ca3", "type": "rule" } ] }, { "id": "48573b36-9264-43f9-9bc7-8777a8af8153", "type": "rule_group", "children": [ { "id": "113c4554-8c71-439a-8561-80a848238605", "type": "rule" } ] }, { "id": "f5db396d-1d08-424c-b46b-55ddd84a408a", "type": "rule_group", "children": [ { "id": "9bd96222-78f0-4829-9bdd-580fbfc266f1", "type": "rule" } ] }, { "id": "17ab25e6-820d-48f1-a9ff-13c5f1ac2997", "type": "rule_group", "children": [ { "id": "86fa9683-122d-4912-b0d5-71b605393efe", "type": "rule" } ] }, { "id": "948dff7d-2ce9-4e4e-84eb-3da3b23f4926", "type": "rule_group", "children": [ { "id": "d9cb46f6-ed94-4732-b65c-0e3b6c23b925", "type": "rule" } ] }, { "id": "201f7b52-4d22-4122-affa-fe9e1a07b9c7", "type": "rule_group", "children": [ { "id": "3665b9ec-f0b1-44d7-a332-029c01d5a12f", "type": "rule" } ] }, { "id": "fccd29ea-79e1-4909-8ca4-a5f14e4990f9", "type": "rule_group", "children": [ { "id": "95a25c35-273d-41c5-a05b-8bb5b64511b8", "type": "rule" } ] }, { "id": "28303372-9fd7-43cc-af10-d9055eba86e8", "type": "rule_group", "children": [ { "id": "95ab20fc-47bf-4f12-98e2-210788e57c4d", "type": "rule" } ] }, { "id": "b7a18fae-e7b9-45b9-ba76-199771a91617", "type": "rule_group", "children": [ { "id": "cddead56-e867-4ef5-a4ce-afb8f40df9c8", "type": "rule" } ] }, { "id": "9ad52402-59eb-4c7a-908a-e99435514a0b", "type": "rule_group", "children": [ { "id": "56328e38-84da-4c22-93a5-bbda26793cad", "type": "rule" } ] } ], "summary": "", "description": "" } }, "schema": { "$ref": "#/components/schemas/rule_tree" } } } }, "404": { "description": "Returns with Not Found", "content": { "application/vnd.api+json": { "examples": { "Description of an error when requesting a non-existing Tailoring": { "value": { "errors": [ "V2::Tailoring not found with ID c64cb451-91c1-4ec7-8c86-8a5d5ee2f60d" ] }, "summary": "", "description": "" } }, "schema": { "$ref": "#/components/schemas/errors" } } } } } } }, "/policies/{policy_id}/tailorings/{tailoring_id}/tailoring_file.json": { "get": { "summary": "Request a Tailoring file", "parameters": [ { "name": "X-RH-IDENTITY", "in": "header", "schema": { "type": "string" }, "description": "For internal use only" }, { "name": "policy_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tailoring_id", "in": "path", "required": true, "description": "UUID **or** OS minor version number", "schema": { "type": "string" } } ], "tags": [ "Policies" ], "description": "Retrieve a tailoring file of a specific tailoring.", "operationId": "TailoringFileJSON", "responses": { "200": { "description": "Returns a Tailoring File", "content": { "application/vnd.api+json": { "examples": { "Returns a Tailoring File": { "value": { "profiles": [ { "id": "xccdf_org.ssgproject.content_profile_cf80dfd96d9eed923432b1d78308c99f", "base_profile_id": "xccdf_org.ssgproject.content_profile_cf80dfd96d9eed923432b1d78308c99f", "title": "Quis ut dolores rerum.", "groups": {}, "rules": {}, "variables": { "foo_value_1f80dc87-36e9-4d1c-81dc-cdc736a7941a": { "value": "461075" }, "foo_value_bd0a7957-f084-4039-999c-4aa7c3590a20": { "value": "137376" } } } ] }, "summary": "", "description": "" }, "Returns a Tailoring File while using os_minor_version": { "value": { "profiles": [ { "id": "xccdf_org.ssgproject.content_profile_167d5ae8331b0e5d123a1150ec164f37", "base_profile_id": "xccdf_org.ssgproject.content_profile_167d5ae8331b0e5d123a1150ec164f37", "title": "Dicta rerum provident quia.", "groups": {}, "rules": {}, "variables": { "foo_value_fd0df0e4-71cf-44c6-ae57-068b2fb7a0fe": { "value": "10768" }, "foo_value_8ae0ae98-02ae-41d2-8814-0e8cc9774c93": { "value": "317598" } } } ] }, "summary": "", "description": "" } }, "schema": { "$ref": "#/components/schemas/tailoring_file_json" } } } } } } }, "/policies/{policy_id}/tailorings/{tailoring_id}/tailoring_file.toml": { "get": { "summary": "Request a Tailoring file", "parameters": [ { "name": "X-RH-IDENTITY", "in": "header", "schema": { "type": "string" }, "description": "For internal use only" }, { "name": "policy_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tailoring_id", "in": "path", "required": true, "description": "UUID **or** OS minor version number", "schema": { "type": "string" } } ], "tags": [ "Policies" ], "description": "Retrieve a tailoring file of a specific tailoring containing an osbuild blueprint generated by OpenSCAP tooling.", "operationId": "TailoringFileTOML", "responses": { "200": { "description": "Returns a Tailoring File", "content": { "application/toml": { "examples": { "Returns a Tailoring File while using os_minor_version": { "value": "description = \"Distinctio dignissimos ipsa. Id quam rerum. Cupiditate voluptatem aliquid.\"\nname = \"In occaecati est ipsa.\"\nversion = \"100.102.21\"\n", "summary": "", "description": "" }, "Returns a Tailoring File": { "value": "description = \"Ullam laborum sunt. Explicabo ipsa ab. Quam autem harum.\"\nname = \"Aut delectus in excepturi.\"\nversion = \"100.103.28\"\n", "summary": "", "description": "" } }, "schema": { "$ref": "#/components/schemas/tailoring_file_toml" } } } } } } }, "/reports/{report_id}/test_results": { "get": { "summary": "Request Test Results under a Report", "parameters": [ { "name": "X-RH-IDENTITY", "in": "header", "schema": { "type": "string" }, "description": "For internal use only" }, { "name": "tags", "in": "query", "required": false, "description": "An array of tags to narrow down the search results. In case the value contains symbols used for separators (`/` or `=`), they need to be encoded.
e.g.: `namespace/key=value`, `insights-client/selinux-config=SELINUX%3Denforcing`", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "limit", "in": "query", "required": false, "description": "Number of items to return per page", "schema": { "type": "number", "maximum": 100, "minimum": 1, "default": 10 } }, { "name": "offset", "in": "query", "required": false, "description": "Offset of first item of paginated response", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "ids_only", "in": "query", "required": false, "description": "Indicates whether to return only resource IDs.", "schema": { "type": "boolean" } }, { "name": "sort_by", "in": "query", "required": false, "description": "Attribute and direction to sort the items by. Represented by an array of fields with an optional direction (`:asc` or `:desc`).

If no direction is selected, `:asc` is used by default.", "schema": { "type": "array", "items": { "enum": [ "display_name", "security_guide_version", "groups", "score", "end_time", "failed_rule_count", "display_name:asc", "display_name:desc", "security_guide_version:asc", "security_guide_version:desc", "groups:asc", "groups:desc", "score:asc", "score:desc", "end_time:asc", "end_time:desc", "failed_rule_count:asc", "failed_rule_count:desc" ] } } }, { "name": "filter", "in": "query", "required": false, "description": "Query string to filter items by their attributes. Compliant with scoped_search query language. However, only `=` or `!=` (resp. `<>`) operators are supported.

Test Results are searchable using attributes `score`, `supported`, `system_id`, `display_name`, `os_minor_version`, `security_guide_version`, `compliant`, `group_name`, `group_id`, and `failed_rule_severity`

(e.g.: `(field_1=something AND field_2!=\"something else\") OR field_3>40`)", "schema": { "type": "string" } }, { "name": "report_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "Reports" ], "description": "Retrieve all of the test results for a specific report.", "operationId": "ReportTestResults", "responses": { "200": { "description": "Lists Test Results under a Report", "content": { "application/vnd.api+json": { "examples": { "List of Test Results": { "value": { "data": [ { "id": "01e8eec3-bb0b-4051-84ef-7ae6067a90c2", "end_time": "2026-05-26T10:20:11.853Z", "failed_rule_count": 0, "supported": true, "score": 84.52113584721558, "type": "test_result", "display_name": "klein.test", "groups": [], "tags": [ { "key": "panel", "value": "back-end", "namespace": "parsing" }, { "key": "program", "value": "cross-platform", "namespace": "generating" }, { "key": "transmitter", "value": "auxiliary", "namespace": "hacking" }, { "key": "capacitor", "value": "bluetooth", "namespace": "calculating" }, { "key": "bus", "value": "digital", "namespace": "bypassing" } ], "os_major_version": 8, "os_minor_version": 0, "compliant": false, "system_id": "d1f1d354-c553-4839-8ca0-96cfed354c57", "security_guide_version": "100.104.32" }, { "id": "0b4bb18c-1534-413d-9dcf-4a5843e1522d", "end_time": "2026-05-26T10:20:12.048Z", "failed_rule_count": 0, "supported": true, "score": 25.95289770757479, "type": "test_result", "display_name": "heathcote-price.example", "groups": [], "tags": [ { "key": "driver", "value": "wireless", "namespace": "compressing" }, { "key": "interface", "value": "neural", "namespace": "connecting" }, { "key": "transmitter", "value": "virtual", "namespace": "backing up" }, { "key": "port", "value": "haptic", "namespace": "bypassing" }, { "key": "driver", "value": "open-source", "namespace": "transmitting" } ], "os_major_version": 8, "os_minor_version": 0, "compliant": false, "system_id": "e32c8d22-d4b9-4b5b-a87b-f484f1853582", "security_guide_version": "100.104.32" }, { "id": "11b9f7f9-9c3e-419c-a4cf-f5a57d01cccf", "end_time": "2026-05-26T10:20:12.088Z", "failed_rule_count": 0, "supported": true, "score": 58.89490381882461, "type": "test_result", "display_name": "wiza-stoltenberg.test", "groups": [], "tags": [ { "key": "hard drive", "value": "haptic", "namespace": "parsing" }, { "key": "circuit", "value": "online", "namespace": "overriding" }, { "key": "pixel", "value": "multi-byte", "namespace": "connecting" }, { "key": "array", "value": "back-end", "namespace": "backing up" }, { "key": "port", "value": "wireless", "namespace": "transmitting" } ], "os_major_version": 8, "os_minor_version": 0, "compliant": false, "system_id": "42005c6a-7e29-4a3d-9a02-d7bb64c73285", "security_guide_version": "100.104.32" }, { "id": "1d6c3574-ca47-45c0-afa9-989791c794d0", "end_time": "2026-05-26T10:20:12.009Z", "failed_rule_count": 0, "supported": true, "score": 49.54618146769524, "type": "test_result", "display_name": "smith.test", "groups": [], "tags": [ { "key": "circuit", "value": "back-end", "namespace": "generating" }, { "key": "circuit", "value": "bluetooth", "namespace": "overriding" }, { "key": "port", "value": "haptic", "namespace": "hacking" }, { "key": "bandwidth", "value": "redundant", "namespace": "connecting" }, { "key": "pixel", "value": "redundant", "namespace": "compressing" } ], "os_major_version": 8, "os_minor_version": 0, "compliant": false, "system_id": "fbd8b7b4-2e85-43ea-8f3c-0c2ab7451152", "security_guide_version": "100.104.32" }, { "id": "20bb5895-29eb-44f3-a3e1-bcfde0785a8e", "end_time": "2026-05-26T10:20:11.867Z", "failed_rule_count": 0, "supported": true, "score": 28.33755111218326, "type": "test_result", "display_name": "dickinson-nikolaus.example", "groups": [], "tags": [ { "key": "array", "value": "neural", "namespace": "synthesizing" }, { "key": "protocol", "value": "wireless", "namespace": "backing up" }, { "key": "panel", "value": "multi-byte", "namespace": "hacking" }, { "key": "microchip", "value": "cross-platform", "namespace": "overriding" }, { "key": "feed", "value": "auxiliary", "namespace": "calculating" } ], "os_major_version": 8, "os_minor_version": 0, "compliant": false, "system_id": "d11fee87-618b-407e-a6c5-4f6dbdd453a1", "security_guide_version": "100.104.32" }, { "id": "45b6cea1-28c3-4a9e-9c46-d71b9c89e87f", "end_time": "2026-05-26T10:20:11.802Z", "failed_rule_count": 0, "supported": true, "score": 7.852387567497232, "type": "test_result", "display_name": "wiza-fadel.test", "groups": [], "tags": [ { "key": "card", "value": "back-end", "namespace": "programming" }, { "key": "pixel", "value": "optical", "namespace": "connecting" }, { "key": "pixel", "value": "online", "namespace": "navigating" }, { "key": "panel", "value": "wireless", "namespace": "calculating" }, { "key": "sensor", "value": "mobile", "namespace": "backing up" } ], "os_major_version": 8, "os_minor_version": 0, "compliant": false, "system_id": "21b5f525-efdc-4827-a170-892db8371edf", "security_guide_version": "100.104.32" }, { "id": "4702f654-ee98-4b11-9745-dac1a825d5df", "end_time": "2026-05-26T10:20:11.812Z", "failed_rule_count": 0, "supported": true, "score": 99.65221493613686, "type": "test_result", "display_name": "schowalter.test", "groups": [], "tags": [ { "key": "transmitter", "value": "digital", "namespace": "hacking" }, { "key": "matrix", "value": "primary", "namespace": "quantifying" }, { "key": "matrix", "value": "multi-byte", "namespace": "compressing" }, { "key": "microchip", "value": "digital", "namespace": "transmitting" }, { "key": "sensor", "value": "neural", "namespace": "transmitting" } ], "os_major_version": 8, "os_minor_version": 0, "compliant": true, "system_id": "a5a1ba73-d81a-4500-87ef-9dd58a22b63f", "security_guide_version": "100.104.32" }, { "id": "4fb3c1fe-c564-49bd-b661-a6970d5a0b0c", "end_time": "2026-05-26T10:20:11.972Z", "failed_rule_count": 0, "supported": true, "score": 87.23558760331836, "type": "test_result", "display_name": "toy-tillman.test", "groups": [], "tags": [ { "key": "system", "value": "virtual", "namespace": "indexing" }, { "key": "system", "value": "back-end", "namespace": "calculating" }, { "key": "firewall", "value": "neural", "namespace": "bypassing" }, { "key": "hard drive", "value": "multi-byte", "namespace": "calculating" }, { "key": "matrix", "value": "primary", "namespace": "indexing" } ], "os_major_version": 8, "os_minor_version": 0, "compliant": false, "system_id": "8d28b607-4882-4b67-8827-6ef0d0dac4c3", "security_guide_version": "100.104.32" }, { "id": "52564779-be8c-4b92-ac38-5d5a48d02734", "end_time": "2026-05-26T10:20:12.264Z", "failed_rule_count": 0, "supported": true, "score": 64.74401503375394, "type": "test_result", "display_name": "littel-corwin.test", "groups": [], "tags": [ { "key": "feed", "value": "primary", "namespace": "copying" }, { "key": "array", "value": "virtual", "namespace": "compressing" }, { "key": "pixel", "value": "auxiliary", "namespace": "compressing" }, { "key": "protocol", "value": "redundant", "namespace": "programming" }, { "key": "bus", "value": "virtual", "namespace": "indexing" } ], "os_major_version": 8, "os_minor_version": 0, "compliant": false, "system_id": "8f894970-96b6-48b6-a217-3f77ae39e856", "security_guide_version": "100.104.32" }, { "id": "5565df35-2ee0-472f-ba2a-af0ddae86f69", "end_time": "2026-05-26T10:20:12.211Z", "failed_rule_count": 0, "supported": true, "score": 77.23009305758418, "type": "test_result", "display_name": "schiller-berge.test", "groups": [], "tags": [ { "key": "transmitter", "value": "wireless", "namespace": "generating" }, { "key": "firewall", "value": "primary", "namespace": "indexing" }, { "key": "application", "value": "primary", "namespace": "compressing" }, { "key": "firewall", "value": "redundant", "namespace": "compressing" }, { "key": "bus", "value": "optical", "namespace": "compressing" } ], "os_major_version": 8, "os_minor_version": 0, "compliant": false, "system_id": "1db178ad-8afe-4f71-8c4a-468e1e23956b", "security_guide_version": "100.104.32" } ], "meta": { "total": 25, "tags": [], "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/reports/dccfea6d-3d95-4339-9133-c7eefe9185a9/test_results?limit=10&offset=0", "last": "/api/compliance/v2/reports/dccfea6d-3d95-4339-9133-c7eefe9185a9/test_results?limit=10&offset=20", "next": "/api/compliance/v2/reports/dccfea6d-3d95-4339-9133-c7eefe9185a9/test_results?limit=10&offset=10" } }, "summary": "", "description": "" }, "List of Test Results sorted by \"score:asc\"": { "value": { "data": [ { "id": "201b6469-d4f4-466a-ae06-8ba3355e3cb7", "end_time": "2026-05-26T10:20:12.968Z", "failed_rule_count": 0, "supported": true, "score": 3.083724948733646, "type": "test_result", "display_name": "stiedemann.example", "groups": [], "tags": [ { "key": "transmitter", "value": "back-end", "namespace": "generating" }, { "key": "matrix", "value": "optical", "namespace": "parsing" }, { "key": "capacitor", "value": "optical", "namespace": "generating" }, { "key": "bandwidth", "value": "solid state", "namespace": "navigating" }, { "key": "monitor", "value": "open-source", "namespace": "bypassing" } ], "os_major_version": 8, "os_minor_version": 0, "compliant": false, "system_id": "942954e3-30ce-4520-9252-7406c68eb036", "security_guide_version": "100.105.49" }, { "id": "bc70a2ca-d7ff-4493-bfab-d75373e55797", "end_time": "2026-05-26T10:20:13.108Z", "failed_rule_count": 0, "supported": true, "score": 4.381475478672803, "type": "test_result", "display_name": "gulgowski.test", "groups": [], "tags": [ { "key": "sensor", "value": "digital", "namespace": "connecting" }, { "key": "microchip", "value": "optical", "namespace": "programming" }, { "key": "transmitter", "value": "neural", "namespace": "overriding" }, { "key": "system", "value": "back-end", "namespace": "generating" }, { "key": "pixel", "value": "cross-platform", "namespace": "synthesizing" } ], "os_major_version": 8, "os_minor_version": 0, "compliant": false, "system_id": "c28edfc7-c0d4-4463-8cba-758a4b6aabd7", "security_guide_version": "100.105.49" }, { "id": "7b37c61e-6e1a-4a56-85be-a6df1657ee41", "end_time": "2026-05-26T10:20:13.098Z", "failed_rule_count": 0, "supported": true, "score": 4.913737279776908, "type": "test_result", "display_name": "graham.test", "groups": [], "tags": [ { "key": "bandwidth", "value": "online", "namespace": "quantifying" }, { "key": "alarm", "value": "multi-byte", "namespace": "generating" }, { "key": "monitor", "value": "auxiliary", "namespace": "programming" }, { "key": "panel", "value": "multi-byte", "namespace": "connecting" }, { "key": "capacitor", "value": "virtual", "namespace": "copying" } ], "os_major_version": 8, "os_minor_version": 0, "compliant": false, "system_id": "bc85c630-8d64-473f-82ee-b138a3eeb867", "security_guide_version": "100.105.49" }, { "id": "ea901aae-7509-4e13-bb07-e60f2ee88beb", "end_time": "2026-05-26T10:20:12.880Z", "failed_rule_count": 0, "supported": true, "score": 10.31744226503905, "type": "test_result", "display_name": "zemlak-west.test", "groups": [], "tags": [ { "key": "card", "value": "auxiliary", "namespace": "calculating" }, { "key": "matrix", "value": "wireless", "namespace": "quantifying" }, { "key": "card", "value": "optical", "namespace": "connecting" }, { "key": "array", "value": "optical", "namespace": "indexing" }, { "key": "alarm", "value": "online", "namespace": "generating" } ], "os_major_version": 8, "os_minor_version": 0, "compliant": false, "system_id": "bf2e06bc-eb2f-4e5b-9b2d-2679474b1d5b", "security_guide_version": "100.105.49" }, { "id": "d97f6e4a-de6d-4634-be1b-3eb99687dc48", "end_time": "2026-05-26T10:20:12.836Z", "failed_rule_count": 0, "supported": true, "score": 14.0999493996868, "type": "test_result", "display_name": "gottlieb.test", "groups": [], "tags": [ { "key": "microchip", "value": "primary", "namespace": "copying" }, { "key": "circuit", "value": "solid state", "namespace": "copying" }, { "key": "matrix", "value": "auxiliary", "namespace": "programming" }, { "key": "bus", "value": "multi-byte", "namespace": "compressing" }, { "key": "firewall", "value": "auxiliary", "namespace": "copying" } ], "os_major_version": 8, "os_minor_version": 0, "compliant": false, "system_id": "777b8fea-afed-442b-bb01-d5d19a01924a", "security_guide_version": "100.105.49" }, { "id": "cf2a9025-0308-483b-8ae9-d8937796408e", "end_time": "2026-05-26T10:20:13.056Z", "failed_rule_count": 0, "supported": true, "score": 23.44125261167361, "type": "test_result", "display_name": "aufderhar.example", "groups": [], "tags": [ { "key": "pixel", "value": "wireless", "namespace": "copying" }, { "key": "application", "value": "open-source", "namespace": "navigating" }, { "key": "matrix", "value": "virtual", "namespace": "navigating" }, { "key": "microchip", "value": "mobile", "namespace": "synthesizing" }, { "key": "bandwidth", "value": "back-end", "namespace": "indexing" } ], "os_major_version": 8, "os_minor_version": 0, "compliant": false, "system_id": "49e58508-272c-4657-861d-be2cfaf9028c", "security_guide_version": "100.105.49" }, { "id": "9b8b5cce-1920-43dc-8985-e788a98494dc", "end_time": "2026-05-26T10:20:13.077Z", "failed_rule_count": 0, "supported": true, "score": 31.86743737583451, "type": "test_result", "display_name": "metz.example", "groups": [], "tags": [ { "key": "application", "value": "multi-byte", "namespace": "generating" }, { "key": "driver", "value": "optical", "namespace": "compressing" }, { "key": "card", "value": "online", "namespace": "indexing" }, { "key": "bandwidth", "value": "mobile", "namespace": "programming" }, { "key": "capacitor", "value": "1080p", "namespace": "hacking" } ], "os_major_version": 8, "os_minor_version": 0, "compliant": false, "system_id": "fbf23d57-a4b1-424c-aa86-a30c1fd829a3", "security_guide_version": "100.105.49" }, { "id": "61c0a085-4540-4a5d-86d0-d6bea5ba69c7", "end_time": "2026-05-26T10:20:12.890Z", "failed_rule_count": 0, "supported": true, "score": 33.09820179936971, "type": "test_result", "display_name": "kohler.example", "groups": [], "tags": [ { "key": "matrix", "value": "bluetooth", "namespace": "indexing" }, { "key": "bus", "value": "open-source", "namespace": "indexing" }, { "key": "capacitor", "value": "virtual", "namespace": "hacking" }, { "key": "sensor", "value": "virtual", "namespace": "hacking" }, { "key": "alarm", "value": "open-source", "namespace": "backing up" } ], "os_major_version": 8, "os_minor_version": 0, "compliant": false, "system_id": "b131e296-80e1-464b-b08d-fd4c15e490df", "security_guide_version": "100.105.49" }, { "id": "30413821-3586-4cd3-bc41-60c7f6aac14e", "end_time": "2026-05-26T10:20:13.046Z", "failed_rule_count": 0, "supported": true, "score": 34.51317917600404, "type": "test_result", "display_name": "runolfsdottir.test", "groups": [], "tags": [ { "key": "microchip", "value": "back-end", "namespace": "indexing" }, { "key": "driver", "value": "1080p", "namespace": "compressing" }, { "key": "protocol", "value": "optical", "namespace": "hacking" }, { "key": "array", "value": "1080p", "namespace": "compressing" }, { "key": "sensor", "value": "digital", "namespace": "connecting" } ], "os_major_version": 8, "os_minor_version": 0, "compliant": false, "system_id": "c5f42c99-2972-4ee1-abff-d2ad4377d1f9", "security_guide_version": "100.105.49" }, { "id": "a9385d13-d39d-41c8-a829-1010b24eb40f", "end_time": "2026-05-26T10:20:13.005Z", "failed_rule_count": 0, "supported": true, "score": 34.8014180569018, "type": "test_result", "display_name": "batz.test", "groups": [], "tags": [ { "key": "feed", "value": "solid state", "namespace": "parsing" }, { "key": "pixel", "value": "multi-byte", "namespace": "overriding" }, { "key": "array", "value": "auxiliary", "namespace": "bypassing" }, { "key": "feed", "value": "1080p", "namespace": "overriding" }, { "key": "bus", "value": "wireless", "namespace": "parsing" } ], "os_major_version": 8, "os_minor_version": 0, "compliant": false, "system_id": "9b04325d-78f3-4826-8e37-3ec7c07b24ab", "security_guide_version": "100.105.49" } ], "meta": { "total": 25, "tags": [], "limit": 10, "offset": 0, "sort_by": "score" }, "links": { "first": "/api/compliance/v2/reports/c06fcc7c-8363-4295-95b9-b6a4d6f3afd8/test_results?limit=10&offset=0&sort_by=score", "last": "/api/compliance/v2/reports/c06fcc7c-8363-4295-95b9-b6a4d6f3afd8/test_results?limit=10&offset=20&sort_by=score", "next": "/api/compliance/v2/reports/c06fcc7c-8363-4295-95b9-b6a4d6f3afd8/test_results?limit=10&offset=10&sort_by=score" } }, "summary": "", "description": "" }, "List of Test Results filtered by \"(os_minor_version=8)\"": { "value": { "data": [], "meta": { "total": 0, "filter": "(os_minor_version=8)", "tags": [], "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/reports/79afbd25-6abb-4fb7-b412-4ec90fd7601d/test_results?filter=%28os_minor_version%3D8%29&limit=10&offset=0", "last": "/api/compliance/v2/reports/79afbd25-6abb-4fb7-b412-4ec90fd7601d/test_results?filter=%28os_minor_version%3D8%29&limit=10&offset=0" } }, "summary": "", "description": "" } }, "schema": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/metadata" }, "links": { "$ref": "#/components/schemas/links" }, "data": { "type": "array", "items": { "properties": { "schema": { "$ref": "#/components/schemas/test_result" } } } } } } } } }, "422": { "description": "Returns with Unprocessable Content", "content": { "application/vnd.api+json": { "examples": { "Description of an error when sorting by incorrect parameter": { "value": { "errors": [ "Result cannot be sorted by the 'description' column." ] }, "summary": "", "description": "" }, "Description of an error when requesting higher limit than supported": { "value": { "errors": [ "Invalid parameter: limit must be less than or equal to 100" ] }, "summary": "", "description": "" } }, "schema": { "$ref": "#/components/schemas/errors" } } } } } } }, "/reports/{report_id}/test_results/os_versions": { "get": { "summary": "Request the list of available OS versions", "parameters": [ { "name": "X-RH-IDENTITY", "in": "header", "schema": { "type": "string" }, "description": "For internal use only" }, { "name": "filter", "in": "query", "required": false, "description": "Query string to filter items by their attributes. Compliant with scoped_search query language. However, only `=` or `!=` (resp. `<>`) operators are supported.

Test Results are searchable using attributes `score`, `supported`, `system_id`, `display_name`, `os_minor_version`, `security_guide_version`, `compliant`, `group_name`, `group_id`, and `failed_rule_severity`

(e.g.: `(field_1=something AND field_2!=\"something else\") OR field_3>40`)", "schema": { "type": "string" } }, { "name": "report_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "Reports" ], "description": "This feature is exclusively used by the frontend", "operationId": "ReportTestResultsOS", "deprecated": true, "responses": { "200": { "description": "Lists available OS versions", "content": { "application/vnd.api+json": { "examples": { "List of available OS versions": { "value": [ "8.0" ], "summary": "", "description": "" } }, "schema": { "type": "array", "items": { "type": "string" } } } } } } } }, "/reports/{report_id}/test_results/security_guide_versions": { "get": { "summary": "Request the list of available Security Guide versions", "parameters": [ { "name": "X-RH-IDENTITY", "in": "header", "schema": { "type": "string" }, "description": "For internal use only" }, { "name": "report_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "Reports" ], "description": "This feature is exclusively used by the frontend", "operationId": "ReportTestResultsSG", "deprecated": true, "responses": { "200": { "description": "Lists available Security Guide versions", "content": { "application/vnd.api+json": { "examples": { "List of available Security Guide versions": { "value": [ "100.111.47" ], "summary": "", "description": "" } }, "schema": { "type": "array", "items": { "type": "string" } } } } } } } }, "/reports/{report_id}/test_results/{test_result_id}": { "get": { "summary": "Request a Test Result", "parameters": [ { "name": "X-RH-IDENTITY", "in": "header", "schema": { "type": "string" }, "description": "For internal use only" }, { "name": "test_result_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "report_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "Reports" ], "description": "Retrieve a specific test result for a specific report.", "operationId": "ReportTestResult", "responses": { "200": { "description": "Returns a Test Result under a Report", "content": { "application/vnd.api+json": { "examples": { "Returns a Test Result under a Report": { "value": { "data": { "id": "89214864-0c70-4bb2-9ff5-c93c8da0c82e", "end_time": "2026-05-26T10:20:17.001Z", "failed_rule_count": 0, "supported": true, "score": 94.74176910542772, "type": "test_result", "display_name": "langworth.example", "groups": [], "tags": [ { "key": "array", "value": "bluetooth", "namespace": "navigating" }, { "key": "monitor", "value": "optical", "namespace": "compressing" }, { "key": "application", "value": "mobile", "namespace": "hacking" }, { "key": "card", "value": "online", "namespace": "quantifying" }, { "key": "hard drive", "value": "open-source", "namespace": "programming" } ], "os_major_version": 8, "os_minor_version": 0, "compliant": true, "system_id": "abe857e1-87ac-4d5b-a386-55d7fcdd4561", "security_guide_version": "100.113.14" } }, "summary": "", "description": "" } }, "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/system" } } } } } } } }, "404": { "description": "Returns with Not Found", "content": { "application/vnd.api+json": { "examples": { "Description of an error when requesting a non-existing Test Result": { "value": { "errors": [ "V2::TestResult not found with ID 7366d05d-0e72-4e4e-81f1-b6c4fa5f5370" ] }, "summary": "", "description": "" } }, "schema": { "$ref": "#/components/schemas/errors" } } } } } } }, "/security_guides/{security_guide_id}/value_definitions": { "get": { "summary": "Request Value Definitions", "parameters": [ { "name": "X-RH-IDENTITY", "in": "header", "schema": { "type": "string" }, "description": "For internal use only" }, { "name": "limit", "in": "query", "required": false, "description": "Number of items to return per page", "schema": { "type": "number", "maximum": 100, "minimum": 1, "default": 10 } }, { "name": "offset", "in": "query", "required": false, "description": "Offset of first item of paginated response", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "ids_only", "in": "query", "required": false, "description": "Indicates whether to return only resource IDs.", "schema": { "type": "boolean" } }, { "name": "sort_by", "in": "query", "required": false, "description": "Attribute and direction to sort the items by. Represented by an array of fields with an optional direction (`:asc` or `:desc`).

If no direction is selected, `:asc` is used by default.", "schema": { "type": "array", "items": { "enum": [ "title", "title:asc", "title:desc" ] } } }, { "name": "filter", "in": "query", "required": false, "description": "Query string to filter items by their attributes. Compliant with scoped_search query language. However, only `=` or `!=` (resp. `<>`) operators are supported.

Value Definitions are searchable using attributes `title` and `ref_id`

(e.g.: `(field_1=something AND field_2!=\"something else\") OR field_3>40`)", "schema": { "type": "string" } }, { "name": "security_guide_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "Content" ], "description": "Retrieve a list of the fields which can be edited within a profile.", "operationId": "ValueDefinitions", "responses": { "200": { "description": "Lists Value Definitions", "content": { "application/vnd.api+json": { "examples": { "List of Value Definitions": { "value": { "data": [ { "id": "09a6448f-f391-4dac-8bf2-5c1361a35aa0", "ref_id": "foo_value_ee387e37-4caa-404b-a1fc-d599f889bcc8", "title": "Enim sit atque voluptas.", "description": "Nesciunt veniam perferendis. Architecto non asperiores. Voluptas quod quia.", "value_type": "number", "default_value": "0.7307832188334862", "type": "value_definition" }, { "id": "170a6c18-5b69-458d-9b6c-433840d6ca50", "ref_id": "foo_value_20877e16-8bc4-470c-99c6-84bda1b61f2b", "title": "Perspiciatis qui eum modi.", "description": "Ducimus dicta rerum. Mollitia consequuntur repellendus. Quidem cupiditate quia.", "value_type": "number", "default_value": "0.8430726710775431", "type": "value_definition" }, { "id": "271ca95c-db9e-4970-af8c-eee4da6b9811", "ref_id": "foo_value_f9a0f655-4cc4-4b86-a31e-c7acf861ce66", "title": "Non et doloribus ex.", "description": "Cumque animi et. Eveniet perspiciatis aut. Non et similique.", "value_type": "number", "default_value": "0.3734382628307221", "type": "value_definition" }, { "id": "2f7e41c6-7ea6-42e1-a33b-673f6158b304", "ref_id": "foo_value_263828c9-8811-4c96-a48b-5ddeafc98272", "title": "Est voluptates veritatis aut.", "description": "Rem voluptas reprehenderit. Consequatur repellat possimus. Quia itaque omnis.", "value_type": "number", "default_value": "0.7239671088483839", "type": "value_definition" }, { "id": "3fcd0c6a-5cd5-40c8-ba91-85bb691c2915", "ref_id": "foo_value_04e65692-d799-400c-a216-e85aa50f7f97", "title": "Neque in et labore.", "description": "Sit est et. Recusandae non veritatis. Saepe ea laborum.", "value_type": "number", "default_value": "0.6236283116481277", "type": "value_definition" }, { "id": "4686b8ec-cb6a-4d88-ad58-cc00cc9eb21a", "ref_id": "foo_value_f774d00c-1b13-4af8-a559-30dbe01341d4", "title": "Rem placeat sequi sit.", "description": "Officiis dolores officia. Necessitatibus et quidem. Pariatur quibusdam eos.", "value_type": "number", "default_value": "0.10000368105944835", "type": "value_definition" }, { "id": "4abbb422-331d-4367-9022-c2a1e55651c1", "ref_id": "foo_value_98f3c49d-e8f9-4953-8935-22053a0e2775", "title": "Aspernatur necessitatibus nihil numquam.", "description": "Eos qui vel. Quam quidem possimus. Facere illum corrupti.", "value_type": "number", "default_value": "0.7356940650060987", "type": "value_definition" }, { "id": "4b685818-b45a-43e8-ae31-21721c79bb4a", "ref_id": "foo_value_bbbfc3ca-3d52-4016-a3ca-e9ad0c890cca", "title": "Voluptatem aut nisi placeat.", "description": "Vel quae optio. Consequuntur vel ipsa. Blanditiis quo repellendus.", "value_type": "number", "default_value": "0.7081488822939329", "type": "value_definition" }, { "id": "5284a73e-a4b3-40c0-b285-f2b28d9c2a9d", "ref_id": "foo_value_32ab29f1-7d1e-4527-b9fa-28c34dfac000", "title": "Alias quam eligendi nam.", "description": "Qui et beatae. Voluptatem sed sunt. Animi vel illo.", "value_type": "number", "default_value": "0.9227818532547599", "type": "value_definition" }, { "id": "58ae7f68-d970-4bb2-ac14-a195cfbf2c51", "ref_id": "foo_value_b36f7eff-64b3-49b8-bea5-d41a5373763d", "title": "Et dolor blanditiis eos.", "description": "Voluptatem nesciunt non. Occaecati et consequuntur. Aut deserunt ut.", "value_type": "number", "default_value": "0.5559506355850092", "type": "value_definition" } ], "meta": { "total": 25, "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/security_guides/f7fe8a04-0b0f-467e-8696-0a5ae7804cfa/value_definitions?limit=10&offset=0", "last": "/api/compliance/v2/security_guides/f7fe8a04-0b0f-467e-8696-0a5ae7804cfa/value_definitions?limit=10&offset=20", "next": "/api/compliance/v2/security_guides/f7fe8a04-0b0f-467e-8696-0a5ae7804cfa/value_definitions?limit=10&offset=10" } }, "summary": "", "description": "" }, "List of Value Definitions sorted by \"title:asc\"": { "value": { "data": [ { "id": "98f8cc99-8774-4d53-9c73-3d6a9a7e9707", "ref_id": "foo_value_66f9a2cf-93c1-4936-ae19-2f2e141e6b34", "title": "Aut maxime accusantium in.", "description": "Sapiente est blanditiis. Eaque ut fuga. Possimus et dolores.", "value_type": "number", "default_value": "0.43652721368157255", "type": "value_definition" }, { "id": "0c1ff984-dd6a-4527-8245-2c8634921686", "ref_id": "foo_value_bfc29f4a-7e19-41dd-9f8f-76b47169f258", "title": "Est sed rerum et.", "description": "Et voluptatem eum. Non quasi nihil. Est blanditiis magnam.", "value_type": "number", "default_value": "0.3627093790097151", "type": "value_definition" }, { "id": "6c756459-a770-4a10-b1b3-ba4ed15b6b66", "ref_id": "foo_value_20145261-29bb-45c1-a397-81e8a7eac138", "title": "Ex voluptas molestiae optio.", "description": "Enim adipisci facere. Error magni rerum. Ea explicabo tempora.", "value_type": "number", "default_value": "0.2367119299812216", "type": "value_definition" }, { "id": "37089a14-d870-4035-8741-cb087621181f", "ref_id": "foo_value_ddfeca15-a92c-4bee-9194-649696c060f4", "title": "Exercitationem omnis alias aliquid.", "description": "Eveniet aperiam blanditiis. Sed laboriosam suscipit. Modi totam voluptatibus.", "value_type": "number", "default_value": "0.739472957026416", "type": "value_definition" }, { "id": "e2f18b22-409b-4ef3-b9cb-b7e8ac3fbaf5", "ref_id": "foo_value_6fa32e6d-7a5b-444d-8617-fc381ec9e767", "title": "Fuga dignissimos ullam sit.", "description": "Vel praesentium perferendis. Debitis qui illo. Iusto optio qui.", "value_type": "number", "default_value": "0.23197132767949213", "type": "value_definition" }, { "id": "b68b5ee8-f7a9-4129-85d1-7687ad4a925c", "ref_id": "foo_value_75a94523-6e78-4d0b-9c85-278140f108df", "title": "Hic unde esse quis.", "description": "Deserunt rerum vitae. Ea eligendi et. Rerum eius omnis.", "value_type": "number", "default_value": "0.14673591482083548", "type": "value_definition" }, { "id": "d65427df-f21f-4fe6-97e0-b70c3a1471d6", "ref_id": "foo_value_0a17e02a-5ba9-4d3c-b7a6-49f14aa2b32b", "title": "Nam at quisquam quia.", "description": "Voluptas nostrum deleniti. Aut rem quis. Quia dolorum molestiae.", "value_type": "number", "default_value": "0.26457474222847244", "type": "value_definition" }, { "id": "17b148c3-c338-4ee6-9835-e895d208c0d8", "ref_id": "foo_value_11fe616a-9282-44bb-a0a1-da864adec72f", "title": "Nobis beatae nihil autem.", "description": "Doloremque expedita perspiciatis. Quaerat voluptatum consequuntur. Porro deserunt sit.", "value_type": "number", "default_value": "0.1319783302649582", "type": "value_definition" }, { "id": "0bf3b830-ed1f-4108-8d56-cf757ae2242c", "ref_id": "foo_value_3d66e514-9d8c-4c89-9032-b1264e53ea7e", "title": "Nulla facere tenetur necessitatibus.", "description": "Doloribus delectus consequatur. Nobis necessitatibus porro. Neque quod ut.", "value_type": "number", "default_value": "0.447018012321427", "type": "value_definition" }, { "id": "b943b158-b1eb-4af7-ac66-144b62759547", "ref_id": "foo_value_d5ac1d62-d4e0-4304-9a7e-63893122f6c1", "title": "Odio eos aut vitae.", "description": "Aut earum rem. Libero reprehenderit magnam. Mollitia et nisi.", "value_type": "number", "default_value": "0.013265216787442413", "type": "value_definition" } ], "meta": { "total": 25, "limit": 10, "offset": 0, "sort_by": "title" }, "links": { "first": "/api/compliance/v2/security_guides/012cfc45-6d3a-4426-a28c-3581d2976fc7/value_definitions?limit=10&offset=0&sort_by=title", "last": "/api/compliance/v2/security_guides/012cfc45-6d3a-4426-a28c-3581d2976fc7/value_definitions?limit=10&offset=20&sort_by=title", "next": "/api/compliance/v2/security_guides/012cfc45-6d3a-4426-a28c-3581d2976fc7/value_definitions?limit=10&offset=10&sort_by=title" } }, "summary": "", "description": "" }, "List of Value Definitions filtered by '(title=Nisi doloribus excepturi illo.)'": { "value": { "data": [ { "id": "02d92fbe-8c05-4d18-a72e-49b0d98e2c64", "ref_id": "foo_value_d70bef11-3059-4217-aa31-552e80ed9217", "title": "Nisi doloribus excepturi illo.", "description": "Magni voluptatem ad. Et eum porro. Voluptates voluptatem architecto.", "value_type": "number", "default_value": "0.5934354566076198", "type": "value_definition" } ], "meta": { "total": 1, "filter": "(title=\"Nisi doloribus excepturi illo.\")", "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/security_guides/ad60a5b5-60f7-4885-8438-3249b4e3bdc6/value_definitions?filter=%28title%3D%22Nisi+doloribus+excepturi+illo.%22%29&limit=10&offset=0", "last": "/api/compliance/v2/security_guides/ad60a5b5-60f7-4885-8438-3249b4e3bdc6/value_definitions?filter=%28title%3D%22Nisi+doloribus+excepturi+illo.%22%29&limit=10&offset=0" } }, "summary": "", "description": "" } }, "schema": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/metadata" }, "links": { "$ref": "#/components/schemas/links" }, "data": { "type": "array", "items": { "properties": { "schema": { "$ref": "#/components/schemas/value_definition" } } } } } } } } }, "422": { "description": "Returns with Unprocessable Content", "content": { "application/vnd.api+json": { "examples": { "Description of an error when sorting by incorrect parameter": { "value": { "errors": [ "Result cannot be sorted by the 'description' column." ] }, "summary": "", "description": "" }, "Description of an error when requesting higher limit than supported": { "value": { "errors": [ "Invalid parameter: limit must be less than or equal to 100" ] }, "summary": "", "description": "" } }, "schema": { "$ref": "#/components/schemas/errors" } } } } } } }, "/security_guides/{security_guide_id}/value_definitions/{value_definition_id}": { "get": { "summary": "Request a Value Definition", "parameters": [ { "name": "X-RH-IDENTITY", "in": "header", "schema": { "type": "string" }, "description": "For internal use only" }, { "name": "security_guide_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "value_definition_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "Content" ], "description": "Retrieve a specific value definition.", "operationId": "ValueDefinition", "responses": { "200": { "description": "Returns a Value Definition", "content": { "application/vnd.api+json": { "examples": { "Returns a Value Definition": { "value": { "data": { "id": "4b9d5759-e849-467c-b489-1bf9fd64ce46", "ref_id": "foo_value_5e4f52b2-ec7c-40b5-be65-19f01247bfe8", "title": "Accusamus repellat illo autem.", "description": "Repellat ratione aut. Labore harum sit. Consectetur similique sunt.", "value_type": "number", "default_value": "0.13348778850551846", "type": "value_definition" } }, "summary": "", "description": "" } }, "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/value_definition" } } } } } } } }, "404": { "description": "Returns with Not Found", "content": { "application/vnd.api+json": { "examples": { "Description of an error when requesting a non-existing Value Definition": { "value": { "errors": [ "V2::ValueDefinition not found with ID ac600e77-4403-4a73-91ca-67e46763bb24" ] }, "summary": "", "description": "" } }, "schema": { "$ref": "#/components/schemas/errors" } } } } } } } }, "components": { "schemas": { "errors": { "type": "object", "required": [ "errors" ], "properties": { "errors": { "type": "array", "items": { "type": "string", "examples": [ "V2::SecurityGuide not found with ID a4708198-9d00-4035-bf57-1e7aaad217c5" ] } } } }, "id": { "type": "string", "format": "uuid", "readOnly": true }, "links": { "type": "object", "properties": { "first": { "type": "string", "format": "uri", "readOnly": true, "description": "Link to first page" }, "last": { "type": "string", "format": "uri", "readOnly": true, "description": "Link to last page" }, "previous": { "type": "string", "format": "uri", "readOnly": true, "description": "Link to previous page" }, "next": { "type": "string", "format": "uri", "readOnly": true, "description": "Link to next page" } } }, "metadata": { "type": "object", "properties": { "total": { "type": "number", "examples": [ 1, 42, 770 ], "readOnly": true, "description": "Total number of items" }, "limit": { "type": "number", "maximum": 100, "minimum": 1, "default": 10, "examples": [ 10, 100 ], "readOnly": true, "description": "Number of items returned per page" }, "offset": { "type": "number", "minimum": 0, "default": 0, "examples": [ 15, 90 ], "readOnly": true, "description": "Offset of the first item of paginated response" }, "sort_by": { "type": "string", "examples": [ "version:asc" ], "description": "Attribute and direction the items are sorted by" }, "filter": { "type": "string", "default": "", "examples": [ "title='Standard System Security Profile for Fedora'" ], "description": "Query string used to filter items by their attributes" } } }, "policy": { "type": "object", "required": [ "compliance_threshold", "profile_id" ], "properties": { "id": { "$ref": "#/components/schemas/id" }, "type": { "type": "string", "enum": [ "policy" ], "readOnly": true }, "title": { "type": "string", "examples": [ "CIS Red Hat Enterprise Linux 7 Benchmark" ], "description": "Short title of the Policy" }, "description": { "type": "string", "examples": [ "This profile defines a baseline that aligns to the Center for Internet Security®Red Hat Enterprise Linux 7 Benchmark™, v2.2.0, released 12-27-2017." ], "description": "Longer description of the Policy" }, "business_objective": { "type": "string", "examples": [ "Guide to the Secure Configuration of Red Hat Enterprise Linux 7" ], "description": "The Business Objective associated to the Policy" }, "compliance_threshold": { "type": "number", "examples": [ 90 ], "maximum": 100, "minimum": 0, "description": "The percentage above which the Policy meets compliance requirements" }, "profile_id": { "type": "string", "format": "uuid", "writeOnly": true, "examples": [ "9c4bccad-eb1f-473f-bd3d-2de6e125f725" ], "description": "Identifier of the underlying Profile" }, "os_major_version": { "type": "number", "minimum": 6, "examples": [ 7 ], "description": "Major version of the Operating System that the Policy covers", "readOnly": true }, "ref_id": { "type": "string", "examples": [ "xccdf_org.ssgproject.content_profile_pci-dss" ], "description": "Identificator of the Profile", "readOnly": true }, "profile_title": { "type": "string", "examples": [ "CIS Red Hat Enterprise Linux 7 Benchmark" ], "description": "Title of the associated Policy", "readOnly": true }, "total_system_count": { "type": "number", "minium": 0, "examples": [ 3 ], "description": "The number of Systems assigned to this Policy", "readOnly": true } } }, "policy_update": { "type": "object", "properties": { "description": { "type": "string", "examples": [ "This profile defines a baseline that aligns to the Center for Internet Security®Red Hat Enterprise Linux 7 Benchmark™, v2.2.0, released 12-27-2017." ], "description": "Longer description of the Policy" }, "business_objective": { "type": "string", "examples": [ "Guide to the Secure Configuration of Red Hat Enterprise Linux 7" ], "description": "The Business Objective associated to the Policy" }, "compliance_threshold": { "type": "number", "examples": [ 90 ], "maximum": 100, "minimum": 0, "description": "The percentage above which the Policy meets compliance requirements" } } }, "profile": { "type": "object", "properties": { "id": { "$ref": "#/components/schemas/id" }, "type": { "type": "string", "readOnly": true, "enum": [ "profile" ] }, "ref_id": { "type": "string", "examples": [ "xccdf_org.ssgproject.content_profile_pci-dss" ], "readOnly": true, "description": "Identificator of the Profile" }, "title": { "type": "string", "examples": [ "CIS Red Hat Enterprise Linux 7 Benchmark" ], "readOnly": true, "description": "Short title of the Profile" }, "description": { "type": "string", "examples": [ "This profile defines a baseline that aligns to the Center for Internet Security®Red Hat Enterprise Linux 7 Benchmark™, v2.2.0, released 12-27-2017." ], "readOnly": true, "description": "Longer description of the Profile" }, "value_overrides": { "type": "object", "readOnly": true, "description": "Pair of keys and values for Value Definition customizations" } } }, "report": { "type": "object", "properties": { "id": { "$ref": "#/components/schemas/id" }, "type": { "type": "string", "enum": [ "report" ], "readOnly": true }, "title": { "type": "string", "examples": [ "CIS Red Hat Enterprise Linux 7 Benchmark" ], "description": "Short title of the Report", "readOnly": true }, "business_objective": { "type": "string", "examples": [ "Guide to the Secure Configuration of Red Hat Enterprise Linux 7" ], "description": "The Business Objective associated to the Policy", "readOnly": true }, "compliance_threshold": { "type": "number", "examples": [ 90 ], "maximum": 100, "minimum": 0, "description": "The percentage above which the Policy meets compliance requirements", "readOnly": true }, "os_major_version": { "type": "number", "minimum": 6, "examples": [ 7 ], "description": "Major version of the Operating System that the Report covers", "readOnly": true }, "ref_id": { "type": "string", "examples": [ "xccdf_org.ssgproject.content_profile_pci-dss" ], "description": "Identificator of the Profile", "readOnly": true }, "profile_title": { "type": "string", "examples": [ "CIS Red Hat Enterprise Linux 7 Benchmark" ], "description": "Title of the associated Profile", "readOnly": true }, "percent_compliant": { "type": "number", "minimum": 0, "maximum": 100, "examples": [ 68 ], "description": "Describes percentage of compliant systems", "readOnly": true }, "assigned_system_count": { "type": "number", "minium": 1, "examples": [ 42 ], "description": "The number of Systems assigned to this Report", "readOnly": true }, "compliant_system_count": { "type": "number", "minium": 0, "examples": [ 21 ], "description": "The number of compliant Systems in this Report", "readOnly": true }, "all_systems_exposed": { "type": "boolean", "description": "Informs if the user has access to all the Systems under the Report", "examples": [ true ], "readOnly": true }, "unsupported_system_count": { "type": "number", "minium": 0, "examples": [ 3 ], "description": "The number of unsupported Systems in this Report", "readOnly": true }, "reported_system_count": { "type": "number", "minium": 0, "examples": [ 3 ], "description": "The number of Systems in this Report that have Test Results available", "readOnly": true } } }, "report_stats": { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string", "examples": [ "Remove tftp" ], "readOnly": true, "description": "Short title of the Rule" }, "ref_id": { "type": "string", "examples": [ "xccdf_org.ssgproject.content_rule_package_tftp_removed" ], "readOnly": true, "description": "Identificator of the Rule" }, "identifier": { "type": "object", "readOnly": true, "description": "Identifier of the Rule", "properties": { "label": { "type": "string", "readOnly": true, "examples": [ "CCE-80798-2" ] }, "system": { "type": "string", "readOnly": true, "examples": [ "https://nvd.nist.gov/cce/index.cfm" ] } }, "examples": [ "CEE-1234-123" ] }, "severity": { "type": "string", "examples": [ "low" ], "readOnly": true, "description": "The severity of the Rule" }, "count": { "type": "integer", "examples": [ 102 ], "readOnly": true, "description": "Number of failures" } } } }, "rule": { "type": "object", "properties": { "id": { "$ref": "#/components/schemas/id" }, "type": { "type": "string", "readOnly": true, "enum": [ "rule" ] }, "ref_id": { "type": "string", "examples": [ "xccdf_org.ssgproject.content_rule_package_tftp_removed" ], "readOnly": true, "description": "Identificator of the Rule" }, "rule_group_id": { "type": "string", "format": "uuid", "examples": [ "cf50fd69-0205-49e8-8e12-c1b2a6291f1d" ], "readOnly": true, "description": "UUID of the parent Rule Group" }, "title": { "type": "string", "examples": [ "Remove tftp" ], "readOnly": true, "description": "Short title of the Rule" }, "rationale": { "type": "string", "examples": [ "It is recommended that TFTP be remvoed, unless there is a specific need for TFTP (such as a boot server). In that case, use extreme caution when configuring the services." ], "readOnly": true, "description": "Rationale of the Rule" }, "description": { "type": "string", "examples": [ "Trivial File Transfer Protocol (TFTP) is a simple file transfer protocol, typically used to automatically transfer configuration or boot files between machines. TFTP does not support authentication and can be easily hacked. The package tftp is a client program that allows for connections to a tftp server." ], "readOnly": true, "description": "Longer description of the Rule" }, "precedence": { "type": "integer", "examples": [ 3 ], "readOnly": true, "description": "The original sorting precedence of the Rule in the Security Guide" }, "severity": { "type": "string", "examples": [ "low" ], "readOnly": true, "description": "The severity of the Rule" }, "identifier": { "type": "object", "readOnly": true, "description": "Identifier of the Rule", "properties": { "label": { "type": "string", "readOnly": true, "examples": [ "CCE-80798-2" ] }, "system": { "type": "string", "readOnly": true, "examples": [ "https://nvd.nist.gov/cce/index.cfm" ] } }, "examples": [ "CEE-1234-123" ] }, "references": { "type": "array", "items": { "type": "object", "readOnly": true, "description": "List of Tags assigned to the System", "properties": { "label": { "type": "string", "readOnly": true, "examples": [ "APO01.06" ] }, "href": { "type": "string", "readOnly": true, "examples": [ "https://www.isaca.org/resources/cobit" ] } } }, "readOnly": true, "description": "Array of the Rule References" }, "remediation_available": { "type": "boolean", "examples": [ true, false ], "readOnly": true, "description": "Whether or not a remediation is available for the given rule." }, "remediation_issue_id": { "type": [ "string", "null" ], "examples": [ "ssg:xccdf_org.ssgproject.content_benchmark_RHEL-6|0.1.46|rht-ccp|xccdf_org.ssgproject.content_rule_sshd_disable_rhosts" ], "readOnly": true, "description": "The idenfitier of the remediation associated to this rule, only available under profiles." } } }, "rule_group": { "type": "object", "properties": { "id": { "$ref": "#/components/schemas/id" }, "type": { "type": "string", "readOnly": true, "enum": [ "rule_group" ] }, "ref_id": { "type": "string", "examples": [ "xccdf_org.ssgproject.content_group_locking_out_password_attempts" ], "readOnly": true, "description": "Identificator of the Rule Group" }, "title": { "type": "string", "examples": [ "Set Lockouts for Failed Password Attempt" ], "readOnly": true, "description": "Short title of the Rule Group" }, "rationale": { "type": "string", "examples": [ "By limiting the number of failed logon attempts, the risk of unauthorized system access via user password guessing, otherwise known as brute-forcing, is reduced. Limits are imposed by locking the account." ], "readOnly": true, "description": "Rationale of the Rule Group" }, "description": { "type": "string", "examples": [ "The pam_faillock PAM module provides the capability to lock out user accounts after a number of failed login attempts. Its documentation is available in /usr/share/doc/pam-VERSION/txts/README.pam_faillock." ], "readOnly": true, "description": "Longer description of the Rule Group" }, "precedence": { "type": "integer", "examples": [ 3 ], "readOnly": true, "description": "The original sorting precedence of the Rule Group in the Security Guide" } } }, "rule_result": { "type": "object", "properties": { "id": { "$ref": "#/components/schemas/id" }, "type": { "type": "string", "readOnly": true, "enum": [ "rule" ] }, "result": { "type": "string", "enum": [ "pass", "fail", "error", "unknown", "fixed", "notapplicable", "notchecked", "informational", "notselected" ], "readOnly": true, "description": "Status of the Rule Result" }, "rule_id": { "type": "string", "format": "uuid", "examples": [ "ac0475d7-043c-439b-abef-606f02531e10" ], "readOnly": true, "description": "UUID of the affected Rule" }, "system_id": { "type": "string", "format": "uuid", "examples": [ "e6ba5c79-48af-4899-bb1d-964116b58c7a" ], "readOnly": true, "description": "UUID of the affected System" }, "ref_id": { "type": "string", "examples": [ "xccdf_org.ssgproject.content_rule_package_tftp_removed" ], "readOnly": true, "description": "Identificator of the Rule" }, "rule_group_id": { "type": "string", "format": "uuid", "examples": [ "cf50fd69-0205-49e8-8e12-c1b2a6291f1d" ], "readOnly": true, "description": "UUID of the parent Rule Group" }, "title": { "type": "string", "examples": [ "Remove tftp" ], "readOnly": true, "description": "Short title of the Rule" }, "rationale": { "type": "string", "examples": [ "It is recommended that TFTP be remvoed, unless there is a specific need for TFTP (such as a boot server). In that case, use extreme caution when configuring the services." ], "readOnly": true, "description": "Rationale of the Rule" }, "description": { "type": "string", "examples": [ "Trivial File Transfer Protocol (TFTP) is a simple file transfer protocol, typically used to automatically transfer configuration or boot files between machines. TFTP does not support authentication and can be easily hacked. The package tftp is a client program that allows for connections to a tftp server." ], "readOnly": true, "description": "Longer description of the Rule" }, "precedence": { "type": "integer", "examples": [ 3 ], "readOnly": true, "description": "The original sorting precedence of the Rule in the Security Guide" }, "severity": { "type": "string", "examples": [ "low" ], "readOnly": true, "description": "The severity of the Rule" }, "remediation_issue_id": { "type": [ "string", "null" ], "examples": [ "ssg:xccdf_org.ssgproject.content_benchmark_RHEL-6|0.1.46|rht-ccp|xccdf_org.ssgproject.content_rule_sshd_disable_rhosts" ], "readOnly": true, "description": "The idenfitier of the remediation associated to this rule, only available under profiles." } } }, "rule_tree": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "id": { "$ref": "#/components/schemas/id" }, "type": { "type": "string", "enum": [ "rule_group" ] }, "children": { "$ref": "#/components/schemas/rule_tree" } } }, { "type": "object", "properties": { "id": { "$ref": "#/components/schemas/id" }, "type": { "type": "string", "enum": [ "rule" ] } } } ] } }, "security_guide": { "type": "object", "properties": { "id": { "$ref": "#/components/schemas/id" }, "type": { "type": "string", "readOnly": true, "enum": [ "security_guide" ] }, "ref_id": { "type": "string", "examples": [ "xccdf_org.ssgproject.content_benchmark_RHEL-7" ], "readOnly": true, "description": "Identificator of the Security Guide" }, "title": { "type": "string", "examples": [ "Guide to the Secure Configuration of Red Hat Enterprise Linux 7" ], "readOnly": true, "description": "Short title of the Security Guide" }, "version": { "type": "string", "examples": [ "0.1.46" ], "readOnly": true, "description": "Version of the Security Guide" }, "description": { "type": "string", "examples": [ "This guide presents a catalog of security-relevant configuration settings for Red Hat Enterprise Linux 7." ], "readOnly": true, "description": "Longer description of the Security Guide" }, "os_major_version": { "type": "number", "minimum": 6, "examples": [ 7 ], "readOnly": true, "description": "Major version of the Operating System that the Security Guide covers" } } }, "status": { "type": "object", "properties": { "data": { "type": "object", "properties": { "api": { "type": "boolean", "example": true } } } } }, "supported_profile": { "type": "object", "properties": { "id": { "$ref": "#/components/schemas/id" }, "type": { "type": "string", "readOnly": true, "enum": [ "supported_profile" ] }, "ref_id": { "type": "string", "examples": [ "xccdf_org.ssgproject.content_profile_cis" ], "readOnly": true, "description": "Identificator of the latest supported Profile" }, "title": { "type": "string", "examples": [ "CIS Red Hat Enterprise Linux 7 Benchmark" ], "readOnly": true, "description": "Short title of the Profile" }, "description": { "type": "string", "examples": [ "This profile defines a baseline that aligns to the Center for Internet Security®Red Hat Enterprise Linux 7 Benchmark™, v2.2.0, released 12-27-2017." ], "readOnly": true, "description": "Longer description of the Profile" }, "security_guide_id": { "type": "string", "format": "uuid", "examples": [ "e6ba5c79-48af-4899-bb1d-964116b58c7a" ], "readOnly": true, "description": "UUID of the latest Security Guide supporting this Profile" }, "security_guide_version": { "type": "string", "examples": [ "0.1.72" ], "readOnly": true, "description": "Version of the latest Security Guide supporting this Profile" }, "os_major_version": { "type": "number", "examples": [ 7 ], "readOnly": true, "description": "Major version of the Operating System that the Profile covers" }, "os_minor_versions": { "type": "array", "items": { "type": "number", "examples": [ 1 ] }, "readOnly": true, "description": "List of the supported Operating System minor versions that the Profile covers" } } }, "system": { "type": "object", "properties": { "id": { "$ref": "#/components/schemas/id" }, "type": { "type": "string", "enum": [ "system" ], "readOnly": true }, "display_name": { "type": "string", "readOnly": true, "examples": [ "localhost" ], "description": "Display Name of the System" }, "groups": { "type": "array", "readOnly": true, "items": { "type": "object", "description": "List of Inventory Groups the System belongs to", "properties": { "id": { "$ref": "#/components/schemas/id" }, "name": { "type": "string", "readOnly": true, "examples": [ "production" ] } } } }, "culled_timestamp": { "type": "string", "readOnly": true, "examples": [ "2020-06-04T19:31:55Z" ] }, "last_check_in": { "type": "string", "readOnly": true, "examples": [ "2020-06-04T19:31:55Z" ] }, "stale_timestamp": { "type": "string", "readOnly": true, "examples": [ "2020-06-04T19:31:55Z" ] }, "stale_warning_timestamp": { "type": "string", "readOnly": true, "examples": [ "2020-06-04T19:31:55Z" ] }, "updated": { "type": "string", "readOnly": true, "examples": [ "2020-06-04T19:31:55Z" ] }, "insights_id": { "$ref": "#/components/schemas/id" }, "tags": { "type": "array", "readOnly": true, "items": { "type": "object", "readOnly": true, "description": "List of Tags assigned to the System", "properties": { "namespace": { "type": "string", "readOnly": true, "examples": [ "insights" ] }, "key": { "type": "string", "readOnly": true, "examples": [ "environment" ] }, "value": { "type": "string", "readOnly": true, "examples": [ "production" ] } } } }, "os_major_version": { "type": "number", "examples": [ 7 ], "readOnly": true, "description": "Major version of the Operating System" }, "os_minor_version": { "type": "number", "examples": [ 1 ], "readOnly": true, "description": "Minor version of the Operating System" }, "policies": { "type": "array", "readOnly": true, "description": "List of Policies assigned to the System, visible only when not listing Systems under a given Policy", "items": { "type": "object", "readOnly": true, "properties": { "id": { "$ref": "#/components/schemas/id" }, "title": { "type": "string", "readOnly": true, "examples": [ "CIS Red Hat Enterprise Linux 7 Benchmark" ], "description": "Short title of the Policy" } } } } } }, "tailoring": { "type": "object", "properties": { "id": { "$ref": "#/components/schemas/id" }, "type": { "type": "string", "readOnly": true, "enum": [ "tailoring" ] }, "profile_id": { "type": "string", "examples": [ "cde8be06-74bc-4a2d-9e7f-11d30c5ea588" ], "readOnly": true, "description": "Identificator of the Profile from which the Tailoring was cloned" }, "security_guide_id": { "type": "string", "examples": [ "8800e1d8-70da-4e62-8cf0-16e8cee784c7" ], "readOnly": true, "description": "Identificator of the Security Guide that contains the parent Profile" }, "security_guide_version": { "type": "string", "examples": [ "0.1.210" ], "readOnly": true, "description": "Version of the Security Guide that contains the parent Profile" }, "os_major_version": { "type": "number", "examples": [ 7 ], "readOnly": true, "description": "Major version of the Operating System that the Tailoring covers" }, "os_minor_version": { "type": "number", "examples": [ 1 ], "readOnly": true, "description": "Minor version of the Operating System that the Tailoring covers" }, "value_overrides": { "type": "object", "description": "Pair of keys and values for Value Definition customizations", "examples": [ { "6b77e3c3-af53-46e6-894c-6669d76f80c0": "foo", "36bf61e0-7c36-468a-b39b-9e75e279c09e": "123", "9d246f10-bbef-489c-a4d9-cfb38f555e0b": "false" } ] } } }, "tailoring_create": { "type": "object", "required": [ "os_minor_version" ], "properties": { "os_minor_version": { "type": "number", "examples": [ 1 ], "description": "Minor version of the Operating System that the Tailoring covers" } } }, "tailoring_file_json": { "title": "Tailoring File", "description": "Defines customizations of rules and variables for a set of profiles", "type": "object", "additionalProperties": true, "properties": { "profiles": { "type": "array", "items": { "type": "object", "title": "Profile", "description": "A new tailored profile with modifications", "additionalProperties": true, "anyOf": [ { "required": [ "id", "base_profile_id" ] }, { "required": [ "id", "title" ] } ], "properties": { "id": { "type": "string", "description": "New profile identifier, can be same as 'base_profile_id', to 'shadow' the origin" }, "base_profile_id": { "type": "string", "description": "Original profile identifier, the base for modifications" }, "title": { "type": "string", "description": "Title for the new profile, inherited from base profile if not given, required if there is no base profile" }, "groups": { "type": "object", "description": "Group modifications, keys are identifiers", "additionalProperties": { "type": "object", "additionalProperties": true, "anyOf": [ { "required": [ "evaluate" ] } ], "properties": { "evaluate": { "type": "boolean", "description": "Includes or excludes a group of rules from evaluation" } } } }, "rules": { "type": "object", "description": "Rule modifications, keys are identifiers", "additionalProperties": { "type": "object", "additionalProperties": true, "anyOf": [ { "required": [ "evaluate" ] }, { "required": [ "severity" ] }, { "required": [ "role" ] } ], "properties": { "evaluate": { "type": "boolean", "description": "Includes or excludes a rule from evaluation" }, "severity": { "type": "string", "enum": [ "unknown", "info", "low", "medium", "high" ], "description": "Overrides severity level of the rule" }, "role": { "type": "string", "enum": [ "full", "unscored", "unchecked" ], "description": "Overrides role of the rule" } } } }, "variables": { "type": "object", "description": "Variables modifications, keys are identifiers", "additionalProperties": { "type": "object", "additionalProperties": true, "oneOf": [ { "required": [ "value" ] }, { "required": [ "option_id" ] } ], "properties": { "value": { "type": [ "string", "integer", "boolean" ], "description": "Directly overrides variable's value with a given value" }, "option_id": { "type": "string", "description": "Overrides variable's value with a predefined value identified by 'option_id'" } } } } } } } } }, "tailoring_file_toml": { "title": "Blueprint Configuration Schema", "description": "Incomplete schema inspired by content of https://github.com/osbuild/blueprint-schema/blob/993ad4c66cdeb043417012bf2238806002d8be95/testdata/all-fields2.in.toml", "type": "string", "additionalProperties": true, "properties": { "name": { "type": "string", "description": "Name of the blueprint" }, "description": { "type": "string", "description": "Description of the blueprint" } }, "name": "Tailoring File Blueprint" }, "test_result": { "type": "object", "properties": { "id": { "$ref": "#/components/schemas/id" }, "type": { "type": "string", "enum": [ "test_result" ], "readOnly": true }, "display_name": { "type": "string", "readOnly": true, "examples": [ "localhost" ], "description": "Display Name of the System" }, "groups": { "type": "array", "readOnly": true, "items": { "type": "object", "description": "List of Inventory Groups the System belongs to", "properties": { "id": { "$ref": "#/components/schemas/id" }, "name": { "type": "string", "readOnly": true, "examples": [ "production" ] } } } }, "tags": { "type": "array", "readOnly": true, "items": { "type": "object", "readOnly": true, "description": "List of Tags assigned to the System", "properties": { "namespace": { "type": "string", "readOnly": true, "examples": [ "insights" ] }, "key": { "type": "string", "readOnly": true, "examples": [ "environment" ] }, "value": { "type": "string", "readOnly": true, "examples": [ "production" ] } } } }, "system_id": { "type": "string", "format": "uuid", "examples": [ "e6ba5c79-48af-4899-bb1d-964116b58c7a" ], "readOnly": true, "description": "UUID of the underlying System" }, "os_major_version": { "type": "number", "examples": [ 7 ], "readOnly": true, "description": "Major version of the Operating System" }, "os_minor_version": { "type": "number", "examples": [ 1 ], "readOnly": true, "description": "Minor version of the Operating System" }, "compliant": { "type": [ "boolean", "null" ], "examples": [ false, true ], "readOnly": true, "description": "Whether the Test Result is compliant or not within a given Report." }, "score": { "type": "number", "examples": [ 99.99 ], "readOnly": true, "description": "Compliance Score of the System within a given Report." }, "supported": { "type": [ "boolean", "null" ], "examples": [ false, true ], "readOnly": true, "description": "Whether the System is supported or not by a Profile within a given Policy." }, "failed_rule_count": { "type": [ "integer", "null" ], "examples": [ 3 ], "readOnly": true, "description": "Number of failures, errors and unknown states for rules in the Test Result." }, "end_time": { "type": "string", "examples": [ "2020-06-04T19:31:55Z" ], "readOnly": true, "description": "The date when the System has been reported a Test Result for the last time." } } }, "value_definition": { "type": "object", "properties": { "id": { "$ref": "#/components/schemas/id" }, "type": { "type": "string", "enum": [ "value_definition" ] }, "ref_id": { "type": "string", "examples": [ "xccdf_org.ssgproject.content_value_var_rekey_limit_size" ], "readOnly": true, "description": "Identificator of the Value Definition" }, "title": { "type": "string", "examples": [ "SSH RekeyLimit - size" ], "readOnly": true, "description": "Short title of the Value Definition" }, "value_type": { "type": "string", "examples": [ "string" ], "readOnly": true, "description": "Type of the Value Definition" }, "description": { "type": "string", "examples": [ "Specify the size component of the rekey limit." ], "readOnly": true, "description": "Longer description of the Value Definition" }, "default_value": { "type": "string", "examples": [ "512M" ], "readOnly": true, "description": "Default value of the Value Definition" } } } } }, "tags": [ { "name": "Systems" }, { "name": "Content" }, { "name": "Policies" }, { "name": "Reports" } ] }