{ "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": "0f94039e-edf4-4d97-9024-feb8ac5678b3", "title": "Autem possimus quod aut.", "description": "Laudantium consequatur quia. Dignissimos consequatur voluptatem. Quas sed illo.", "business_objective": null, "compliance_threshold": 42.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Beatae rem voluptatem perferendis.", "ref_id": "xccdf_org.ssgproject.content_profile_8709f3b3170fc8f6d6ec0342173561aa" }, { "id": "190ae90d-8c1a-4e82-874b-d82e451981fc", "title": "Quidem velit iure odio.", "description": "Doloribus dolor officia. Laboriosam molestiae quam. Dignissimos et quod.", "business_objective": null, "compliance_threshold": 11.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Quis optio asperiores cupiditate.", "ref_id": "xccdf_org.ssgproject.content_profile_1424ae0b010de74d5d976d57efbd405b" }, { "id": "281ab23c-835e-47e6-835b-3b89f7ba89b0", "title": "Earum vero aut quidem.", "description": "Repellat quo consequatur. Ea qui iure. Sit ipsum omnis.", "business_objective": null, "compliance_threshold": 38.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Animi autem aut qui.", "ref_id": "xccdf_org.ssgproject.content_profile_ececb37e3b85c5febc9938e6165aab6e" }, { "id": "29e741d7-e7fd-4439-a168-d4a67063a881", "title": "Aut voluptatem aliquid dolores.", "description": "A temporibus eaque. Velit porro delectus. Omnis doloremque nulla.", "business_objective": null, "compliance_threshold": 30.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Odit blanditiis necessitatibus cum.", "ref_id": "xccdf_org.ssgproject.content_profile_db7966f127052e5742c30f1f1df3c78e" }, { "id": "3609780b-4a12-4a0a-ae0c-d26b2273d922", "title": "Ut aut enim aut.", "description": "Rem eveniet velit. Necessitatibus totam sit. Et nisi a.", "business_objective": null, "compliance_threshold": 48.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Ut inventore architecto autem.", "ref_id": "xccdf_org.ssgproject.content_profile_18cec078ae29a81abceae2f4995f483f" }, { "id": "4769ad1a-539e-494c-a7fc-9dea719344ec", "title": "At deserunt sequi sint.", "description": "Omnis quo magnam. Impedit possimus iste. Qui recusandae commodi.", "business_objective": null, "compliance_threshold": 98.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Suscipit aut cum veritatis.", "ref_id": "xccdf_org.ssgproject.content_profile_8d7217252336110754a17b72a61a88ed" }, { "id": "4bcdf2e5-5d03-48c4-bb81-2c43d9a68859", "title": "Voluptatem et voluptates itaque.", "description": "Voluptatibus accusamus aut. Vel numquam consequatur. Iure consectetur facilis.", "business_objective": null, "compliance_threshold": 59.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Nam unde iste qui.", "ref_id": "xccdf_org.ssgproject.content_profile_405508168efcafa8a0b850f9e73c528d" }, { "id": "54aeefac-b0ed-48b6-b4df-8d718593a5ef", "title": "Eveniet porro recusandae perferendis.", "description": "Occaecati sequi odit. Molestias non quod. Expedita in quod.", "business_objective": null, "compliance_threshold": 63.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Ratione dolore laborum quam.", "ref_id": "xccdf_org.ssgproject.content_profile_3f80ef95e99aa67b3430fa5600223671" }, { "id": "5765f083-1920-441e-8833-523557a6a9b4", "title": "Consequatur enim fugiat velit.", "description": "Voluptatem rerum et. Quaerat aut quam. Inventore deserunt distinctio.", "business_objective": null, "compliance_threshold": 70.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Earum perferendis itaque qui.", "ref_id": "xccdf_org.ssgproject.content_profile_ab0bb9e0da104ddd52ea8cc41edb791c" }, { "id": "64b01f69-03c2-4b15-927a-e3309752480a", "title": "Nemo sequi provident delectus.", "description": "Suscipit minus magni. Voluptas fugit placeat. Impedit doloremque fugit.", "business_objective": null, "compliance_threshold": 28.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Id id sequi a.", "ref_id": "xccdf_org.ssgproject.content_profile_bd3d9ffe4a02bba45d8653e5497364a0" } ], "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": "0339462a-3a24-4959-b234-c5b8b583feec", "title": "Cumque ab minima nemo.", "description": "Veritatis sit eaque. Consequatur molestias accusantium. Et ea nam.", "business_objective": null, "compliance_threshold": 94.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Quia quis cupiditate in.", "ref_id": "xccdf_org.ssgproject.content_profile_bafcd3788554881bc37309249b9334c5" }, { "id": "1461bd1b-0a6a-4d4c-aacb-efdf6c31f38d", "title": "Accusamus accusantium incidunt ipsa.", "description": "Ducimus corporis sunt. Laborum ut velit. Et numquam officia.", "business_objective": null, "compliance_threshold": 61.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Ab facilis sapiente in.", "ref_id": "xccdf_org.ssgproject.content_profile_2fea5fe31baf47305f0cc292ce6cf093" }, { "id": "1800480d-6f04-4172-b53f-c4648fc33242", "title": "Minus voluptas officia voluptas.", "description": "Voluptas commodi voluptatem. Aut et architecto. Excepturi inventore voluptatem.", "business_objective": null, "compliance_threshold": 12.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Voluptatem sed aperiam nihil.", "ref_id": "xccdf_org.ssgproject.content_profile_c4400dc0899e3df9a01b1a16a7e1c6b4" }, { "id": "19e9a0fd-aa44-4e6f-bc4d-1af2e8e7af3a", "title": "Sed inventore voluptas minus.", "description": "Ullam et possimus. Voluptates iure rem. Qui a unde.", "business_objective": null, "compliance_threshold": 47.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Enim vitae et neque.", "ref_id": "xccdf_org.ssgproject.content_profile_d92cfa28f900a9f7f59ebcf88072bfcd" }, { "id": "25227b9d-fb8f-45c9-9139-501df8c5f5ab", "title": "Quis quia sequi ut.", "description": "Qui laborum quod. Aperiam rem doloremque. Ea quis corrupti.", "business_objective": null, "compliance_threshold": 40.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Est doloribus voluptatibus et.", "ref_id": "xccdf_org.ssgproject.content_profile_020e809b9a8f2f551bc442eecd08d3dc" }, { "id": "33a0a02c-a55d-4ebb-9d70-1b51b5e5b5c5", "title": "Asperiores delectus harum voluptatum.", "description": "Reprehenderit optio labore. Veniam eum et. Deserunt dolores asperiores.", "business_objective": null, "compliance_threshold": 72.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Reiciendis illo molestiae distinctio.", "ref_id": "xccdf_org.ssgproject.content_profile_0ba59f773d356b8f44e9ecbbd2e14481" }, { "id": "3645faf0-b9eb-4b7e-abdb-5bc2f0873e07", "title": "Assumenda et magnam illum.", "description": "Repudiandae voluptas in. Qui aliquam aperiam. Nesciunt optio ut.", "business_objective": null, "compliance_threshold": 90.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Suscipit distinctio eligendi perferendis.", "ref_id": "xccdf_org.ssgproject.content_profile_5a2392f097e221290ec686ffc5018a33" }, { "id": "397e80f2-73bd-432c-8ca4-38eb90399de3", "title": "Ab eos rem omnis.", "description": "Quam quo fugiat. Ab vitae qui. Ullam nostrum distinctio.", "business_objective": null, "compliance_threshold": 44.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Ea sit veritatis quaerat.", "ref_id": "xccdf_org.ssgproject.content_profile_c04c517d2042e97abb1093b967cacc42" }, { "id": "3dfa6f7f-f4b5-40c9-abee-f5e13409405c", "title": "Reprehenderit et et pariatur.", "description": "Ullam repellendus et. Consequatur accusantium ea. Atque cum sunt.", "business_objective": null, "compliance_threshold": 13.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Error quaerat itaque adipisci.", "ref_id": "xccdf_org.ssgproject.content_profile_dcb3ec3a6df4005d6e986a0a2fa7a686" }, { "id": "4662b4f1-a572-4651-89fe-7e7e7300271b", "title": "Deserunt praesentium tenetur et.", "description": "Sapiente velit praesentium. Ipsum quae illum. Qui unde totam.", "business_objective": null, "compliance_threshold": 91.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Aperiam perspiciatis non aut.", "ref_id": "xccdf_org.ssgproject.content_profile_ce8d667aad71238ede0ca6b5152ca130" } ], "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": "dac4331c-bc97-4dda-8fef-44ae4fee20dd", "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": "Rerum maxime cum corrupti.", "ref_id": "xccdf_org.ssgproject.content_profile_c0b0437d5d5c9ecf69bc014e00fa2671" } }, "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": "41483e8d-2d21-410a-b6f8-c07ba303db5c", "title": "Sequi debitis animi enim.", "description": "Consequatur numquam aliquam. Laborum quam hic. Sint aut magnam.", "business_objective": null, "compliance_threshold": 4.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Molestiae doloremque qui et.", "ref_id": "xccdf_org.ssgproject.content_profile_acbd7599b617034118f441373c25ea8e" } }, "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 ba11d557-175a-422e-9f5b-359a130fb6b0" ] }, "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": "c630c37e-fffb-451f-9983-e1f8eb1cdfb9", "title": "Molestiae impedit laudantium error.", "description": "Deserunt expedita aut. Officia consequatur eos. Consequatur totam laudantium.", "business_objective": null, "compliance_threshold": 100.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Nihil accusamus nisi perspiciatis.", "ref_id": "xccdf_org.ssgproject.content_profile_279fcab126b10b2d52f0f403ea8b9460" } }, "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": "86f52c77-9d9c-4c58-b042-f711033e14f9", "title": "Voluptatem mollitia ea fuga.", "description": "Iure ut et. Odit qui quisquam. Sint quam maiores.", "business_objective": null, "compliance_threshold": 10.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "In fugit voluptatem qui.", "ref_id": "xccdf_org.ssgproject.content_profile_db43538d86c5c6b06d01cb66d00f4eee" } }, "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": "0591322e-dbb9-4571-b695-6ac8716562af", "title": "Iure repudiandae provident impedit.", "description": "Maxime soluta repellat. Quam et beatae. Quaerat numquam vitae.", "business_objective": null, "compliance_threshold": 56.0, "total_system_count": 1, "type": "policy", "os_major_version": 7, "profile_title": "Quos quod esse eum.", "ref_id": "xccdf_org.ssgproject.content_profile_cd024af0319907da8a40d7f5d33a5609" }, { "id": "07111464-fad2-482d-b7c3-b6dfac08a594", "title": "Ut quod rerum laboriosam.", "description": "Odit est dolorem. Atque quia voluptas. Aut perspiciatis quia.", "business_objective": null, "compliance_threshold": 13.0, "total_system_count": 1, "type": "policy", "os_major_version": 7, "profile_title": "Omnis ut perspiciatis enim.", "ref_id": "xccdf_org.ssgproject.content_profile_41a3a7de9ba84a1b49c30659fc8a1cb4" }, { "id": "0e37fb96-d37e-4be3-bcd4-76aac9df289f", "title": "Qui dolor quia autem.", "description": "Et iure eos. Officia mollitia numquam. Beatae sint doloremque.", "business_objective": null, "compliance_threshold": 12.0, "total_system_count": 1, "type": "policy", "os_major_version": 7, "profile_title": "Dolorem odit omnis deleniti.", "ref_id": "xccdf_org.ssgproject.content_profile_f4f4897e77d6eda13695857a5a145f06" }, { "id": "0f162d09-07e4-45cc-a191-43b775fcaf58", "title": "Ipsum optio quis vel.", "description": "Non porro odio. Dolorem minima dolor. Blanditiis debitis voluptate.", "business_objective": null, "compliance_threshold": 95.0, "total_system_count": 1, "type": "policy", "os_major_version": 7, "profile_title": "Vel quis nisi sint.", "ref_id": "xccdf_org.ssgproject.content_profile_9daef8c4dd38b40904f1e726263b900a" }, { "id": "1db8ab97-75dc-4059-8e18-8102a959aaec", "title": "Dolorem ea qui sapiente.", "description": "Impedit voluptate et. Fuga et omnis. Saepe delectus qui.", "business_objective": null, "compliance_threshold": 24.0, "total_system_count": 1, "type": "policy", "os_major_version": 7, "profile_title": "Rerum necessitatibus modi nulla.", "ref_id": "xccdf_org.ssgproject.content_profile_d1289ddd5a76e58734e4562538f4a4bc" }, { "id": "23aaba2c-d664-48d9-8011-dec2c7cbd0e1", "title": "Reprehenderit voluptates nulla atque.", "description": "Consectetur sapiente omnis. Officiis eveniet eos. Veritatis consequatur dicta.", "business_objective": null, "compliance_threshold": 13.0, "total_system_count": 1, "type": "policy", "os_major_version": 7, "profile_title": "Accusantium eius perspiciatis ad.", "ref_id": "xccdf_org.ssgproject.content_profile_7cd15d3a6a0dec3f040fd256cc04e96a" }, { "id": "357d4cb0-7756-415c-8f50-88b2c2991f64", "title": "Soluta enim doloribus et.", "description": "Sint ut voluptatibus. Architecto in enim. Quasi id et.", "business_objective": null, "compliance_threshold": 60.0, "total_system_count": 1, "type": "policy", "os_major_version": 7, "profile_title": "Laborum aut deleniti distinctio.", "ref_id": "xccdf_org.ssgproject.content_profile_94c37c2563577d2f06e12718ebed63f7" }, { "id": "465df653-20e9-4448-b1fb-ba6d37bb4098", "title": "Architecto id assumenda aliquid.", "description": "Nulla dolore eveniet. Id et consequatur. Dolores ipsa ut.", "business_objective": null, "compliance_threshold": 54.0, "total_system_count": 1, "type": "policy", "os_major_version": 7, "profile_title": "Repudiandae voluptatibus odio saepe.", "ref_id": "xccdf_org.ssgproject.content_profile_9f48a072bc6b1279560d1a60cd514cbb" }, { "id": "4d480f20-a4d4-44ed-869b-3a0427750bd4", "title": "Architecto repudiandae dolores facere.", "description": "Placeat rerum doloremque. Non eos consequatur. Vero molestiae libero.", "business_objective": null, "compliance_threshold": 42.0, "total_system_count": 1, "type": "policy", "os_major_version": 7, "profile_title": "Vel molestias provident et.", "ref_id": "xccdf_org.ssgproject.content_profile_7dab6afe2da773dd13f1856efeeedc4a" }, { "id": "54b947a1-2aa2-4816-833e-4e1d964e7ed0", "title": "Quod voluptas repudiandae iste.", "description": "Eius saepe ea. Minima quia quaerat. Officia aut qui.", "business_objective": null, "compliance_threshold": 14.0, "total_system_count": 1, "type": "policy", "os_major_version": 7, "profile_title": "Cupiditate perferendis quasi soluta.", "ref_id": "xccdf_org.ssgproject.content_profile_3e3829424053fb4927743a95e271f311" } ], "meta": { "total": 25, "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/systems/1c71dc65-9486-4262-a766-2dc1e608de35/policies?limit=10&offset=0", "last": "/api/compliance/v2/systems/1c71dc65-9486-4262-a766-2dc1e608de35/policies?limit=10&offset=20", "next": "/api/compliance/v2/systems/1c71dc65-9486-4262-a766-2dc1e608de35/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": "0171deba-3445-4204-bf7a-eb9c36d925e7", "ref_id": "xccdf_org.ssgproject.content_profile_79db77841b1b80adc4185f566cf246eb", "title": "Enim porro doloremque unde.", "description": "Reiciendis mollitia voluptatem. Sunt modi facilis. Minus harum maiores.", "value_overrides": {}, "type": "profile" }, { "id": "01f9d6a8-b0b7-4d39-a44c-82f804f9a5f9", "ref_id": "xccdf_org.ssgproject.content_profile_f7a52ca515034b5c0f9d0d643e625001", "title": "Vel distinctio voluptatem non.", "description": "Labore et non. Cupiditate magnam tempore. Qui et consequatur.", "value_overrides": {}, "type": "profile" }, { "id": "07c5b0d5-e66d-4c72-9ded-9e2ec3ff150b", "ref_id": "xccdf_org.ssgproject.content_profile_0739ab1e8e5d8654c14fd43d0386c570", "title": "Ad reiciendis blanditiis consequatur.", "description": "Ex eveniet sed. Illum consequatur animi. Impedit voluptas sit.", "value_overrides": {}, "type": "profile" }, { "id": "0b62074a-5ee5-48cc-ac91-08d1110b99b0", "ref_id": "xccdf_org.ssgproject.content_profile_b85ba04a0bb7941b9032a2d671f92256", "title": "Maiores debitis labore consequatur.", "description": "Vel ad vitae. Nihil eaque a. Expedita neque omnis.", "value_overrides": {}, "type": "profile" }, { "id": "18c3f103-1c07-46ec-88ab-8a34b83ad611", "ref_id": "xccdf_org.ssgproject.content_profile_e4079ddb0065c952e41a1f773e702674", "title": "Iusto est tempore voluptatem.", "description": "Voluptas et atque. Minima odit harum. Fuga eos aut.", "value_overrides": {}, "type": "profile" }, { "id": "1ee3fa58-e8b9-48ad-9723-9b59e9a60913", "ref_id": "xccdf_org.ssgproject.content_profile_133588544456fe1707b2f1650875b93a", "title": "Voluptatibus accusantium atque temporibus.", "description": "Id amet quibusdam. Provident corrupti praesentium. Nobis exercitationem sapiente.", "value_overrides": {}, "type": "profile" }, { "id": "1f575e99-7e65-4a5c-8d8f-e0ce9c8c7327", "ref_id": "xccdf_org.ssgproject.content_profile_a7d14552c74dda4c8919c848ea909c2d", "title": "Illo et voluptatem et.", "description": "Magnam nihil ut. Saepe laudantium et. Dolorum sunt earum.", "value_overrides": {}, "type": "profile" }, { "id": "1fc14de4-7b27-4953-a58e-4c92364e3c2d", "ref_id": "xccdf_org.ssgproject.content_profile_37b3c46d06eeb00153fff189e1b9c89e", "title": "Unde ut illum pariatur.", "description": "Aut est nihil. Ut accusantium ducimus. Dolor ea deserunt.", "value_overrides": {}, "type": "profile" }, { "id": "332f6df0-56b2-47dd-8569-123fb2ad0f59", "ref_id": "xccdf_org.ssgproject.content_profile_8af7c90e0cb3fd2831d6846ffcea691c", "title": "Eveniet molestiae beatae labore.", "description": "Dolorem exercitationem et. Qui vero possimus. A accusantium aspernatur.", "value_overrides": {}, "type": "profile" }, { "id": "3766d87d-f838-4208-9895-89ae2c903cc0", "ref_id": "xccdf_org.ssgproject.content_profile_2ba2d57c2ecc3eadacd22bb23aa77286", "title": "Consequatur veritatis doloribus et.", "description": "Rem velit assumenda. Est reiciendis distinctio. At nobis ut.", "value_overrides": {}, "type": "profile" } ], "meta": { "total": 25, "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/security_guides/298ab390-9c61-4730-b534-8e996c15d1b8/profiles?limit=10&offset=0", "last": "/api/compliance/v2/security_guides/298ab390-9c61-4730-b534-8e996c15d1b8/profiles?limit=10&offset=20", "next": "/api/compliance/v2/security_guides/298ab390-9c61-4730-b534-8e996c15d1b8/profiles?limit=10&offset=10" } }, "summary": "", "description": "" }, "List of Profiles sorted by \"title:asc\"": { "value": { "data": [ { "id": "8d10dd88-3e50-47bf-a522-eaee45665b62", "ref_id": "xccdf_org.ssgproject.content_profile_2d7220c6fa830343ba47d2332aeac845", "title": "Accusantium modi rerum sapiente.", "description": "Quia earum nam. Eum eos veritatis. Quis pariatur non.", "value_overrides": {}, "type": "profile" }, { "id": "2ae437be-27fb-4f51-ae63-feb9dc94c5fa", "ref_id": "xccdf_org.ssgproject.content_profile_13e2caa186d60c300e52cea80ae9d298", "title": "Adipisci est sunt ipsam.", "description": "Magnam quod eius. Distinctio placeat repudiandae. Iure et ut.", "value_overrides": {}, "type": "profile" }, { "id": "30b2c057-afdc-4406-8392-a6ae938e9389", "ref_id": "xccdf_org.ssgproject.content_profile_ea304156f3821fa2099b3a1b0d402ad2", "title": "Aspernatur quo qui aperiam.", "description": "Hic illum accusamus. Sunt mollitia non. Adipisci aut ducimus.", "value_overrides": {}, "type": "profile" }, { "id": "3ab4dae1-684b-4dd5-9efa-53dd2b32d579", "ref_id": "xccdf_org.ssgproject.content_profile_7fc3f45280b1245e573ddd2bbca31748", "title": "Dolore hic sapiente non.", "description": "Asperiores fugiat aut. Et qui maxime. Quisquam molestiae sunt.", "value_overrides": {}, "type": "profile" }, { "id": "b433af51-3d57-42d1-8fb7-c08bcdbc183e", "ref_id": "xccdf_org.ssgproject.content_profile_ab26743b2988325c6cf9908be6e54201", "title": "Ea quis cumque ipsum.", "description": "Natus dicta sed. Sit nam inventore. Illo dolor aut.", "value_overrides": {}, "type": "profile" }, { "id": "198a2dab-698f-4896-b0bd-d1e15cd5dbcc", "ref_id": "xccdf_org.ssgproject.content_profile_16d43510e9edb71d6e527ab2b587d0f5", "title": "Enim aut in sunt.", "description": "Est nulla tenetur. Quis est assumenda. Voluptatum fugiat dignissimos.", "value_overrides": {}, "type": "profile" }, { "id": "b61a910f-c06d-4ea0-aea8-2a2d87963516", "ref_id": "xccdf_org.ssgproject.content_profile_160d97aa1bdc0e963e949c396acac941", "title": "Enim et vel maiores.", "description": "At quas incidunt. Adipisci perferendis dolorem. Aut qui et.", "value_overrides": {}, "type": "profile" }, { "id": "f8d6c113-8b44-42a7-a7bb-a2f16e8e6cd9", "ref_id": "xccdf_org.ssgproject.content_profile_0f4ece290731011ff455c76ecca173d0", "title": "Ex ab deleniti qui.", "description": "Optio non eligendi. Tempora laboriosam dolor. Iure illum ullam.", "value_overrides": {}, "type": "profile" }, { "id": "92c22a49-2d3e-4a3f-8188-b67b36e6ddcf", "ref_id": "xccdf_org.ssgproject.content_profile_bf65d45844e5f9420a9d6fbed72898db", "title": "In ex dolorem saepe.", "description": "Esse quia quaerat. Et itaque enim. Illo est quis.", "value_overrides": {}, "type": "profile" }, { "id": "5128bf6f-c2fd-4333-ace4-166177d87d08", "ref_id": "xccdf_org.ssgproject.content_profile_cdcca292146d10d90991394bdd4a8f61", "title": "Iste quia dolore ut.", "description": "Porro maiores sit. Nobis quo iure. Necessitatibus est possimus.", "value_overrides": {}, "type": "profile" } ], "meta": { "total": 25, "limit": 10, "offset": 0, "sort_by": "title" }, "links": { "first": "/api/compliance/v2/security_guides/fefa7dee-9175-41c2-9193-ca1a84b0f3aa/profiles?limit=10&offset=0&sort_by=title", "last": "/api/compliance/v2/security_guides/fefa7dee-9175-41c2-9193-ca1a84b0f3aa/profiles?limit=10&offset=20&sort_by=title", "next": "/api/compliance/v2/security_guides/fefa7dee-9175-41c2-9193-ca1a84b0f3aa/profiles?limit=10&offset=10&sort_by=title" } }, "summary": "", "description": "" }, "List of Profiles filtered by '(title=Vitae nam et alias.)'": { "value": { "data": [ { "id": "00932763-d653-498f-b17e-7ae808d6f7c6", "ref_id": "xccdf_org.ssgproject.content_profile_4e59b60daf41cbed2bb94ccee025a378", "title": "Vitae nam et alias.", "description": "Similique facere accusamus. Odit perspiciatis omnis. Voluptatem quia est.", "value_overrides": {}, "type": "profile" } ], "meta": { "total": 1, "filter": "(title=\"Vitae nam et alias.\")", "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/security_guides/434b6b61-3424-438c-862c-cadb783fa777/profiles?filter=%28title%3D%22Vitae+nam+et+alias.%22%29&limit=10&offset=0", "last": "/api/compliance/v2/security_guides/434b6b61-3424-438c-862c-cadb783fa777/profiles?filter=%28title%3D%22Vitae+nam+et+alias.%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": "75c90bd7-d1a5-46cc-a43f-38153d92915b", "ref_id": "xccdf_org.ssgproject.content_profile_3b61b43ab4f9aa37c5876d1bd8ee59bf", "title": "Ex temporibus doloremque quidem.", "description": "Rerum est dolores. Nihil qui nesciunt. Dolore quas quis.", "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 408716a2-5bac-4d42-960f-d55b829fc3e4" ] }, "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": "6b8f8f01-7ad2-4f22-8c5a-c7d349569b31", "type": "rule_group", "children": [ { "id": "e130d311-52c9-4811-8786-d7749d1e1d96", "type": "rule" } ] }, { "id": "dadfbb1a-52cf-41c2-bb8b-a394ff6467eb", "type": "rule_group", "children": [ { "id": "e7e74a7c-db00-4108-8581-eb0fad7071a2", "type": "rule" } ] }, { "id": "471444f5-e45b-495a-86cd-583b47cf573d", "type": "rule_group", "children": [ { "id": "54ca5918-4668-45ce-8545-ad653f908ad9", "type": "rule" } ] }, { "id": "b63b03ef-b7c3-41ba-96dc-92e8375a8d89", "type": "rule_group", "children": [ { "id": "9b8f67a7-e557-4b8e-bf21-f53a239d6cdd", "type": "rule" } ] }, { "id": "391d3336-48a8-4129-8484-d19d3de47b54", "type": "rule_group", "children": [ { "id": "bfa26f47-f0fc-4a37-8316-cf34504834e2", "type": "rule" } ] }, { "id": "45d64845-8f4b-4c8e-ac79-938c61caa9e2", "type": "rule_group", "children": [ { "id": "18aa53ec-057d-4fb9-b537-3f44dfe184eb", "type": "rule" } ] }, { "id": "fbe5693a-f3a0-4051-b531-b589fdacad75", "type": "rule_group", "children": [ { "id": "44e342c1-ea7c-4df5-b17d-7d96ca816b57", "type": "rule" } ] }, { "id": "0eaa6dd3-3194-45db-8916-bb82231f43eb", "type": "rule_group", "children": [ { "id": "8bfbe18d-89c3-48d6-916f-ef04df94e3c0", "type": "rule" } ] }, { "id": "ebb30976-28b9-4c30-a611-24fbbe61d1ef", "type": "rule_group", "children": [ { "id": "91fa97ee-bb3d-4451-9f91-40a99d12cb8b", "type": "rule" } ] }, { "id": "32a76e7a-10b2-4434-8bb2-89d2678ac808", "type": "rule_group", "children": [ { "id": "b3979ae3-50e1-4dc6-9b3f-2cc3fa290904", "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 858f10f9-188e-488d-81d1-c63cf762d19e" ] }, "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": "03e83245-961e-477f-94be-252ee17a56bd", "title": "Nemo praesentium consequuntur voluptatum.", "description": "Ullam quam asperiores. Dolores quasi quisquam. Modi dicta iure.", "business_objective": "bus", "compliance_threshold": 90.0, "type": "report", "os_major_version": 8, "profile_title": "Non vero possimus accusamus.", "ref_id": "xccdf_org.ssgproject.content_profile_24ab109e903bd5f8f9c52bd8996f8dd9", "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": "22b24a96-2f37-4615-968f-2fd80238f69c", "title": "Quia nihil iste nulla.", "description": "Molestias quaerat nemo. Dignissimos autem qui. Exercitationem aliquam nam.", "business_objective": "matrix", "compliance_threshold": 90.0, "type": "report", "os_major_version": 8, "profile_title": "Aliquid occaecati velit debitis.", "ref_id": "xccdf_org.ssgproject.content_profile_4eac094338d49dd01fd87f9bd9ae7d22", "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": "5b7eccde-0c3e-4314-a1f4-473b60d63467", "title": "Alias eligendi laudantium unde.", "description": "Velit odio beatae. Consequatur iure amet. Ea sequi quia.", "business_objective": "bus", "compliance_threshold": 90.0, "type": "report", "os_major_version": 8, "profile_title": "Non sapiente porro reprehenderit.", "ref_id": "xccdf_org.ssgproject.content_profile_84aef6769b18a023a8ad78ec17c5cdf9", "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": "647152cb-df86-42a1-b7a6-bb70d2a8fcbd", "title": "Eveniet veniam unde qui.", "description": "Non neque et. Tenetur asperiores suscipit. Officiis libero qui.", "business_objective": "application", "compliance_threshold": 90.0, "type": "report", "os_major_version": 8, "profile_title": "Nemo est necessitatibus illo.", "ref_id": "xccdf_org.ssgproject.content_profile_780240b040d03a67cf6e5576c9c2f71e", "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": "e454d1ea-2c88-4407-be9e-39c51c60a2aa", "title": "Dolores in qui quia.", "description": "Molestias quaerat aliquid. Est odit doloremque. Optio qui et.", "business_objective": "firewall", "compliance_threshold": 90.0, "type": "report", "os_major_version": 8, "profile_title": "Dicta veniam commodi dolorem.", "ref_id": "xccdf_org.ssgproject.content_profile_a3899e79d6b2ab808e119dcc4b053ea9", "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": "16ee953b-483f-43fc-81ed-d24848f9595b", "title": "Accusamus aliquid odit rerum.", "description": "Ut sequi dolorem. Minima id esse. Minus nemo voluptates.", "business_objective": "firewall", "compliance_threshold": 90.0, "type": "report", "os_major_version": 8, "profile_title": "Atque vel velit assumenda.", "ref_id": "xccdf_org.ssgproject.content_profile_ebc68e84d0ecc1fed83b3b1cafddcbe8", "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": "50f12cd3-8b7f-4d28-bc36-8fb80b4cbe81", "title": "Modi vel voluptatem non.", "description": "Qui vel in. Quas sint iste. Molestias est ad.", "business_objective": "panel", "compliance_threshold": 90.0, "type": "report", "os_major_version": 8, "profile_title": "Tempore est dicta expedita.", "ref_id": "xccdf_org.ssgproject.content_profile_8a31c5da27e5e392496d04d3a3fedb13", "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": "567b72fc-cc67-4fe7-a341-f2e0734a398a", "title": "Animi est aliquam ducimus.", "description": "Nihil et sint. Qui dolor qui. Enim et laboriosam.", "business_objective": "panel", "compliance_threshold": 90.0, "type": "report", "os_major_version": 8, "profile_title": "Voluptates impedit esse aspernatur.", "ref_id": "xccdf_org.ssgproject.content_profile_7d32db9e820b4d88609a318ed4706a60", "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": "6ca8d87a-7807-429b-a5b9-53787ec98058", "title": "Sed saepe aut voluptates.", "description": "Et ut occaecati. Aut et iusto. Nisi laboriosam voluptatum.", "business_objective": "system", "compliance_threshold": 90.0, "type": "report", "os_major_version": 8, "profile_title": "Repudiandae consequatur aperiam nulla.", "ref_id": "xccdf_org.ssgproject.content_profile_ee5ba9828a6ef4dd7b7de66fd40fe376", "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": "a6a9b463-df3c-4274-b318-65fefd753295", "title": "Excepturi rerum earum doloribus.", "description": "Eum quis repudiandae. Quasi accusantium et. Ut autem alias.", "business_objective": "transmitter", "compliance_threshold": 90.0, "type": "report", "os_major_version": 8, "profile_title": "Illum dolor sit nostrum.", "ref_id": "xccdf_org.ssgproject.content_profile_45482a377731abf8a1ee9844b30cd9ce", "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": "e00fa525-ddef-446d-96ff-4445e1ec6bfe", "title": "Beatae veniam aut vel.", "description": "Est aliquam nam. Ad sint enim. Sit et cumque.", "business_objective": "card", "compliance_threshold": 90.0, "type": "report", "os_major_version": 9, "profile_title": "Vitae voluptatem esse aperiam.", "ref_id": "xccdf_org.ssgproject.content_profile_ded7c565532a83db0df869610172197e", "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 8141e95a-920f-4f74-85ed-fbc16e08103b" ] }, "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": "91d11eb0-2d32-414a-bb3d-1e38c00b60b6", "title": "Iste sit quia esse.", "description": "Aliquam dolore et. Tenetur vero nam. Quos consectetur blanditiis.", "business_objective": "driver", "compliance_threshold": 90.0, "type": "report", "os_major_version": 9, "profile_title": "Ducimus inventore sapiente est.", "ref_id": "xccdf_org.ssgproject.content_profile_e4ef6398fe9dba7242e740b6d850ecaf", "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 9818a6a2-26bf-43d5-b180-1a0deb9b2956" ] }, "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": "4d989dd2-d87b-4418-8e20-f1f678541c17", "title": "Nemo impedit quia dicta.", "description": "Tenetur sed et. Similique dolorum ipsam. Et voluptates est.", "business_objective": "bus", "compliance_threshold": 90.0, "type": "report", "os_major_version": 8, "profile_title": "Sunt sed id quidem.", "ref_id": "xccdf_org.ssgproject.content_profile_95bb3894679c6cc27e22ad452ea9e6e1", "all_systems_exposed": false, "percent_compliant": 0, "compliant_system_count": 0, "unsupported_system_count": 0, "reported_system_count": 0, "never_reported_system_count": 1 }, { "id": "728913be-c438-4d8a-a3e6-7f0425ec766d", "title": "Nesciunt tempora veniam quo.", "description": "Blanditiis autem perferendis. Aliquam aut id. Debitis animi tempora.", "business_objective": "driver", "compliance_threshold": 90.0, "type": "report", "os_major_version": 8, "profile_title": "Sed eum necessitatibus minima.", "ref_id": "xccdf_org.ssgproject.content_profile_127d94301147e41e150331ac52daf489", "all_systems_exposed": false, "percent_compliant": 0, "compliant_system_count": 0, "unsupported_system_count": 0, "reported_system_count": 0, "never_reported_system_count": 1 }, { "id": "8ad04111-fd60-4900-8ab7-a72f4b3a6b0a", "title": "Quas dolores quisquam modi.", "description": "Animi tempore quia. Ut et ducimus. Nostrum officia sunt.", "business_objective": "port", "compliance_threshold": 90.0, "type": "report", "os_major_version": 8, "profile_title": "Voluptas et et consequuntur.", "ref_id": "xccdf_org.ssgproject.content_profile_e5a9f5945da169ac2d34e5f88bcb3382", "all_systems_exposed": false, "percent_compliant": 0, "compliant_system_count": 0, "unsupported_system_count": 0, "reported_system_count": 0, "never_reported_system_count": 1 }, { "id": "a34052b2-a800-4f38-abc8-7006e70b7643", "title": "Incidunt omnis ut at.", "description": "Facilis sint fugit. Nostrum est sequi. Qui neque et.", "business_objective": "array", "compliance_threshold": 90.0, "type": "report", "os_major_version": 8, "profile_title": "Ipsum et sint commodi.", "ref_id": "xccdf_org.ssgproject.content_profile_301452796ceebca6a6b80de7042ce1c9", "all_systems_exposed": false, "percent_compliant": 0, "compliant_system_count": 0, "unsupported_system_count": 0, "reported_system_count": 0, "never_reported_system_count": 1 }, { "id": "f4509136-0842-4c7b-b063-8135e6ab83ba", "title": "Sint sed inventore unde.", "description": "Praesentium corrupti iste. Ipsum iste enim. Reiciendis sit minus.", "business_objective": "application", "compliance_threshold": 90.0, "type": "report", "os_major_version": 8, "profile_title": "Et quasi ut qui.", "ref_id": "xccdf_org.ssgproject.content_profile_ae29722990c84eaf68d83ed9ee5b2d45", "all_systems_exposed": false, "percent_compliant": 0, "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/204476ed-5367-410c-971d-6563031bbfec/reports?limit=10&offset=0", "last": "/api/compliance/v2/systems/204476ed-5367-410c-971d-6563031bbfec/reports?limit=10&offset=0" } }, "summary": "", "description": "" }, "List of Reports sorted by \"title:asc\"": { "value": { "data": [ { "id": "0a43f42d-e1d7-461f-aff5-087608287d26", "title": "Aut quia officia illo.", "description": "Officiis magnam numquam. Est dicta amet. Asperiores sit soluta.", "business_objective": "panel", "compliance_threshold": 90.0, "type": "report", "os_major_version": 8, "profile_title": "Vel modi sunt repellendus.", "ref_id": "xccdf_org.ssgproject.content_profile_2f4d3a75dd86eea356cfc5346691a837", "all_systems_exposed": false, "percent_compliant": 0, "compliant_system_count": 0, "unsupported_system_count": 0, "reported_system_count": 0, "never_reported_system_count": 1 }, { "id": "c2b20a0b-f272-45de-939b-591d1af4dcf8", "title": "Consequatur aut facilis consequatur.", "description": "Quia veniam enim. Velit occaecati velit. Dicta quae consequatur.", "business_objective": "array", "compliance_threshold": 90.0, "type": "report", "os_major_version": 8, "profile_title": "Quod sit sunt ipsam.", "ref_id": "xccdf_org.ssgproject.content_profile_02c381192e7489298ac99843a6417be9", "all_systems_exposed": false, "percent_compliant": 0, "compliant_system_count": 0, "unsupported_system_count": 0, "reported_system_count": 0, "never_reported_system_count": 1 }, { "id": "1c2ceea9-6de3-4bfc-a143-b46be1fa4ab9", "title": "Est maiores eligendi nostrum.", "description": "Sit aliquid ea. Ullam quis architecto. Et accusantium at.", "business_objective": "capacitor", "compliance_threshold": 90.0, "type": "report", "os_major_version": 8, "profile_title": "Quia voluptatem autem sint.", "ref_id": "xccdf_org.ssgproject.content_profile_b53afed8f57c4128373ce88619e92cfb", "all_systems_exposed": false, "percent_compliant": 0, "compliant_system_count": 0, "unsupported_system_count": 0, "reported_system_count": 0, "never_reported_system_count": 1 }, { "id": "2d5715de-62d1-4044-8b9b-01664b37f84d", "title": "Quam quia non velit.", "description": "Eos voluptate quia. Minus blanditiis ex. Dicta delectus voluptas.", "business_objective": "application", "compliance_threshold": 90.0, "type": "report", "os_major_version": 8, "profile_title": "Ratione minima quas nemo.", "ref_id": "xccdf_org.ssgproject.content_profile_70ed0d5a853a2e107cd46921843b4490", "all_systems_exposed": false, "percent_compliant": 0, "compliant_system_count": 0, "unsupported_system_count": 0, "reported_system_count": 0, "never_reported_system_count": 1 }, { "id": "89bf0bc2-1401-4f37-9ca3-52f3a0181327", "title": "Voluptate fugiat eveniet id.", "description": "Deserunt qui aut. Nemo architecto ab. Est et voluptatem.", "business_objective": "sensor", "compliance_threshold": 90.0, "type": "report", "os_major_version": 8, "profile_title": "Dolores laboriosam dolorem non.", "ref_id": "xccdf_org.ssgproject.content_profile_d09dec804f643a968479944c9f6b3e42", "all_systems_exposed": false, "percent_compliant": 0, "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/2915e513-7620-4402-a175-83ca94cb185c/reports?limit=10&offset=0&sort_by=title", "last": "/api/compliance/v2/systems/2915e513-7620-4402-a175-83ca94cb185c/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": "0b546982-2d10-4abc-8602-d2e805361d08", "ref_id": "xccdf_org.ssgproject.content_rule_group_83477e8f9784292cb5de4779ce02e841", "title": "Perferendis quasi voluptas ut.", "rationale": "Pariatur dolores in. Quod qui voluptatibus. Non cum nobis.", "description": "Itaque repudiandae sequi. Perspiciatis rerum nostrum. Corrupti ea veniam.", "precedence": null, "type": "rule_group" }, { "id": "0be42461-e584-4f8b-8dd5-05c0d1f96ee6", "ref_id": "xccdf_org.ssgproject.content_rule_group_97ead71e290096e74959e68ef31ed355", "title": "Dolorem temporibus iusto vel.", "rationale": "Omnis ut error. Sunt dolorem est. Accusantium nihil magni.", "description": "Nisi voluptatum rerum. Dignissimos velit quibusdam. Recusandae nesciunt culpa.", "precedence": null, "type": "rule_group" }, { "id": "11cca37b-cb87-4344-bcdd-1d45ec6d912c", "ref_id": "xccdf_org.ssgproject.content_rule_group_51dedc924cb62a08f2715a095550f0d8", "title": "Necessitatibus consectetur velit inventore.", "rationale": "Architecto molestiae voluptatem. Deserunt reprehenderit excepturi. Debitis non fugit.", "description": "Vero quae dolore. Tempora et quidem. Voluptatem rerum delectus.", "precedence": null, "type": "rule_group" }, { "id": "1e510f93-8054-4e04-9682-54d24e727b6f", "ref_id": "xccdf_org.ssgproject.content_rule_group_1439708d37b006b68922c5823b11ba89", "title": "Aut non autem asperiores.", "rationale": "Harum corporis quo. Perferendis velit culpa. Ea eligendi culpa.", "description": "Soluta sed officia. Error iure cum. At deserunt commodi.", "precedence": null, "type": "rule_group" }, { "id": "28a42c46-e8d4-4ed3-b0a9-ef011cce8765", "ref_id": "xccdf_org.ssgproject.content_rule_group_fa94b626f9d41ed03eeac03247d06123", "title": "A impedit rerum adipisci.", "rationale": "Et odio labore. Ipsam incidunt quam. Tenetur id maxime.", "description": "Natus qui quos. Qui eum eos. Maiores reprehenderit perferendis.", "precedence": null, "type": "rule_group" }, { "id": "384ef968-6328-4411-950b-301a8016aefc", "ref_id": "xccdf_org.ssgproject.content_rule_group_98d14fe38ea7cc2e8d400a1c3a1d8e92", "title": "Quia non animi facilis.", "rationale": "Asperiores sit blanditiis. Aspernatur ut distinctio. Minus et harum.", "description": "Molestiae velit consequatur. Rerum dolor dolores. Magnam fugiat dolor.", "precedence": null, "type": "rule_group" }, { "id": "47dfaa6f-7335-4353-913a-b55743c9a815", "ref_id": "xccdf_org.ssgproject.content_rule_group_d82a03a0f72bdb347df7eeb6b7adbb7c", "title": "Sint vero cupiditate natus.", "rationale": "Perferendis doloribus reprehenderit. Autem consequatur omnis. Odit id sequi.", "description": "Ipsum quidem vitae. Expedita excepturi ut. Et a quas.", "precedence": null, "type": "rule_group" }, { "id": "5c5d69ad-2a8b-4953-a88a-4184070c6723", "ref_id": "xccdf_org.ssgproject.content_rule_group_b6becfc76a9864d7e539509d599407f7", "title": "Aut facilis laboriosam dolores.", "rationale": "Excepturi deleniti totam. Odio dolores in. Ipsa et est.", "description": "Sunt voluptatem quibusdam. Quasi quidem sapiente. Necessitatibus eveniet mollitia.", "precedence": null, "type": "rule_group" }, { "id": "6078bd41-4f2b-4721-bbee-5b9cb823d582", "ref_id": "xccdf_org.ssgproject.content_rule_group_bf154e01a7673ddb712aecd61b38902d", "title": "Commodi veritatis doloremque qui.", "rationale": "Cumque necessitatibus ea. Et dolores iste. Illo est magnam.", "description": "Placeat optio eos. Atque eos eveniet. Ea explicabo impedit.", "precedence": null, "type": "rule_group" }, { "id": "68fe263e-f2d4-4a37-963e-780b3217b4c1", "ref_id": "xccdf_org.ssgproject.content_rule_group_75395854a3a5efa8399d03df997afd8c", "title": "Repellat odit placeat iusto.", "rationale": "In tenetur laborum. Illo nesciunt esse. Enim necessitatibus et.", "description": "Ipsam qui in. In maxime sed. Eum omnis quod.", "precedence": null, "type": "rule_group" } ], "meta": { "total": 25, "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/security_guides/c414bb3a-7be8-4358-9af3-303304d719a6/rule_groups?limit=10&offset=0", "last": "/api/compliance/v2/security_guides/c414bb3a-7be8-4358-9af3-303304d719a6/rule_groups?limit=10&offset=20", "next": "/api/compliance/v2/security_guides/c414bb3a-7be8-4358-9af3-303304d719a6/rule_groups?limit=10&offset=10" } }, "summary": "", "description": "" }, "List of Rule Groups sorted by \"precedence:asc\"": { "value": { "data": [ { "id": "0d0cb197-779b-421a-811e-425f5a921523", "ref_id": "xccdf_org.ssgproject.content_rule_group_5c1e339baf151b7e70bf6e63751ebc86", "title": "Temporibus et doloremque ex.", "rationale": "Qui magnam eligendi. Dolorem veritatis quibusdam. Doloremque numquam rerum.", "description": "Cumque distinctio rerum. Corrupti soluta sit. Aliquam aut fugit.", "precedence": null, "type": "rule_group" }, { "id": "14635e52-27d0-493b-acc2-1aa09fefc3ef", "ref_id": "xccdf_org.ssgproject.content_rule_group_bc5d2a09c8e121cb59f6ce1b9e1aa636", "title": "Neque doloribus necessitatibus ad.", "rationale": "Eos qui et. Fuga quisquam at. Temporibus aperiam dicta.", "description": "Autem quis unde. Tempora nesciunt explicabo. Dolorum odit quis.", "precedence": null, "type": "rule_group" }, { "id": "1deac5c2-dc84-4a9d-828c-0734d049e7b2", "ref_id": "xccdf_org.ssgproject.content_rule_group_80a9615806db2396c195db5f96daf352", "title": "Non qui ut cumque.", "rationale": "Quia natus praesentium. Voluptates fuga est. Modi adipisci aut.", "description": "Possimus molestias aut. Nesciunt eaque voluptatem. Ipsam quod voluptatum.", "precedence": null, "type": "rule_group" }, { "id": "2c2b9084-5310-4307-848c-f922d4143e10", "ref_id": "xccdf_org.ssgproject.content_rule_group_415e069b0af4b1e59bb318187b26b061", "title": "Rerum hic amet soluta.", "rationale": "Optio soluta ut. Recusandae ut quia. Nam sunt delectus.", "description": "Maiores autem omnis. Quia quisquam quaerat. Est repellat labore.", "precedence": null, "type": "rule_group" }, { "id": "2fb34f92-499b-4fe7-972d-f93073f36052", "ref_id": "xccdf_org.ssgproject.content_rule_group_7cbea23b767e66fc6c4b075ae11346ab", "title": "Quae libero voluptatem sit.", "rationale": "Velit est nesciunt. Et vitae similique. Consectetur reprehenderit iusto.", "description": "Omnis voluptates ut. Consequatur sed ipsum. Aut minima non.", "precedence": null, "type": "rule_group" }, { "id": "3181b361-f8a2-4e77-9e8b-5282acb48a91", "ref_id": "xccdf_org.ssgproject.content_rule_group_62f537a9e443fc699d9f64a5dfcbe510", "title": "Aut eligendi occaecati nemo.", "rationale": "Cumque rerum ipsa. Rem exercitationem voluptatem. Eligendi unde dolor.", "description": "Numquam vel qui. Tenetur beatae illum. Repellendus deleniti mollitia.", "precedence": null, "type": "rule_group" }, { "id": "32a6631c-398a-473e-89e9-ce5e3d8929d2", "ref_id": "xccdf_org.ssgproject.content_rule_group_e8102c2908fdf2eb31d7bb3fcbd58d7e", "title": "Perferendis nobis suscipit et.", "rationale": "Perferendis ducimus maxime. Nemo eum rerum. Magni dolores aspernatur.", "description": "Nihil voluptatem est. Veritatis iusto quia. Reiciendis ratione omnis.", "precedence": null, "type": "rule_group" }, { "id": "34596e62-93ad-48c5-b848-c45cf0cd31af", "ref_id": "xccdf_org.ssgproject.content_rule_group_274a7cc2b3ed9824da6307805d620c87", "title": "Quia inventore itaque nemo.", "rationale": "Libero incidunt quos. Reprehenderit ut magni. Labore dolorum maxime.", "description": "Dolor rerum id. Asperiores architecto quisquam. Ut fugiat illum.", "precedence": null, "type": "rule_group" }, { "id": "511f4ec8-15a0-4e36-bb0d-f556d472973d", "ref_id": "xccdf_org.ssgproject.content_rule_group_88935dfefd3bb259c9628a2887bfbf2d", "title": "Natus nobis et voluptatem.", "rationale": "Necessitatibus doloremque velit. Placeat ducimus corrupti. Mollitia nihil voluptatem.", "description": "Voluptas aut molestiae. Voluptatem eum voluptatem. Sequi voluptatem accusantium.", "precedence": null, "type": "rule_group" }, { "id": "57128a14-8468-4dcc-917d-8aa667f672a3", "ref_id": "xccdf_org.ssgproject.content_rule_group_7d8060982c8e8ce7c62aa6a284e9a523", "title": "Blanditiis harum magni ut.", "rationale": "Dignissimos qui excepturi. Sed et voluptas. Ut quod cupiditate.", "description": "Illo repellendus quisquam. Et maiores eum. Velit deleniti est.", "precedence": null, "type": "rule_group" } ], "meta": { "total": 25, "limit": 10, "offset": 0, "sort_by": "precedence" }, "links": { "first": "/api/compliance/v2/security_guides/8cb72bde-61d7-486e-9b0e-113b2287cf37/rule_groups?limit=10&offset=0&sort_by=precedence", "last": "/api/compliance/v2/security_guides/8cb72bde-61d7-486e-9b0e-113b2287cf37/rule_groups?limit=10&offset=20&sort_by=precedence", "next": "/api/compliance/v2/security_guides/8cb72bde-61d7-486e-9b0e-113b2287cf37/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": "a4fa1004-12ae-410d-a458-77997ebabb76", "ref_id": "xccdf_org.ssgproject.content_rule_group_f9931a9f9ccaab1af118b183afd1e6a0", "title": "Voluptas quis quas quibusdam.", "rationale": "Voluptatem maxime harum. Debitis praesentium vitae. Aut officia error.", "description": "Nesciunt quis natus. Laboriosam sint minima. Assumenda nam quam.", "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 02760ed3-42c9-49c6-b8a4-21587753bc4e" ] }, "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": "7254f4ac-200e-453e-9abf-57f60ace2b71", "result": "fail", "rule_id": "be59d42f-1936-44e2-b212-e48e96903156", "type": "rule_result", "system_id": "0ee2f529-6388-4f66-8bfd-9d036e65fee9", "ref_id": "xccdf_org.ssgproject.content_rule_1c41a5fc7cc4af1cb617155685fea901", "rule_group_id": "ea3a4a6b-5cda-4825-b55f-676e20427037", "title": "Facere doloremque odio impedit.", "rationale": "Possimus impedit cupiditate. Totam corporis optio. Autem voluptas cupiditate.", "description": "Dolorum est voluptatibus. Et asperiores sit. Ea sint ab.", "severity": "medium", "precedence": 2063, "identifier": { "href": "http://pfeffer.example/abby_johnson", "label": "Ufthak" }, "references": [ { "href": "http://schneider.test/vinnie", "label": "Minardil" }, { "href": "http://turner.example/michaela", "label": "Baran" }, { "href": "http://bosco-welch.example/ardelle_kirlin", "label": "Odo Proudfoot" }, { "href": "http://schulist.example/kristyn", "label": "Óin" }, { "href": "http://harvey-wintheiser.example/tracy_pacocha", "label": "Hildifons Took" } ], "remediation_issue_id": null } ], "meta": { "total": 1, "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/reports/687ff979-aaae-4407-9840-8dfb65e7a2bc/test_results/2bc31221-3012-4a31-9091-abdc28edd967/rule_results?limit=10&offset=0", "last": "/api/compliance/v2/reports/687ff979-aaae-4407-9840-8dfb65e7a2bc/test_results/2bc31221-3012-4a31-9091-abdc28edd967/rule_results?limit=10&offset=0" } }, "summary": "", "description": "" }, "List of Rule Results sorted by \"result:asc\"": { "value": { "data": [ { "id": "660c4831-3773-4420-b460-b985736fbcdd", "result": "fail", "rule_id": "9febbafa-65d4-4884-a9a7-259bcc451a56", "type": "rule_result", "system_id": "9c160e4f-dac8-419d-a490-0d99092c1920", "ref_id": "xccdf_org.ssgproject.content_rule_f7ac3a584f2b3b87a2fdaee2a186b57c", "rule_group_id": "691d7ed7-3a66-4fe5-b9d7-18e16351354b", "title": "Necessitatibus cum maxime aut.", "rationale": "Laborum totam voluptatum. Dolorum minima alias. At occaecati ipsum.", "description": "Commodi explicabo nesciunt. Eum delectus illum. Voluptatem culpa sit.", "severity": "medium", "precedence": 1352, "identifier": { "href": "http://senger-rowe.test/kenton", "label": "Ciryatur" }, "references": [ { "href": "http://ernser-bednar.example/monty", "label": "Idis" }, { "href": "http://cremin-volkman.example/lottie.kuvalis", "label": "Aragorn" }, { "href": "http://hodkiewicz.example/letitia_miller", "label": "Marach" }, { "href": "http://denesik-beier.example/ned.moore", "label": "Angamaitë" }, { "href": "http://mante.example/miquel_kemmer", "label": "Mrs. Bunce" } ], "remediation_issue_id": null } ], "meta": { "total": 1, "limit": 10, "offset": 0, "sort_by": "result" }, "links": { "first": "/api/compliance/v2/reports/a883bc43-2097-4980-8afb-34816d649310/test_results/a600ddc9-3044-4016-8224-bf60e2b2f34f/rule_results?limit=10&offset=0&sort_by=result", "last": "/api/compliance/v2/reports/a883bc43-2097-4980-8afb-34816d649310/test_results/a600ddc9-3044-4016-8224-bf60e2b2f34f/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/300f9030-9c0b-4594-a2b1-4e94e3d8f508/test_results/8568e665-e03a-467c-b9b2-3cfaffc2afdd/rule_results?filter=%28title%3Dfoo%29&limit=10&offset=0", "last": "/api/compliance/v2/reports/300f9030-9c0b-4594-a2b1-4e94e3d8f508/test_results/8568e665-e03a-467c-b9b2-3cfaffc2afdd/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": "126dbb91-6baf-40d0-a84e-1c836aec7e19", "ref_id": "xccdf_org.ssgproject.content_rule_9cedcc969d2d5767047cc136ac86fbf3", "title": "Quos soluta atque debitis.", "rationale": "Tenetur magni sit. Maxime quidem nostrum. Corporis saepe nihil.", "description": "Recusandae esse quia. Distinctio dolores quod. Sed voluptatem illo.", "severity": "medium", "precedence": 5882, "identifier": { "href": "http://daugherty.test/marcellus.cremin", "label": "Great Goblin" }, "references": [ { "href": "http://zboncak-kassulke.test/earnest_turcotte", "label": "Turgon" }, { "href": "http://gutmann.test/leticia", "label": "Aerin" }, { "href": "http://bayer-lindgren.test/carolyne", "label": "Ilberic Brandybuck" }, { "href": "http://zulauf.test/michel_kerluke", "label": "Gerda Boffin" }, { "href": "http://torphy.example/ray", "label": "Herefara" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "a8a045da-50aa-4c7c-89a5-4ce9b4338a64", "type": "rule" }, { "id": "1533a2ac-d3aa-4ef5-9f82-944544c0fec6", "ref_id": "xccdf_org.ssgproject.content_rule_6084827c0fba6e7b1b5b150896991ead", "title": "Dolore iure non adipisci.", "rationale": "Dolor maiores cumque. Ipsam placeat illo. Iste voluptatum dolorem.", "description": "Aperiam voluptates atque. Enim quo aspernatur. Ad vitae doloremque.", "severity": "medium", "precedence": 8874, "identifier": { "href": "http://luettgen-bernier.test/royce", "label": "Hallatan" }, "references": [ { "href": "http://roberts.test/ignacio.kub", "label": "Númendil" }, { "href": "http://simonis-collier.example/lamonica.bernier", "label": "Hador" }, { "href": "http://kertzmann-baumbach.test/eustolia", "label": "Tar-Calmacil" }, { "href": "http://stracke.test/keneth", "label": "Peregrin Took" }, { "href": "http://kassulke.example/karmen.bode", "label": "Minastan" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "c25e63fc-9253-4cea-b55f-0aa0afc5a6af", "type": "rule" }, { "id": "40febe1a-1095-4d1a-8164-5b3897c7de2e", "ref_id": "xccdf_org.ssgproject.content_rule_11326566a28280208743f94123d84626", "title": "Quae totam voluptates et.", "rationale": "Pariatur veritatis quibusdam. At sit eaque. Consequatur cum cupiditate.", "description": "Dolor quia impedit. Tempore omnis qui. Consequuntur hic aut.", "severity": "medium", "precedence": 5243, "identifier": { "href": "http://morar-wolf.test/lynn_leffler", "label": "Faniel" }, "references": [ { "href": "http://murphy.example/yolonda_oberbrunner", "label": "Ciryon" }, { "href": "http://collins-kertzmann.example/mike_rempel", "label": "Duinhir" }, { "href": "http://greenholt.test/alan.okuneva", "label": "Tindómiel" }, { "href": "http://rempel-feil.test/lyndon", "label": "Aulendil" }, { "href": "http://terry-reichert.test/solange", "label": "Lúthien" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "f37e8cca-2c05-41ac-95e5-611ae2e163d5", "type": "rule" }, { "id": "452ff51c-236b-41bb-b374-730ad7a2614c", "ref_id": "xccdf_org.ssgproject.content_rule_68d0bc29d7c1341d7f0167846c213606", "title": "Molestias laboriosam distinctio eos.", "rationale": "Id omnis excepturi. Aut consequuntur animi. Et quod quia.", "description": "Aperiam commodi praesentium. Voluptates fuga est. Nesciunt odio ratione.", "severity": "low", "precedence": 2764, "identifier": { "href": "http://steuber.test/murray", "label": "Hatholdir" }, "references": [ { "href": "http://emmerich.test/anton", "label": "Aldor" }, { "href": "http://brown.test/marjorie.legros", "label": "Ingwion" }, { "href": "http://boehm.example/foster", "label": "Ailinel" }, { "href": "http://predovic.example/marla", "label": "Maglor" }, { "href": "http://becker.example/carmelo", "label": "Goldilocks Gardner" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "c3f91df2-385b-4d25-8e66-d350dc1ea864", "type": "rule" }, { "id": "486ee5c7-201a-4a8f-8e67-52a0443b304d", "ref_id": "xccdf_org.ssgproject.content_rule_90431b731e49e41b731a2d970b2e87a5", "title": "Non id corporis assumenda.", "rationale": "Accusantium ex officia. Est provident quasi. Non provident eos.", "description": "Qui non excepturi. Iure aut et. Placeat et soluta.", "severity": "low", "precedence": 8721, "identifier": { "href": "http://miller.example/shena_kutch", "label": "Hunleth" }, "references": [ { "href": "http://botsford.test/ahmad", "label": "Quickbeam" }, { "href": "http://cronin.example/ian", "label": "Damrod" }, { "href": "http://prohaska.example/boris", "label": "Almarian" }, { "href": "http://blick.test/chuck", "label": "Bilbo Baggins" }, { "href": "http://parker.test/stacey.mraz", "label": "Elros" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "eb9c4831-86dc-4d69-ba26-120bfb4505bf", "type": "rule" }, { "id": "63b46e9d-33f6-4275-810b-100bb68bcc06", "ref_id": "xccdf_org.ssgproject.content_rule_fee5c35b2507357401189af755f4aa94", "title": "Facere nobis quasi consequatur.", "rationale": "Saepe rerum dolor. Optio iste quaerat. Aut doloremque ut.", "description": "Qui saepe sint. Fugit reiciendis quos. Itaque recusandae facilis.", "severity": "high", "precedence": 5288, "identifier": { "href": "http://ledner-kovacek.example/ernesto_jenkins", "label": "Gram" }, "references": [ { "href": "http://stark-ebert.example/joannie", "label": "Togo Goodbody" }, { "href": "http://swift-douglas.test/katharina.schaden", "label": "Vardilmë" }, { "href": "http://dubuque-hand.example/buddy", "label": "Erling" }, { "href": "http://kozey.example/luke_langworth", "label": "Tar-Meneldur" }, { "href": "http://herzog.test/sandra.auer", "label": "Willie Banks" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "c80d29a9-8f8a-4f38-9996-c87a3dac43a6", "type": "rule" }, { "id": "71e0202f-6d33-4a9f-9e6a-7189712ca157", "ref_id": "xccdf_org.ssgproject.content_rule_b880c28ca930c94a50afaf1d9cc27824", "title": "Nesciunt quod sed sit.", "rationale": "Dolores qui voluptatibus. Impedit consequatur id. Sunt minus aut.", "description": "Molestiae doloremque vel. Et voluptatibus non. Qui accusamus voluptatem.", "severity": "low", "precedence": 2461, "identifier": { "href": "http://gerhold.test/rosalyn.gutkowski", "label": "Aghan" }, "references": [ { "href": "http://pfeffer-conn.test/bert", "label": "Frodo Baggins" }, { "href": "http://daniel.test/curt_ortiz", "label": "Merimas Brandybuck" }, { "href": "http://bode.test/dorothea_herzog", "label": "Írildë" }, { "href": "http://mante-lindgren.example/marielle_abshire", "label": "Glóin" }, { "href": "http://cartwright-larkin.test/ciera", "label": "Erendis" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "b460d64d-5190-45c9-a2c4-e3f3fc4ee3f7", "type": "rule" }, { "id": "78d4c6f2-22aa-4809-a452-5013dafe907f", "ref_id": "xccdf_org.ssgproject.content_rule_46bd24389d29eb986296054597408e3b", "title": "Voluptatem atque voluptas vel.", "rationale": "Aperiam vel soluta. Est aut nihil. Et blanditiis et.", "description": "Molestiae reiciendis qui. Nesciunt saepe facilis. Explicabo facere similique.", "severity": "medium", "precedence": 7218, "identifier": { "href": "http://lang-schroeder.test/clifton_rath", "label": "Éothéod" }, "references": [ { "href": "http://moore-brown.test/fernande_huel", "label": "Forthwini" }, { "href": "http://kshlerin.test/maryrose.waelchi", "label": "Gaffer Gamgee" }, { "href": "http://windler.example/van", "label": "Isumbras" }, { "href": "http://ferry.test/ralph_kris", "label": "Marroc Brandybuck" }, { "href": "http://carter-corkery.example/dannie_herman", "label": "Ulbar" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "f86f8517-4a7e-4963-9f15-9e50896faf4f", "type": "rule" }, { "id": "82474b5b-edac-41c2-a93c-65e140eb416a", "ref_id": "xccdf_org.ssgproject.content_rule_de5c629bb846a8030ee808dc3b14e5bc", "title": "Qui beatae dolores eos.", "rationale": "Numquam ipsa enim. Quidem natus velit. Voluptate et quasi.", "description": "Dolore vel officia. Voluptatum voluptatibus delectus. Minus molestias reprehenderit.", "severity": "medium", "precedence": 1972, "identifier": { "href": "http://miller-strosin.example/dexter", "label": "Halfred of Overhill" }, "references": [ { "href": "http://beahan.test/yuriko_hermiston", "label": "Folcwine" }, { "href": "http://turner.test/pasquale", "label": "Eglantine Banks" }, { "href": "http://mayer-stark.example/harrison.altenwerth", "label": "Poppy Chubb-Baggins" }, { "href": "http://tremblay-boyle.test/an.swift", "label": "Borondir" }, { "href": "http://labadie-hilll.test/brent", "label": "Gundor" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "1bbe73d9-fe6a-484e-94de-3452b93fbb7d", "type": "rule" }, { "id": "93e54742-c947-4983-93de-9db0d64fb212", "ref_id": "xccdf_org.ssgproject.content_rule_a5b8e5b1ce19d07abb6acee5476dbf9f", "title": "Molestiae sunt voluptas sapiente.", "rationale": "Omnis laboriosam minus. Fugiat nemo et. Vel nisi dolor.", "description": "Et eaque quo. Voluptas et quia. Culpa sed deleniti.", "severity": "medium", "precedence": 6144, "identifier": { "href": "http://parisian.test/jonathan_yundt", "label": "Ciryon" }, "references": [ { "href": "http://pfannerstill.test/harold", "label": "Andvír" }, { "href": "http://waelchi-ryan.example/derrick.hamill", "label": "Nob" }, { "href": "http://kuphal.example/ezekiel.willms", "label": "Torhir Ifant" }, { "href": "http://toy.example/burt", "label": "Beldir" }, { "href": "http://jast.test/kimi", "label": "Wídfara" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "f85c7238-eb58-4170-a38d-109195136088", "type": "rule" } ], "meta": { "total": 25, "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/security_guides/4a228c3c-594c-4785-a8c5-4e664bf3f4e2/rules?limit=10&offset=0", "last": "/api/compliance/v2/security_guides/4a228c3c-594c-4785-a8c5-4e664bf3f4e2/rules?limit=10&offset=20", "next": "/api/compliance/v2/security_guides/4a228c3c-594c-4785-a8c5-4e664bf3f4e2/rules?limit=10&offset=10" } }, "summary": "", "description": "" }, "List of Rules sorted by \"precedence:asc\"": { "value": { "data": [ { "id": "a35ebee5-c900-438a-a16f-44d6cd42a142", "ref_id": "xccdf_org.ssgproject.content_rule_7bb5d32f6a590f3de01a02cff0eda4d2", "title": "Ipsa quaerat quis consequatur.", "rationale": "Voluptates natus totam. Dignissimos voluptatem in. Sapiente eum sit.", "description": "Et distinctio provident. Fugit et veniam. Hic tempore officia.", "severity": "low", "precedence": 254, "identifier": { "href": "http://cassin-bahringer.example/theron_paucek", "label": "Anardil" }, "references": [ { "href": "http://heathcote-schiller.test/lona_corkery", "label": "Irolas" }, { "href": "http://champlin.test/marissa", "label": "Eärendil" }, { "href": "http://klein.example/philomena_corwin", "label": "Arantar" }, { "href": "http://cummings.example/gabriela", "label": "Ivorwen" }, { "href": "http://windler.example/antione_jones", "label": "Amaranth Brandybuck" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "e18fb67f-b327-4de4-9e60-5d4730c0c726", "type": "rule" }, { "id": "65cf8a2f-9de1-45d0-920e-989809f14b83", "ref_id": "xccdf_org.ssgproject.content_rule_a9556b31aea91de1062034a8cd2de04a", "title": "Enim aut rerum rerum.", "rationale": "Provident nobis at. Unde doloribus sed. Asperiores temporibus labore.", "description": "Possimus quis odit. Ratione aut sit. Delectus qui rerum.", "severity": "medium", "precedence": 626, "identifier": { "href": "http://grant-johnson.test/lloyd.maggio", "label": "Mîm" }, "references": [ { "href": "http://veum-wisozk.test/alberta", "label": "Rosa Baggins" }, { "href": "http://hayes.example/marlo_dooley", "label": "Girion" }, { "href": "http://keebler.test/leonardo.will", "label": "Goldwine" }, { "href": "http://miller.test/ned", "label": "Wilcome" }, { "href": "http://mills.example/joannie", "label": "Nerdanel" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "219301c2-8651-4051-9820-11ae8a4a3e5d", "type": "rule" }, { "id": "a8091a38-7399-4311-a7af-301cb9ab45b6", "ref_id": "xccdf_org.ssgproject.content_rule_275ae90efded59f01f18d1927ddd3461", "title": "Quod similique incidunt eaque.", "rationale": "Voluptatem nobis ducimus. Cum autem qui. Tenetur et tempora.", "description": "Vero qui consequatur. Nostrum nihil excepturi. Natus ut culpa.", "severity": "medium", "precedence": 822, "identifier": { "href": "http://mertz-lynch.example/christinia.rohan", "label": "Aranuir" }, "references": [ { "href": "http://senger.example/kina", "label": "Lothíriel" }, { "href": "http://mayert.test/wilbert.nolan", "label": "Isilmo" }, { "href": "http://leannon.test/melynda.wilderman", "label": "Pott the Mayor" }, { "href": "http://crooks-flatley.example/rene", "label": "Ulfang" }, { "href": "http://nikolaus-ward.test/dion", "label": "Éomund" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "3e67d5e8-8c08-473b-bd74-a1d3232484cc", "type": "rule" }, { "id": "25d3baab-348c-41b2-8230-53de7c192a98", "ref_id": "xccdf_org.ssgproject.content_rule_86161b799b8ef58929fb9278b6914f27", "title": "Odio dolorem excepturi incidunt.", "rationale": "Facere nam est. Est et ut. Autem sequi earum.", "description": "Ullam fugit officia. Consequatur quas quo. Fugit dolores praesentium.", "severity": "high", "precedence": 1037, "identifier": { "href": "http://medhurst-wilderman.example/carlton_towne", "label": "Galadriel" }, "references": [ { "href": "http://bradtke.test/kenton.douglas", "label": "Gormadoc Brandybuck" }, { "href": "http://wiza.test/kizzie", "label": "Malvegil" }, { "href": "http://streich.example/shandi", "label": "Turambar" }, { "href": "http://stokes-ondricka.example/myrl_turcotte", "label": "Hallas" }, { "href": "http://schoen-quigley.example/hector", "label": "Turgon" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "56d503fe-7a2b-49b0-b7ef-9243a7af90d7", "type": "rule" }, { "id": "b94bc7a5-2d09-4f73-9e58-4f35bd9fe5b5", "ref_id": "xccdf_org.ssgproject.content_rule_29655caea52f018d488e865d96475687", "title": "Autem molestiae provident aut.", "rationale": "Molestiae modi eos. Voluptas eveniet magni. Ea expedita deserunt.", "description": "Ut et recusandae. Ipsam veritatis similique. Odit quaerat rerum.", "severity": "high", "precedence": 1094, "identifier": { "href": "http://doyle.test/elana.schneider", "label": "Elemmírë" }, "references": [ { "href": "http://johnson.example/roy.pouros", "label": "Dudo Baggins" }, { "href": "http://bins.test/lashandra.larson", "label": "Elemmírë" }, { "href": "http://fay.test/eddie", "label": "Gerda Boffin" }, { "href": "http://wiegand-boyer.example/wesley", "label": "Caliondo" }, { "href": "http://friesen.test/breana", "label": "Flambard Took" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "ca44efc1-7e83-4e0e-85f7-bc222bd4ac6e", "type": "rule" }, { "id": "66802fd8-a601-40fc-8680-bc8856063af2", "ref_id": "xccdf_org.ssgproject.content_rule_35fbf2da11139c487d1f78f973a89608", "title": "Sunt est atque qui.", "rationale": "Magnam sed aut. Consectetur tempora enim. Ex velit a.", "description": "Nostrum fugiat amet. Ducimus rem optio. Illum et assumenda.", "severity": "medium", "precedence": 1156, "identifier": { "href": "http://rutherford.test/verline_balistreri", "label": "Mablung" }, "references": [ { "href": "http://heller-green.test/rich.fadel", "label": "Torhir Ifant" }, { "href": "http://bins-kuvalis.test/lizabeth", "label": "Morwen" }, { "href": "http://padberg.example/leo", "label": "Fredegar Bolger" }, { "href": "http://hodkiewicz.test/rasheeda", "label": "Déorwine" }, { "href": "http://becker.test/spencer", "label": "Lofar" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "c70261d9-638c-46dc-ae81-8e69d159a5c5", "type": "rule" }, { "id": "c1e691e8-5922-4fd2-8f8d-282e673a9f26", "ref_id": "xccdf_org.ssgproject.content_rule_e958b2a5886cee3a1263133ab824836b", "title": "Et quidem aut hic.", "rationale": "Vel voluptatem reiciendis. Mollitia laudantium voluptates. Recusandae vero perferendis.", "description": "Earum omnis sed. Ea vel ut. Beatae est sequi.", "severity": "low", "precedence": 2203, "identifier": { "href": "http://grant-harber.example/reynaldo_schultz", "label": "Hardang" }, "references": [ { "href": "http://zieme.test/clay", "label": "Saelon" }, { "href": "http://breitenberg.example/audrie", "label": "Wídfara" }, { "href": "http://jacobs.test/lashell", "label": "Gorgol" }, { "href": "http://okuneva.test/kareem_spinka", "label": "Gléowine" }, { "href": "http://wisoky.test/bernita", "label": "Aranwë" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "d3b69e94-819d-4a7d-9936-f79be4acb881", "type": "rule" }, { "id": "e43604aa-7dd6-484a-bb7b-cf6a2dc2829b", "ref_id": "xccdf_org.ssgproject.content_rule_5b18f40cd279ca426f9bf2dc9b1bad41", "title": "Eum quibusdam ut aut.", "rationale": "Sapiente at magnam. Dolor eos voluptates. Repellendus et inventore.", "description": "Placeat excepturi quis. Minus veniam vero. Delectus libero sed.", "severity": "high", "precedence": 2589, "identifier": { "href": "http://nienow.test/graig.connelly", "label": "Valacar" }, "references": [ { "href": "http://erdman-yundt.example/rosendo_dare", "label": "Derufin" }, { "href": "http://gorczany-hintz.example/samual.huels", "label": "Halfred of Overhill" }, { "href": "http://yundt.example/oscar", "label": "Ar-Pharazôn" }, { "href": "http://funk.test/anissa", "label": "Lily Brown" }, { "href": "http://okeefe.test/donnell.conn", "label": "Tarciryan" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "3f0f91f0-c806-4c8c-a66c-0f3f94a18b1e", "type": "rule" }, { "id": "734bb8f4-3b77-4f00-bb46-85868cd6e7fa", "ref_id": "xccdf_org.ssgproject.content_rule_bf653b5e8d6b2391c86a02f67bc5087d", "title": "Sunt hic neque est.", "rationale": "Aperiam optio et. Aliquam eos rem. Illum vel recusandae.", "description": "Explicabo nobis qui. Pariatur dolores nulla. Corrupti aut sapiente.", "severity": "medium", "precedence": 3074, "identifier": { "href": "http://sauer.test/porter", "label": "Herefara" }, "references": [ { "href": "http://hilll.example/shauna.lubowitz", "label": "Otto Boffin" }, { "href": "http://skiles-hammes.example/helaine_corwin", "label": "Tar-Meneldur" }, { "href": "http://green.example/chase", "label": "Gundolpho Bolger" }, { "href": "http://jerde-hayes.test/augustine_grady", "label": "Eradan" }, { "href": "http://wilkinson-bednar.example/yolonda_carter", "label": "Borthand" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "8b568d03-955a-4821-aea2-1bc02591e8e4", "type": "rule" }, { "id": "765ba5b1-b237-4f50-87da-c7bc0cec8153", "ref_id": "xccdf_org.ssgproject.content_rule_1a68d72f03510840212fe1e2707cc265", "title": "Voluptas in dolorem repudiandae.", "rationale": "Eos doloremque rerum. Quis cum aut. Nihil voluptatem veniam.", "description": "Non ut perspiciatis. Aut autem eum. Tenetur culpa enim.", "severity": "high", "precedence": 3591, "identifier": { "href": "http://watsica.example/jay", "label": "Daisy Gardner" }, "references": [ { "href": "http://hamill-mckenzie.test/ashely_walter", "label": "Elendil" }, { "href": "http://rempel.example/roseann_schaefer", "label": "Ulwarth" }, { "href": "http://leuschke.test/carmella.dubuque", "label": "Saeros" }, { "href": "http://kshlerin.test/twila", "label": "Oropher" }, { "href": "http://herzog.example/arlen.predovic", "label": "Cotman" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "779ae607-2c9f-454d-af27-6b939466c788", "type": "rule" } ], "meta": { "total": 25, "limit": 10, "offset": 0, "sort_by": "precedence" }, "links": { "first": "/api/compliance/v2/security_guides/44ed38ce-83c1-4275-8910-b5b66b310ce1/rules?limit=10&offset=0&sort_by=precedence", "last": "/api/compliance/v2/security_guides/44ed38ce-83c1-4275-8910-b5b66b310ce1/rules?limit=10&offset=20&sort_by=precedence", "next": "/api/compliance/v2/security_guides/44ed38ce-83c1-4275-8910-b5b66b310ce1/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": "165e055c-26b1-40cb-b06a-e13f5f2c84d4", "ref_id": "xccdf_org.ssgproject.content_rule_80f3d5be7185f95afdada4eed8d269e1", "title": "Enim voluptatem ex quis.", "rationale": "Dolor iure tenetur. Amet non dolores. Nostrum sint aut.", "description": "Perspiciatis eaque ut. Rerum sit velit. A et et.", "severity": "medium", "precedence": 463, "identifier": { "href": "http://morissette-vandervort.test/carrol_bartoletti", "label": "Quickbeam" }, "references": [ { "href": "http://hahn-green.example/shandra.kub", "label": "Tar-Anárion" }, { "href": "http://willms.example/kimi.beatty", "label": "Éothain" }, { "href": "http://trantow.example/stephan_romaguera", "label": "Ingwion" }, { "href": "http://jenkins.test/brad", "label": "Caliondo" }, { "href": "http://tillman-wilderman.example/lino", "label": "May Gamgee" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "0020b3ba-e886-4a2d-8762-8acef408013f", "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 5fe3a05c-b010-46bb-8ff0-23f831476fb2" ] }, "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": "17809522-d84a-4030-ab77-faa22da6ac2d", "ref_id": "xccdf_org.ssgproject.content_rule_35860b05c7e34056ca2ea88d74b90851", "title": "Ea consequatur omnis officia.", "rationale": "Voluptatem et delectus. Repudiandae modi impedit. Consequatur laborum autem.", "description": "Dolores placeat sapiente. Magni dolor et. Ut pariatur ad.", "severity": "medium", "precedence": 1081, "identifier": { "href": "http://schinner.example/cynthia", "label": "Eldacar" }, "references": [ { "href": "http://moen-larson.example/benjamin", "label": "Bregolas" }, { "href": "http://reinger.example/laurel", "label": "Huan" }, { "href": "http://streich-weimann.test/britt_schultz", "label": "Forhend" }, { "href": "http://thiel.test/hosea", "label": "Daeron" }, { "href": "http://graham.example/jacob_leffler", "label": "Nellas" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "de7123c9-e1c0-4f9c-ae11-8973379a4f69", "type": "rule", "remediation_issue_id": null }, { "id": "2f828ce6-a7c2-4ac7-8808-0f34a7b06ca3", "ref_id": "xccdf_org.ssgproject.content_rule_dd06511e082fcbdad85ededff7c14005", "title": "Sunt quidem voluptatem facere.", "rationale": "Ex neque quos. Dolorum voluptatem et. Laboriosam et labore.", "description": "Sed suscipit aliquid. Vel impedit tenetur. Deleniti dolorum totam.", "severity": "low", "precedence": 7910, "identifier": { "href": "http://hackett-abshire.test/jamaal.gerlach", "label": "Scatha" }, "references": [ { "href": "http://rath.example/laine_corkery", "label": "Faniel" }, { "href": "http://becker.example/evia", "label": "Eldarion" }, { "href": "http://kassulke.test/ramona", "label": "Ivy Goodenough" }, { "href": "http://olson-leannon.test/syreeta", "label": "Arciryas" }, { "href": "http://spencer.example/clark.pacocha", "label": "Haldan" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "4a31a70f-5659-42b8-a693-7c982638b4d5", "type": "rule", "remediation_issue_id": null }, { "id": "39cbb094-159f-466f-8b19-82d7e0f25c84", "ref_id": "xccdf_org.ssgproject.content_rule_9574ac8138fe1cd6859c4ab7dbe3b869", "title": "Numquam ducimus sit nesciunt.", "rationale": "Id cum dolorem. Ab molestias voluptates. Rem neque distinctio.", "description": "Beatae iure quis. Non atque enim. Est atque possimus.", "severity": "medium", "precedence": 7923, "identifier": { "href": "http://bode.test/omar", "label": "Fíli" }, "references": [ { "href": "http://strosin-nicolas.test/tonette_boyer", "label": "Túrin" }, { "href": "http://kuhic.example/shon_hand", "label": "Meneldil" }, { "href": "http://wiza.test/dalene", "label": "Lindórië" }, { "href": "http://dach.example/jack", "label": "Dodinas Brandybuck" }, { "href": "http://christiansen.example/agustin_murphy", "label": "Glaurung" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "47d930c5-539b-4d0a-80ac-e7b7fc4a22a5", "type": "rule", "remediation_issue_id": null }, { "id": "4b4429ba-985e-4ed4-a9fd-b7dcf619c6b8", "ref_id": "xccdf_org.ssgproject.content_rule_88dc44685e1dc1929c7cf76c09179e22", "title": "Occaecati consequatur aut omnis.", "rationale": "Aut et omnis. Non id consequatur. Aut voluptatum suscipit.", "description": "Ut quibusdam voluptates. Doloremque adipisci voluptatem. Molestiae aut vel.", "severity": "medium", "precedence": 2247, "identifier": { "href": "http://trantow.example/lisette", "label": "Orleg" }, "references": [ { "href": "http://pagac-toy.test/loyce", "label": "Grim" }, { "href": "http://dubuque.test/gennie.turcotte", "label": "Rosamunda Took" }, { "href": "http://armstrong.example/lon_okeefe", "label": "Hallacar" }, { "href": "http://nolan-crooks.test/doug_predovic", "label": "Frerin" }, { "href": "http://jones.test/francis", "label": "Tar-Elendil" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "4cb98f92-7ced-4b7d-8747-948a304e5267", "type": "rule", "remediation_issue_id": null }, { "id": "4b455f0e-4e1f-4849-9345-50bf50dcfb79", "ref_id": "xccdf_org.ssgproject.content_rule_240e4fe1060259ae93688d689012b793", "title": "Dolores fuga fugiat in.", "rationale": "Id eos quae. Distinctio cumque iure. Consequatur natus facere.", "description": "Eos et similique. Suscipit et culpa. Rerum consequatur enim.", "severity": "low", "precedence": 8799, "identifier": { "href": "http://rath.example/jon", "label": "Bandobras Took" }, "references": [ { "href": "http://reynolds-goyette.test/douglass", "label": "Óin" }, { "href": "http://kuhic-franecki.test/cesar", "label": "Elrohir" }, { "href": "http://turcotte-green.example/silva", "label": "Amrod" }, { "href": "http://langosh.test/arnoldo", "label": "Posco Baggins" }, { "href": "http://kuhn-miller.example/jamal", "label": "Emeldir" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "951bba50-f4b1-4175-a632-26cf76aafc6a", "type": "rule", "remediation_issue_id": null }, { "id": "4d305b43-b5fc-4184-b44c-a525639cfbe6", "ref_id": "xccdf_org.ssgproject.content_rule_c44674eed04d95238ea5e276fdb113c5", "title": "Odit quis nostrum laboriosam.", "rationale": "Est suscipit rerum. Explicabo molestias placeat. Molestias eveniet excepturi.", "description": "Dolores velit ipsa. Nesciunt sint occaecati. Voluptatem ut laudantium.", "severity": "medium", "precedence": 7345, "identifier": { "href": "http://maggio.test/roman.dicki", "label": "Caranthir" }, "references": [ { "href": "http://kertzmann.example/kory", "label": "Old Noakes" }, { "href": "http://wunsch.example/reda", "label": "Eglantine Banks" }, { "href": "http://konopelski.example/lawerence_watsica", "label": "Idis" }, { "href": "http://mckenzie.example/nancey.pollich", "label": "Beregar" }, { "href": "http://wuckert.test/brendan", "label": "Adelard Took" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "854fbc7c-55ac-41dd-921b-8a80e620cba4", "type": "rule", "remediation_issue_id": null }, { "id": "5b1c001f-93a2-4ba4-a629-23f53e4f83b9", "ref_id": "xccdf_org.ssgproject.content_rule_8cae6ac05a2f032f09eb6a6c9246414c", "title": "Optio repellat necessitatibus et.", "rationale": "Reiciendis tenetur repellendus. Dolor voluptates nihil. Consequuntur mollitia placeat.", "description": "Fuga aut quas. Perferendis corporis animi. Dolores saepe sint.", "severity": "high", "precedence": 9767, "identifier": { "href": "http://cummings.test/frederick", "label": "Gilmith" }, "references": [ { "href": "http://weber-dicki.example/marylou", "label": "Mairen" }, { "href": "http://conroy.example/emmanuel.hoppe", "label": "Flambard Took" }, { "href": "http://friesen.example/deana.kihn", "label": "Boar of Everholt" }, { "href": "http://schinner-schamberger.test/concepcion_schaden", "label": "Arminas" }, { "href": "http://kozey.test/clair_halvorson", "label": "Elfhild" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "f8f1f1f3-9cee-49ce-b0b3-c7b4d9b9c28a", "type": "rule", "remediation_issue_id": null }, { "id": "5f606e3f-c3ce-4a47-a105-ec26f5f75f56", "ref_id": "xccdf_org.ssgproject.content_rule_a57565cb9672cdab897f2f3f08a594c6", "title": "Quis ipsam officia magnam.", "rationale": "Ut ipsam placeat. Qui incidunt vel. Iste nulla fugiat.", "description": "Deserunt dolores quo. Eum voluptas dolores. Sint debitis laboriosam.", "severity": "medium", "precedence": 1949, "identifier": { "href": "http://kutch.example/oneida", "label": "Valacar" }, "references": [ { "href": "http://sauer.test/winnie_blanda", "label": "Gamil Zirak" }, { "href": "http://tremblay-kessler.example/emory", "label": "Nimloth of Doriath" }, { "href": "http://swaniawski.test/tonya", "label": "Mairen" }, { "href": "http://zieme.test/jo_deckow", "label": "Rudibert Bolger" }, { "href": "http://cummerata-schuster.example/adolph.russel", "label": "Pengolodh" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "8f97cba2-cffe-4ab1-b2a8-929facf5746d", "type": "rule", "remediation_issue_id": null }, { "id": "601d0d29-fc93-4481-903a-ab8e3b3e5cc2", "ref_id": "xccdf_org.ssgproject.content_rule_01952fa5e2363bb7d44711d534371630", "title": "Et et reiciendis culpa.", "rationale": "Eos iure autem. Est repellat illum. Eaque qui aliquid.", "description": "Placeat modi inventore. Neque maiores eos. Voluptatem dolores vel.", "severity": "medium", "precedence": 6062, "identifier": { "href": "http://smitham-ohara.example/evelynn.frami", "label": "Draugluin" }, "references": [ { "href": "http://monahan-mayert.example/gene", "label": "Dina Diggle" }, { "href": "http://considine-lang.example/kyung_corkery", "label": "Ulfang" }, { "href": "http://hessel.example/obdulia_tromp", "label": "Arahad" }, { "href": "http://kertzmann-gorczany.test/mario", "label": "Amrod" }, { "href": "http://howell.example/buddy", "label": "Tarondor" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "76bfa57d-cb7b-4a1c-a1b9-698cce145741", "type": "rule", "remediation_issue_id": null }, { "id": "60534b2e-db38-42bd-a762-2e8df359faf5", "ref_id": "xccdf_org.ssgproject.content_rule_a61feee18c8833528002523e3c1b4497", "title": "Facere dolores qui et.", "rationale": "Quo esse qui. Tempore exercitationem voluptate. Praesentium animi est.", "description": "Et veritatis quia. Eius provident incidunt. Ea accusantium et.", "severity": "high", "precedence": 2173, "identifier": { "href": "http://bins-terry.example/felicita_rice", "label": "Cotman" }, "references": [ { "href": "http://medhurst.test/markus_upton", "label": "Angelica Baggins" }, { "href": "http://kerluke-lubowitz.example/asa", "label": "Ibun" }, { "href": "http://bosco-brown.example/dennis", "label": "Atanatar" }, { "href": "http://jacobs-nader.test/myles", "label": "Minto Burrows" }, { "href": "http://metz-baumbach.example/doreen.stark", "label": "Aragost" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "14626d40-6954-44c6-84f4-b37b91235b4d", "type": "rule", "remediation_issue_id": null } ], "meta": { "total": 25, "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/security_guides/72f5e75d-70fd-4255-8c4c-0abf5ecb9e31/profiles/04e34a27-02ce-4b15-8c52-98f1a59012a3/rules?limit=10&offset=0", "last": "/api/compliance/v2/security_guides/72f5e75d-70fd-4255-8c4c-0abf5ecb9e31/profiles/04e34a27-02ce-4b15-8c52-98f1a59012a3/rules?limit=10&offset=20", "next": "/api/compliance/v2/security_guides/72f5e75d-70fd-4255-8c4c-0abf5ecb9e31/profiles/04e34a27-02ce-4b15-8c52-98f1a59012a3/rules?limit=10&offset=10" } }, "summary": "", "description": "" }, "List of Rules sorted by \"precedence:asc\"": { "value": { "data": [ { "id": "ad6a7ef2-13be-4482-bf5f-557d95df5b6c", "ref_id": "xccdf_org.ssgproject.content_rule_35e8df048700e9ea3cb24ade47f0cb2e", "title": "Sit culpa fugit tempora.", "rationale": "Natus nulla dolorem. Explicabo animi similique. Laborum eius provident.", "description": "Mollitia voluptate adipisci. Necessitatibus dolorem omnis. Ipsam consequuntur quod.", "severity": "low", "precedence": 129, "identifier": { "href": "http://johnson.example/ira", "label": "Primrose Boffin" }, "references": [ { "href": "http://dubuque.test/anne_crist", "label": "Minastan" }, { "href": "http://brown.test/mauricio.willms", "label": "Gundabald Bolger" }, { "href": "http://kautzer-torp.example/ruthann_prosacco", "label": "Gorbulas Brandybuck" }, { "href": "http://dubuque.test/jules", "label": "Glorfindel" }, { "href": "http://feil-dickinson.example/bret.abbott", "label": "Primrose Gardner" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "fd7f978c-0910-44cc-943d-06bf772e314b", "type": "rule", "remediation_issue_id": null }, { "id": "c9f8077c-7453-4020-a502-604459bb7687", "ref_id": "xccdf_org.ssgproject.content_rule_6d6adbe43ada443dfdae5703ad890874", "title": "Blanditiis qui ut fugit.", "rationale": "Nostrum exercitationem sit. Reprehenderit nostrum doloremque. Molestias corrupti sint.", "description": "Eos nemo repellendus. Inventore saepe maxime. Sequi repellat eaque.", "severity": "medium", "precedence": 313, "identifier": { "href": "http://friesen.example/lakiesha_metz", "label": "Chica Chubb" }, "references": [ { "href": "http://bogan-purdy.example/salvatore.baumbach", "label": "Barliman Butterbur" }, { "href": "http://kuhlman.example/moises_welch", "label": "Soronto" }, { "href": "http://windler.example/linnea", "label": "Tar-Telemmaitë" }, { "href": "http://grimes.example/cody.medhurst", "label": "Ciryatur" }, { "href": "http://sauer.example/libby", "label": "Sangahyando" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "c5051f0a-8f1a-4e37-aae9-9c3e062b47ed", "type": "rule", "remediation_issue_id": null }, { "id": "465ab2c6-53e2-48c0-b6a0-c2b6c4ecd0d6", "ref_id": "xccdf_org.ssgproject.content_rule_f1a32ced79f082fdd2150a9d9c3efd6c", "title": "Blanditiis corrupti ab aliquam.", "rationale": "Ratione in qui. Quia suscipit id. Nostrum qui sed.", "description": "Quaerat dolorem et. Consequatur ullam non. Et id vero.", "severity": "low", "precedence": 339, "identifier": { "href": "http://nicolas.example/corie.heaney", "label": "Peregrin Took" }, "references": [ { "href": "http://koch.example/booker_witting", "label": "Golasgil" }, { "href": "http://mueller.example/son", "label": "Bregor" }, { "href": "http://roob-glover.test/kraig", "label": "Nienor" }, { "href": "http://thompson-volkman.test/tomi", "label": "Huan" }, { "href": "http://oconnell.example/maurice", "label": "Valandur" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "e5424691-c3e2-499f-b5a2-cc2faabcd99a", "type": "rule", "remediation_issue_id": null }, { "id": "6fef8178-3799-465a-80c6-2d320d25cfb0", "ref_id": "xccdf_org.ssgproject.content_rule_b200bb5a55bfab79ce8b94b09dbafbd8", "title": "Culpa eveniet animi itaque.", "rationale": "Doloribus nihil temporibus. Esse impedit tempora. Ratione culpa vero.", "description": "Omnis omnis natus. Neque quisquam accusamus. Saepe est cumque.", "severity": "low", "precedence": 534, "identifier": { "href": "http://okon-cummerata.test/fabiola", "label": "Isilmo" }, "references": [ { "href": "http://witting.test/bruno", "label": "Pimpernel Took" }, { "href": "http://shields.test/rafael_wiegand", "label": "Hyarmendacil" }, { "href": "http://daniel-anderson.example/zane_considine", "label": "Hatholdir" }, { "href": "http://swift-spinka.test/emmitt", "label": "Gildor" }, { "href": "http://nienow-armstrong.test/jaimie.grimes", "label": "Hildifons Took" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "45854fd3-d9f3-4615-97ad-ddfb3ca6053b", "type": "rule", "remediation_issue_id": null }, { "id": "09ca8426-b5b7-4c58-9d93-9c1e5531b659", "ref_id": "xccdf_org.ssgproject.content_rule_34476ab98d2a66f4c8ec80a154a31bea", "title": "Sunt id et magnam.", "rationale": "Et libero sunt. Voluptatum optio rerum. Ea autem reprehenderit.", "description": "Placeat velit beatae. Eligendi dolorum eius. Quibusdam maiores nihil.", "severity": "medium", "precedence": 593, "identifier": { "href": "http://gutmann.test/shelby", "label": "Chica Chubb" }, "references": [ { "href": "http://damore-thiel.example/michel", "label": "Imin" }, { "href": "http://friesen-cummerata.example/lupe", "label": "Maeglin" }, { "href": "http://kessler.example/otilia", "label": "Thengel" }, { "href": "http://dicki.test/neville_roberts", "label": "Eärnil" }, { "href": "http://kovacek.test/jimmy", "label": "Elrond" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "1e5a3ac7-5278-4952-82ab-aaeaef88b719", "type": "rule", "remediation_issue_id": null }, { "id": "b3f09a3d-80a2-466c-9dd8-07c306c8b788", "ref_id": "xccdf_org.ssgproject.content_rule_4f5c677c7c757e80716e856af4fd5d9c", "title": "Accusamus quam ut sint.", "rationale": "Eos ex dolor. Illum eligendi vel. Ad beatae esse.", "description": "Ratione officiis rem. Nesciunt minima molestiae. Sapiente omnis culpa.", "severity": "medium", "precedence": 692, "identifier": { "href": "http://jaskolski-quitzon.test/inge", "label": "Bombur" }, "references": [ { "href": "http://herman.test/gilbert", "label": "Telumehtar Umbardacil" }, { "href": "http://kerluke-kris.example/julia.barton", "label": "Elfstan Fairbairn" }, { "href": "http://sawayn-daugherty.example/ruthann", "label": "Gundolpho Bolger" }, { "href": "http://nienow.example/margarette_huel", "label": "Nolondil" }, { "href": "http://johns-becker.example/glendora_braun", "label": "Finwë" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "bc76f11f-cca6-4ab6-9dea-fb9ae421c173", "type": "rule", "remediation_issue_id": null }, { "id": "743cc82d-d344-48e0-92ac-fa21b2d9da2c", "ref_id": "xccdf_org.ssgproject.content_rule_150a262bfcad6a73fb85eb379f79f3f8", "title": "Excepturi et vero harum.", "rationale": "Eaque quam aliquid. Ab optio pariatur. Est eum cumque.", "description": "Veniam molestiae dolorum. Enim tempore error. Blanditiis distinctio optio.", "severity": "low", "precedence": 763, "identifier": { "href": "http://witting.example/laticia.greenholt", "label": "Annael" }, "references": [ { "href": "http://farrell.test/magaret.mccullough", "label": "Morwë" }, { "href": "http://ferry.example/demarcus", "label": "Imin" }, { "href": "http://dubuque.example/scott_volkman", "label": "Gorhendad Oldbuck" }, { "href": "http://funk-collier.test/chris", "label": "Aranwë" }, { "href": "http://marvin.test/keven_heaney", "label": "Girion" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "70bf9084-9d83-4685-ba27-9545a3c3fc49", "type": "rule", "remediation_issue_id": null }, { "id": "ab8597d3-3b62-4588-9638-bbfc7e3b5382", "ref_id": "xccdf_org.ssgproject.content_rule_4648a94c76e41577ce17212e78ed9bc0", "title": "Minima iure quasi et.", "rationale": "Hic sed possimus. Autem ipsum quos. Soluta ex reiciendis.", "description": "Corrupti voluptas a. Autem iure aperiam. Autem illo est.", "severity": "low", "precedence": 884, "identifier": { "href": "http://mitchell-predovic.test/roman.feil", "label": "Urthel" }, "references": [ { "href": "http://rempel.test/kiara", "label": "Manthor" }, { "href": "http://anderson-kovacek.test/celine_mcglynn", "label": "Hallas" }, { "href": "http://bernhard.test/rickey.ledner", "label": "Tom Bombadil" }, { "href": "http://wuckert.test/jerold", "label": "Girion" }, { "href": "http://kiehn-lowe.test/juan_mante", "label": "Madril" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "6cb6ed61-74a8-4bd7-89d8-2c86b06f18ba", "type": "rule", "remediation_issue_id": null }, { "id": "1ac5c814-f7a2-4e11-bd27-ef0c1174e474", "ref_id": "xccdf_org.ssgproject.content_rule_21d934893821696c005a4fda31d49934", "title": "Quia quo deserunt facilis.", "rationale": "Adipisci alias doloribus. Voluptatem labore assumenda. Beatae sunt officiis.", "description": "Nobis est id. Suscipit doloremque ut. Nam blanditiis facilis.", "severity": "medium", "precedence": 1235, "identifier": { "href": "http://kris-fadel.example/ned", "label": "Soronto" }, "references": [ { "href": "http://bartell.test/amiee_bednar", "label": "Heribald Bolger" }, { "href": "http://barton.test/kasha_torphy", "label": "Pott the Mayor" }, { "href": "http://cronin.example/kareem", "label": "Farmer Maggot" }, { "href": "http://mraz-beer.test/suzann.jacobson", "label": "Arvedui" }, { "href": "http://towne.test/kyle.strosin", "label": "Dori" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "3e3d8516-fbc5-4a6c-8f33-d71d0acbc9dc", "type": "rule", "remediation_issue_id": null }, { "id": "e9f04e7a-13b6-4a27-9f66-44bd5d4faa9a", "ref_id": "xccdf_org.ssgproject.content_rule_a9b8517807269c324bbf10c26ddefa82", "title": "Sint quo illum id.", "rationale": "Ipsam aut omnis. Inventore quibusdam tenetur. Quasi non doloremque.", "description": "Vel rerum molestias. Voluptatem suscipit perspiciatis. Non et similique.", "severity": "low", "precedence": 1625, "identifier": { "href": "http://graham.test/emmanuel.conroy", "label": "Gundabald Bolger" }, "references": [ { "href": "http://hahn-reinger.test/sunshine", "label": "Zimraphel" }, { "href": "http://parisian.example/veronica_runolfsdottir", "label": "Thráin" }, { "href": "http://armstrong.test/melida_larkin", "label": "Tatië" }, { "href": "http://beahan.test/kelsey", "label": "Barahir" }, { "href": "http://toy.test/bessie_brown", "label": "Belemir" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "c90e7a0b-0b5e-4987-97cd-c11f6fbba051", "type": "rule", "remediation_issue_id": null } ], "meta": { "total": 25, "limit": 10, "offset": 0, "sort_by": "precedence" }, "links": { "first": "/api/compliance/v2/security_guides/470ea94e-f0b5-4ace-adbf-43f025ca1cab/profiles/3628e4c0-b010-4187-8bc8-5d076c1fb18c/rules?limit=10&offset=0&sort_by=precedence", "last": "/api/compliance/v2/security_guides/470ea94e-f0b5-4ace-adbf-43f025ca1cab/profiles/3628e4c0-b010-4187-8bc8-5d076c1fb18c/rules?limit=10&offset=20&sort_by=precedence", "next": "/api/compliance/v2/security_guides/470ea94e-f0b5-4ace-adbf-43f025ca1cab/profiles/3628e4c0-b010-4187-8bc8-5d076c1fb18c/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": "060205fd-a702-4cd2-b83e-ae206de831c2", "ref_id": "xccdf_org.ssgproject.content_rule_3e9762052b70bcef58d25b11424966f8", "title": "Quia tenetur qui consectetur.", "rationale": "Ipsum quia minus. Nulla sunt possimus. Cum officia quis.", "description": "Quaerat laudantium voluptas. Vel animi molestias. Optio nam placeat.", "severity": "high", "precedence": 8632, "identifier": { "href": "http://koch-wolff.example/quinton", "label": "Belegor" }, "references": [ { "href": "http://heathcote-smith.test/gaye", "label": "Peony Baggins" }, { "href": "http://heaney.example/lesley", "label": "Eärnur" }, { "href": "http://stark.test/golden.kertzmann", "label": "Indor" }, { "href": "http://mayer-rohan.example/luvenia.treutel", "label": "Éowyn" }, { "href": "http://hoeger.example/neoma", "label": "Déorwine" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "b2eeb8dc-7cd4-4008-85e6-b6e96858ff78", "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 b3c1a145-31da-42a4-b2e1-17e729d9b6de" ] }, "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": "02fc00e4-5669-4270-9d48-ffb8eb2d6869", "ref_id": "xccdf_org.ssgproject.content_rule_775b29c0561074291e1c42ce5c613620", "title": "Cupiditate deserunt sit maiores.", "rationale": "Est eveniet quasi. Doloremque doloribus aut. Molestiae labore et.", "description": "Deleniti ea non. Enim aperiam quae. Ea quo eligendi.", "severity": "medium", "precedence": 5817, "identifier": { "href": "http://hilll.example/su_hermann", "label": "Beldir" }, "references": [ { "href": "http://kilback-franecki.example/shon", "label": "Aranwë" }, { "href": "http://boehm.example/florence", "label": "Nar" }, { "href": "http://yundt.example/al", "label": "Jessamine Boffin" }, { "href": "http://pollich.example/lavonne.zieme", "label": "Erendis" }, { "href": "http://wunsch.example/ted.senger", "label": "Dudo Baggins" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "6b8f65d4-cd08-4168-94cd-b17255698a9a", "type": "rule" } ], "meta": { "total": 1, "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/policies/aac1a8a7-9345-40fc-8d4c-a83034404701/tailorings/faf60b76-4a54-4a01-87ff-24591eb06645/rules?limit=10&offset=0", "last": "/api/compliance/v2/policies/aac1a8a7-9345-40fc-8d4c-a83034404701/tailorings/faf60b76-4a54-4a01-87ff-24591eb06645/rules?limit=10&offset=0" } }, "summary": "", "description": "" }, "List of Rules sorted by \"precedence:asc\"": { "value": { "data": [ { "id": "f1c95a74-cde2-4e89-b01c-2b3e79b2c9eb", "ref_id": "xccdf_org.ssgproject.content_rule_c14ec5e28c3df91877334ad836da36c8", "title": "Non ut illo voluptas.", "rationale": "Alias veritatis iusto. Nam ea facilis. Reiciendis ut ut.", "description": "Sunt dolor odio. Quasi consequatur laborum. Harum ad libero.", "severity": "medium", "precedence": 1694, "identifier": { "href": "http://thompson-deckow.example/glenn_senger", "label": "Herugar Bolger" }, "references": [ { "href": "http://koss.test/vida_gleichner", "label": "Boron" }, { "href": "http://wehner.test/dusty", "label": "Posco Baggins" }, { "href": "http://prohaska-west.example/odis_leannon", "label": "Fëanor" }, { "href": "http://crooks.example/roman_willms", "label": "Hallatan" }, { "href": "http://lebsack.example/randell", "label": "Elboron" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "7dbedb32-8188-4670-b2a1-7cc0cc6f36d9", "type": "rule" } ], "meta": { "total": 1, "limit": 10, "offset": 0, "sort_by": "precedence" }, "links": { "first": "/api/compliance/v2/policies/4779ca35-6a0a-4b0c-9c48-819389a3f751/tailorings/d0ef09a5-aa81-42c1-806a-348af103fc22/rules?limit=10&offset=0&sort_by=precedence", "last": "/api/compliance/v2/policies/4779ca35-6a0a-4b0c-9c48-819389a3f751/tailorings/d0ef09a5-aa81-42c1-806a-348af103fc22/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": "01f62bef-081c-4026-95c1-3f9812990b76", "ref_id": "xccdf_org.ssgproject.content_rule_0872e74c2e1b364adc5443fb8403acb4", "title": "Qui animi rerum dolores.", "rationale": "Ab laborum blanditiis. Minima soluta quibusdam. In nisi consequuntur.", "description": "Ut labore dolore. Et non libero. Consequatur sint blanditiis.", "severity": "medium", "precedence": 4432, "identifier": { "href": "http://konopelski.example/kimberlie", "label": "Frumgar" }, "references": [ { "href": "http://walsh.test/sonny", "label": "Grór" }, { "href": "http://rohan.test/gene_stoltenberg", "label": "Menegilda Goold" }, { "href": "http://zboncak.test/chun", "label": "Robin Smallburrow" }, { "href": "http://ortiz.test/alona", "label": "Aglahad" }, { "href": "http://herzog.test/vincent_pollich", "label": "Gimilzagar" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "f699ab81-28bc-4b3b-8514-4bdd45cf02b7", "type": "rule" }, { "id": "06a67044-b97a-4e99-ab7b-80aa88a9fd19", "ref_id": "xccdf_org.ssgproject.content_rule_d98d624602dacfedf3a6a20a17d38fa0", "title": "Temporibus eius architecto et.", "rationale": "Tenetur sunt exercitationem. Nam asperiores quis. Aut sed a.", "description": "Asperiores sit ut. Iure assumenda dicta. Eligendi rerum ullam.", "severity": "low", "precedence": 1537, "identifier": { "href": "http://gerlach.example/nelson.schowalter", "label": "Tom Bombadil" }, "references": [ { "href": "http://tillman-dicki.example/dovie_blick", "label": "Thráin" }, { "href": "http://rosenbaum.test/carlos_kunde", "label": "Éowyn" }, { "href": "http://emmerich.test/virgina", "label": "Haleth" }, { "href": "http://rempel.test/cyrstal", "label": "Valandur" }, { "href": "http://wolff.example/mohammed.roberts", "label": "Eradan" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "19dbc835-9517-4a7f-9480-8127608d892c", "type": "rule" }, { "id": "0d81c6a9-a013-4b90-8ef8-b573247454d8", "ref_id": "xccdf_org.ssgproject.content_rule_2f3f7cb116fc3b1fdcd0c276a6ad7e81", "title": "Dignissimos et ea adipisci.", "rationale": "Qui corrupti earum. Incidunt qui dolore. Consequatur suscipit corporis.", "description": "In harum voluptatum. Consequatur vel necessitatibus. Ducimus suscipit qui.", "severity": "low", "precedence": 1909, "identifier": { "href": "http://kuhn.test/kyle", "label": "Thrór" }, "references": [ { "href": "http://abbott.test/tod", "label": "Drogo Baggins" }, { "href": "http://wehner.test/nubia_senger", "label": "Polo Baggins" }, { "href": "http://cartwright-kub.example/deon_larkin", "label": "Húrin" }, { "href": "http://franecki.example/rivka", "label": "Haldad" }, { "href": "http://white-mcclure.test/adrian", "label": "Lúthien" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "ac8335ec-bd28-464d-a3a5-2a82cbfae368", "type": "rule" }, { "id": "1332a8f1-334a-4226-bbe4-aabd3d48213e", "ref_id": "xccdf_org.ssgproject.content_rule_108b392f1e5ff95cea6c31264676b40c", "title": "Ut et omnis at.", "rationale": "Et animi placeat. Officia vitae blanditiis. At in esse.", "description": "Minima a libero. Et ipsum laboriosam. Ullam consequatur hic.", "severity": "low", "precedence": 2545, "identifier": { "href": "http://ohara.test/dorthy.hoeger", "label": "Elladan" }, "references": [ { "href": "http://nikolaus.example/franklyn", "label": "Melian" }, { "href": "http://kulas-schiller.example/ellis", "label": "Bifur" }, { "href": "http://lockman-smitham.test/sherwood_upton", "label": "Amlach" }, { "href": "http://skiles-cronin.example/wen.champlin", "label": "Dírhaval" }, { "href": "http://bartell-white.test/amado", "label": "Lobelia Sackville-Baggins" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "fdd1b752-63a2-481e-83c4-00d44147ede2", "type": "rule" }, { "id": "2110271e-cc9a-4440-b219-fbb04a31a259", "ref_id": "xccdf_org.ssgproject.content_rule_dc110cf52b79f523cfcc5bffa55c7fb8", "title": "Voluptatem nobis est id.", "rationale": "Fugiat numquam quia. Ducimus maxime ipsam. Nam occaecati aut.", "description": "Et nobis cumque. Modi qui atque. Cumque et autem.", "severity": "high", "precedence": 7161, "identifier": { "href": "http://goldner.test/shelba_zieme", "label": "Gundabald Bolger" }, "references": [ { "href": "http://kuhn.test/isreal.keeling", "label": "Gundolpho Bolger" }, { "href": "http://douglas.example/colby", "label": "Tar-Vanimeldë" }, { "href": "http://schoen.example/jerry", "label": "Imrahil" }, { "href": "http://fritsch.example/pura", "label": "Orontor" }, { "href": "http://sawayn.example/nakita_ratke", "label": "Dior" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "b2dba17d-c6e0-459f-9e8a-a02f497be93b", "type": "rule" }, { "id": "2c5e6be6-0c5a-4817-ac6b-150717bbb5ba", "ref_id": "xccdf_org.ssgproject.content_rule_48c99f08f92d7b18ee0d51e243c150fd", "title": "Rerum aut animi minima.", "rationale": "Deserunt fugit voluptates. Maiores minima expedita. Delectus sit possimus.", "description": "Eligendi sit itaque. Ipsam assumenda quisquam. Qui nihil qui.", "severity": "low", "precedence": 2708, "identifier": { "href": "http://carter.example/ayesha_hermiston", "label": "Rowlie Appledore" }, "references": [ { "href": "http://corwin-schaefer.example/adolph_dickinson", "label": "Erkenbrand" }, { "href": "http://erdman.test/lorelei_quitzon", "label": "Boar of Everholt" }, { "href": "http://streich.example/maxie.cormier", "label": "Galion" }, { "href": "http://bergnaum-veum.example/desmond_runolfsson", "label": "Arahael" }, { "href": "http://wilderman.example/bernardo", "label": "Witch-king" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "a68dac64-3517-4b5e-9e52-be77d5371afa", "type": "rule" }, { "id": "3304fcdd-b46b-4979-9fbe-e921aa970e00", "ref_id": "xccdf_org.ssgproject.content_rule_9b2875742ccc0f6e1953539e75d344c9", "title": "Quia possimus aut vel.", "rationale": "Perferendis repellat sit. Porro magni accusantium. Expedita eaque possimus.", "description": "Distinctio exercitationem est. Quisquam reprehenderit ipsam. Quia ut laudantium.", "severity": "high", "precedence": 5387, "identifier": { "href": "http://mills.test/napoleon.lebsack", "label": "Aerin" }, "references": [ { "href": "http://pfeffer.test/deangelo.bins", "label": "Belladonna Took" }, { "href": "http://wyman.example/leonarda", "label": "Malbeth" }, { "href": "http://aufderhar.test/carolynn.heller", "label": "Galador" }, { "href": "http://daugherty.example/meta", "label": "Orontor" }, { "href": "http://leuschke-mcglynn.test/anton_watsica", "label": "Frodo Baggins" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "6af84484-512a-41e3-9f2f-dad026309853", "type": "rule" }, { "id": "5c0b492d-ce27-4850-ab46-3b65a3ee87aa", "ref_id": "xccdf_org.ssgproject.content_rule_6658dd23bfe530b4d3ab9899212cdf24", "title": "Aperiam ratione consectetur dignissimos.", "rationale": "Id quasi exercitationem. Rerum magnam libero. In nihil est.", "description": "Qui eos impedit. Asperiores voluptates ex. Esse assumenda deleniti.", "severity": "low", "precedence": 3292, "identifier": { "href": "http://morar-lemke.example/armand.stamm", "label": "Tolman Cotton Junior" }, "references": [ { "href": "http://towne.example/jerri.cummings", "label": "Frodo Gardner" }, { "href": "http://ward.test/mittie.nienow", "label": "Haldir" }, { "href": "http://schaden.test/ezekiel", "label": "Saradas Brandybuck" }, { "href": "http://gottlieb-smith.test/dannielle.koss", "label": "Gorlim" }, { "href": "http://konopelski-klocko.test/reid_auer", "label": "Tar-Aldarion" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "cb336b86-4b1f-4a8c-8af1-3e58f0173263", "type": "rule" }, { "id": "790870d2-6163-4ad6-9fcd-d546308301be", "ref_id": "xccdf_org.ssgproject.content_rule_04bde8bea2e441827f89bc9d7c1cff95", "title": "Voluptatibus et tenetur omnis.", "rationale": "Molestiae autem sed. Qui nemo minima. Fuga quos rem.", "description": "Assumenda consequuntur nesciunt. Dolorem minima odit. Nemo porro dolor.", "severity": "low", "precedence": 9909, "identifier": { "href": "http://leannon.test/courtney", "label": "Gilmith" }, "references": [ { "href": "http://hilll-borer.example/wilmer", "label": "Haleth" }, { "href": "http://treutel.test/donetta", "label": "Carc" }, { "href": "http://renner-mueller.example/junior", "label": "Tar-Alcarin" }, { "href": "http://bradtke.test/devon_stracke", "label": "Narmacil" }, { "href": "http://howell-bauch.example/mana", "label": "Mauhúr" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "04b331f2-0ef0-47e4-83c0-e5f07a1a22c1", "type": "rule" }, { "id": "850c1b17-7db2-483c-89bc-4280195b181f", "ref_id": "xccdf_org.ssgproject.content_rule_56c1da626ca2d015393c8afa0381eef3", "title": "Qui aliquid vitae tenetur.", "rationale": "Dolores voluptatem vitae. Magni id voluptas. Dolorem omnis veniam.", "description": "Expedita corporis velit. Ducimus dolorem ut. Facere ipsa labore.", "severity": "high", "precedence": 1191, "identifier": { "href": "http://oreilly.example/elliot", "label": "Tar-Anducal" }, "references": [ { "href": "http://prohaska.example/diego_dooley", "label": "Herubrand" }, { "href": "http://rogahn.example/dominic", "label": "Barach" }, { "href": "http://gulgowski.example/gwyneth.mueller", "label": "Manthor" }, { "href": "http://boehm-wyman.example/josiah", "label": "Gundahad Bolger" }, { "href": "http://rempel-renner.test/dwight", "label": "Algund" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "8c46af12-64da-45a7-9011-8907cda53ef6", "type": "rule" } ], "meta": { "total": 25, "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/policies/4966996f-3d50-4360-9126-59b59e50ac7e/tailorings/a2b1e6fb-40da-4faf-a606-986a34c7b9fa/rules?limit=10&offset=0", "last": "/api/compliance/v2/policies/4966996f-3d50-4360-9126-59b59e50ac7e/tailorings/a2b1e6fb-40da-4faf-a606-986a34c7b9fa/rules?limit=10&offset=20", "next": "/api/compliance/v2/policies/4966996f-3d50-4360-9126-59b59e50ac7e/tailorings/a2b1e6fb-40da-4faf-a606-986a34c7b9fa/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": "d3edede1-d9c8-4d04-9fae-4b47dbd34f6a", "ref_id": "xccdf_org.ssgproject.content_rule_31e5416d1919b01311734f38c7c8758b", "title": "Dolores perferendis enim nemo.", "rationale": "Et quo totam. Molestiae repellat tempore. Eveniet ea quo.", "description": "Voluptate quia beatae. Eos ab aut. Assumenda est sit.", "severity": "high", "precedence": 6955, "identifier": { "href": "http://friesen.test/leah", "label": "Ingwë" }, "references": [ { "href": "http://mcclure-mertz.test/reta", "label": "Finbor" }, { "href": "http://gerlach-zboncak.example/sharell_breitenberg", "label": "Borondir" }, { "href": "http://herman.example/tessa", "label": "Lavender Grubb" }, { "href": "http://lubowitz-kemmer.test/loren_kirlin", "label": "Elboron" }, { "href": "http://sawayn.example/freeman", "label": "Eradan" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "69ebb277-266e-47ab-a89c-aa283d462202", "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 145c72bb-c502-4fd2-836e-aa0bf5b9dbd1" ] }, "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": "ab94af80-101f-4011-b821-26190986bc13", "ref_id": "xccdf_org.ssgproject.content_rule_1d41278af32c6771681dfb661ae5ec46", "title": "Asperiores et quasi deserunt.", "rationale": "Unde qui in. Molestiae qui corrupti. Tempora commodi exercitationem.", "description": "Consequatur vero natus. Et quis eum. Dolores esse velit.", "severity": "high", "precedence": 1957, "identifier": { "href": "http://dickinson-ferry.test/benedict", "label": "Quickbeam" }, "references": [ { "href": "http://harvey.test/illa", "label": "Vidugavia" }, { "href": "http://schmitt.test/zackary.cruickshank", "label": "Artamir" }, { "href": "http://marvin-schmeler.test/alejandro_mcdermott", "label": "Andwise Roper" }, { "href": "http://gottlieb.test/jeff", "label": "Minastan" }, { "href": "http://mcglynn.test/laverne", "label": "Gimilzagar" } ], "value_checks": [], "remediation_available": false, "rule_group_id": "75740bad-9640-440b-b5da-b8b2534fcc68", "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 451a1b05-a51a-426f-8871-e2d547593a4c" ] }, "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": "0024aaa9-c4ec-49eb-9558-56316cb94802", "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", "title": "Corporis reprehenderit deleniti incidunt.", "version": "100.84.15", "description": "Consequuntur possimus qui. Rerum porro cumque. Animi nam aut.", "os_major_version": 7, "type": "security_guide" }, { "id": "01298c79-c5c3-4cbc-b88d-f414aebbc64e", "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", "title": "Nemo neque qui optio.", "version": "100.84.18", "description": "Autem voluptas reprehenderit. Et atque deserunt. Nostrum explicabo earum.", "os_major_version": 7, "type": "security_guide" }, { "id": "04eaf7d9-04a6-4251-b5fd-900eb9d27db9", "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", "title": "Quia aut assumenda neque.", "version": "100.84.12", "description": "Molestias a amet. Fuga consequatur earum. Consectetur blanditiis iure.", "os_major_version": 7, "type": "security_guide" }, { "id": "0b05c80c-3aa0-4130-8bd5-42d35315eb72", "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", "title": "Est et officiis quo.", "version": "100.84.13", "description": "Commodi quos iste. Et et assumenda. Iusto est officia.", "os_major_version": 7, "type": "security_guide" }, { "id": "182cde24-f084-4e13-a2e5-ed649e8ed43f", "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", "title": "Magnam doloribus placeat quo.", "version": "100.84.14", "description": "Et quia qui. Velit provident magnam. Expedita deserunt sapiente.", "os_major_version": 7, "type": "security_guide" }, { "id": "24bb4c4b-ee4f-48da-9178-f04742b6093d", "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", "title": "Est omnis tenetur officia.", "version": "100.84.30", "description": "Est illum eveniet. Deleniti autem exercitationem. Dolorem quam aut.", "os_major_version": 7, "type": "security_guide" }, { "id": "2520b698-c6a7-498c-b410-e75c21c5f3d7", "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", "title": "Ut quibusdam deserunt consequatur.", "version": "100.84.20", "description": "Id laborum cumque. Quidem neque corrupti. Fuga sint magni.", "os_major_version": 7, "type": "security_guide" }, { "id": "3057ecaa-7532-4bcf-8eeb-74e2e0b68918", "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", "title": "Asperiores sunt autem aut.", "version": "100.84.27", "description": "Modi tenetur ab. Voluptate aut aut. Eum omnis enim.", "os_major_version": 7, "type": "security_guide" }, { "id": "325e337d-f0af-4012-ac75-635a5ebdbcbd", "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", "title": "Consequatur nesciunt quisquam repellat.", "version": "100.84.24", "description": "Aliquam impedit esse. Alias cupiditate nulla. Explicabo eaque omnis.", "os_major_version": 7, "type": "security_guide" }, { "id": "33dccbdf-3d8e-434a-879b-cf115d0014b7", "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", "title": "Voluptas necessitatibus rerum quia.", "version": "100.84.26", "description": "Alias laudantium soluta. Placeat nulla nam. Quia aut et.", "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": "04e9c7b8-f6c8-4df5-8ad5-85991e066da3", "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", "title": "Eos voluptatibus qui ea.", "version": "100.84.44", "description": "Dolor alias quisquam. Saepe nulla ut. Vel et repellendus.", "os_major_version": 7, "type": "security_guide" }, { "id": "0e9ca322-1e73-460b-8d19-3d5619966982", "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", "title": "Quia vel ipsum in.", "version": "100.85.9", "description": "Aperiam ipsum est. Et impedit amet. Molestiae repellendus voluptate.", "os_major_version": 7, "type": "security_guide" }, { "id": "11793082-a98e-40ad-a97b-332d3a8002b7", "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", "title": "Omnis optio aut tempore.", "version": "100.84.35", "description": "Fugit eum necessitatibus. Fuga porro officia. Mollitia maxime rem.", "os_major_version": 7, "type": "security_guide" }, { "id": "30490c8d-2e65-49e8-980a-a74add95416d", "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", "title": "Exercitationem non inventore adipisci.", "version": "100.84.37", "description": "Et facilis in. Et quia officiis. Dolorem aut ullam.", "os_major_version": 7, "type": "security_guide" }, { "id": "36c9cb87-2ad0-4dc0-a9d1-4387574fe4a7", "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", "title": "Voluptatem sint est eum.", "version": "100.85.5", "description": "Odio voluptas voluptatem. Dicta delectus necessitatibus. Quam ut mollitia.", "os_major_version": 7, "type": "security_guide" }, { "id": "39eb969d-098c-4cdf-8bdb-c8c933cd35ad", "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", "title": "Nihil tenetur quibusdam incidunt.", "version": "100.84.47", "description": "Facilis sequi perferendis. Officia perspiciatis odit. Labore quisquam quia.", "os_major_version": 7, "type": "security_guide" }, { "id": "41961339-976a-4821-aa9d-179ed19c20ec", "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", "title": "Rem doloribus et explicabo.", "version": "100.85.6", "description": "Asperiores voluptatibus minima. Enim nobis sequi. Velit autem sit.", "os_major_version": 7, "type": "security_guide" }, { "id": "43c63f26-b74a-4312-b2e5-84e4f641ffa3", "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", "title": "Earum ratione voluptatem eos.", "version": "100.84.38", "description": "Ut qui sit. Temporibus ullam aperiam. Officiis illo consequatur.", "os_major_version": 7, "type": "security_guide" }, { "id": "43e831d4-dec7-4af1-aa4a-2c041548551f", "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", "title": "Iure dolor amet explicabo.", "version": "100.84.39", "description": "Natus omnis molestias. Esse molestiae cupiditate. Ex quisquam aut.", "os_major_version": 7, "type": "security_guide" }, { "id": "4cbe816d-3098-4bd6-a00c-fccfd6a1166b", "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", "title": "Iusto autem cum autem.", "version": "100.84.49", "description": "Fugit quibusdam distinctio. Molestiae tempore labore. Doloremque molestiae voluptas.", "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`, `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": "9181c794-0c3a-4219-90c2-3aa1712446ed", "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", "title": "Aut aliquam qui mollitia.", "version": "100.87.10", "description": "Molestias iste quas. Officia labore quibusdam. Quo doloribus laboriosam.", "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 54294d13-ac46-4c54-9913-e5f65959e6bf" ] }, "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": "48dfef1f-3f47-48e1-a650-e180b901960f", "type": "rule_group", "children": [ { "id": "cce390fb-e2df-4038-8aa1-3fb8af7eb249", "type": "rule" } ] }, { "id": "503b0a9d-0f73-4ad0-a7fb-1be08d019174", "type": "rule_group", "children": [ { "id": "52e35799-fb97-4bfc-9f01-5ebfde27ef69", "type": "rule" } ] }, { "id": "96f36b7e-05d3-4c20-b7af-aebdbe53e633", "type": "rule_group", "children": [ { "id": "4ba78bea-35ec-4018-98b4-c16290a041dd", "type": "rule" } ] }, { "id": "a4201df5-2666-41f4-bb01-1521df48320a", "type": "rule_group", "children": [ { "id": "5ba19da1-5393-4d0a-9623-1db62e7aa8c5", "type": "rule" } ] }, { "id": "8ec2a04a-00b4-4a26-b650-3c085085940c", "type": "rule_group", "children": [ { "id": "e916cbf6-bd0f-41fb-bfb7-25ebdae110ef", "type": "rule" } ] }, { "id": "fdef01e2-09b5-4f48-a851-6e01437c19c9", "type": "rule_group", "children": [ { "id": "a08f0050-c07d-409f-9cef-a204fb80510d", "type": "rule" } ] }, { "id": "4dd0fc48-3cd5-4c7b-96ef-0489d710eb18", "type": "rule_group", "children": [ { "id": "af106382-80b8-4b79-ad9e-8f5410651b46", "type": "rule" } ] }, { "id": "5634ac49-3742-4f9f-a82e-9eabb9bf8e3b", "type": "rule_group", "children": [ { "id": "d7e6a066-3b7e-43e5-a7f2-8b6d52ac1a01", "type": "rule" } ] }, { "id": "09d0d4ff-3200-4c8a-bf3d-4e65f8c837f4", "type": "rule_group", "children": [ { "id": "d9bd92a3-15c2-4a16-81c7-d5697c0aa729", "type": "rule" } ] }, { "id": "111f033c-70c6-4901-8ddf-662d2b6ac5d7", "type": "rule_group", "children": [ { "id": "fdbcb798-1401-4755-a10e-5eb3098daeb3", "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 28200f30-a59d-411b-9506-5faa4080fe17" ] }, "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": "c8340f59-bb9d-4976-9da0-17eb8374833e", "title": "Est excepturi porro exercitationem.", "description": "Exercitationem quia aut. Voluptas non eius. Aliquid aut numquam.", "ref_id": "xccdf_org.ssgproject.content_profile_571d8e03b12062ffa78144dcc1189587", "security_guide_id": "751bbfbf-2b35-4118-9955-59f40191e7a5", "security_guide_version": "100.87.37", "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": "ea9df3af-8194-4665-bf50-ea23c465a500", "title": "Ab illo odio possimus.", "description": "Aut porro beatae. Neque qui aut. Ipsa libero ex.", "ref_id": "xccdf_org.ssgproject.content_profile_36d6edf808f816a2d9737202f1a74de9", "security_guide_id": "50ecfb97-60b4-4a24-b87e-ec23f0ab186a", "security_guide_version": "100.87.38", "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`, `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": "152f3fea-d835-403c-ade8-1adaad611f9e", "display_name": "borer.example", "groups": [], "culled_timestamp": "2036-03-18T12:32:41.673Z", "last_check_in": "2036-03-12T12:32:41.673Z", "stale_timestamp": "2036-03-04T12:32:41.673Z", "stale_warning_timestamp": "2036-03-11T12:32:41.673Z", "updated": "2026-03-04T12:32:41.673Z", "insights_id": null, "tags": [ { "key": "system", "value": "redundant", "namespace": "bypassing" }, { "key": "pixel", "value": "1080p", "namespace": "copying" }, { "key": "bandwidth", "value": "neural", "namespace": "calculating" }, { "key": "circuit", "value": "back-end", "namespace": "transmitting" }, { "key": "transmitter", "value": "multi-byte", "namespace": "programming" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "1fea68a9-939c-489c-b73a-0e223d81f67a", "display_name": "dare-koss.example", "groups": [], "culled_timestamp": "2036-03-18T12:32:41.671Z", "last_check_in": "2036-03-12T12:32:41.671Z", "stale_timestamp": "2036-03-04T12:32:41.671Z", "stale_warning_timestamp": "2036-03-11T12:32:41.671Z", "updated": "2026-03-04T12:32:41.671Z", "insights_id": null, "tags": [ { "key": "monitor", "value": "wireless", "namespace": "hacking" }, { "key": "card", "value": "redundant", "namespace": "backing up" }, { "key": "protocol", "value": "wireless", "namespace": "indexing" }, { "key": "hard drive", "value": "bluetooth", "namespace": "transmitting" }, { "key": "microchip", "value": "solid state", "namespace": "quantifying" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "3f202a0b-f2fa-4ebb-a470-8fb71122e44a", "display_name": "predovic-braun.test", "groups": [], "culled_timestamp": "2036-03-18T12:32:41.675Z", "last_check_in": "2036-03-12T12:32:41.675Z", "stale_timestamp": "2036-03-04T12:32:41.675Z", "stale_warning_timestamp": "2036-03-11T12:32:41.675Z", "updated": "2026-03-04T12:32:41.675Z", "insights_id": null, "tags": [ { "key": "monitor", "value": "digital", "namespace": "generating" }, { "key": "sensor", "value": "auxiliary", "namespace": "compressing" }, { "key": "bus", "value": "virtual", "namespace": "copying" }, { "key": "program", "value": "primary", "namespace": "bypassing" }, { "key": "microchip", "value": "cross-platform", "namespace": "connecting" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "5a0b1540-17fd-4237-84cc-1b465627074d", "display_name": "baumbach.test", "groups": [], "culled_timestamp": "2036-03-18T12:32:41.679Z", "last_check_in": "2036-03-12T12:32:41.679Z", "stale_timestamp": "2036-03-04T12:32:41.679Z", "stale_warning_timestamp": "2036-03-11T12:32:41.679Z", "updated": "2026-03-04T12:32:41.679Z", "insights_id": null, "tags": [ { "key": "program", "value": "haptic", "namespace": "quantifying" }, { "key": "interface", "value": "neural", "namespace": "hacking" }, { "key": "capacitor", "value": "solid state", "namespace": "generating" }, { "key": "alarm", "value": "multi-byte", "namespace": "quantifying" }, { "key": "card", "value": "neural", "namespace": "compressing" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "5b364ec9-1cc0-459a-9c72-ce431ac86118", "display_name": "jakubowski.example", "groups": [], "culled_timestamp": "2036-03-18T12:32:41.677Z", "last_check_in": "2036-03-12T12:32:41.677Z", "stale_timestamp": "2036-03-04T12:32:41.677Z", "stale_warning_timestamp": "2036-03-11T12:32:41.677Z", "updated": "2026-03-04T12:32:41.677Z", "insights_id": null, "tags": [ { "key": "sensor", "value": "solid state", "namespace": "programming" }, { "key": "alarm", "value": "mobile", "namespace": "indexing" }, { "key": "matrix", "value": "multi-byte", "namespace": "programming" }, { "key": "bus", "value": "cross-platform", "namespace": "navigating" }, { "key": "monitor", "value": "digital", "namespace": "navigating" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "5c60027c-23dc-49fe-8349-579be626c263", "display_name": "grant-bauch.example", "groups": [], "culled_timestamp": "2036-03-18T12:32:41.715Z", "last_check_in": "2036-03-12T12:32:41.715Z", "stale_timestamp": "2036-03-04T12:32:41.715Z", "stale_warning_timestamp": "2036-03-11T12:32:41.715Z", "updated": "2026-03-04T12:32:41.716Z", "insights_id": null, "tags": [ { "key": "sensor", "value": "digital", "namespace": "hacking" }, { "key": "matrix", "value": "back-end", "namespace": "connecting" }, { "key": "hard drive", "value": "primary", "namespace": "copying" }, { "key": "transmitter", "value": "wireless", "namespace": "transmitting" }, { "key": "pixel", "value": "multi-byte", "namespace": "connecting" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "61852d28-836d-47b3-bcae-ded92eb72adf", "display_name": "trantow.example", "groups": [], "culled_timestamp": "2036-03-18T12:32:41.707Z", "last_check_in": "2036-03-12T12:32:41.707Z", "stale_timestamp": "2036-03-04T12:32:41.707Z", "stale_warning_timestamp": "2036-03-11T12:32:41.707Z", "updated": "2026-03-04T12:32:41.707Z", "insights_id": null, "tags": [ { "key": "microchip", "value": "online", "namespace": "generating" }, { "key": "hard drive", "value": "online", "namespace": "indexing" }, { "key": "protocol", "value": "digital", "namespace": "calculating" }, { "key": "protocol", "value": "haptic", "namespace": "quantifying" }, { "key": "protocol", "value": "virtual", "namespace": "compressing" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "6ade5337-2afe-4217-8d9b-37903223aa4f", "display_name": "donnelly.example", "groups": [], "culled_timestamp": "2036-03-18T12:32:41.686Z", "last_check_in": "2036-03-12T12:32:41.686Z", "stale_timestamp": "2036-03-04T12:32:41.686Z", "stale_warning_timestamp": "2036-03-11T12:32:41.686Z", "updated": "2026-03-04T12:32:41.686Z", "insights_id": null, "tags": [ { "key": "pixel", "value": "bluetooth", "namespace": "calculating" }, { "key": "driver", "value": "open-source", "namespace": "calculating" }, { "key": "hard drive", "value": "1080p", "namespace": "parsing" }, { "key": "transmitter", "value": "digital", "namespace": "parsing" }, { "key": "alarm", "value": "optical", "namespace": "hacking" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "75e2dabd-3f56-4404-bfc7-67588cfe9b90", "display_name": "kerluke.test", "groups": [], "culled_timestamp": "2036-03-18T12:32:41.656Z", "last_check_in": "2036-03-12T12:32:41.656Z", "stale_timestamp": "2036-03-04T12:32:41.656Z", "stale_warning_timestamp": "2036-03-11T12:32:41.656Z", "updated": "2026-03-04T12:32:41.656Z", "insights_id": null, "tags": [ { "key": "card", "value": "cross-platform", "namespace": "calculating" }, { "key": "pixel", "value": "haptic", "namespace": "generating" }, { "key": "program", "value": "mobile", "namespace": "copying" }, { "key": "driver", "value": "optical", "namespace": "transmitting" }, { "key": "protocol", "value": "online", "namespace": "bypassing" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "7b66fcd0-dba6-4c3a-9801-1f16982c219f", "display_name": "legros.example", "groups": [], "culled_timestamp": "2036-03-18T12:32:41.723Z", "last_check_in": "2036-03-12T12:32:41.723Z", "stale_timestamp": "2036-03-04T12:32:41.723Z", "stale_warning_timestamp": "2036-03-11T12:32:41.723Z", "updated": "2026-03-04T12:32:41.723Z", "insights_id": null, "tags": [ { "key": "firewall", "value": "optical", "namespace": "copying" }, { "key": "system", "value": "wireless", "namespace": "indexing" }, { "key": "bus", "value": "digital", "namespace": "calculating" }, { "key": "driver", "value": "optical", "namespace": "transmitting" }, { "key": "program", "value": "redundant", "namespace": "calculating" } ], "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": "10c0c620-d170-43bb-b24f-3806e4f9b3b2", "display_name": "bernier.test", "groups": [], "culled_timestamp": "2036-03-18T12:32:41.827Z", "last_check_in": "2036-03-12T12:32:41.827Z", "stale_timestamp": "2036-03-04T12:32:41.827Z", "stale_warning_timestamp": "2036-03-11T12:32:41.827Z", "updated": "2026-03-04T12:32:41.827Z", "insights_id": null, "tags": [ { "key": "alarm", "value": "bluetooth", "namespace": "connecting" }, { "key": "pixel", "value": "digital", "namespace": "synthesizing" }, { "key": "driver", "value": "multi-byte", "namespace": "indexing" }, { "key": "firewall", "value": "digital", "namespace": "quantifying" }, { "key": "monitor", "value": "virtual", "namespace": "generating" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "15f454a0-76ee-4dc0-be34-c34ffeca8006", "display_name": "kutch-hackett.example", "groups": [], "culled_timestamp": "2036-03-18T12:32:41.847Z", "last_check_in": "2036-03-12T12:32:41.847Z", "stale_timestamp": "2036-03-04T12:32:41.847Z", "stale_warning_timestamp": "2036-03-11T12:32:41.847Z", "updated": "2026-03-04T12:32:41.848Z", "insights_id": null, "tags": [ { "key": "microchip", "value": "neural", "namespace": "generating" }, { "key": "program", "value": "multi-byte", "namespace": "quantifying" }, { "key": "array", "value": "auxiliary", "namespace": "indexing" }, { "key": "circuit", "value": "wireless", "namespace": "hacking" }, { "key": "transmitter", "value": "wireless", "namespace": "calculating" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "2061fc63-9cf5-4c0b-9edb-33de5d49ab2c", "display_name": "larson.test", "groups": [], "culled_timestamp": "2036-03-18T12:32:41.813Z", "last_check_in": "2036-03-12T12:32:41.813Z", "stale_timestamp": "2036-03-04T12:32:41.813Z", "stale_warning_timestamp": "2036-03-11T12:32:41.813Z", "updated": "2026-03-04T12:32:41.813Z", "insights_id": null, "tags": [ { "key": "panel", "value": "auxiliary", "namespace": "transmitting" }, { "key": "system", "value": "bluetooth", "namespace": "parsing" }, { "key": "matrix", "value": "open-source", "namespace": "overriding" }, { "key": "interface", "value": "auxiliary", "namespace": "transmitting" }, { "key": "application", "value": "auxiliary", "namespace": "generating" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "23403b37-deb9-46e8-ac9c-49142e5004f7", "display_name": "wiza.test", "groups": [], "culled_timestamp": "2036-03-18T12:32:41.844Z", "last_check_in": "2036-03-12T12:32:41.844Z", "stale_timestamp": "2036-03-04T12:32:41.844Z", "stale_warning_timestamp": "2036-03-11T12:32:41.844Z", "updated": "2026-03-04T12:32:41.845Z", "insights_id": null, "tags": [ { "key": "microchip", "value": "open-source", "namespace": "connecting" }, { "key": "monitor", "value": "virtual", "namespace": "compressing" }, { "key": "hard drive", "value": "digital", "namespace": "parsing" }, { "key": "port", "value": "optical", "namespace": "calculating" }, { "key": "firewall", "value": "virtual", "namespace": "generating" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "26e213c8-b732-4339-86ef-2d1ef9ddde14", "display_name": "koch.test", "groups": [], "culled_timestamp": "2036-03-18T12:32:41.799Z", "last_check_in": "2036-03-12T12:32:41.799Z", "stale_timestamp": "2036-03-04T12:32:41.799Z", "stale_warning_timestamp": "2036-03-11T12:32:41.799Z", "updated": "2026-03-04T12:32:41.799Z", "insights_id": null, "tags": [ { "key": "interface", "value": "digital", "namespace": "compressing" }, { "key": "bus", "value": "optical", "namespace": "indexing" }, { "key": "circuit", "value": "open-source", "namespace": "programming" }, { "key": "feed", "value": "solid state", "namespace": "bypassing" }, { "key": "monitor", "value": "mobile", "namespace": "compressing" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "28c3db6a-e23c-4d56-9bd3-bc05f8c4ac99", "display_name": "weimann.example", "groups": [], "culled_timestamp": "2036-03-18T12:32:41.804Z", "last_check_in": "2036-03-12T12:32:41.804Z", "stale_timestamp": "2036-03-04T12:32:41.804Z", "stale_warning_timestamp": "2036-03-11T12:32:41.804Z", "updated": "2026-03-04T12:32:41.804Z", "insights_id": null, "tags": [ { "key": "panel", "value": "1080p", "namespace": "synthesizing" }, { "key": "driver", "value": "solid state", "namespace": "calculating" }, { "key": "feed", "value": "multi-byte", "namespace": "bypassing" }, { "key": "interface", "value": "auxiliary", "namespace": "navigating" }, { "key": "monitor", "value": "open-source", "namespace": "bypassing" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "2a46a534-b852-4b7f-8d18-70c36a1c2265", "display_name": "krajcik.example", "groups": [], "culled_timestamp": "2036-03-18T12:32:41.796Z", "last_check_in": "2036-03-12T12:32:41.796Z", "stale_timestamp": "2036-03-04T12:32:41.796Z", "stale_warning_timestamp": "2036-03-11T12:32:41.796Z", "updated": "2026-03-04T12:32:41.797Z", "insights_id": null, "tags": [ { "key": "microchip", "value": "redundant", "namespace": "calculating" }, { "key": "pixel", "value": "solid state", "namespace": "backing up" }, { "key": "driver", "value": "1080p", "namespace": "copying" }, { "key": "circuit", "value": "auxiliary", "namespace": "transmitting" }, { "key": "transmitter", "value": "wireless", "namespace": "connecting" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "3c57ee33-a2d6-496b-961a-44e855eb645a", "display_name": "osinski-wisozk.test", "groups": [], "culled_timestamp": "2036-03-18T12:32:41.774Z", "last_check_in": "2036-03-12T12:32:41.774Z", "stale_timestamp": "2036-03-04T12:32:41.774Z", "stale_warning_timestamp": "2036-03-11T12:32:41.774Z", "updated": "2026-03-04T12:32:41.774Z", "insights_id": null, "tags": [ { "key": "sensor", "value": "haptic", "namespace": "hacking" }, { "key": "system", "value": "solid state", "namespace": "programming" }, { "key": "port", "value": "online", "namespace": "bypassing" }, { "key": "pixel", "value": "mobile", "namespace": "transmitting" }, { "key": "feed", "value": "digital", "namespace": "parsing" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "46ba3170-6097-4725-8acd-6ceedcd774ab", "display_name": "rau-hyatt.test", "groups": [], "culled_timestamp": "2036-03-18T12:32:41.791Z", "last_check_in": "2036-03-12T12:32:41.791Z", "stale_timestamp": "2036-03-04T12:32:41.791Z", "stale_warning_timestamp": "2036-03-11T12:32:41.791Z", "updated": "2026-03-04T12:32:41.791Z", "insights_id": null, "tags": [ { "key": "card", "value": "mobile", "namespace": "overriding" }, { "key": "circuit", "value": "virtual", "namespace": "generating" }, { "key": "system", "value": "1080p", "namespace": "bypassing" }, { "key": "protocol", "value": "virtual", "namespace": "navigating" }, { "key": "feed", "value": "wireless", "namespace": "backing up" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "509dfca1-8e27-4e78-b960-1c7fcf91c417", "display_name": "lueilwitz.test", "groups": [], "culled_timestamp": "2036-03-18T12:32:41.781Z", "last_check_in": "2036-03-12T12:32:41.781Z", "stale_timestamp": "2036-03-04T12:32:41.781Z", "stale_warning_timestamp": "2036-03-11T12:32:41.781Z", "updated": "2026-03-04T12:32:41.781Z", "insights_id": null, "tags": [ { "key": "bandwidth", "value": "primary", "namespace": "transmitting" }, { "key": "interface", "value": "mobile", "namespace": "bypassing" }, { "key": "hard drive", "value": "primary", "namespace": "transmitting" }, { "key": "interface", "value": "mobile", "namespace": "copying" }, { "key": "array", "value": "optical", "namespace": "navigating" } ], "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": "171caf92-3355-4055-bab7-47908173bd75", "display_name": "rohan-zieme.test", "groups": [], "culled_timestamp": "2036-03-18T12:32:41.907Z", "last_check_in": "2036-03-12T12:32:41.907Z", "stale_timestamp": "2036-03-04T12:32:41.907Z", "stale_warning_timestamp": "2036-03-11T12:32:41.907Z", "updated": "2026-03-04T12:32:41.907Z", "insights_id": null, "tags": [ { "key": "array", "value": "auxiliary", "namespace": "indexing" }, { "key": "program", "value": "cross-platform", "namespace": "parsing" }, { "key": "hard drive", "value": "multi-byte", "namespace": "programming" }, { "key": "card", "value": "wireless", "namespace": "programming" }, { "key": "alarm", "value": "digital", "namespace": "copying" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "32cc4cce-1e9e-4411-8172-b8db24eac1fc", "display_name": "bosco.example", "groups": [], "culled_timestamp": "2036-03-18T12:32:41.889Z", "last_check_in": "2036-03-12T12:32:41.889Z", "stale_timestamp": "2036-03-04T12:32:41.889Z", "stale_warning_timestamp": "2036-03-11T12:32:41.889Z", "updated": "2026-03-04T12:32:41.889Z", "insights_id": null, "tags": [ { "key": "capacitor", "value": "virtual", "namespace": "backing up" }, { "key": "card", "value": "open-source", "namespace": "indexing" }, { "key": "feed", "value": "primary", "namespace": "synthesizing" }, { "key": "pixel", "value": "back-end", "namespace": "navigating" }, { "key": "protocol", "value": "1080p", "namespace": "backing up" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "3ff8ddfd-e684-478b-8a9c-62f1f46ed383", "display_name": "dicki.test", "groups": [], "culled_timestamp": "2036-03-18T12:32:41.894Z", "last_check_in": "2036-03-12T12:32:41.894Z", "stale_timestamp": "2036-03-04T12:32:41.894Z", "stale_warning_timestamp": "2036-03-11T12:32:41.894Z", "updated": "2026-03-04T12:32:41.894Z", "insights_id": null, "tags": [ { "key": "program", "value": "multi-byte", "namespace": "compressing" }, { "key": "circuit", "value": "primary", "namespace": "hacking" }, { "key": "monitor", "value": "bluetooth", "namespace": "indexing" }, { "key": "alarm", "value": "primary", "namespace": "parsing" }, { "key": "panel", "value": "neural", "namespace": "generating" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "470ecb8f-92ad-48cb-bfcd-20e5cab83b50", "display_name": "zulauf.test", "groups": [], "culled_timestamp": "2036-03-18T12:32:41.912Z", "last_check_in": "2036-03-12T12:32:41.912Z", "stale_timestamp": "2036-03-04T12:32:41.912Z", "stale_warning_timestamp": "2036-03-11T12:32:41.912Z", "updated": "2026-03-04T12:32:41.912Z", "insights_id": null, "tags": [ { "key": "port", "value": "back-end", "namespace": "parsing" }, { "key": "sensor", "value": "online", "namespace": "quantifying" }, { "key": "monitor", "value": "cross-platform", "namespace": "backing up" }, { "key": "interface", "value": "wireless", "namespace": "connecting" }, { "key": "firewall", "value": "back-end", "namespace": "indexing" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "4a085736-5f8f-44a9-b2df-f2aa15043f8f", "display_name": "vandervort.test", "groups": [], "culled_timestamp": "2036-03-18T12:32:41.927Z", "last_check_in": "2036-03-12T12:32:41.927Z", "stale_timestamp": "2036-03-04T12:32:41.927Z", "stale_warning_timestamp": "2036-03-11T12:32:41.927Z", "updated": "2026-03-04T12:32:41.928Z", "insights_id": null, "tags": [ { "key": "system", "value": "multi-byte", "namespace": "overriding" }, { "key": "circuit", "value": "1080p", "namespace": "programming" }, { "key": "alarm", "value": "bluetooth", "namespace": "copying" }, { "key": "circuit", "value": "primary", "namespace": "copying" }, { "key": "port", "value": "optical", "namespace": "calculating" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "5d2fe33a-6d7d-4724-b574-650cdc304644", "display_name": "murray.example", "groups": [], "culled_timestamp": "2036-03-18T12:32:41.925Z", "last_check_in": "2036-03-12T12:32:41.925Z", "stale_timestamp": "2036-03-04T12:32:41.925Z", "stale_warning_timestamp": "2036-03-11T12:32:41.925Z", "updated": "2026-03-04T12:32:41.925Z", "insights_id": null, "tags": [ { "key": "microchip", "value": "cross-platform", "namespace": "parsing" }, { "key": "circuit", "value": "virtual", "namespace": "quantifying" }, { "key": "panel", "value": "mobile", "namespace": "backing up" }, { "key": "driver", "value": "optical", "namespace": "parsing" }, { "key": "panel", "value": "haptic", "namespace": "copying" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "5fc891f3-7572-47d9-a12a-408d631ab80f", "display_name": "senger-bosco.example", "groups": [], "culled_timestamp": "2036-03-18T12:32:41.904Z", "last_check_in": "2036-03-12T12:32:41.904Z", "stale_timestamp": "2036-03-04T12:32:41.904Z", "stale_warning_timestamp": "2036-03-11T12:32:41.904Z", "updated": "2026-03-04T12:32:41.904Z", "insights_id": null, "tags": [ { "key": "feed", "value": "primary", "namespace": "quantifying" }, { "key": "sensor", "value": "virtual", "namespace": "parsing" }, { "key": "program", "value": "multi-byte", "namespace": "calculating" }, { "key": "bandwidth", "value": "redundant", "namespace": "programming" }, { "key": "program", "value": "auxiliary", "namespace": "calculating" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "6482f550-0c27-4ec5-a52e-dfd8b4f17315", "display_name": "schulist.example", "groups": [], "culled_timestamp": "2036-03-18T12:32:41.935Z", "last_check_in": "2036-03-12T12:32:41.935Z", "stale_timestamp": "2036-03-04T12:32:41.935Z", "stale_warning_timestamp": "2036-03-11T12:32:41.935Z", "updated": "2026-03-04T12:32:41.935Z", "insights_id": null, "tags": [ { "key": "application", "value": "bluetooth", "namespace": "hacking" }, { "key": "array", "value": "bluetooth", "namespace": "connecting" }, { "key": "hard drive", "value": "multi-byte", "namespace": "navigating" }, { "key": "circuit", "value": "haptic", "namespace": "quantifying" }, { "key": "bus", "value": "multi-byte", "namespace": "backing up" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "64dfb513-7789-455c-9ef0-c2d20f8c8e3b", "display_name": "braun.test", "groups": [], "culled_timestamp": "2036-03-18T12:32:41.932Z", "last_check_in": "2036-03-12T12:32:41.932Z", "stale_timestamp": "2036-03-04T12:32:41.932Z", "stale_warning_timestamp": "2036-03-11T12:32:41.932Z", "updated": "2026-03-04T12:32:41.933Z", "insights_id": null, "tags": [ { "key": "circuit", "value": "digital", "namespace": "connecting" }, { "key": "feed", "value": "optical", "namespace": "programming" }, { "key": "feed", "value": "cross-platform", "namespace": "transmitting" }, { "key": "panel", "value": "open-source", "namespace": "transmitting" }, { "key": "port", "value": "wireless", "namespace": "overriding" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "6fced23b-9039-4ac6-939f-eb73792971c5", "display_name": "fahey.test", "groups": [], "culled_timestamp": "2036-03-18T12:32:41.930Z", "last_check_in": "2036-03-12T12:32:41.930Z", "stale_timestamp": "2036-03-04T12:32:41.930Z", "stale_warning_timestamp": "2036-03-11T12:32:41.930Z", "updated": "2026-03-04T12:32:41.930Z", "insights_id": null, "tags": [ { "key": "firewall", "value": "1080p", "namespace": "synthesizing" }, { "key": "program", "value": "wireless", "namespace": "bypassing" }, { "key": "feed", "value": "optical", "namespace": "backing up" }, { "key": "matrix", "value": "cross-platform", "namespace": "transmitting" }, { "key": "program", "value": "online", "namespace": "generating" } ], "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`, `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": "df74f68f-a669-4c98-a230-876e814bd4c7", "display_name": "hodkiewicz-beahan.test", "groups": [], "culled_timestamp": "2036-03-18T12:32:42.317Z", "last_check_in": "2036-03-12T12:32:42.317Z", "stale_timestamp": "2036-03-04T12:32:42.317Z", "stale_warning_timestamp": "2036-03-11T12:32:42.317Z", "updated": "2026-03-04T12:32:42.317Z", "insights_id": null, "tags": [ { "key": "array", "value": "virtual", "namespace": "transmitting" }, { "key": "hard drive", "value": "optical", "namespace": "copying" }, { "key": "bus", "value": "open-source", "namespace": "backing up" }, { "key": "array", "value": "optical", "namespace": "parsing" }, { "key": "port", "value": "auxiliary", "namespace": "copying" } ], "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 70ecf61c-265d-4947-a1e5-60b311c996f2" ] }, "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`, and `group_name`

(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": "038cb503-15c7-4dd8-9928-2530533ff4fa", "display_name": "wintheiser-tremblay.example", "groups": [], "culled_timestamp": "2036-03-18T12:32:42.412Z", "last_check_in": "2036-03-12T12:32:42.412Z", "stale_timestamp": "2036-03-04T12:32:42.412Z", "stale_warning_timestamp": "2036-03-11T12:32:42.412Z", "updated": "2026-03-04T12:32:42.412Z", "insights_id": null, "tags": [ { "key": "array", "value": "redundant", "namespace": "connecting" }, { "key": "matrix", "value": "multi-byte", "namespace": "quantifying" }, { "key": "sensor", "value": "solid state", "namespace": "programming" }, { "key": "interface", "value": "wireless", "namespace": "transmitting" }, { "key": "card", "value": "cross-platform", "namespace": "overriding" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "0c73d332-08f4-491b-a44d-e7e4397dfb07", "display_name": "lueilwitz.example", "groups": [], "culled_timestamp": "2036-03-18T12:32:42.544Z", "last_check_in": "2036-03-12T12:32:42.544Z", "stale_timestamp": "2036-03-04T12:32:42.544Z", "stale_warning_timestamp": "2036-03-11T12:32:42.544Z", "updated": "2026-03-04T12:32:42.544Z", "insights_id": null, "tags": [ { "key": "panel", "value": "redundant", "namespace": "indexing" }, { "key": "system", "value": "open-source", "namespace": "generating" }, { "key": "program", "value": "wireless", "namespace": "compressing" }, { "key": "bus", "value": "bluetooth", "namespace": "hacking" }, { "key": "port", "value": "multi-byte", "namespace": "parsing" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "1cdec56c-d4de-4ed9-933d-c22ad813d572", "display_name": "armstrong.example", "groups": [], "culled_timestamp": "2036-03-18T12:32:42.528Z", "last_check_in": "2036-03-12T12:32:42.528Z", "stale_timestamp": "2036-03-04T12:32:42.528Z", "stale_warning_timestamp": "2036-03-11T12:32:42.528Z", "updated": "2026-03-04T12:32:42.528Z", "insights_id": null, "tags": [ { "key": "monitor", "value": "auxiliary", "namespace": "hacking" }, { "key": "capacitor", "value": "virtual", "namespace": "programming" }, { "key": "alarm", "value": "optical", "namespace": "copying" }, { "key": "microchip", "value": "back-end", "namespace": "copying" }, { "key": "firewall", "value": "open-source", "namespace": "quantifying" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "2b00d465-9dcc-4b41-8345-e673b23e2c4d", "display_name": "rau-lind.example", "groups": [], "culled_timestamp": "2036-03-18T12:32:42.380Z", "last_check_in": "2036-03-12T12:32:42.380Z", "stale_timestamp": "2036-03-04T12:32:42.380Z", "stale_warning_timestamp": "2036-03-11T12:32:42.380Z", "updated": "2026-03-04T12:32:42.380Z", "insights_id": null, "tags": [ { "key": "monitor", "value": "online", "namespace": "bypassing" }, { "key": "protocol", "value": "optical", "namespace": "calculating" }, { "key": "firewall", "value": "primary", "namespace": "calculating" }, { "key": "program", "value": "back-end", "namespace": "bypassing" }, { "key": "port", "value": "optical", "namespace": "quantifying" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "350e3f1e-64fc-43d1-b1f4-8e5ba2eee9c1", "display_name": "heidenreich.example", "groups": [], "culled_timestamp": "2036-03-18T12:32:42.815Z", "last_check_in": "2036-03-12T12:32:42.815Z", "stale_timestamp": "2036-03-04T12:32:42.815Z", "stale_warning_timestamp": "2036-03-11T12:32:42.815Z", "updated": "2026-03-04T12:32:42.815Z", "insights_id": null, "tags": [ { "key": "card", "value": "haptic", "namespace": "bypassing" }, { "key": "card", "value": "haptic", "namespace": "generating" }, { "key": "feed", "value": "digital", "namespace": "backing up" }, { "key": "circuit", "value": "virtual", "namespace": "generating" }, { "key": "bus", "value": "wireless", "namespace": "indexing" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "4789d189-56ba-4369-a649-20b098b88afe", "display_name": "batz.example", "groups": [], "culled_timestamp": "2036-03-18T12:32:42.489Z", "last_check_in": "2036-03-12T12:32:42.489Z", "stale_timestamp": "2036-03-04T12:32:42.489Z", "stale_warning_timestamp": "2036-03-11T12:32:42.489Z", "updated": "2026-03-04T12:32:42.489Z", "insights_id": null, "tags": [ { "key": "circuit", "value": "digital", "namespace": "navigating" }, { "key": "sensor", "value": "1080p", "namespace": "indexing" }, { "key": "card", "value": "multi-byte", "namespace": "copying" }, { "key": "application", "value": "cross-platform", "namespace": "programming" }, { "key": "pixel", "value": "optical", "namespace": "compressing" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "4995d933-d568-42ea-86a6-d8fdb000faa0", "display_name": "zboncak.test", "groups": [], "culled_timestamp": "2036-03-18T12:32:42.770Z", "last_check_in": "2036-03-12T12:32:42.770Z", "stale_timestamp": "2036-03-04T12:32:42.770Z", "stale_warning_timestamp": "2036-03-11T12:32:42.770Z", "updated": "2026-03-04T12:32:42.770Z", "insights_id": null, "tags": [ { "key": "card", "value": "online", "namespace": "programming" }, { "key": "transmitter", "value": "multi-byte", "namespace": "calculating" }, { "key": "interface", "value": "open-source", "namespace": "quantifying" }, { "key": "feed", "value": "solid state", "namespace": "bypassing" }, { "key": "array", "value": "wireless", "namespace": "generating" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "4a81a8df-2518-4ecd-a844-e2ac06e73f81", "display_name": "kuhlman.example", "groups": [], "culled_timestamp": "2036-03-18T12:32:42.561Z", "last_check_in": "2036-03-12T12:32:42.561Z", "stale_timestamp": "2036-03-04T12:32:42.561Z", "stale_warning_timestamp": "2036-03-11T12:32:42.561Z", "updated": "2026-03-04T12:32:42.561Z", "insights_id": null, "tags": [ { "key": "application", "value": "optical", "namespace": "connecting" }, { "key": "firewall", "value": "mobile", "namespace": "hacking" }, { "key": "sensor", "value": "bluetooth", "namespace": "generating" }, { "key": "monitor", "value": "virtual", "namespace": "compressing" }, { "key": "hard drive", "value": "multi-byte", "namespace": "bypassing" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "6052c381-8ced-4ca8-9aaf-ba3545269f1b", "display_name": "hilpert.test", "groups": [], "culled_timestamp": "2036-03-18T12:32:42.644Z", "last_check_in": "2036-03-12T12:32:42.644Z", "stale_timestamp": "2036-03-04T12:32:42.644Z", "stale_warning_timestamp": "2036-03-11T12:32:42.644Z", "updated": "2026-03-04T12:32:42.644Z", "insights_id": null, "tags": [ { "key": "circuit", "value": "auxiliary", "namespace": "connecting" }, { "key": "array", "value": "cross-platform", "namespace": "transmitting" }, { "key": "panel", "value": "optical", "namespace": "generating" }, { "key": "circuit", "value": "cross-platform", "namespace": "calculating" }, { "key": "interface", "value": "online", "namespace": "bypassing" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "7bab0645-ee05-4594-864d-c38bd81c7c74", "display_name": "pfeffer.example", "groups": [], "culled_timestamp": "2036-03-18T12:32:42.577Z", "last_check_in": "2036-03-12T12:32:42.577Z", "stale_timestamp": "2036-03-04T12:32:42.577Z", "stale_warning_timestamp": "2036-03-11T12:32:42.577Z", "updated": "2026-03-04T12:32:42.577Z", "insights_id": null, "tags": [ { "key": "firewall", "value": "mobile", "namespace": "overriding" }, { "key": "microchip", "value": "multi-byte", "namespace": "calculating" }, { "key": "card", "value": "open-source", "namespace": "overriding" }, { "key": "application", "value": "cross-platform", "namespace": "compressing" }, { "key": "card", "value": "optical", "namespace": "indexing" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 } ], "meta": { "total": 25, "tags": [], "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/policies/fd9e3a09-d5de-45a4-a5e8-adf6d0a4c7cf/systems?limit=10&offset=0", "last": "/api/compliance/v2/policies/fd9e3a09-d5de-45a4-a5e8-adf6d0a4c7cf/systems?limit=10&offset=20", "next": "/api/compliance/v2/policies/fd9e3a09-d5de-45a4-a5e8-adf6d0a4c7cf/systems?limit=10&offset=10" } }, "summary": "", "description": "" }, "List of Systems sorted by \"os_minor_version:asc\"": { "value": { "data": [ { "id": "03e1f7a5-d704-4881-8268-ae7a62d15ba5", "display_name": "homenick-kuphal.example", "groups": [], "culled_timestamp": "2036-03-18T12:32:43.124Z", "last_check_in": "2036-03-12T12:32:43.124Z", "stale_timestamp": "2036-03-04T12:32:43.124Z", "stale_warning_timestamp": "2036-03-11T12:32:43.124Z", "updated": "2026-03-04T12:32:43.124Z", "insights_id": null, "tags": [ { "key": "matrix", "value": "1080p", "namespace": "synthesizing" }, { "key": "bandwidth", "value": "1080p", "namespace": "transmitting" }, { "key": "bus", "value": "bluetooth", "namespace": "indexing" }, { "key": "protocol", "value": "digital", "namespace": "copying" }, { "key": "circuit", "value": "open-source", "namespace": "backing up" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "06cd36f7-20a9-418d-aec9-3113b4b07ed5", "display_name": "cronin.example", "groups": [], "culled_timestamp": "2036-03-18T12:32:43.175Z", "last_check_in": "2036-03-12T12:32:43.175Z", "stale_timestamp": "2036-03-04T12:32:43.175Z", "stale_warning_timestamp": "2036-03-11T12:32:43.175Z", "updated": "2026-03-04T12:32:43.175Z", "insights_id": null, "tags": [ { "key": "interface", "value": "neural", "namespace": "backing up" }, { "key": "protocol", "value": "virtual", "namespace": "programming" }, { "key": "pixel", "value": "redundant", "namespace": "generating" }, { "key": "pixel", "value": "wireless", "namespace": "programming" }, { "key": "transmitter", "value": "auxiliary", "namespace": "copying" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "0e9a7624-d36c-4586-9d4b-9bc58bfedd82", "display_name": "gleason.example", "groups": [], "culled_timestamp": "2036-03-18T12:32:43.029Z", "last_check_in": "2036-03-12T12:32:43.029Z", "stale_timestamp": "2036-03-04T12:32:43.029Z", "stale_warning_timestamp": "2036-03-11T12:32:43.029Z", "updated": "2026-03-04T12:32:43.029Z", "insights_id": null, "tags": [ { "key": "array", "value": "solid state", "namespace": "compressing" }, { "key": "microchip", "value": "multi-byte", "namespace": "connecting" }, { "key": "microchip", "value": "1080p", "namespace": "programming" }, { "key": "circuit", "value": "optical", "namespace": "compressing" }, { "key": "alarm", "value": "haptic", "namespace": "overriding" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "18eaaa7a-3181-436c-8eed-75a4f3490035", "display_name": "legros.example", "groups": [], "culled_timestamp": "2036-03-18T12:32:43.287Z", "last_check_in": "2036-03-12T12:32:43.287Z", "stale_timestamp": "2036-03-04T12:32:43.287Z", "stale_warning_timestamp": "2036-03-11T12:32:43.287Z", "updated": "2026-03-04T12:32:43.288Z", "insights_id": null, "tags": [ { "key": "system", "value": "redundant", "namespace": "bypassing" }, { "key": "interface", "value": "wireless", "namespace": "navigating" }, { "key": "circuit", "value": "online", "namespace": "navigating" }, { "key": "hard drive", "value": "wireless", "namespace": "hacking" }, { "key": "panel", "value": "primary", "namespace": "parsing" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "23872973-9b9d-40ca-a96b-9299591a3528", "display_name": "weissnat.example", "groups": [], "culled_timestamp": "2036-03-18T12:32:43.535Z", "last_check_in": "2036-03-12T12:32:43.535Z", "stale_timestamp": "2036-03-04T12:32:43.535Z", "stale_warning_timestamp": "2036-03-11T12:32:43.535Z", "updated": "2026-03-04T12:32:43.535Z", "insights_id": null, "tags": [ { "key": "capacitor", "value": "mobile", "namespace": "navigating" }, { "key": "matrix", "value": "digital", "namespace": "bypassing" }, { "key": "system", "value": "cross-platform", "namespace": "synthesizing" }, { "key": "bus", "value": "multi-byte", "namespace": "calculating" }, { "key": "card", "value": "1080p", "namespace": "copying" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "3be2d191-d5ed-44e0-8071-28c5ed947cd8", "display_name": "barton.example", "groups": [], "culled_timestamp": "2036-03-18T12:32:43.387Z", "last_check_in": "2036-03-12T12:32:43.387Z", "stale_timestamp": "2036-03-04T12:32:43.387Z", "stale_warning_timestamp": "2036-03-11T12:32:43.387Z", "updated": "2026-03-04T12:32:43.387Z", "insights_id": null, "tags": [ { "key": "capacitor", "value": "virtual", "namespace": "programming" }, { "key": "program", "value": "online", "namespace": "programming" }, { "key": "firewall", "value": "multi-byte", "namespace": "compressing" }, { "key": "protocol", "value": "neural", "namespace": "hacking" }, { "key": "microchip", "value": "online", "namespace": "calculating" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "3dfe4b77-a91c-4f76-b5dd-21006c36db83", "display_name": "mante-jones.test", "groups": [], "culled_timestamp": "2036-03-18T12:32:43.368Z", "last_check_in": "2036-03-12T12:32:43.368Z", "stale_timestamp": "2036-03-04T12:32:43.368Z", "stale_warning_timestamp": "2036-03-11T12:32:43.368Z", "updated": "2026-03-04T12:32:43.368Z", "insights_id": null, "tags": [ { "key": "panel", "value": "primary", "namespace": "generating" }, { "key": "driver", "value": "wireless", "namespace": "compressing" }, { "key": "pixel", "value": "cross-platform", "namespace": "quantifying" }, { "key": "system", "value": "online", "namespace": "quantifying" }, { "key": "transmitter", "value": "back-end", "namespace": "backing up" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "44874037-44a4-46a2-9f4f-bdf917c21850", "display_name": "bednar-bruen.example", "groups": [], "culled_timestamp": "2036-03-18T12:32:43.578Z", "last_check_in": "2036-03-12T12:32:43.578Z", "stale_timestamp": "2036-03-04T12:32:43.578Z", "stale_warning_timestamp": "2036-03-11T12:32:43.578Z", "updated": "2026-03-04T12:32:43.578Z", "insights_id": null, "tags": [ { "key": "feed", "value": "mobile", "namespace": "generating" }, { "key": "circuit", "value": "neural", "namespace": "indexing" }, { "key": "protocol", "value": "multi-byte", "namespace": "quantifying" }, { "key": "firewall", "value": "wireless", "namespace": "calculating" }, { "key": "array", "value": "redundant", "namespace": "copying" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "60816264-8e6e-42c1-8912-137c1e763997", "display_name": "klein.example", "groups": [], "culled_timestamp": "2036-03-18T12:32:43.557Z", "last_check_in": "2036-03-12T12:32:43.557Z", "stale_timestamp": "2036-03-04T12:32:43.557Z", "stale_warning_timestamp": "2036-03-11T12:32:43.557Z", "updated": "2026-03-04T12:32:43.557Z", "insights_id": null, "tags": [ { "key": "protocol", "value": "primary", "namespace": "quantifying" }, { "key": "program", "value": "back-end", "namespace": "programming" }, { "key": "application", "value": "primary", "namespace": "navigating" }, { "key": "interface", "value": "open-source", "namespace": "compressing" }, { "key": "monitor", "value": "auxiliary", "namespace": "compressing" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "61bb8307-f6e2-48bc-b597-46c67195b32f", "display_name": "rath.test", "groups": [], "culled_timestamp": "2036-03-18T12:32:43.226Z", "last_check_in": "2036-03-12T12:32:43.226Z", "stale_timestamp": "2036-03-04T12:32:43.226Z", "stale_warning_timestamp": "2036-03-11T12:32:43.226Z", "updated": "2026-03-04T12:32:43.226Z", "insights_id": null, "tags": [ { "key": "panel", "value": "multi-byte", "namespace": "programming" }, { "key": "driver", "value": "1080p", "namespace": "connecting" }, { "key": "firewall", "value": "multi-byte", "namespace": "overriding" }, { "key": "feed", "value": "wireless", "namespace": "backing up" }, { "key": "system", "value": "bluetooth", "namespace": "compressing" } ], "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/dab57c91-433a-4587-b66b-6b6e20eced54/systems?limit=10&offset=0&sort_by=os_minor_version", "last": "/api/compliance/v2/policies/dab57c91-433a-4587-b66b-6b6e20eced54/systems?limit=10&offset=20&sort_by=os_minor_version", "next": "/api/compliance/v2/policies/dab57c91-433a-4587-b66b-6b6e20eced54/systems?limit=10&offset=10&sort_by=os_minor_version" } }, "summary": "", "description": "" }, "List of Systems filtered by \"(os_minor_version=0)\"": { "value": { "data": [ { "id": "1acc7ca3-8195-4c55-a6c0-1eba6cd32a93", "display_name": "towne.example", "groups": [], "culled_timestamp": "2036-03-18T12:32:44.001Z", "last_check_in": "2036-03-12T12:32:44.001Z", "stale_timestamp": "2036-03-04T12:32:44.001Z", "stale_warning_timestamp": "2036-03-11T12:32:44.001Z", "updated": "2026-03-04T12:32:44.001Z", "insights_id": null, "tags": [ { "key": "port", "value": "redundant", "namespace": "backing up" }, { "key": "bus", "value": "cross-platform", "namespace": "transmitting" }, { "key": "interface", "value": "optical", "namespace": "generating" }, { "key": "feed", "value": "solid state", "namespace": "calculating" }, { "key": "matrix", "value": "multi-byte", "namespace": "quantifying" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "230eabdd-4eb6-46f1-92a9-139b9c872037", "display_name": "kris.example", "groups": [], "culled_timestamp": "2036-03-18T12:32:43.915Z", "last_check_in": "2036-03-12T12:32:43.915Z", "stale_timestamp": "2036-03-04T12:32:43.915Z", "stale_warning_timestamp": "2036-03-11T12:32:43.915Z", "updated": "2026-03-04T12:32:43.915Z", "insights_id": null, "tags": [ { "key": "array", "value": "optical", "namespace": "hacking" }, { "key": "system", "value": "1080p", "namespace": "programming" }, { "key": "sensor", "value": "redundant", "namespace": "bypassing" }, { "key": "alarm", "value": "digital", "namespace": "transmitting" }, { "key": "hard drive", "value": "optical", "namespace": "programming" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "27ce5148-5131-4f7b-8f08-8cc7ef0143df", "display_name": "dibbert.test", "groups": [], "culled_timestamp": "2036-03-18T12:32:43.948Z", "last_check_in": "2036-03-12T12:32:43.948Z", "stale_timestamp": "2036-03-04T12:32:43.948Z", "stale_warning_timestamp": "2036-03-11T12:32:43.948Z", "updated": "2026-03-04T12:32:43.948Z", "insights_id": null, "tags": [ { "key": "feed", "value": "haptic", "namespace": "backing up" }, { "key": "array", "value": "neural", "namespace": "overriding" }, { "key": "microchip", "value": "auxiliary", "namespace": "navigating" }, { "key": "card", "value": "primary", "namespace": "overriding" }, { "key": "pixel", "value": "multi-byte", "namespace": "programming" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "3eac5e64-091f-4cc4-a4e2-c5b470ea184d", "display_name": "barrows-kub.example", "groups": [], "culled_timestamp": "2036-03-18T12:32:43.931Z", "last_check_in": "2036-03-12T12:32:43.931Z", "stale_timestamp": "2036-03-04T12:32:43.931Z", "stale_warning_timestamp": "2036-03-11T12:32:43.931Z", "updated": "2026-03-04T12:32:43.931Z", "insights_id": null, "tags": [ { "key": "bandwidth", "value": "digital", "namespace": "indexing" }, { "key": "alarm", "value": "bluetooth", "namespace": "overriding" }, { "key": "interface", "value": "optical", "namespace": "bypassing" }, { "key": "hard drive", "value": "primary", "namespace": "navigating" }, { "key": "panel", "value": "neural", "namespace": "transmitting" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "3fc93423-7b64-442a-8e62-60cfbc1a70bd", "display_name": "nader.test", "groups": [], "culled_timestamp": "2036-03-18T12:32:44.072Z", "last_check_in": "2036-03-12T12:32:44.072Z", "stale_timestamp": "2036-03-04T12:32:44.072Z", "stale_warning_timestamp": "2036-03-11T12:32:44.072Z", "updated": "2026-03-04T12:32:44.072Z", "insights_id": null, "tags": [ { "key": "port", "value": "primary", "namespace": "parsing" }, { "key": "feed", "value": "mobile", "namespace": "connecting" }, { "key": "port", "value": "digital", "namespace": "hacking" }, { "key": "monitor", "value": "redundant", "namespace": "transmitting" }, { "key": "protocol", "value": "virtual", "namespace": "transmitting" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "58e76e41-545b-41d7-baa6-755faf46a247", "display_name": "corwin.test", "groups": [], "culled_timestamp": "2036-03-18T12:32:43.791Z", "last_check_in": "2036-03-12T12:32:43.791Z", "stale_timestamp": "2036-03-04T12:32:43.791Z", "stale_warning_timestamp": "2036-03-11T12:32:43.791Z", "updated": "2026-03-04T12:32:43.791Z", "insights_id": null, "tags": [ { "key": "transmitter", "value": "optical", "namespace": "overriding" }, { "key": "transmitter", "value": "digital", "namespace": "copying" }, { "key": "monitor", "value": "bluetooth", "namespace": "generating" }, { "key": "firewall", "value": "back-end", "namespace": "generating" }, { "key": "transmitter", "value": "1080p", "namespace": "programming" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "679401f5-51f6-4174-bff0-71d3a7db3924", "display_name": "rau-bradtke.example", "groups": [], "culled_timestamp": "2036-03-18T12:32:43.983Z", "last_check_in": "2036-03-12T12:32:43.983Z", "stale_timestamp": "2036-03-04T12:32:43.983Z", "stale_warning_timestamp": "2036-03-11T12:32:43.983Z", "updated": "2026-03-04T12:32:43.984Z", "insights_id": null, "tags": [ { "key": "port", "value": "haptic", "namespace": "bypassing" }, { "key": "application", "value": "digital", "namespace": "bypassing" }, { "key": "circuit", "value": "multi-byte", "namespace": "parsing" }, { "key": "sensor", "value": "optical", "namespace": "copying" }, { "key": "panel", "value": "auxiliary", "namespace": "indexing" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "69d2e3a5-ddd1-4b92-bdab-0b0ff75ccfd4", "display_name": "rogahn.example", "groups": [], "culled_timestamp": "2036-03-18T12:32:44.119Z", "last_check_in": "2036-03-12T12:32:44.119Z", "stale_timestamp": "2036-03-04T12:32:44.119Z", "stale_warning_timestamp": "2036-03-11T12:32:44.119Z", "updated": "2026-03-04T12:32:44.119Z", "insights_id": null, "tags": [ { "key": "card", "value": "open-source", "namespace": "hacking" }, { "key": "bandwidth", "value": "virtual", "namespace": "backing up" }, { "key": "interface", "value": "1080p", "namespace": "compressing" }, { "key": "interface", "value": "multi-byte", "namespace": "compressing" }, { "key": "driver", "value": "haptic", "namespace": "hacking" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "6b160579-664d-48fe-b4c9-546634d79376", "display_name": "koepp.test", "groups": [], "culled_timestamp": "2036-03-18T12:32:43.852Z", "last_check_in": "2036-03-12T12:32:43.852Z", "stale_timestamp": "2036-03-04T12:32:43.852Z", "stale_warning_timestamp": "2036-03-11T12:32:43.852Z", "updated": "2026-03-04T12:32:43.852Z", "insights_id": null, "tags": [ { "key": "sensor", "value": "1080p", "namespace": "synthesizing" }, { "key": "circuit", "value": "cross-platform", "namespace": "programming" }, { "key": "program", "value": "optical", "namespace": "compressing" }, { "key": "array", "value": "open-source", "namespace": "compressing" }, { "key": "hard drive", "value": "wireless", "namespace": "parsing" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "7aa68bc3-71ce-4fe8-86ba-a5c8d3c96f0e", "display_name": "stracke.test", "groups": [], "culled_timestamp": "2036-03-18T12:32:43.898Z", "last_check_in": "2036-03-12T12:32:43.898Z", "stale_timestamp": "2036-03-04T12:32:43.898Z", "stale_warning_timestamp": "2036-03-11T12:32:43.898Z", "updated": "2026-03-04T12:32:43.898Z", "insights_id": null, "tags": [ { "key": "hard drive", "value": "haptic", "namespace": "copying" }, { "key": "system", "value": "bluetooth", "namespace": "synthesizing" }, { "key": "bandwidth", "value": "multi-byte", "namespace": "transmitting" }, { "key": "pixel", "value": "neural", "namespace": "programming" }, { "key": "application", "value": "haptic", "namespace": "backing up" } ], "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/459223f4-48b5-42bf-8e51-cdfb33019b86/systems?filter=%28os_minor_version%3D0%29&limit=10&offset=0", "last": "/api/compliance/v2/policies/459223f4-48b5-42bf-8e51-cdfb33019b86/systems?filter=%28os_minor_version%3D0%29&limit=10&offset=20", "next": "/api/compliance/v2/policies/459223f4-48b5-42bf-8e51-cdfb33019b86/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": "0333dd66-92d1-4ace-b683-26204d347f1d", "display_name": "walker.example", "groups": [], "culled_timestamp": "2036-03-18T12:32:45.768Z", "last_check_in": "2036-03-12T12:32:45.768Z", "stale_timestamp": "2036-03-04T12:32:45.768Z", "stale_warning_timestamp": "2036-03-11T12:32:45.768Z", "updated": "2026-03-04T12:32:45.768Z", "insights_id": null, "tags": [ { "key": "system", "value": "auxiliary", "namespace": "synthesizing" }, { "key": "monitor", "value": "primary", "namespace": "overriding" }, { "key": "panel", "value": "back-end", "namespace": "navigating" }, { "key": "firewall", "value": "virtual", "namespace": "backing up" }, { "key": "bandwidth", "value": "multi-byte", "namespace": "quantifying" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "0a660d3e-8c4c-46e9-a6ee-f79b3d716037", "display_name": "barton.example", "groups": [], "culled_timestamp": "2036-03-18T12:32:45.777Z", "last_check_in": "2036-03-12T12:32:45.777Z", "stale_timestamp": "2036-03-04T12:32:45.777Z", "stale_warning_timestamp": "2036-03-11T12:32:45.777Z", "updated": "2026-03-04T12:32:45.777Z", "insights_id": null, "tags": [ { "key": "interface", "value": "mobile", "namespace": "quantifying" }, { "key": "interface", "value": "redundant", "namespace": "navigating" }, { "key": "application", "value": "cross-platform", "namespace": "connecting" }, { "key": "panel", "value": "neural", "namespace": "calculating" }, { "key": "application", "value": "redundant", "namespace": "copying" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "0f055c0c-e9ee-49ca-9e9f-6cffee255424", "display_name": "pfeffer.example", "groups": [], "culled_timestamp": "2036-03-18T12:32:45.743Z", "last_check_in": "2036-03-12T12:32:45.743Z", "stale_timestamp": "2036-03-04T12:32:45.743Z", "stale_warning_timestamp": "2036-03-11T12:32:45.743Z", "updated": "2026-03-04T12:32:45.744Z", "insights_id": null, "tags": [ { "key": "panel", "value": "virtual", "namespace": "quantifying" }, { "key": "protocol", "value": "bluetooth", "namespace": "navigating" }, { "key": "feed", "value": "online", "namespace": "parsing" }, { "key": "firewall", "value": "auxiliary", "namespace": "synthesizing" }, { "key": "program", "value": "back-end", "namespace": "copying" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "244672e5-0eef-4ae6-98f8-30f316f70ba5", "display_name": "quigley.example", "groups": [], "culled_timestamp": "2036-03-18T12:32:45.746Z", "last_check_in": "2036-03-12T12:32:45.746Z", "stale_timestamp": "2036-03-04T12:32:45.746Z", "stale_warning_timestamp": "2036-03-11T12:32:45.746Z", "updated": "2026-03-04T12:32:45.746Z", "insights_id": null, "tags": [ { "key": "sensor", "value": "haptic", "namespace": "programming" }, { "key": "monitor", "value": "digital", "namespace": "bypassing" }, { "key": "array", "value": "wireless", "namespace": "overriding" }, { "key": "hard drive", "value": "back-end", "namespace": "backing up" }, { "key": "panel", "value": "cross-platform", "namespace": "programming" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "3e32bc6c-b098-40ab-84b2-4eb67487a1c9", "display_name": "strosin-strosin.test", "groups": [], "culled_timestamp": "2036-03-18T12:32:45.787Z", "last_check_in": "2036-03-12T12:32:45.787Z", "stale_timestamp": "2036-03-04T12:32:45.787Z", "stale_warning_timestamp": "2036-03-11T12:32:45.787Z", "updated": "2026-03-04T12:32:45.787Z", "insights_id": null, "tags": [ { "key": "feed", "value": "cross-platform", "namespace": "synthesizing" }, { "key": "alarm", "value": "mobile", "namespace": "synthesizing" }, { "key": "bandwidth", "value": "digital", "namespace": "overriding" }, { "key": "capacitor", "value": "multi-byte", "namespace": "generating" }, { "key": "transmitter", "value": "redundant", "namespace": "transmitting" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "54d9d50a-d42f-4c07-8006-aba51092a9df", "display_name": "nienow.test", "groups": [], "culled_timestamp": "2036-03-18T12:32:45.784Z", "last_check_in": "2036-03-12T12:32:45.784Z", "stale_timestamp": "2036-03-04T12:32:45.784Z", "stale_warning_timestamp": "2036-03-11T12:32:45.784Z", "updated": "2026-03-04T12:32:45.784Z", "insights_id": null, "tags": [ { "key": "application", "value": "auxiliary", "namespace": "quantifying" }, { "key": "matrix", "value": "redundant", "namespace": "compressing" }, { "key": "bus", "value": "bluetooth", "namespace": "generating" }, { "key": "application", "value": "bluetooth", "namespace": "connecting" }, { "key": "card", "value": "mobile", "namespace": "hacking" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "610eeb81-26ac-4e7b-bb21-db4f17df392e", "display_name": "cole.example", "groups": [], "culled_timestamp": "2036-03-18T12:32:45.751Z", "last_check_in": "2036-03-12T12:32:45.751Z", "stale_timestamp": "2036-03-04T12:32:45.751Z", "stale_warning_timestamp": "2036-03-11T12:32:45.751Z", "updated": "2026-03-04T12:32:45.751Z", "insights_id": null, "tags": [ { "key": "feed", "value": "back-end", "namespace": "copying" }, { "key": "matrix", "value": "open-source", "namespace": "parsing" }, { "key": "card", "value": "haptic", "namespace": "navigating" }, { "key": "application", "value": "mobile", "namespace": "indexing" }, { "key": "feed", "value": "primary", "namespace": "synthesizing" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "64e8ee60-f1c5-41cd-b481-30cb2713d1ff", "display_name": "hauck.test", "groups": [], "culled_timestamp": "2036-03-18T12:32:45.774Z", "last_check_in": "2036-03-12T12:32:45.774Z", "stale_timestamp": "2036-03-04T12:32:45.774Z", "stale_warning_timestamp": "2036-03-11T12:32:45.774Z", "updated": "2026-03-04T12:32:45.774Z", "insights_id": null, "tags": [ { "key": "sensor", "value": "virtual", "namespace": "overriding" }, { "key": "matrix", "value": "cross-platform", "namespace": "parsing" }, { "key": "microchip", "value": "redundant", "namespace": "generating" }, { "key": "sensor", "value": "auxiliary", "namespace": "programming" }, { "key": "protocol", "value": "1080p", "namespace": "generating" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "6a67c5ea-cc46-4ac6-bbd1-e296b4d19c83", "display_name": "wolff.example", "groups": [], "culled_timestamp": "2036-03-18T12:32:45.779Z", "last_check_in": "2036-03-12T12:32:45.779Z", "stale_timestamp": "2036-03-04T12:32:45.779Z", "stale_warning_timestamp": "2036-03-11T12:32:45.779Z", "updated": "2026-03-04T12:32:45.779Z", "insights_id": null, "tags": [ { "key": "system", "value": "solid state", "namespace": "programming" }, { "key": "array", "value": "virtual", "namespace": "compressing" }, { "key": "alarm", "value": "auxiliary", "namespace": "backing up" }, { "key": "firewall", "value": "primary", "namespace": "overriding" }, { "key": "card", "value": "virtual", "namespace": "calculating" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "74ff40cd-9969-4a4f-9626-fe0e58aa0db3", "display_name": "lehner.example", "groups": [], "culled_timestamp": "2036-03-18T12:32:45.754Z", "last_check_in": "2036-03-12T12:32:45.754Z", "stale_timestamp": "2036-03-04T12:32:45.754Z", "stale_warning_timestamp": "2036-03-11T12:32:45.754Z", "updated": "2026-03-04T12:32:45.754Z", "insights_id": null, "tags": [ { "key": "matrix", "value": "1080p", "namespace": "calculating" }, { "key": "panel", "value": "wireless", "namespace": "navigating" }, { "key": "sensor", "value": "digital", "namespace": "connecting" }, { "key": "alarm", "value": "haptic", "namespace": "indexing" }, { "key": "bus", "value": "neural", "namespace": "calculating" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 } ], "meta": { "total": 25, "tags": [], "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/policies/f33cc8e8-12e7-468b-926c-136be5b34313/systems?limit=10&offset=0", "last": "/api/compliance/v2/policies/f33cc8e8-12e7-468b-926c-136be5b34313/systems?limit=10&offset=20", "next": "/api/compliance/v2/policies/f33cc8e8-12e7-468b-926c-136be5b34313/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": [ "69a5cd5a-c1bf-4166-9671-bff0de456cde" ] } } } } } } } } }, "/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`, `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": "840218ce-4fac-4bc3-9abb-6558e554fb80", "display_name": "bruen.example", "groups": [], "culled_timestamp": "2036-03-18T12:32:46.450Z", "last_check_in": "2036-03-12T12:32:46.450Z", "stale_timestamp": "2036-03-04T12:32:46.450Z", "stale_warning_timestamp": "2036-03-11T12:32:46.450Z", "updated": "2026-03-04T12:32:46.450Z", "insights_id": null, "tags": [ { "key": "panel", "value": "haptic", "namespace": "connecting" }, { "key": "protocol", "value": "1080p", "namespace": "compressing" }, { "key": "card", "value": "bluetooth", "namespace": "navigating" }, { "key": "capacitor", "value": "cross-platform", "namespace": "backing up" }, { "key": "microchip", "value": "bluetooth", "namespace": "connecting" } ], "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 878b0589-82e0-4263-a3c1-9f17c3f54a37" ] }, "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": "3efcf28e-2b93-420a-89e2-eeda004f5fa7", "display_name": "sporer.test", "groups": [], "culled_timestamp": "2036-03-18T12:32:46.607Z", "last_check_in": "2036-03-12T12:32:46.607Z", "stale_timestamp": "2036-03-04T12:32:46.607Z", "stale_warning_timestamp": "2036-03-11T12:32:46.607Z", "updated": "2026-03-04T12:32:46.607Z", "insights_id": null, "tags": [ { "key": "bus", "value": "1080p", "namespace": "calculating" }, { "key": "transmitter", "value": "multi-byte", "namespace": "overriding" }, { "key": "alarm", "value": "cross-platform", "namespace": "calculating" }, { "key": "application", "value": "back-end", "namespace": "parsing" }, { "key": "hard drive", "value": "haptic", "namespace": "bypassing" } ], "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 83d0aabb-2a82-498f-88eb-a528c5f5d8e1" ] }, "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`, and `group_name`

(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": "1839cb67-de5f-4038-ad02-2545708f7f6f", "display_name": "cormier.example", "groups": [], "culled_timestamp": "2036-03-18T12:32:47.670Z", "last_check_in": "2036-03-12T12:32:47.670Z", "stale_timestamp": "2036-03-04T12:32:47.670Z", "stale_warning_timestamp": "2036-03-11T12:32:47.670Z", "updated": "2026-03-04T12:32:47.670Z", "insights_id": null, "tags": [ { "key": "firewall", "value": "haptic", "namespace": "calculating" }, { "key": "pixel", "value": "haptic", "namespace": "bypassing" }, { "key": "microchip", "value": "online", "namespace": "transmitting" }, { "key": "sensor", "value": "auxiliary", "namespace": "backing up" }, { "key": "circuit", "value": "optical", "namespace": "synthesizing" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "98cedc7e-33ed-4e69-a949-f422f08bab2c", "title": "Tempora quia est nobis." } ] }, { "id": "20fb1394-1fad-4d07-a041-2f45ef56da09", "display_name": "grimes.test", "groups": [], "culled_timestamp": "2036-03-18T12:32:47.230Z", "last_check_in": "2036-03-12T12:32:47.230Z", "stale_timestamp": "2036-03-04T12:32:47.230Z", "stale_warning_timestamp": "2036-03-11T12:32:47.230Z", "updated": "2026-03-04T12:32:47.230Z", "insights_id": null, "tags": [ { "key": "card", "value": "haptic", "namespace": "backing up" }, { "key": "alarm", "value": "online", "namespace": "bypassing" }, { "key": "transmitter", "value": "haptic", "namespace": "synthesizing" }, { "key": "bus", "value": "bluetooth", "namespace": "navigating" }, { "key": "protocol", "value": "neural", "namespace": "generating" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "98cedc7e-33ed-4e69-a949-f422f08bab2c", "title": "Tempora quia est nobis." } ] }, { "id": "233a3bd1-d392-404b-a3a6-021096a00d1e", "display_name": "reilly.test", "groups": [], "culled_timestamp": "2036-03-18T12:32:47.548Z", "last_check_in": "2036-03-12T12:32:47.548Z", "stale_timestamp": "2036-03-04T12:32:47.548Z", "stale_warning_timestamp": "2036-03-11T12:32:47.548Z", "updated": "2026-03-04T12:32:47.548Z", "insights_id": null, "tags": [ { "key": "program", "value": "multi-byte", "namespace": "transmitting" }, { "key": "circuit", "value": "cross-platform", "namespace": "programming" }, { "key": "interface", "value": "virtual", "namespace": "transmitting" }, { "key": "feed", "value": "back-end", "namespace": "quantifying" }, { "key": "sensor", "value": "redundant", "namespace": "transmitting" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "98cedc7e-33ed-4e69-a949-f422f08bab2c", "title": "Tempora quia est nobis." } ] }, { "id": "25af9423-bc4b-4dd5-a916-d41e6bac7260", "display_name": "bahringer.test", "groups": [], "culled_timestamp": "2036-03-18T12:32:47.253Z", "last_check_in": "2036-03-12T12:32:47.253Z", "stale_timestamp": "2036-03-04T12:32:47.253Z", "stale_warning_timestamp": "2036-03-11T12:32:47.253Z", "updated": "2026-03-04T12:32:47.253Z", "insights_id": null, "tags": [ { "key": "interface", "value": "wireless", "namespace": "copying" }, { "key": "pixel", "value": "online", "namespace": "hacking" }, { "key": "feed", "value": "multi-byte", "namespace": "hacking" }, { "key": "port", "value": "redundant", "namespace": "transmitting" }, { "key": "panel", "value": "mobile", "namespace": "synthesizing" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "98cedc7e-33ed-4e69-a949-f422f08bab2c", "title": "Tempora quia est nobis." } ] }, { "id": "31119018-a6b9-4620-8db9-3fc320dce416", "display_name": "zemlak-grimes.test", "groups": [], "culled_timestamp": "2036-03-18T12:32:47.409Z", "last_check_in": "2036-03-12T12:32:47.409Z", "stale_timestamp": "2036-03-04T12:32:47.409Z", "stale_warning_timestamp": "2036-03-11T12:32:47.409Z", "updated": "2026-03-04T12:32:47.409Z", "insights_id": null, "tags": [ { "key": "driver", "value": "virtual", "namespace": "hacking" }, { "key": "card", "value": "auxiliary", "namespace": "copying" }, { "key": "panel", "value": "virtual", "namespace": "overriding" }, { "key": "circuit", "value": "primary", "namespace": "parsing" }, { "key": "matrix", "value": "neural", "namespace": "programming" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "98cedc7e-33ed-4e69-a949-f422f08bab2c", "title": "Tempora quia est nobis." } ] }, { "id": "37d6d094-0b69-4186-a50f-73708e7c1afc", "display_name": "jacobi.example", "groups": [], "culled_timestamp": "2036-03-18T12:32:47.327Z", "last_check_in": "2036-03-12T12:32:47.327Z", "stale_timestamp": "2036-03-04T12:32:47.327Z", "stale_warning_timestamp": "2036-03-11T12:32:47.327Z", "updated": "2026-03-04T12:32:47.328Z", "insights_id": null, "tags": [ { "key": "alarm", "value": "neural", "namespace": "backing up" }, { "key": "system", "value": "online", "namespace": "hacking" }, { "key": "firewall", "value": "bluetooth", "namespace": "compressing" }, { "key": "card", "value": "mobile", "namespace": "generating" }, { "key": "application", "value": "online", "namespace": "bypassing" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "98cedc7e-33ed-4e69-a949-f422f08bab2c", "title": "Tempora quia est nobis." } ] }, { "id": "3c97348c-373f-4521-87a5-4d7536ba8587", "display_name": "auer.example", "groups": [], "culled_timestamp": "2036-03-18T12:32:47.485Z", "last_check_in": "2036-03-12T12:32:47.485Z", "stale_timestamp": "2036-03-04T12:32:47.485Z", "stale_warning_timestamp": "2036-03-11T12:32:47.485Z", "updated": "2026-03-04T12:32:47.485Z", "insights_id": null, "tags": [ { "key": "alarm", "value": "back-end", "namespace": "transmitting" }, { "key": "interface", "value": "mobile", "namespace": "transmitting" }, { "key": "alarm", "value": "mobile", "namespace": "generating" }, { "key": "bandwidth", "value": "redundant", "namespace": "navigating" }, { "key": "matrix", "value": "redundant", "namespace": "bypassing" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "98cedc7e-33ed-4e69-a949-f422f08bab2c", "title": "Tempora quia est nobis." } ] }, { "id": "49ed1a1f-3779-4b41-a1d0-1b50b4efe48e", "display_name": "ankunding.example", "groups": [], "culled_timestamp": "2036-03-18T12:32:47.693Z", "last_check_in": "2036-03-12T12:32:47.693Z", "stale_timestamp": "2036-03-04T12:32:47.693Z", "stale_warning_timestamp": "2036-03-11T12:32:47.693Z", "updated": "2026-03-04T12:32:47.693Z", "insights_id": null, "tags": [ { "key": "system", "value": "wireless", "namespace": "synthesizing" }, { "key": "port", "value": "open-source", "namespace": "compressing" }, { "key": "monitor", "value": "bluetooth", "namespace": "hacking" }, { "key": "driver", "value": "solid state", "namespace": "hacking" }, { "key": "protocol", "value": "optical", "namespace": "overriding" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "98cedc7e-33ed-4e69-a949-f422f08bab2c", "title": "Tempora quia est nobis." } ] }, { "id": "4daf304a-38cb-4454-b56b-e54961dcaf62", "display_name": "treutel.example", "groups": [], "culled_timestamp": "2036-03-18T12:32:47.527Z", "last_check_in": "2036-03-12T12:32:47.527Z", "stale_timestamp": "2036-03-04T12:32:47.527Z", "stale_warning_timestamp": "2036-03-11T12:32:47.527Z", "updated": "2026-03-04T12:32:47.527Z", "insights_id": null, "tags": [ { "key": "interface", "value": "wireless", "namespace": "parsing" }, { "key": "application", "value": "neural", "namespace": "backing up" }, { "key": "alarm", "value": "bluetooth", "namespace": "programming" }, { "key": "circuit", "value": "back-end", "namespace": "copying" }, { "key": "transmitter", "value": "optical", "namespace": "copying" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "98cedc7e-33ed-4e69-a949-f422f08bab2c", "title": "Tempora quia est nobis." } ] }, { "id": "667a57a1-7ba4-4a08-afcc-67fb60ef0b3e", "display_name": "steuber-franecki.example", "groups": [], "culled_timestamp": "2036-03-18T12:32:47.276Z", "last_check_in": "2036-03-12T12:32:47.276Z", "stale_timestamp": "2036-03-04T12:32:47.276Z", "stale_warning_timestamp": "2036-03-11T12:32:47.276Z", "updated": "2026-03-04T12:32:47.276Z", "insights_id": null, "tags": [ { "key": "program", "value": "online", "namespace": "overriding" }, { "key": "firewall", "value": "solid state", "namespace": "indexing" }, { "key": "microchip", "value": "virtual", "namespace": "backing up" }, { "key": "firewall", "value": "back-end", "namespace": "synthesizing" }, { "key": "card", "value": "digital", "namespace": "connecting" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "98cedc7e-33ed-4e69-a949-f422f08bab2c", "title": "Tempora quia est nobis." } ] } ], "meta": { "total": 25, "tags": [], "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/reports/98cedc7e-33ed-4e69-a949-f422f08bab2c/systems?limit=10&offset=0", "last": "/api/compliance/v2/reports/98cedc7e-33ed-4e69-a949-f422f08bab2c/systems?limit=10&offset=20", "next": "/api/compliance/v2/reports/98cedc7e-33ed-4e69-a949-f422f08bab2c/systems?limit=10&offset=10" } }, "summary": "", "description": "" }, "List of Systems sorted by \"os_minor_version:asc\"": { "value": { "data": [ { "id": "0e22f45e-8cb9-4f95-833a-fa07239b2794", "display_name": "rempel-schinner.example", "groups": [], "culled_timestamp": "2036-03-18T12:32:48.410Z", "last_check_in": "2036-03-12T12:32:48.410Z", "stale_timestamp": "2036-03-04T12:32:48.410Z", "stale_warning_timestamp": "2036-03-11T12:32:48.410Z", "updated": "2026-03-04T12:32:48.410Z", "insights_id": null, "tags": [ { "key": "microchip", "value": "mobile", "namespace": "connecting" }, { "key": "application", "value": "primary", "namespace": "synthesizing" }, { "key": "application", "value": "wireless", "namespace": "connecting" }, { "key": "protocol", "value": "back-end", "namespace": "bypassing" }, { "key": "circuit", "value": "1080p", "namespace": "copying" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "cc92e379-df41-4f26-a6b6-67f52bd1301d", "title": "Sed provident repellat rem." } ] }, { "id": "0e2c1e40-5963-4ad9-851b-c667d6b245f9", "display_name": "graham.example", "groups": [], "culled_timestamp": "2036-03-18T12:32:48.951Z", "last_check_in": "2036-03-12T12:32:48.951Z", "stale_timestamp": "2036-03-04T12:32:48.951Z", "stale_warning_timestamp": "2036-03-11T12:32:48.951Z", "updated": "2026-03-04T12:32:48.951Z", "insights_id": null, "tags": [ { "key": "system", "value": "auxiliary", "namespace": "compressing" }, { "key": "sensor", "value": "virtual", "namespace": "overriding" }, { "key": "interface", "value": "solid state", "namespace": "bypassing" }, { "key": "application", "value": "back-end", "namespace": "compressing" }, { "key": "driver", "value": "mobile", "namespace": "programming" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "cc92e379-df41-4f26-a6b6-67f52bd1301d", "title": "Sed provident repellat rem." } ] }, { "id": "15eb1e56-c714-4e4e-beca-411a1418eff6", "display_name": "lind.example", "groups": [], "culled_timestamp": "2036-03-18T12:32:48.600Z", "last_check_in": "2036-03-12T12:32:48.600Z", "stale_timestamp": "2036-03-04T12:32:48.600Z", "stale_warning_timestamp": "2036-03-11T12:32:48.600Z", "updated": "2026-03-04T12:32:48.601Z", "insights_id": null, "tags": [ { "key": "bandwidth", "value": "1080p", "namespace": "navigating" }, { "key": "feed", "value": "online", "namespace": "connecting" }, { "key": "pixel", "value": "open-source", "namespace": "programming" }, { "key": "card", "value": "haptic", "namespace": "navigating" }, { "key": "firewall", "value": "bluetooth", "namespace": "connecting" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "cc92e379-df41-4f26-a6b6-67f52bd1301d", "title": "Sed provident repellat rem." } ] }, { "id": "1cda6521-6434-427b-a053-dfce4c65ae52", "display_name": "lesch.test", "groups": [], "culled_timestamp": "2036-03-18T12:32:48.783Z", "last_check_in": "2036-03-12T12:32:48.783Z", "stale_timestamp": "2036-03-04T12:32:48.783Z", "stale_warning_timestamp": "2036-03-11T12:32:48.783Z", "updated": "2026-03-04T12:32:48.783Z", "insights_id": null, "tags": [ { "key": "firewall", "value": "redundant", "namespace": "copying" }, { "key": "application", "value": "open-source", "namespace": "navigating" }, { "key": "system", "value": "open-source", "namespace": "navigating" }, { "key": "array", "value": "bluetooth", "namespace": "connecting" }, { "key": "matrix", "value": "1080p", "namespace": "parsing" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "cc92e379-df41-4f26-a6b6-67f52bd1301d", "title": "Sed provident repellat rem." } ] }, { "id": "2c80d3c3-da99-4f1f-811d-e9a17d5647c0", "display_name": "hauck.test", "groups": [], "culled_timestamp": "2036-03-18T12:32:48.827Z", "last_check_in": "2036-03-12T12:32:48.827Z", "stale_timestamp": "2036-03-04T12:32:48.827Z", "stale_warning_timestamp": "2036-03-11T12:32:48.827Z", "updated": "2026-03-04T12:32:48.827Z", "insights_id": null, "tags": [ { "key": "bandwidth", "value": "haptic", "namespace": "navigating" }, { "key": "capacitor", "value": "bluetooth", "namespace": "synthesizing" }, { "key": "application", "value": "multi-byte", "namespace": "connecting" }, { "key": "bus", "value": "online", "namespace": "synthesizing" }, { "key": "interface", "value": "solid state", "namespace": "generating" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "cc92e379-df41-4f26-a6b6-67f52bd1301d", "title": "Sed provident repellat rem." } ] }, { "id": "34d4f36f-e7b3-48e3-96dd-a856b650237e", "display_name": "green.example", "groups": [], "culled_timestamp": "2036-03-18T12:32:48.755Z", "last_check_in": "2036-03-12T12:32:48.755Z", "stale_timestamp": "2036-03-04T12:32:48.755Z", "stale_warning_timestamp": "2036-03-11T12:32:48.755Z", "updated": "2026-03-04T12:32:48.755Z", "insights_id": null, "tags": [ { "key": "driver", "value": "cross-platform", "namespace": "parsing" }, { "key": "application", "value": "digital", "namespace": "connecting" }, { "key": "circuit", "value": "neural", "namespace": "hacking" }, { "key": "protocol", "value": "haptic", "namespace": "calculating" }, { "key": "protocol", "value": "mobile", "namespace": "connecting" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "cc92e379-df41-4f26-a6b6-67f52bd1301d", "title": "Sed provident repellat rem." } ] }, { "id": "3a8dff2c-7cf6-4467-acd6-d214223a35e2", "display_name": "reichert.test", "groups": [], "culled_timestamp": "2036-03-18T12:32:48.846Z", "last_check_in": "2036-03-12T12:32:48.846Z", "stale_timestamp": "2036-03-04T12:32:48.846Z", "stale_warning_timestamp": "2036-03-11T12:32:48.846Z", "updated": "2026-03-04T12:32:48.846Z", "insights_id": null, "tags": [ { "key": "transmitter", "value": "mobile", "namespace": "hacking" }, { "key": "protocol", "value": "multi-byte", "namespace": "compressing" }, { "key": "sensor", "value": "multi-byte", "namespace": "indexing" }, { "key": "application", "value": "cross-platform", "namespace": "compressing" }, { "key": "panel", "value": "haptic", "namespace": "generating" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "cc92e379-df41-4f26-a6b6-67f52bd1301d", "title": "Sed provident repellat rem." } ] }, { "id": "438fa836-299e-4043-8f8c-6d93c63375cb", "display_name": "gutkowski.test", "groups": [], "culled_timestamp": "2036-03-18T12:32:48.695Z", "last_check_in": "2036-03-12T12:32:48.695Z", "stale_timestamp": "2036-03-04T12:32:48.695Z", "stale_warning_timestamp": "2036-03-11T12:32:48.695Z", "updated": "2026-03-04T12:32:48.695Z", "insights_id": null, "tags": [ { "key": "microchip", "value": "bluetooth", "namespace": "programming" }, { "key": "pixel", "value": "online", "namespace": "generating" }, { "key": "card", "value": "bluetooth", "namespace": "parsing" }, { "key": "bus", "value": "digital", "namespace": "parsing" }, { "key": "sensor", "value": "bluetooth", "namespace": "calculating" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "cc92e379-df41-4f26-a6b6-67f52bd1301d", "title": "Sed provident repellat rem." } ] }, { "id": "480f2471-b235-4837-956a-dfa7a03d786d", "display_name": "langosh.example", "groups": [], "culled_timestamp": "2036-03-18T12:32:48.881Z", "last_check_in": "2036-03-12T12:32:48.881Z", "stale_timestamp": "2036-03-04T12:32:48.881Z", "stale_warning_timestamp": "2036-03-11T12:32:48.881Z", "updated": "2026-03-04T12:32:48.881Z", "insights_id": null, "tags": [ { "key": "sensor", "value": "multi-byte", "namespace": "indexing" }, { "key": "firewall", "value": "1080p", "namespace": "calculating" }, { "key": "microchip", "value": "1080p", "namespace": "compressing" }, { "key": "alarm", "value": "auxiliary", "namespace": "calculating" }, { "key": "bandwidth", "value": "auxiliary", "namespace": "overriding" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "cc92e379-df41-4f26-a6b6-67f52bd1301d", "title": "Sed provident repellat rem." } ] }, { "id": "51715644-38db-461e-b672-711010e91465", "display_name": "smith.example", "groups": [], "culled_timestamp": "2036-03-18T12:32:48.917Z", "last_check_in": "2036-03-12T12:32:48.917Z", "stale_timestamp": "2036-03-04T12:32:48.917Z", "stale_warning_timestamp": "2036-03-11T12:32:48.917Z", "updated": "2026-03-04T12:32:48.917Z", "insights_id": null, "tags": [ { "key": "sensor", "value": "redundant", "namespace": "connecting" }, { "key": "circuit", "value": "optical", "namespace": "generating" }, { "key": "protocol", "value": "online", "namespace": "bypassing" }, { "key": "driver", "value": "solid state", "namespace": "generating" }, { "key": "bus", "value": "auxiliary", "namespace": "parsing" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "cc92e379-df41-4f26-a6b6-67f52bd1301d", "title": "Sed provident repellat rem." } ] } ], "meta": { "total": 25, "tags": [], "limit": 10, "offset": 0, "sort_by": "os_minor_version" }, "links": { "first": "/api/compliance/v2/reports/cc92e379-df41-4f26-a6b6-67f52bd1301d/systems?limit=10&offset=0&sort_by=os_minor_version", "last": "/api/compliance/v2/reports/cc92e379-df41-4f26-a6b6-67f52bd1301d/systems?limit=10&offset=20&sort_by=os_minor_version", "next": "/api/compliance/v2/reports/cc92e379-df41-4f26-a6b6-67f52bd1301d/systems?limit=10&offset=10&sort_by=os_minor_version" } }, "summary": "", "description": "" }, "List of Systems filtered by \"(os_minor_version=0)\"": { "value": { "data": [ { "id": "00b1cb55-12fe-4851-b3e2-8c385977b037", "display_name": "reinger.example", "groups": [], "culled_timestamp": "2036-03-18T12:32:49.895Z", "last_check_in": "2036-03-12T12:32:49.895Z", "stale_timestamp": "2036-03-04T12:32:49.895Z", "stale_warning_timestamp": "2036-03-11T12:32:49.895Z", "updated": "2026-03-04T12:32:49.895Z", "insights_id": null, "tags": [ { "key": "microchip", "value": "mobile", "namespace": "connecting" }, { "key": "circuit", "value": "back-end", "namespace": "bypassing" }, { "key": "interface", "value": "cross-platform", "namespace": "copying" }, { "key": "monitor", "value": "open-source", "namespace": "navigating" }, { "key": "array", "value": "auxiliary", "namespace": "navigating" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "c1079fd9-caef-4b40-a195-d5d333a500f1", "title": "Culpa voluptas cupiditate libero." } ] }, { "id": "08fe6b69-8606-498c-b26d-4554c95d9ae1", "display_name": "durgan-balistreri.test", "groups": [], "culled_timestamp": "2036-03-18T12:32:50.111Z", "last_check_in": "2036-03-12T12:32:50.111Z", "stale_timestamp": "2036-03-04T12:32:50.111Z", "stale_warning_timestamp": "2036-03-11T12:32:50.111Z", "updated": "2026-03-04T12:32:50.112Z", "insights_id": null, "tags": [ { "key": "matrix", "value": "virtual", "namespace": "copying" }, { "key": "transmitter", "value": "primary", "namespace": "connecting" }, { "key": "array", "value": "wireless", "namespace": "generating" }, { "key": "circuit", "value": "primary", "namespace": "quantifying" }, { "key": "capacitor", "value": "redundant", "namespace": "quantifying" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "c1079fd9-caef-4b40-a195-d5d333a500f1", "title": "Culpa voluptas cupiditate libero." } ] }, { "id": "11a74499-310f-48a0-b427-196a11eb4a7c", "display_name": "romaguera-volkman.test", "groups": [], "culled_timestamp": "2036-03-18T12:32:50.375Z", "last_check_in": "2036-03-12T12:32:50.375Z", "stale_timestamp": "2036-03-04T12:32:50.375Z", "stale_warning_timestamp": "2036-03-11T12:32:50.375Z", "updated": "2026-03-04T12:32:50.375Z", "insights_id": null, "tags": [ { "key": "alarm", "value": "mobile", "namespace": "hacking" }, { "key": "panel", "value": "1080p", "namespace": "quantifying" }, { "key": "application", "value": "haptic", "namespace": "copying" }, { "key": "circuit", "value": "wireless", "namespace": "synthesizing" }, { "key": "card", "value": "multi-byte", "namespace": "programming" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "c1079fd9-caef-4b40-a195-d5d333a500f1", "title": "Culpa voluptas cupiditate libero." } ] }, { "id": "172c20f6-eb8a-4a1f-a524-2b11c2dda141", "display_name": "schulist-frami.example", "groups": [], "culled_timestamp": "2036-03-18T12:32:50.453Z", "last_check_in": "2036-03-12T12:32:50.453Z", "stale_timestamp": "2036-03-04T12:32:50.453Z", "stale_warning_timestamp": "2036-03-11T12:32:50.453Z", "updated": "2026-03-04T12:32:50.453Z", "insights_id": null, "tags": [ { "key": "capacitor", "value": "mobile", "namespace": "copying" }, { "key": "sensor", "value": "optical", "namespace": "programming" }, { "key": "circuit", "value": "auxiliary", "namespace": "overriding" }, { "key": "program", "value": "back-end", "namespace": "indexing" }, { "key": "panel", "value": "haptic", "namespace": "bypassing" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "c1079fd9-caef-4b40-a195-d5d333a500f1", "title": "Culpa voluptas cupiditate libero." } ] }, { "id": "1c4354d7-941c-4339-a814-61b83661e628", "display_name": "howell.example", "groups": [], "culled_timestamp": "2036-03-18T12:32:49.867Z", "last_check_in": "2036-03-12T12:32:49.867Z", "stale_timestamp": "2036-03-04T12:32:49.867Z", "stale_warning_timestamp": "2036-03-11T12:32:49.867Z", "updated": "2026-03-04T12:32:49.867Z", "insights_id": null, "tags": [ { "key": "matrix", "value": "open-source", "namespace": "overriding" }, { "key": "matrix", "value": "multi-byte", "namespace": "parsing" }, { "key": "matrix", "value": "optical", "namespace": "parsing" }, { "key": "microchip", "value": "optical", "namespace": "navigating" }, { "key": "program", "value": "haptic", "namespace": "navigating" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "c1079fd9-caef-4b40-a195-d5d333a500f1", "title": "Culpa voluptas cupiditate libero." } ] }, { "id": "28d02001-14b9-4f14-9c13-5f059d7e5a12", "display_name": "nikolaus-schuppe.test", "groups": [], "culled_timestamp": "2036-03-18T12:32:49.840Z", "last_check_in": "2036-03-12T12:32:49.840Z", "stale_timestamp": "2036-03-04T12:32:49.840Z", "stale_warning_timestamp": "2036-03-11T12:32:49.840Z", "updated": "2026-03-04T12:32:49.840Z", "insights_id": null, "tags": [ { "key": "driver", "value": "virtual", "namespace": "indexing" }, { "key": "bus", "value": "auxiliary", "namespace": "parsing" }, { "key": "circuit", "value": "primary", "namespace": "transmitting" }, { "key": "capacitor", "value": "primary", "namespace": "navigating" }, { "key": "sensor", "value": "neural", "namespace": "transmitting" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "c1079fd9-caef-4b40-a195-d5d333a500f1", "title": "Culpa voluptas cupiditate libero." } ] }, { "id": "2c6f4924-6386-4d3b-a241-b96ad346aec9", "display_name": "balistreri.test", "groups": [], "culled_timestamp": "2036-03-18T12:32:50.421Z", "last_check_in": "2036-03-12T12:32:50.421Z", "stale_timestamp": "2036-03-04T12:32:50.421Z", "stale_warning_timestamp": "2036-03-11T12:32:50.421Z", "updated": "2026-03-04T12:32:50.421Z", "insights_id": null, "tags": [ { "key": "monitor", "value": "digital", "namespace": "navigating" }, { "key": "protocol", "value": "mobile", "namespace": "compressing" }, { "key": "driver", "value": "virtual", "namespace": "connecting" }, { "key": "pixel", "value": "1080p", "namespace": "compressing" }, { "key": "sensor", "value": "wireless", "namespace": "copying" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "c1079fd9-caef-4b40-a195-d5d333a500f1", "title": "Culpa voluptas cupiditate libero." } ] }, { "id": "2c8dcdda-a35b-4e90-8fae-bffa041f9087", "display_name": "jerde-hettinger.test", "groups": [], "culled_timestamp": "2036-03-18T12:32:50.086Z", "last_check_in": "2036-03-12T12:32:50.086Z", "stale_timestamp": "2036-03-04T12:32:50.086Z", "stale_warning_timestamp": "2036-03-11T12:32:50.086Z", "updated": "2026-03-04T12:32:50.086Z", "insights_id": null, "tags": [ { "key": "firewall", "value": "solid state", "namespace": "calculating" }, { "key": "hard drive", "value": "solid state", "namespace": "transmitting" }, { "key": "bandwidth", "value": "multi-byte", "namespace": "backing up" }, { "key": "array", "value": "primary", "namespace": "calculating" }, { "key": "array", "value": "digital", "namespace": "synthesizing" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "c1079fd9-caef-4b40-a195-d5d333a500f1", "title": "Culpa voluptas cupiditate libero." } ] }, { "id": "335726f6-b2c8-4eaf-8357-501b35ebf219", "display_name": "spencer.example", "groups": [], "culled_timestamp": "2036-03-18T12:32:49.719Z", "last_check_in": "2036-03-12T12:32:49.719Z", "stale_timestamp": "2036-03-04T12:32:49.719Z", "stale_warning_timestamp": "2036-03-11T12:32:49.719Z", "updated": "2026-03-04T12:32:49.719Z", "insights_id": null, "tags": [ { "key": "interface", "value": "open-source", "namespace": "compressing" }, { "key": "array", "value": "mobile", "namespace": "hacking" }, { "key": "pixel", "value": "virtual", "namespace": "backing up" }, { "key": "system", "value": "wireless", "namespace": "generating" }, { "key": "matrix", "value": "primary", "namespace": "programming" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "c1079fd9-caef-4b40-a195-d5d333a500f1", "title": "Culpa voluptas cupiditate libero." } ] }, { "id": "39174f5b-e834-42ee-a0fe-cfb55ece147f", "display_name": "funk.test", "groups": [], "culled_timestamp": "2036-03-18T12:32:50.195Z", "last_check_in": "2036-03-12T12:32:50.195Z", "stale_timestamp": "2036-03-04T12:32:50.195Z", "stale_warning_timestamp": "2036-03-11T12:32:50.195Z", "updated": "2026-03-04T12:32:50.195Z", "insights_id": null, "tags": [ { "key": "driver", "value": "back-end", "namespace": "quantifying" }, { "key": "alarm", "value": "1080p", "namespace": "bypassing" }, { "key": "program", "value": "open-source", "namespace": "navigating" }, { "key": "alarm", "value": "mobile", "namespace": "compressing" }, { "key": "alarm", "value": "online", "namespace": "programming" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "c1079fd9-caef-4b40-a195-d5d333a500f1", "title": "Culpa voluptas cupiditate libero." } ] } ], "meta": { "total": 25, "filter": "(os_minor_version=0)", "tags": [], "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/reports/c1079fd9-caef-4b40-a195-d5d333a500f1/systems?filter=%28os_minor_version%3D0%29&limit=10&offset=0", "last": "/api/compliance/v2/reports/c1079fd9-caef-4b40-a195-d5d333a500f1/systems?filter=%28os_minor_version%3D0%29&limit=10&offset=20", "next": "/api/compliance/v2/reports/c1079fd9-caef-4b40-a195-d5d333a500f1/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`, `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": "5294bbdf-612d-4f57-9196-71830100ce1e", "display_name": "halvorson.example", "groups": [], "culled_timestamp": "2036-03-18T12:32:55.270Z", "last_check_in": "2036-03-12T12:32:55.270Z", "stale_timestamp": "2036-03-04T12:32:55.270Z", "stale_warning_timestamp": "2036-03-11T12:32:55.270Z", "updated": "2026-03-04T12:32:55.270Z", "insights_id": null, "tags": [ { "key": "feed", "value": "bluetooth", "namespace": "hacking" }, { "key": "card", "value": "cross-platform", "namespace": "hacking" }, { "key": "feed", "value": "cross-platform", "namespace": "calculating" }, { "key": "array", "value": "open-source", "namespace": "synthesizing" }, { "key": "port", "value": "mobile", "namespace": "compressing" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "4fe5286b-b411-4984-a578-f9fb3ef204ca", "title": "Vitae dolores impedit quo." } ] } }, "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 e04681f1-2f50-4a8e-afc4-8ce775bfa58b" ] }, "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": "05ac8624-5eed-4088-9048-f33374fa2fa1", "profile_id": "c552bc87-5963-46f7-9c7b-c5106d6c2435", "os_minor_version": 21, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "a6634438-7ba0-4139-ba3b-19370a94648e", "security_guide_version": "100.98.21" }, { "id": "0812cc1f-5412-4e5a-8aed-190d45579303", "profile_id": "26aa9ce2-0b7f-42b0-8c34-f7d1fbbc00f3", "os_minor_version": 18, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "01a128db-7dca-4a87-8fdd-da30f83be237", "security_guide_version": "100.98.18" }, { "id": "0903c41f-da82-4e67-a815-0df72d38d757", "profile_id": "d60eb0e3-f5fd-4a5a-a621-8005c216bf05", "os_minor_version": 24, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "ade85e7b-345d-4d8e-99e3-63cf40f57e4b", "security_guide_version": "100.98.24" }, { "id": "0f21f57f-6402-4a10-a622-4cffbaf8218d", "profile_id": "fcdd52e2-2efc-4858-9984-14c8a06fd47e", "os_minor_version": 0, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "e6973c15-04f5-42dd-9751-710c521dcf30", "security_guide_version": "100.98.0" }, { "id": "23cf991c-0ccb-43e2-8509-be58288bcfce", "profile_id": "8b22f3a5-f234-4e5b-be85-92f218a4cfc8", "os_minor_version": 8, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "13b5d1d6-3c44-4f9e-89d3-553cf83feaee", "security_guide_version": "100.98.8" }, { "id": "291c98bd-8322-4d5d-ad6b-d782bbb60c39", "profile_id": "72470b42-3db0-4f08-82dd-0df50282bb79", "os_minor_version": 2, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "121388b7-b301-447f-a538-e43729c7a884", "security_guide_version": "100.98.2" }, { "id": "31d3fc81-300c-4310-a1e8-159d39ad3930", "profile_id": "28ec87fc-24f0-4b15-9fa7-322a76419a59", "os_minor_version": 5, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "6c047777-c279-4529-903a-884f86869812", "security_guide_version": "100.98.5" }, { "id": "32a49831-da8d-4664-96f1-fd1bb6cfa52a", "profile_id": "8192545f-0b88-4b25-a32a-02d455e40f96", "os_minor_version": 10, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "14c108aa-5c23-4d60-8a7a-e4ef72fbe428", "security_guide_version": "100.98.10" }, { "id": "455fcecb-7844-4db7-a0a3-124976746012", "profile_id": "e4558099-2ef1-432c-90dd-e0f08f684cd1", "os_minor_version": 9, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "0a2c3e78-b037-4d43-a3a1-650d9537425d", "security_guide_version": "100.98.9" }, { "id": "510cab52-aa96-4cb7-8460-b0cca2184c11", "profile_id": "4d63d132-639b-41a9-91ac-c4d99be65450", "os_minor_version": 15, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "067437fd-c62b-40c1-9615-eb39aabc82ed", "security_guide_version": "100.98.15" } ], "meta": { "total": 25, "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/policies/42adf711-2e6e-44a1-94b9-5875ff4bd44e/tailorings?limit=10&offset=0", "last": "/api/compliance/v2/policies/42adf711-2e6e-44a1-94b9-5875ff4bd44e/tailorings?limit=10&offset=20", "next": "/api/compliance/v2/policies/42adf711-2e6e-44a1-94b9-5875ff4bd44e/tailorings?limit=10&offset=10" } }, "summary": "", "description": "" }, "List of Tailorings sorted by \"os_minor_version:asc\"": { "value": { "data": [ { "id": "20572080-f8ca-4c4a-993b-f209df1b7507", "profile_id": "2e7a90fb-1855-44b7-965d-cfcc3908ddeb", "os_minor_version": 0, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "47979ec4-03db-4689-aaab-8bef37e7a1b2", "security_guide_version": "100.98.25" }, { "id": "f6363294-54c7-40c1-a54e-a67fdc11b100", "profile_id": "d372d550-540b-4d6e-9971-46eca3c12669", "os_minor_version": 1, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "93dc7b03-efe1-4e47-9781-d3a25d346530", "security_guide_version": "100.98.26" }, { "id": "fe0a8578-2126-4aab-8229-0d1ca1d0d2ae", "profile_id": "eb351dfc-bf22-451f-812f-b99179c3ac66", "os_minor_version": 2, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "d76ce6e1-073b-4c5a-8baf-6be35f98cd9b", "security_guide_version": "100.98.27" }, { "id": "bbcb620c-db73-4312-81b1-12b1e896f13c", "profile_id": "93eb3b25-6adb-4e19-8d5d-e77dbc15e84c", "os_minor_version": 3, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "c98506b3-8efe-4e08-bc6f-a7c8c3d41ab3", "security_guide_version": "100.98.28" }, { "id": "611293c8-b41f-4dcc-9f3d-7495ef2c41bd", "profile_id": "e758873f-766f-41e0-a4be-b3ae55765a2e", "os_minor_version": 4, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "30ffee6c-9879-4d8d-ad32-89d7d80e9d54", "security_guide_version": "100.98.29" }, { "id": "87aaa45e-001a-40e7-9fd0-ae4ea8ab0f0c", "profile_id": "a7d5da53-0a7b-4ae6-b1d0-4239355f8fde", "os_minor_version": 5, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "cc1bce15-cfae-46fa-82bf-7c4e9c465ffa", "security_guide_version": "100.98.30" }, { "id": "e909d54a-8ab5-4afd-a642-30cf36d3a0f4", "profile_id": "92c0a4f4-61e2-405b-9ed6-e32ff44b9143", "os_minor_version": 6, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "4f5d44de-6b1a-49be-b558-4775cabfb4f3", "security_guide_version": "100.98.31" }, { "id": "bf2dfd96-44f7-4307-9964-0b57434cf3fb", "profile_id": "c556a464-cb44-435e-af56-1d32df2f56f6", "os_minor_version": 7, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "e3368a90-c043-4a7f-8d7d-9ad0281bb95f", "security_guide_version": "100.98.32" }, { "id": "fe1d315e-8c9f-44c1-ab53-9c1a35c30cf0", "profile_id": "d86162be-5069-4059-a9a8-944546ffb5bd", "os_minor_version": 8, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "d2e2f062-908f-4ab5-8cc0-5092e86d1f04", "security_guide_version": "100.98.33" }, { "id": "c03e5991-d67a-4a40-8efc-88c3b0d0fc11", "profile_id": "5b95bd94-3bc9-4f62-a6a8-8fa71bcadf31", "os_minor_version": 9, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "9a00c24f-2943-4733-8c48-332ebaff3e1e", "security_guide_version": "100.98.34" } ], "meta": { "total": 25, "limit": 10, "offset": 0, "sort_by": "os_minor_version" }, "links": { "first": "/api/compliance/v2/policies/e29a6bed-e87d-41de-9b7a-bad5a55b8fbf/tailorings?limit=10&offset=0&sort_by=os_minor_version", "last": "/api/compliance/v2/policies/e29a6bed-e87d-41de-9b7a-bad5a55b8fbf/tailorings?limit=10&offset=20&sort_by=os_minor_version", "next": "/api/compliance/v2/policies/e29a6bed-e87d-41de-9b7a-bad5a55b8fbf/tailorings?limit=10&offset=10&sort_by=os_minor_version" } }, "summary": "", "description": "" }, "List of Tailorings filtered by '(os_minor_version=15)'": { "value": { "data": [ { "id": "17a12f5a-eb5a-484b-958f-721377a047f7", "profile_id": "37897b4e-ad3d-4b7b-9203-95cb07a5a91e", "os_minor_version": 15, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "d400b24c-9005-474b-b884-63cc7d0c72f5", "security_guide_version": "100.99.15" } ], "meta": { "total": 1, "filter": "(os_minor_version=15)", "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/policies/70a78072-8fec-4add-9d7f-c1006d1d9431/tailorings?filter=%28os_minor_version%3D15%29&limit=10&offset=0", "last": "/api/compliance/v2/policies/70a78072-8fec-4add-9d7f-c1006d1d9431/tailorings?filter=%28os_minor_version%3D15%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": "c131ef40-4b39-440d-a164-9358805b7fa8", "profile_id": "d5662504-e93a-460f-9fc9-1778ee7b4901", "os_minor_version": 1, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "4850e37b-5fe7-4aaf-9d23-cd43e54a51f5", "security_guide_version": "100.100.25" } }, "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": "00009374-f101-4f25-884a-c091aec8bc22", "profile_id": "83da03b0-ddf9-45de-9727-37a8b360e864", "os_minor_version": 1, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "08f8b92c-6225-484f-b580-a5dca361b439", "security_guide_version": "100.100.26" } }, "summary": "", "description": "" }, "Returns a Tailoring when using os_minor_version": { "value": { "data": { "id": "da246d8f-9da4-49b1-8683-29ff82ea93e9", "profile_id": "588ded6a-8139-4068-a01d-72a13bfc12cd", "os_minor_version": 1, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "b12cb251-23f4-4d45-aef2-0983d8de912e", "security_guide_version": "100.100.27" } }, "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 d722a7b0-6ccf-4b2c-b4da-c6c19435c55c" ] }, "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": "8efe8aec-6981-42a6-92da-4600136f100c", "profile_id": "3c0395f9-ca28-4ecf-8d1b-636926550b55", "os_minor_version": 1, "value_overrides": { "d47de3c3-f46b-461f-97a0-76213b348d72": "123" }, "type": "tailoring", "os_major_version": 7, "security_guide_id": "bd43f388-fc1b-451e-8c31-040f1711663f", "security_guide_version": "100.100.28" } }, "summary": "", "description": "" }, "Returns the updated Tailoring when using os_minor_version": { "value": { "data": { "id": "fa52c076-b885-4d35-85d8-d41980678099", "profile_id": "e6f65379-79df-47fd-a4a1-b6d6e95d3e30", "os_minor_version": 1, "value_overrides": { "66684183-a229-4ba4-b9e0-727ffa744ee3": "123" }, "type": "tailoring", "os_major_version": 7, "security_guide_id": "980ecdcd-f8da-456d-9d0e-0b229bf92ef6", "security_guide_version": "100.100.29" } }, "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": "cb83a4cb-e7b4-4648-a92e-71ba6123cc79", "type": "rule_group", "children": [ { "id": "2292ccba-8864-4114-998c-429855559efc", "type": "rule" } ] }, { "id": "5ec3265d-5967-4b8e-8975-fe6b62e4813e", "type": "rule_group", "children": [ { "id": "d11fd773-d72b-4fb2-9c33-f5824f887ba5", "type": "rule" } ] }, { "id": "63db16a4-5dc8-46dc-90ad-43ac66f728d5", "type": "rule_group", "children": [ { "id": "488c7930-f185-4b47-8935-b71ef0af3c63", "type": "rule" } ] }, { "id": "8efdb51a-e13d-4bff-9c45-7a535d90a51a", "type": "rule_group", "children": [ { "id": "95efe27f-403e-4b6a-bd1e-29a7cbca4f93", "type": "rule" } ] }, { "id": "c61c196a-b248-4944-95cc-83b3fdc751f1", "type": "rule_group", "children": [ { "id": "3988513f-c1cf-4a9d-b308-b4eedbda34a1", "type": "rule" } ] }, { "id": "4ffd73db-ff3a-4b60-8303-7182b77edc36", "type": "rule_group", "children": [ { "id": "5bae6a71-a4df-456c-a79c-189a1b19226a", "type": "rule" } ] }, { "id": "158a662c-db1c-4457-901f-98db83cf0da1", "type": "rule_group", "children": [ { "id": "7eab31b5-817b-48b8-97ac-fdcd470b8bac", "type": "rule" } ] }, { "id": "a1283271-03d7-4727-a6ab-c98533cc183f", "type": "rule_group", "children": [ { "id": "47386b54-d8e6-40c1-83c8-6f60ff915319", "type": "rule" } ] }, { "id": "ae73c2cf-e1b9-4fef-a829-8ac46d9508a2", "type": "rule_group", "children": [ { "id": "53159796-6015-4ad7-be6f-5ac51440fb7b", "type": "rule" } ] }, { "id": "e58452a5-a81b-466d-af03-3b6d990cd93a", "type": "rule_group", "children": [ { "id": "099a9daa-9dbc-445d-bbd8-bfd31f185267", "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 9ec76671-015b-42fc-9193-30ba82b631b5" ] }, "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_4743536d71966e32298c7395d24967ee", "base_profile_id": "xccdf_org.ssgproject.content_profile_4743536d71966e32298c7395d24967ee", "title": "Doloribus qui ducimus voluptates.", "groups": {}, "rules": {}, "variables": { "foo_value_716c5bc7-743a-412e-9924-c4c376ecf546": { "value": "753758" }, "foo_value_a5324d41-4faf-4168-a2ea-f91bf783bbd5": { "value": "311143" } } } ] }, "summary": "", "description": "" }, "Returns a Tailoring File while using os_minor_version": { "value": { "profiles": [ { "id": "xccdf_org.ssgproject.content_profile_bb72620fce4927ed0999a15820c211bc", "base_profile_id": "xccdf_org.ssgproject.content_profile_bb72620fce4927ed0999a15820c211bc", "title": "Magnam et cupiditate repudiandae.", "groups": {}, "rules": {}, "variables": { "foo_value_0743558c-aa1a-4837-9b64-c1e3d48c6a8e": { "value": "146699" }, "foo_value_27a0c7a2-317b-4cd8-85d2-753d5480823f": { "value": "74316" } } } ] }, "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 = \"Voluptatum minima autem. Consectetur architecto sunt. Sequi sed est.\"\nname = \"Voluptatem adipisci ut rerum.\"\nversion = \"100.104.10\"\n", "summary": "", "description": "" }, "Returns a Tailoring File": { "value": "description = \"Voluptatem eius necessitatibus. Facere natus provident. Adipisci aut eum.\"\nname = \"Ut deserunt qui voluptatibus.\"\nversion = \"100.105.18\"\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`, 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": "060bbaf3-7e2c-4ce5-9612-21b8194bde6d", "end_time": "2026-03-04T12:32:03.148Z", "failed_rule_count": 0, "supported": true, "score": 99.18572919938509, "type": "test_result", "display_name": "vonrueden-hansen.example", "groups": [], "tags": [ { "key": "capacitor", "value": "haptic", "namespace": "connecting" }, { "key": "pixel", "value": "virtual", "namespace": "calculating" }, { "key": "circuit", "value": "back-end", "namespace": "calculating" }, { "key": "microchip", "value": "multi-byte", "namespace": "copying" }, { "key": "alarm", "value": "primary", "namespace": "quantifying" } ], "os_major_version": 8, "os_minor_version": 0, "compliant": true, "system_id": "43238cb1-555a-458f-8313-76e8073e6be7", "security_guide_version": "100.106.23" }, { "id": "17448ee7-c86d-4125-9fdb-5521225af04b", "end_time": "2026-03-04T12:32:02.782Z", "failed_rule_count": 0, "supported": true, "score": 99.76790869389863, "type": "test_result", "display_name": "kautzer-bogisich.example", "groups": [], "tags": [ { "key": "transmitter", "value": "virtual", "namespace": "backing up" }, { "key": "monitor", "value": "multi-byte", "namespace": "hacking" }, { "key": "bus", "value": "optical", "namespace": "navigating" }, { "key": "alarm", "value": "1080p", "namespace": "generating" }, { "key": "matrix", "value": "auxiliary", "namespace": "quantifying" } ], "os_major_version": 8, "os_minor_version": 0, "compliant": true, "system_id": "686f2cc4-3810-475e-b082-885cae8ed2d0", "security_guide_version": "100.106.23" }, { "id": "178e773c-7606-46e7-9585-09fcf7385c88", "end_time": "2026-03-04T12:32:02.879Z", "failed_rule_count": 0, "supported": true, "score": 27.85824717677141, "type": "test_result", "display_name": "williamson-sawayn.test", "groups": [], "tags": [ { "key": "application", "value": "redundant", "namespace": "quantifying" }, { "key": "bus", "value": "1080p", "namespace": "programming" }, { "key": "sensor", "value": "redundant", "namespace": "programming" }, { "key": "protocol", "value": "multi-byte", "namespace": "hacking" }, { "key": "program", "value": "multi-byte", "namespace": "synthesizing" } ], "os_major_version": 8, "os_minor_version": 0, "compliant": false, "system_id": "eae4a4f1-6634-4910-adcc-0d76ffae89c0", "security_guide_version": "100.106.23" }, { "id": "1a568915-4b60-4e05-b26b-a0bd77ffc2da", "end_time": "2026-03-04T12:32:02.855Z", "failed_rule_count": 0, "supported": true, "score": 55.39638284086329, "type": "test_result", "display_name": "hickle.example", "groups": [], "tags": [ { "key": "pixel", "value": "wireless", "namespace": "navigating" }, { "key": "card", "value": "primary", "namespace": "generating" }, { "key": "transmitter", "value": "online", "namespace": "compressing" }, { "key": "application", "value": "bluetooth", "namespace": "backing up" }, { "key": "capacitor", "value": "back-end", "namespace": "hacking" } ], "os_major_version": 8, "os_minor_version": 0, "compliant": false, "system_id": "09251f82-95f4-4e7e-a1c7-b650b05663c2", "security_guide_version": "100.106.23" }, { "id": "26d8ddc5-24f2-4304-a0c1-1ce2af6cc561", "end_time": "2026-03-04T12:32:02.929Z", "failed_rule_count": 0, "supported": true, "score": 1.118981517286021, "type": "test_result", "display_name": "leannon-goyette.test", "groups": [], "tags": [ { "key": "panel", "value": "mobile", "namespace": "synthesizing" }, { "key": "protocol", "value": "wireless", "namespace": "navigating" }, { "key": "capacitor", "value": "auxiliary", "namespace": "calculating" }, { "key": "card", "value": "online", "namespace": "backing up" }, { "key": "protocol", "value": "multi-byte", "namespace": "quantifying" } ], "os_major_version": 8, "os_minor_version": 0, "compliant": false, "system_id": "014f3a36-153f-4dfd-9662-3b841f955bae", "security_guide_version": "100.106.23" }, { "id": "42417d27-4b7c-4dcd-ba0f-165e9e8343bf", "end_time": "2026-03-04T12:32:03.032Z", "failed_rule_count": 0, "supported": true, "score": 11.27103508846599, "type": "test_result", "display_name": "hickle-hessel.test", "groups": [], "tags": [ { "key": "program", "value": "online", "namespace": "generating" }, { "key": "microchip", "value": "cross-platform", "namespace": "generating" }, { "key": "hard drive", "value": "auxiliary", "namespace": "generating" }, { "key": "driver", "value": "optical", "namespace": "backing up" }, { "key": "protocol", "value": "wireless", "namespace": "quantifying" } ], "os_major_version": 8, "os_minor_version": 0, "compliant": false, "system_id": "a0882d27-e505-4c2f-8e1f-91a263c78c47", "security_guide_version": "100.106.23" }, { "id": "4b491e67-3806-4f14-805f-6901fca0d00e", "end_time": "2026-03-04T12:32:03.104Z", "failed_rule_count": 0, "supported": true, "score": 97.93469543319273, "type": "test_result", "display_name": "abernathy.test", "groups": [], "tags": [ { "key": "card", "value": "neural", "namespace": "quantifying" }, { "key": "application", "value": "solid state", "namespace": "parsing" }, { "key": "matrix", "value": "redundant", "namespace": "quantifying" }, { "key": "interface", "value": "multi-byte", "namespace": "compressing" }, { "key": "array", "value": "1080p", "namespace": "bypassing" } ], "os_major_version": 8, "os_minor_version": 0, "compliant": true, "system_id": "669f52a5-ce2b-4249-9c59-6dc07e98a9b2", "security_guide_version": "100.106.23" }, { "id": "516c642e-f438-41b4-ad0e-0dc7d6123f48", "end_time": "2026-03-04T12:32:03.223Z", "failed_rule_count": 0, "supported": true, "score": 49.39333651746155, "type": "test_result", "display_name": "adams.example", "groups": [], "tags": [ { "key": "card", "value": "solid state", "namespace": "copying" }, { "key": "sensor", "value": "neural", "namespace": "programming" }, { "key": "matrix", "value": "multi-byte", "namespace": "indexing" }, { "key": "driver", "value": "haptic", "namespace": "overriding" }, { "key": "transmitter", "value": "multi-byte", "namespace": "compressing" } ], "os_major_version": 8, "os_minor_version": 0, "compliant": false, "system_id": "ded50f5a-ef91-4bc8-b071-7b466ef99584", "security_guide_version": "100.106.23" }, { "id": "5550286c-f175-4633-9efc-f3be164ca6a9", "end_time": "2026-03-04T12:32:02.955Z", "failed_rule_count": 0, "supported": true, "score": 1.575896808384325, "type": "test_result", "display_name": "murray.example", "groups": [], "tags": [ { "key": "matrix", "value": "solid state", "namespace": "transmitting" }, { "key": "interface", "value": "cross-platform", "namespace": "connecting" }, { "key": "program", "value": "mobile", "namespace": "generating" }, { "key": "protocol", "value": "haptic", "namespace": "generating" }, { "key": "driver", "value": "optical", "namespace": "compressing" } ], "os_major_version": 8, "os_minor_version": 0, "compliant": false, "system_id": "63c3eaa2-d55b-4de3-8615-84c2e7d3992a", "security_guide_version": "100.106.23" }, { "id": "57ba4e83-2a3a-4be5-b46a-a150e31a7777", "end_time": "2026-03-04T12:32:02.829Z", "failed_rule_count": 0, "supported": true, "score": 8.740404850501903, "type": "test_result", "display_name": "haag.example", "groups": [], "tags": [ { "key": "system", "value": "haptic", "namespace": "backing up" }, { "key": "hard drive", "value": "primary", "namespace": "programming" }, { "key": "feed", "value": "digital", "namespace": "backing up" }, { "key": "driver", "value": "bluetooth", "namespace": "backing up" }, { "key": "transmitter", "value": "digital", "namespace": "navigating" } ], "os_major_version": 8, "os_minor_version": 0, "compliant": false, "system_id": "3290084e-fd26-4c65-bc91-d3d8c4ee9716", "security_guide_version": "100.106.23" } ], "meta": { "total": 25, "tags": [], "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/reports/d3ec558d-15b4-4791-885e-6c540c746303/test_results?limit=10&offset=0", "last": "/api/compliance/v2/reports/d3ec558d-15b4-4791-885e-6c540c746303/test_results?limit=10&offset=20", "next": "/api/compliance/v2/reports/d3ec558d-15b4-4791-885e-6c540c746303/test_results?limit=10&offset=10" } }, "summary": "", "description": "" }, "List of Test Results sorted by \"score:asc\"": { "value": { "data": [ { "id": "d70b9d04-e429-4af9-be93-3e257f0bf3b7", "end_time": "2026-03-04T12:32:04.418Z", "failed_rule_count": 0, "supported": true, "score": 6.831452056250942, "type": "test_result", "display_name": "jast.test", "groups": [], "tags": [ { "key": "program", "value": "mobile", "namespace": "quantifying" }, { "key": "capacitor", "value": "open-source", "namespace": "backing up" }, { "key": "driver", "value": "mobile", "namespace": "transmitting" }, { "key": "driver", "value": "open-source", "namespace": "navigating" }, { "key": "bus", "value": "cross-platform", "namespace": "programming" } ], "os_major_version": 8, "os_minor_version": 0, "compliant": false, "system_id": "df58d7d3-28f5-4df5-b16b-fb1ba37ac9f2", "security_guide_version": "100.107.25" }, { "id": "01ba05e2-9d5e-48b5-a5a1-685214b7c8bf", "end_time": "2026-03-04T12:32:04.464Z", "failed_rule_count": 0, "supported": true, "score": 17.79163452926676, "type": "test_result", "display_name": "aufderhar-hermann.example", "groups": [], "tags": [ { "key": "protocol", "value": "solid state", "namespace": "overriding" }, { "key": "matrix", "value": "primary", "namespace": "overriding" }, { "key": "program", "value": "multi-byte", "namespace": "overriding" }, { "key": "application", "value": "multi-byte", "namespace": "generating" }, { "key": "pixel", "value": "mobile", "namespace": "backing up" } ], "os_major_version": 8, "os_minor_version": 0, "compliant": false, "system_id": "5f8aa128-a560-4ff0-bd1f-65cb4b0d6e2e", "security_guide_version": "100.107.25" }, { "id": "a7d1632d-54fb-4df1-a65f-fa7c0d6ba08c", "end_time": "2026-03-04T12:32:04.035Z", "failed_rule_count": 0, "supported": true, "score": 20.77054166635588, "type": "test_result", "display_name": "gleason-pacocha.test", "groups": [], "tags": [ { "key": "system", "value": "online", "namespace": "connecting" }, { "key": "application", "value": "online", "namespace": "connecting" }, { "key": "interface", "value": "cross-platform", "namespace": "generating" }, { "key": "alarm", "value": "1080p", "namespace": "connecting" }, { "key": "feed", "value": "bluetooth", "namespace": "quantifying" } ], "os_major_version": 8, "os_minor_version": 0, "compliant": false, "system_id": "95e6a951-a374-4ee0-a0f9-57bd74aafc04", "security_guide_version": "100.107.25" }, { "id": "3aded1b0-4ff1-4dbd-9284-c96d0350d7ff", "end_time": "2026-03-04T12:32:04.306Z", "failed_rule_count": 0, "supported": true, "score": 22.79520537005864, "type": "test_result", "display_name": "conroy.test", "groups": [], "tags": [ { "key": "monitor", "value": "redundant", "namespace": "compressing" }, { "key": "feed", "value": "back-end", "namespace": "compressing" }, { "key": "bus", "value": "back-end", "namespace": "backing up" }, { "key": "system", "value": "solid state", "namespace": "compressing" }, { "key": "protocol", "value": "online", "namespace": "compressing" } ], "os_major_version": 8, "os_minor_version": 0, "compliant": false, "system_id": "e6cf5391-4576-49b6-b8e0-d443e147d90f", "security_guide_version": "100.107.25" }, { "id": "34d0383a-9d61-48c2-ad68-e92050d48b35", "end_time": "2026-03-04T12:32:04.482Z", "failed_rule_count": 0, "supported": true, "score": 32.30048143241152, "type": "test_result", "display_name": "herzog.example", "groups": [], "tags": [ { "key": "system", "value": "optical", "namespace": "generating" }, { "key": "matrix", "value": "digital", "namespace": "compressing" }, { "key": "sensor", "value": "redundant", "namespace": "copying" }, { "key": "array", "value": "optical", "namespace": "transmitting" }, { "key": "program", "value": "wireless", "namespace": "quantifying" } ], "os_major_version": 8, "os_minor_version": 0, "compliant": false, "system_id": "baeffcd3-d45d-4be4-980b-557f364d5e62", "security_guide_version": "100.107.25" }, { "id": "70b99995-e04a-4bd6-b77d-73c7672a7a7c", "end_time": "2026-03-04T12:32:04.284Z", "failed_rule_count": 0, "supported": true, "score": 38.19718012300236, "type": "test_result", "display_name": "oconner.test", "groups": [], "tags": [ { "key": "application", "value": "bluetooth", "namespace": "indexing" }, { "key": "firewall", "value": "auxiliary", "namespace": "bypassing" }, { "key": "card", "value": "wireless", "namespace": "copying" }, { "key": "microchip", "value": "multi-byte", "namespace": "compressing" }, { "key": "bandwidth", "value": "mobile", "namespace": "indexing" } ], "os_major_version": 8, "os_minor_version": 0, "compliant": false, "system_id": "5d463f65-bc36-4071-836a-860fa61af087", "security_guide_version": "100.107.25" }, { "id": "fbff6080-2a10-4e8d-962f-68c331e8bf48", "end_time": "2026-03-04T12:32:04.351Z", "failed_rule_count": 0, "supported": true, "score": 38.90972087004453, "type": "test_result", "display_name": "johns-mills.example", "groups": [], "tags": [ { "key": "application", "value": "cross-platform", "namespace": "navigating" }, { "key": "circuit", "value": "open-source", "namespace": "compressing" }, { "key": "microchip", "value": "virtual", "namespace": "parsing" }, { "key": "bandwidth", "value": "open-source", "namespace": "connecting" }, { "key": "sensor", "value": "virtual", "namespace": "programming" } ], "os_major_version": 8, "os_minor_version": 0, "compliant": false, "system_id": "4b36cd30-44a2-48d3-8500-7049e616b861", "security_guide_version": "100.107.25" }, { "id": "f776a22e-4d15-458d-a4ea-bd83ade87ce9", "end_time": "2026-03-04T12:32:04.221Z", "failed_rule_count": 0, "supported": true, "score": 47.41717839455766, "type": "test_result", "display_name": "bailey-berge.test", "groups": [], "tags": [ { "key": "hard drive", "value": "bluetooth", "namespace": "indexing" }, { "key": "sensor", "value": "open-source", "namespace": "backing up" }, { "key": "feed", "value": "virtual", "namespace": "indexing" }, { "key": "transmitter", "value": "redundant", "namespace": "compressing" }, { "key": "firewall", "value": "back-end", "namespace": "transmitting" } ], "os_major_version": 8, "os_minor_version": 0, "compliant": false, "system_id": "d7adf782-f65d-4fe7-8617-d10058dddd37", "security_guide_version": "100.107.25" }, { "id": "8d31c4a0-3b3e-4551-b68b-49b45230b341", "end_time": "2026-03-04T12:32:04.062Z", "failed_rule_count": 0, "supported": true, "score": 47.45230257059466, "type": "test_result", "display_name": "larkin.example", "groups": [], "tags": [ { "key": "array", "value": "cross-platform", "namespace": "synthesizing" }, { "key": "bus", "value": "open-source", "namespace": "calculating" }, { "key": "interface", "value": "haptic", "namespace": "backing up" }, { "key": "microchip", "value": "1080p", "namespace": "synthesizing" }, { "key": "program", "value": "mobile", "namespace": "programming" } ], "os_major_version": 8, "os_minor_version": 0, "compliant": false, "system_id": "8274bdd0-a49d-4ebc-bcff-d54dffe65961", "security_guide_version": "100.107.25" }, { "id": "b06a08a3-9248-4d9d-9da8-ae1028bfc302", "end_time": "2026-03-04T12:32:04.261Z", "failed_rule_count": 0, "supported": true, "score": 48.24888015995113, "type": "test_result", "display_name": "schowalter.example", "groups": [], "tags": [ { "key": "matrix", "value": "mobile", "namespace": "calculating" }, { "key": "microchip", "value": "haptic", "namespace": "transmitting" }, { "key": "hard drive", "value": "multi-byte", "namespace": "overriding" }, { "key": "matrix", "value": "virtual", "namespace": "parsing" }, { "key": "protocol", "value": "mobile", "namespace": "parsing" } ], "os_major_version": 8, "os_minor_version": 0, "compliant": false, "system_id": "12d95ab5-4b82-42d6-9c9b-bbd72700a8e1", "security_guide_version": "100.107.25" } ], "meta": { "total": 25, "tags": [], "limit": 10, "offset": 0, "sort_by": "score" }, "links": { "first": "/api/compliance/v2/reports/2b9242bf-4fe8-420d-abfc-898dc87983b7/test_results?limit=10&offset=0&sort_by=score", "last": "/api/compliance/v2/reports/2b9242bf-4fe8-420d-abfc-898dc87983b7/test_results?limit=10&offset=20&sort_by=score", "next": "/api/compliance/v2/reports/2b9242bf-4fe8-420d-abfc-898dc87983b7/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/d051f4e6-c1af-4903-a7cf-107648e90b30/test_results?filter=%28os_minor_version%3D8%29&limit=10&offset=0", "last": "/api/compliance/v2/reports/d051f4e6-c1af-4903-a7cf-107648e90b30/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`, 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.113.43" ], "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": "718a638b-929f-4edd-b2d5-a4275beaca0c", "end_time": "2026-03-04T12:32:12.081Z", "failed_rule_count": 0, "supported": true, "score": 41.86226677340998, "type": "test_result", "display_name": "farrell.example", "groups": [], "tags": [ { "key": "panel", "value": "1080p", "namespace": "navigating" }, { "key": "microchip", "value": "primary", "namespace": "compressing" }, { "key": "monitor", "value": "back-end", "namespace": "calculating" }, { "key": "bus", "value": "cross-platform", "namespace": "compressing" }, { "key": "program", "value": "redundant", "namespace": "quantifying" } ], "os_major_version": 8, "os_minor_version": 0, "compliant": false, "system_id": "e90f0ec7-844b-46f3-8b72-25d963baca05", "security_guide_version": "100.114.49" } }, "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 a4d7c872-0656-402a-b305-dfe169ecee35" ] }, "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": "0370d768-050d-49f9-9f5e-d6af7e3415b1", "ref_id": "foo_value_6b9e8aa5-eb08-4a18-9e04-8469f956e64e", "title": "Magni itaque voluptatem sint.", "description": "At nihil necessitatibus. Nesciunt harum similique. Sint ut qui.", "value_type": "number", "default_value": "0.002201682507324998", "type": "value_definition" }, { "id": "08e11cda-8814-4feb-b2b5-14f8e2d6ac39", "ref_id": "foo_value_514bd6be-35b2-46f9-8e44-dcc13d340e48", "title": "Similique consectetur explicabo alias.", "description": "Vel dolores illo. Dolore consequuntur porro. Nesciunt nulla facere.", "value_type": "number", "default_value": "0.7581227267474328", "type": "value_definition" }, { "id": "0a1f5438-e904-4952-bb74-63d5ef8672ea", "ref_id": "foo_value_88abaa80-78c7-4771-8682-2528c1b3f44e", "title": "Harum perferendis reprehenderit a.", "description": "Magni blanditiis ratione. Assumenda provident sint. Expedita quibusdam amet.", "value_type": "number", "default_value": "0.8246385841166343", "type": "value_definition" }, { "id": "0d7341ed-de3d-451a-8882-07ddb3ce48c6", "ref_id": "foo_value_b0b2b04d-71bb-47b6-9c3a-605652f72291", "title": "Occaecati qui cumque sit.", "description": "Aut quod ipsam. Vitae deserunt ut. Molestias qui et.", "value_type": "number", "default_value": "0.20476271776772714", "type": "value_definition" }, { "id": "15763d30-4829-4c49-82ad-287c847b7b33", "ref_id": "foo_value_c48d16df-8dff-4ae7-ab29-740ef6471b2e", "title": "Hic maxime perspiciatis consequuntur.", "description": "Et commodi sed. Consequatur magnam repellat. Ad itaque consequatur.", "value_type": "number", "default_value": "0.9310231048007142", "type": "value_definition" }, { "id": "1be10736-602f-462a-a34c-edd7ed1abc70", "ref_id": "foo_value_15e8e26f-9f9e-40a6-a2cc-c1a926b08b2a", "title": "In delectus quia ut.", "description": "Ab molestiae reiciendis. Facilis sit voluptatem. Sed sed et.", "value_type": "number", "default_value": "0.27697263539386885", "type": "value_definition" }, { "id": "21ee1975-34a7-48e7-9a2c-a79da46ee6e7", "ref_id": "foo_value_f95fdd6e-ff3c-4544-9873-982576e6c149", "title": "Qui vel cumque eveniet.", "description": "Eum qui alias. Explicabo ipsum quo. Est odio voluptatem.", "value_type": "number", "default_value": "0.8381760237848901", "type": "value_definition" }, { "id": "3973b20c-4aa8-44bb-b142-3dad421b6cfc", "ref_id": "foo_value_1b64b88c-ce24-4f09-8f57-5536fbb6a4bd", "title": "Sint totam magnam eligendi.", "description": "Est reprehenderit quia. Voluptas magni fugit. Earum dicta atque.", "value_type": "number", "default_value": "0.31430057119545196", "type": "value_definition" }, { "id": "39e6b50b-314f-4db1-b187-3e4616dea1bd", "ref_id": "foo_value_85e6cbe7-c6d1-48a1-a865-ad91214c8e7a", "title": "Sunt non culpa atque.", "description": "Ut repellendus facilis. Ex aliquid laborum. Dolores dolore laboriosam.", "value_type": "number", "default_value": "0.9281348678435196", "type": "value_definition" }, { "id": "4b98b219-18d6-48e7-8a72-c667ea34ccfb", "ref_id": "foo_value_3e8700d8-9863-4e2d-9bc6-9fb87938d40b", "title": "Itaque dolore velit dolorem.", "description": "Enim et consectetur. Labore aut et. Quidem dolores omnis.", "value_type": "number", "default_value": "0.6970969370398925", "type": "value_definition" } ], "meta": { "total": 25, "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/security_guides/1240f3da-bb95-41a1-b27a-9450e6bd84d2/value_definitions?limit=10&offset=0", "last": "/api/compliance/v2/security_guides/1240f3da-bb95-41a1-b27a-9450e6bd84d2/value_definitions?limit=10&offset=20", "next": "/api/compliance/v2/security_guides/1240f3da-bb95-41a1-b27a-9450e6bd84d2/value_definitions?limit=10&offset=10" } }, "summary": "", "description": "" }, "List of Value Definitions sorted by \"title:asc\"": { "value": { "data": [ { "id": "7b262efc-f8a0-4e1c-a657-7c5eca147db1", "ref_id": "foo_value_0507c0d5-ac8a-468d-9b38-1ad32179f856", "title": "Amet ea et nemo.", "description": "Adipisci enim magnam. Saepe temporibus et. Saepe cupiditate excepturi.", "value_type": "number", "default_value": "0.4419597980859281", "type": "value_definition" }, { "id": "bbf2c398-2e85-428d-8603-d121d0fe53f7", "ref_id": "foo_value_d232dc14-2ed1-46b2-a5a1-11282d0ba3aa", "title": "Autem voluptatum fuga adipisci.", "description": "Quis quia inventore. Recusandae officia nesciunt. A nam cum.", "value_type": "number", "default_value": "0.6636452273980795", "type": "value_definition" }, { "id": "165110ad-d64f-4e0f-8c36-8b80185e9e43", "ref_id": "foo_value_9cb45914-9bb4-4d55-9d39-0b73b3a512e3", "title": "Beatae quia nostrum unde.", "description": "Ratione non fuga. Doloremque sunt dolor. Quia distinctio provident.", "value_type": "number", "default_value": "0.3055608305162556", "type": "value_definition" }, { "id": "e4dbc52a-c956-4fc4-9fd1-e05fa76b841f", "ref_id": "foo_value_be5cdb2d-6f69-42b5-bf76-fea9a5893c07", "title": "Consectetur vel facilis nihil.", "description": "Qui sit eum. Consectetur aliquid quae. Sunt ut voluptate.", "value_type": "number", "default_value": "0.5881964188025057", "type": "value_definition" }, { "id": "274204e4-243e-4a8f-ac96-ac30f8bf3053", "ref_id": "foo_value_706c822e-1c98-445e-bc7b-00595dfe3d09", "title": "Dolore delectus cumque laudantium.", "description": "A corporis ratione. Natus voluptatum dolorem. Ipsam qui quidem.", "value_type": "number", "default_value": "0.3288893699581237", "type": "value_definition" }, { "id": "d6d52702-d5d9-45bd-bb6a-1eb2b511608c", "ref_id": "foo_value_79c24697-12b6-43cd-94db-dc27776f227a", "title": "Ea nisi ut perferendis.", "description": "Animi optio est. In sit ullam. Qui nulla rerum.", "value_type": "number", "default_value": "0.10661548975473711", "type": "value_definition" }, { "id": "7969ff9e-aff6-4bae-9510-828991c67eab", "ref_id": "foo_value_a10d5315-bd45-4030-86ec-4139693a16d4", "title": "Eligendi cumque enim in.", "description": "Qui reiciendis aut. Molestiae sapiente quisquam. Ut quo ut.", "value_type": "number", "default_value": "0.39194512281857097", "type": "value_definition" }, { "id": "8a04b148-e58b-47fa-b57b-74cf8084c513", "ref_id": "foo_value_3e3fb4fd-fb5e-440a-aab6-e9accf7bc2df", "title": "Eligendi eum et et.", "description": "Fugiat inventore rerum. Modi quo dolorem. Necessitatibus accusantium quia.", "value_type": "number", "default_value": "0.2420487614837339", "type": "value_definition" }, { "id": "1ea8d3f9-5782-4b02-83ce-f82e007c810c", "ref_id": "foo_value_4d44e57b-081b-4610-a403-ff64caab3920", "title": "Eos esse quia ipsa.", "description": "Amet et doloremque. Sunt nisi quod. Quasi culpa impedit.", "value_type": "number", "default_value": "0.8451160416410493", "type": "value_definition" }, { "id": "800d4f7b-8d47-4335-a777-d2473091838c", "ref_id": "foo_value_36a87b4a-b00b-407e-bf88-bde2d1711e39", "title": "Et optio sit est.", "description": "Quo beatae est. Architecto eveniet fuga. Eum tempora inventore.", "value_type": "number", "default_value": "0.8088034353283782", "type": "value_definition" } ], "meta": { "total": 25, "limit": 10, "offset": 0, "sort_by": "title" }, "links": { "first": "/api/compliance/v2/security_guides/a5e9c799-9c62-4e0c-bd0c-9afb0744c1c0/value_definitions?limit=10&offset=0&sort_by=title", "last": "/api/compliance/v2/security_guides/a5e9c799-9c62-4e0c-bd0c-9afb0744c1c0/value_definitions?limit=10&offset=20&sort_by=title", "next": "/api/compliance/v2/security_guides/a5e9c799-9c62-4e0c-bd0c-9afb0744c1c0/value_definitions?limit=10&offset=10&sort_by=title" } }, "summary": "", "description": "" }, "List of Value Definitions filtered by '(title=Fuga dignissimos recusandae est.)'": { "value": { "data": [ { "id": "06ba5996-254f-4aca-9469-56d5bfae6aa7", "ref_id": "foo_value_39258b97-b7a8-4ba7-bd22-b374e8a17a6d", "title": "Fuga dignissimos recusandae est.", "description": "Facilis consequatur aut. Dolores accusamus possimus. Corrupti voluptatem dignissimos.", "value_type": "number", "default_value": "0.5301827010944175", "type": "value_definition" } ], "meta": { "total": 1, "filter": "(title=\"Fuga dignissimos recusandae est.\")", "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/security_guides/a2dbe1f7-4695-4e26-a76c-c174b73bb05b/value_definitions?filter=%28title%3D%22Fuga+dignissimos+recusandae+est.%22%29&limit=10&offset=0", "last": "/api/compliance/v2/security_guides/a2dbe1f7-4695-4e26-a76c-c174b73bb05b/value_definitions?filter=%28title%3D%22Fuga+dignissimos+recusandae+est.%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": "238d4ebc-9a19-4fd3-9d5b-9269f87cec47", "ref_id": "foo_value_f491fe0f-1ccf-4fe7-a758-0fe8337dacac", "title": "Rerum quidem similique consequatur.", "description": "Sunt vitae aut. Qui vitae officiis. Natus saepe architecto.", "value_type": "number", "default_value": "0.7532810494923049", "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 d2cdf695-0fbc-48fd-9fd4-fcd4ad8c4c15" ] }, "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. Not visible under the Systems endpoint.", "readOnly": true }, "compliant_system_count": { "type": "number", "minium": 0, "examples": [ 21 ], "description": "The number of compliant Systems in this Report. Inconsistent under the Systems endpoint.", "readOnly": true }, "all_systems_exposed": { "type": "boolean", "description": "Informs if the user has access to all the Systems under the Report. \\\n Inconsistent under the Systems endpoint.", "examples": [ false ], "readOnly": true }, "unsupported_system_count": { "type": "number", "minium": 0, "examples": [ 3 ], "description": "The number of unsupported Systems in this Report. \\\n Inconsistent under the Systems endpoint.", "readOnly": true }, "reported_system_count": { "type": "number", "minium": 0, "examples": [ 3 ], "description": "The number of Systems in this Report that have Test Results available. \\\n Inconsistent under the Systems endpoint.", "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": [ { "2680746f-ba5d-4735-824e-fe694092b843": "foo", "e93e6130-4906-4b3b-9a49-843217192846": "123", "840ca0ff-3af1-4e1e-96dc-56a5449a769a": "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" } ] }