{ "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": "0aef59f7-5aac-4614-9346-cc72723eface", "title": "Maiores sunt quos et.", "description": "Quia cupiditate quis. Rerum modi consequuntur. Voluptatem provident ullam.", "business_objective": null, "compliance_threshold": 24.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Quam voluptas eum iste.", "ref_id": "xccdf_org.ssgproject.content_profile_7df4b808ec42b3692cda3bac1713260b" }, { "id": "16114f64-f623-471c-b04e-12586c301e14", "title": "Repellat at reprehenderit harum.", "description": "Quam necessitatibus recusandae. Ut quae quisquam. Explicabo quae vel.", "business_objective": null, "compliance_threshold": 21.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Nam delectus qui rerum.", "ref_id": "xccdf_org.ssgproject.content_profile_1e51f6f4679ce47508c6ce9d2ed0a8e9" }, { "id": "18175462-2ae5-4f46-8430-2e73c06aa760", "title": "Et odit dolorem magni.", "description": "Non saepe exercitationem. Natus ut reiciendis. Deserunt qui consequatur.", "business_objective": null, "compliance_threshold": 29.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Voluptatem qui iste est.", "ref_id": "xccdf_org.ssgproject.content_profile_301035df51e2f8756483224ee4ef7d2c" }, { "id": "2661b423-d86f-4193-bcc7-36f9c6466e3b", "title": "Labore minus quis deserunt.", "description": "Est dicta ut. Omnis libero ea. Dignissimos et in.", "business_objective": null, "compliance_threshold": 89.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Quisquam aliquam quis ducimus.", "ref_id": "xccdf_org.ssgproject.content_profile_6b2a26e4f036aaebef129114ebaf37b5" }, { "id": "2709efbe-184f-4290-b9f6-ff577a9b7a5e", "title": "Et voluptatum est aut.", "description": "Facilis ratione tempora. Voluptates est eos. Occaecati tenetur dolores.", "business_objective": null, "compliance_threshold": 12.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Qui autem id id.", "ref_id": "xccdf_org.ssgproject.content_profile_e8e17ff81d6b5c8b01481c13c851c1db" }, { "id": "2cbfaa94-775b-4cad-b408-a05b6f53f144", "title": "Quam est aut deserunt.", "description": "Velit explicabo maiores. Laboriosam veniam rerum. Commodi et ut.", "business_objective": null, "compliance_threshold": 90.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Pariatur nam et sequi.", "ref_id": "xccdf_org.ssgproject.content_profile_e45e56b6ca8fc23d5fa2bc4a49b19e22" }, { "id": "30cc7e98-54ab-433d-8dc1-e6822941a956", "title": "Aut ratione delectus beatae.", "description": "Molestias totam animi. Magni vitae non. Perspiciatis eos et.", "business_objective": null, "compliance_threshold": 27.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Non voluptatem possimus non.", "ref_id": "xccdf_org.ssgproject.content_profile_65f600924dbf8d9af413cd221d1f462d" }, { "id": "31afdcbc-653c-451a-904c-6425c9c4bd69", "title": "Perspiciatis provident reprehenderit ducimus.", "description": "Excepturi sit sapiente. Perferendis fugit impedit. Porro rerum mollitia.", "business_objective": null, "compliance_threshold": 62.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Natus nisi sed qui.", "ref_id": "xccdf_org.ssgproject.content_profile_c50c7ed64e711e0b5c376579ac9d321f" }, { "id": "34572b3a-4c91-4479-8f94-65d73351e559", "title": "Aperiam est quasi repudiandae.", "description": "Qui alias sit. Recusandae beatae et. Nihil et et.", "business_objective": null, "compliance_threshold": 13.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Ex rerum asperiores molestiae.", "ref_id": "xccdf_org.ssgproject.content_profile_e6e5d11ad98f0198f13d2cbfcb43b5a2" }, { "id": "36f96798-e0c1-40bf-89da-5ada9ba4ce17", "title": "Modi itaque dolorum delectus.", "description": "Reprehenderit qui et. Debitis nihil sit. Aspernatur ut minus.", "business_objective": null, "compliance_threshold": 44.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Rerum rem placeat cupiditate.", "ref_id": "xccdf_org.ssgproject.content_profile_0872cd6091ad51d082384e16e50d7cce" } ], "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": "04e247e5-fd9b-4f00-80ff-9e534a4ba19c", "title": "Dolorum cumque culpa odit.", "description": "Ut ut similique. Facilis illo ipsa. Facere mollitia aspernatur.", "business_objective": null, "compliance_threshold": 18.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Voluptatem modi maiores neque.", "ref_id": "xccdf_org.ssgproject.content_profile_411ebd096aafa4af48be5d2aabbac684" }, { "id": "073818bc-e4a5-49a7-b06f-fa7a08640c64", "title": "Unde voluptates quia aut.", "description": "Dolorem ullam molestiae. Qui sit consequuntur. Quis error neque.", "business_objective": null, "compliance_threshold": 86.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Perspiciatis accusantium sunt nam.", "ref_id": "xccdf_org.ssgproject.content_profile_0de4dc72276aab82b68af219c3418531" }, { "id": "1cff06a1-61d0-4200-93ba-e466b3c93e3f", "title": "Non illum dolor expedita.", "description": "Sunt dignissimos debitis. Iure temporibus eligendi. Aperiam ut deleniti.", "business_objective": null, "compliance_threshold": 71.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Earum et nihil quia.", "ref_id": "xccdf_org.ssgproject.content_profile_bb6287a5729ffd55fee99b2b389848e3" }, { "id": "2189d96c-991f-47ef-bdbf-86b009b3b757", "title": "Laborum quia optio voluptatibus.", "description": "Eveniet nemo eius. Quos et consequatur. Aut vero quibusdam.", "business_objective": null, "compliance_threshold": 85.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Sapiente pariatur omnis blanditiis.", "ref_id": "xccdf_org.ssgproject.content_profile_5af3adb6287a78a1f0f3d702f7ec741e" }, { "id": "23e9562d-b9ae-4f45-8b16-81f491dcc564", "title": "Quia eum aut similique.", "description": "Qui voluptatibus nesciunt. Hic ut aut. Provident fuga libero.", "business_objective": null, "compliance_threshold": 33.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Autem sit eligendi placeat.", "ref_id": "xccdf_org.ssgproject.content_profile_9c4d69808ecf013e6b5a43bdc1c5a48d" }, { "id": "27b5eaf7-cc20-4fc8-be46-3e4ec6544bf7", "title": "Sed aut doloribus aspernatur.", "description": "Et ducimus consequatur. Voluptate autem iusto. Doloremque accusamus labore.", "business_objective": null, "compliance_threshold": 83.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Nihil ipsa fuga laborum.", "ref_id": "xccdf_org.ssgproject.content_profile_5831afccbbcb06df7211d7d02efdcc9b" }, { "id": "2fba4a27-ecf8-466f-80d3-26474430047a", "title": "Iusto qui commodi sint.", "description": "Nostrum id quia. Quasi incidunt officiis. Quaerat non iure.", "business_objective": null, "compliance_threshold": 7.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Ullam dolorem dolor rem.", "ref_id": "xccdf_org.ssgproject.content_profile_64060000bd8adf69b8dcc7d1de67d10f" }, { "id": "32f0a4d1-7dfc-422c-986d-352526046d16", "title": "Possimus cum quos pariatur.", "description": "Architecto nobis veniam. Voluptatem facere voluptate. Quis voluptates ut.", "business_objective": null, "compliance_threshold": 71.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Quisquam nihil et rerum.", "ref_id": "xccdf_org.ssgproject.content_profile_a6fdad4e61f45eded822d3ba9ba1a4b4" }, { "id": "34021287-4a17-41b6-81e5-ea28388ff0b9", "title": "Quia repellendus quia voluptas.", "description": "Incidunt et debitis. Ut ipsa laboriosam. Ut dicta et.", "business_objective": null, "compliance_threshold": 80.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Eveniet est voluptatem accusantium.", "ref_id": "xccdf_org.ssgproject.content_profile_1fb876d87ccc8e3e1ac79e40e5de7758" }, { "id": "3e9ba4af-73e2-4254-a441-dda05f2ebf68", "title": "Quidem est vel qui.", "description": "Dolorem libero ut. Ipsam magni sint. Aut quidem est.", "business_objective": null, "compliance_threshold": 70.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Dicta a voluptatibus rem.", "ref_id": "xccdf_org.ssgproject.content_profile_45b13b752789ae3201d5675ef9ecebfb" } ], "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": "5666da40-a302-4d34-9da5-62af457a168a", "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": "Sed distinctio quia nihil.", "ref_id": "xccdf_org.ssgproject.content_profile_1b9f1caa0965033a01793fa5231c7ad1" } }, "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": "798a9ee1-4dff-4316-a536-59b283b33901", "title": "Et voluptatibus dolores cum.", "description": "Repellendus laboriosam tempora. Itaque ut quisquam. Incidunt reiciendis iste.", "business_objective": null, "compliance_threshold": 9.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Atque enim est magni.", "ref_id": "xccdf_org.ssgproject.content_profile_2750dd8208bfe3bceaab0a64d63c1796" } }, "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 b91e15b6-7cf1-4bd6-8add-6edcc4769cc8" ] }, "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": "3a5a634e-1d12-4eca-a073-93781384b3ed", "title": "Sit perferendis fugiat fugit.", "description": "Animi error sunt. Magnam soluta quis. Magni est esse.", "business_objective": null, "compliance_threshold": 100.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Et eum est beatae.", "ref_id": "xccdf_org.ssgproject.content_profile_a089488092364d0b1afbc8dee2c270a8" } }, "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": "e066629a-f9d7-44c4-9aeb-e0e8249fb270", "title": "Accusamus non consequatur facere.", "description": "Voluptate porro et. Voluptates nobis nostrum. Voluptatum dolores velit.", "business_objective": null, "compliance_threshold": 18.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Ea quia iusto dignissimos.", "ref_id": "xccdf_org.ssgproject.content_profile_1a601f6d84f94a2dad0c71155ff571c8" } }, "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": "171e6813-9160-44b8-9c40-63e918662932", "title": "Consequatur fugiat incidunt perspiciatis.", "description": "Exercitationem ut quam. Voluptates repellendus nostrum. Saepe adipisci molestias.", "business_objective": null, "compliance_threshold": 2.0, "total_system_count": 1, "type": "policy", "os_major_version": 7, "profile_title": "Autem et sapiente rerum.", "ref_id": "xccdf_org.ssgproject.content_profile_48b11f1070adff49b656ce94b024a5b5" }, { "id": "21ba7219-0e3d-40dc-844f-e996e32a5b39", "title": "Autem nisi non qui.", "description": "Dolores ipsum ut. Praesentium consequuntur qui. Magni ut ut.", "business_objective": null, "compliance_threshold": 46.0, "total_system_count": 1, "type": "policy", "os_major_version": 7, "profile_title": "Odit earum reiciendis provident.", "ref_id": "xccdf_org.ssgproject.content_profile_1f4633572e8003024f176b975034fef4" }, { "id": "2d384102-4937-4308-8ba9-64c760403039", "title": "Rerum voluptatem et eaque.", "description": "Natus similique architecto. Necessitatibus modi reiciendis. Soluta omnis at.", "business_objective": null, "compliance_threshold": 55.0, "total_system_count": 1, "type": "policy", "os_major_version": 7, "profile_title": "Aut omnis ad qui.", "ref_id": "xccdf_org.ssgproject.content_profile_43829a2cddb4b7fb684d57b47bf7eef4" }, { "id": "2fd38abe-75eb-450e-9f45-1684bbf370cc", "title": "Earum rerum nemo sed.", "description": "Quia optio est. Rerum assumenda ratione. Iusto rerum autem.", "business_objective": null, "compliance_threshold": 25.0, "total_system_count": 1, "type": "policy", "os_major_version": 7, "profile_title": "Rerum occaecati alias quam.", "ref_id": "xccdf_org.ssgproject.content_profile_2c53fc185f4e88f57cca730d51c85f0a" }, { "id": "36b2bc7b-82d7-4359-b4ff-3c82c6c82c1c", "title": "Cumque aspernatur ipsa officia.", "description": "Repellendus porro iusto. Ipsum et id. Vel tempora minima.", "business_objective": null, "compliance_threshold": 48.0, "total_system_count": 1, "type": "policy", "os_major_version": 7, "profile_title": "Dolorum totam repellendus non.", "ref_id": "xccdf_org.ssgproject.content_profile_0f294cdc28dfde6e68acb85bee089d95" }, { "id": "52eb5258-e423-4138-8bda-223c7898889c", "title": "Harum sed consequatur cumque.", "description": "Molestias officiis praesentium. Aut et voluptas. Tenetur et ratione.", "business_objective": null, "compliance_threshold": 50.0, "total_system_count": 1, "type": "policy", "os_major_version": 7, "profile_title": "Quo possimus temporibus quis.", "ref_id": "xccdf_org.ssgproject.content_profile_bd42968507dd661c58c974a92bb4a505" }, { "id": "5eb1eef7-b84d-46f6-8a66-81fd9a74c819", "title": "Amet molestias suscipit eos.", "description": "Eos sit eligendi. Necessitatibus distinctio error. Debitis id qui.", "business_objective": null, "compliance_threshold": 82.0, "total_system_count": 1, "type": "policy", "os_major_version": 7, "profile_title": "Quae provident aliquid eos.", "ref_id": "xccdf_org.ssgproject.content_profile_9c170e8a7736e2dc5698ad3c897f1302" }, { "id": "6225dfcb-8182-4e4a-8a6e-f218e63fa342", "title": "Iure hic et inventore.", "description": "Tempore eveniet quia. Ex deserunt facilis. Sit dolore odit.", "business_objective": null, "compliance_threshold": 88.0, "total_system_count": 1, "type": "policy", "os_major_version": 7, "profile_title": "Velit quod commodi dolorem.", "ref_id": "xccdf_org.ssgproject.content_profile_48ee54866283803b04bdaa60b0a483fd" }, { "id": "6457bba8-3fab-4372-95e9-62ed9b54f06a", "title": "In earum temporibus nulla.", "description": "Rerum alias mollitia. Similique id ea. Optio aliquam commodi.", "business_objective": null, "compliance_threshold": 13.0, "total_system_count": 1, "type": "policy", "os_major_version": 7, "profile_title": "Consequuntur aut dicta velit.", "ref_id": "xccdf_org.ssgproject.content_profile_63d15f20d7dafd49220fe6bba561f308" }, { "id": "69f94194-0eb9-485e-9913-910b72928989", "title": "Nemo consequatur dolore nihil.", "description": "Consequatur temporibus dicta. Consequuntur facere harum. Corrupti voluptas temporibus.", "business_objective": null, "compliance_threshold": 49.0, "total_system_count": 1, "type": "policy", "os_major_version": 7, "profile_title": "Illum vero sit doloribus.", "ref_id": "xccdf_org.ssgproject.content_profile_3f1834b2eda537af769a452bb5779eca" } ], "meta": { "total": 25, "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/systems/5090ca71-8bfc-4a20-8038-dd678a7498ad/policies?limit=10&offset=0", "last": "/api/compliance/v2/systems/5090ca71-8bfc-4a20-8038-dd678a7498ad/policies?limit=10&offset=20", "next": "/api/compliance/v2/systems/5090ca71-8bfc-4a20-8038-dd678a7498ad/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": "02634e33-878a-4f13-9457-28a61a8eefa2", "ref_id": "xccdf_org.ssgproject.content_profile_4a52b138f1c8f1fdae876cc3c8f716f4", "title": "Illum aspernatur dicta aut.", "description": "Cum iure pariatur. Consequuntur cupiditate eaque. Sed nisi eligendi.", "value_overrides": {}, "type": "profile" }, { "id": "0ac486e2-b9bf-4fc9-9f10-3335869a3a45", "ref_id": "xccdf_org.ssgproject.content_profile_d2b0ec443fea7e27438b398a7a6eff3d", "title": "Aut rerum doloremque est.", "description": "Expedita dicta similique. Accusantium in impedit. Ipsam magnam hic.", "value_overrides": {}, "type": "profile" }, { "id": "219c1916-a451-460c-9b16-74095a9eeed1", "ref_id": "xccdf_org.ssgproject.content_profile_ad9035b7254506ba179e0703a44e8744", "title": "Et ducimus minus saepe.", "description": "Qui magnam sed. Nihil rem mollitia. Veritatis deleniti recusandae.", "value_overrides": {}, "type": "profile" }, { "id": "2f54df73-18c5-40be-beca-d5f2db07bc71", "ref_id": "xccdf_org.ssgproject.content_profile_8b96ef62861a8943fb1fea9df6461f1a", "title": "Sit aspernatur est saepe.", "description": "Fugit voluptatem aperiam. Sit itaque quam. Qui quia molestiae.", "value_overrides": {}, "type": "profile" }, { "id": "52ab0c0d-3142-49dc-b2a8-566b0ffe6c6b", "ref_id": "xccdf_org.ssgproject.content_profile_eb871a77a1e948193b236ba1dfffb19f", "title": "Ad et beatae accusantium.", "description": "Voluptatem voluptas laborum. Omnis est repellat. Molestias velit accusantium.", "value_overrides": {}, "type": "profile" }, { "id": "5481fc11-6bfd-4170-b164-ac33f65e018a", "ref_id": "xccdf_org.ssgproject.content_profile_bedfc52d32d5653741cd02f3634393eb", "title": "Perferendis et incidunt at.", "description": "Voluptate eum fugit. Ab alias assumenda. Autem quas numquam.", "value_overrides": {}, "type": "profile" }, { "id": "58b97ed6-1850-459f-badb-bbb375311f40", "ref_id": "xccdf_org.ssgproject.content_profile_3381f1ac22b4588db9e7ead2cc5a5530", "title": "Deserunt assumenda tempora aut.", "description": "Quas ut est. Maiores ut fugiat. Dolores sit quo.", "value_overrides": {}, "type": "profile" }, { "id": "67ff27d6-e897-44b6-bea7-db4a31417a2f", "ref_id": "xccdf_org.ssgproject.content_profile_ef52ac71e7310d6696e4889ebc308f44", "title": "Quia est eius adipisci.", "description": "Beatae eius a. Ut fugit facilis. Perspiciatis illum quia.", "value_overrides": {}, "type": "profile" }, { "id": "740c9d10-b9b3-49ae-8cf3-4f92b6c0ea51", "ref_id": "xccdf_org.ssgproject.content_profile_e1d8d2268ce32872eb3d1dab34d70cb0", "title": "Dolorum nihil asperiores dolor.", "description": "Et consectetur voluptatem. Non illo tenetur. Ut veniam esse.", "value_overrides": {}, "type": "profile" }, { "id": "7cc7047a-f8f2-4e85-a8d5-8d0138e7dbcb", "ref_id": "xccdf_org.ssgproject.content_profile_ac12ab0843dd12fe54bd972f895b555a", "title": "Quo temporibus minima est.", "description": "Eveniet dignissimos incidunt. Tenetur quia dignissimos. Qui id quia.", "value_overrides": {}, "type": "profile" } ], "meta": { "total": 25, "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/security_guides/0f79628a-f201-486a-96db-434eeab4db5a/profiles?limit=10&offset=0", "last": "/api/compliance/v2/security_guides/0f79628a-f201-486a-96db-434eeab4db5a/profiles?limit=10&offset=20", "next": "/api/compliance/v2/security_guides/0f79628a-f201-486a-96db-434eeab4db5a/profiles?limit=10&offset=10" } }, "summary": "", "description": "" }, "List of Profiles sorted by \"title:asc\"": { "value": { "data": [ { "id": "3fd54e05-93f2-426f-8c54-9137f019c5f3", "ref_id": "xccdf_org.ssgproject.content_profile_77d03e6b6077f69efd8401e0ae0cf438", "title": "Ab aut nihil dolor.", "description": "Expedita repudiandae sunt. Soluta tenetur expedita. Tempore ipsa corporis.", "value_overrides": {}, "type": "profile" }, { "id": "6875cf9f-3a9c-4df7-ab8c-2113a5c7b420", "ref_id": "xccdf_org.ssgproject.content_profile_5f7435ce6574cedccf72e8ac31f95a15", "title": "Aut nihil optio iste.", "description": "Similique modi et. Eum natus quaerat. Est aliquam similique.", "value_overrides": {}, "type": "profile" }, { "id": "dea801a3-5732-494e-87cf-89c4ce9146a8", "ref_id": "xccdf_org.ssgproject.content_profile_2153f6275650c0491085b79ea3264e62", "title": "Deserunt illo natus qui.", "description": "Impedit repudiandae voluptatibus. In tempora eaque. Voluptatibus libero consequuntur.", "value_overrides": {}, "type": "profile" }, { "id": "f6820d61-6b0a-44d7-b174-5d3b244d8fd2", "ref_id": "xccdf_org.ssgproject.content_profile_b70e43a998b924ded89a4e0d3b13e101", "title": "Dolores doloribus aut labore.", "description": "Consequatur molestias quis. Porro dolor sed. Et perferendis eius.", "value_overrides": {}, "type": "profile" }, { "id": "c769a442-b3a2-4440-bc02-c6ee7bfd3aea", "ref_id": "xccdf_org.ssgproject.content_profile_acc33de1ee26b6dd0b37f29809e89bab", "title": "Ducimus inventore quod voluptatem.", "description": "Minima culpa aut. Accusantium nostrum dolorum. Et porro repellendus.", "value_overrides": {}, "type": "profile" }, { "id": "284a41e4-7305-42e8-b19a-aeef1fca9837", "ref_id": "xccdf_org.ssgproject.content_profile_bc9c088d630b637b3c6686daff7d267f", "title": "Enim aut esse accusantium.", "description": "Corrupti explicabo dicta. Voluptatem minus quis. Est architecto aliquam.", "value_overrides": {}, "type": "profile" }, { "id": "c6f93562-e43b-4894-ba99-3e6657ae5853", "ref_id": "xccdf_org.ssgproject.content_profile_611318cefff27e62dabe0725474f0803", "title": "Facere sunt quasi distinctio.", "description": "Aut aut quia. Harum quam cupiditate. Beatae non dolore.", "value_overrides": {}, "type": "profile" }, { "id": "00e6f5cd-2b2c-497b-8c30-57f080e5b19c", "ref_id": "xccdf_org.ssgproject.content_profile_57e0f518b7df1d6ecb387d666993b4c9", "title": "Fugiat facere voluptatem nemo.", "description": "Et labore nemo. Ex officia sequi. Pariatur ducimus fuga.", "value_overrides": {}, "type": "profile" }, { "id": "8d060097-e439-4aac-9a80-e8257335ede3", "ref_id": "xccdf_org.ssgproject.content_profile_49c2f661799cca262dbb6a0296beeb22", "title": "Fugit dignissimos excepturi culpa.", "description": "Non voluptatem perspiciatis. Dolorum soluta accusamus. Harum tempore dolorem.", "value_overrides": {}, "type": "profile" }, { "id": "471c1b53-b2f7-4369-be79-db9642459093", "ref_id": "xccdf_org.ssgproject.content_profile_0d34aed1333dad59ac05a8729f1a2a62", "title": "In et dolores vel.", "description": "Quia nobis natus. Similique saepe non. Numquam maxime laborum.", "value_overrides": {}, "type": "profile" } ], "meta": { "total": 25, "limit": 10, "offset": 0, "sort_by": "title" }, "links": { "first": "/api/compliance/v2/security_guides/e998d0ee-9028-43cd-87d3-d6fdd088c6a8/profiles?limit=10&offset=0&sort_by=title", "last": "/api/compliance/v2/security_guides/e998d0ee-9028-43cd-87d3-d6fdd088c6a8/profiles?limit=10&offset=20&sort_by=title", "next": "/api/compliance/v2/security_guides/e998d0ee-9028-43cd-87d3-d6fdd088c6a8/profiles?limit=10&offset=10&sort_by=title" } }, "summary": "", "description": "" }, "List of Profiles filtered by '(title=Delectus quia impedit et.)'": { "value": { "data": [ { "id": "10ecc052-24a2-47f5-ab39-a7c5e020aa73", "ref_id": "xccdf_org.ssgproject.content_profile_8787f3d5aa9d9e39c4015ffc371a944c", "title": "Delectus quia impedit et.", "description": "Laudantium consequuntur qui. Architecto qui fugit. Sapiente impedit odio.", "value_overrides": {}, "type": "profile" } ], "meta": { "total": 1, "filter": "(title=\"Delectus quia impedit et.\")", "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/security_guides/a2746af1-2cef-4f8f-a99b-18ac00fff9fb/profiles?filter=%28title%3D%22Delectus+quia+impedit+et.%22%29&limit=10&offset=0", "last": "/api/compliance/v2/security_guides/a2746af1-2cef-4f8f-a99b-18ac00fff9fb/profiles?filter=%28title%3D%22Delectus+quia+impedit+et.%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": "85d5e0de-b746-4c50-a630-015f18c1c84b", "ref_id": "xccdf_org.ssgproject.content_profile_e48b4d97035e52abb08ce63a03ff4485", "title": "Asperiores est qui assumenda.", "description": "Saepe enim omnis. Voluptatem molestiae fugit. Modi eius et.", "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 a7acc7ca-5aff-4952-94a7-209c693d0e83" ] }, "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": "7e9393c8-3a8b-40c6-a929-2f4887457b23", "type": "rule_group", "children": [ { "id": "da39b210-b097-4c50-a44d-fb6d01863612", "type": "rule" } ] }, { "id": "45fb501e-e228-4d14-ba23-1a40bce4d8b0", "type": "rule_group", "children": [ { "id": "04825988-9691-4099-b6bd-54eccd7d338d", "type": "rule" } ] }, { "id": "d9fe2525-c6b6-4d57-817b-0456c09ee781", "type": "rule_group", "children": [ { "id": "6093118b-4308-4a8e-8a08-dc283cef6dce", "type": "rule" } ] }, { "id": "7357b6f7-effe-40c3-9c41-6ad035810477", "type": "rule_group", "children": [ { "id": "1ed667f3-5c25-42c2-935e-c8a0c046d4a5", "type": "rule" } ] }, { "id": "bbdc225e-f46a-4874-9e7f-6b8a8cddc721", "type": "rule_group", "children": [ { "id": "aa5c2c3b-953d-4cd2-be35-f33c0afe9fcd", "type": "rule" } ] }, { "id": "c28e7dbf-3ecb-4b5a-a59c-cd4ba2873729", "type": "rule_group", "children": [ { "id": "1f5a96eb-a2ed-43e8-8416-14f5f49ccb35", "type": "rule" } ] }, { "id": "d26e18a7-2918-43a6-8b25-d2ec3946d268", "type": "rule_group", "children": [ { "id": "1801298a-9b54-4553-b532-73063c75c951", "type": "rule" } ] }, { "id": "c57b9d6d-c46b-4498-a0db-303595abea07", "type": "rule_group", "children": [ { "id": "5d96deeb-3369-4d06-9065-77cf45410a60", "type": "rule" } ] }, { "id": "f0777a8e-fbc0-412e-815c-397ebaf3724a", "type": "rule_group", "children": [ { "id": "2000a8b6-0b24-4b2f-bfee-f6adcb2b1d19", "type": "rule" } ] }, { "id": "4179cd23-8308-4933-954d-00c0362c2b24", "type": "rule_group", "children": [ { "id": "3ef28b8e-ca2a-46bf-8316-c437904a0c61", "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 fd37ca20-4bf6-4d3c-b7be-5ddedfaaf1fc" ] }, "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": "689f537f-2b70-4fb6-b424-b14953c87c48", "title": "Iste est at tempore.", "description": "Harum quaerat neque. Dolorem sit qui. Tempore qui praesentium.", "business_objective": "matrix", "compliance_threshold": 90.0, "type": "report", "os_major_version": 8, "profile_title": "A aut dolorum id.", "ref_id": "xccdf_org.ssgproject.content_profile_788fdf94a1646efa05a8c3e03aba5911", "all_systems_exposed": true, "percent_compliant": 25, "assigned_system_count": 4, "compliant_system_count": 1, "unsupported_system_count": 2, "reported_system_count": 4 }, { "id": "7b29ef42-a3b9-4c77-94fe-78600f9e5dee", "title": "Sint sed repellendus fugiat.", "description": "Expedita sint consequatur. Dolores et tempore. Et distinctio ut.", "business_objective": "transmitter", "compliance_threshold": 90.0, "type": "report", "os_major_version": 8, "profile_title": "Sed qui et quam.", "ref_id": "xccdf_org.ssgproject.content_profile_793151f9a5c0f346f17ad1c5f2b68bc5", "all_systems_exposed": true, "percent_compliant": 25, "assigned_system_count": 4, "compliant_system_count": 1, "unsupported_system_count": 2, "reported_system_count": 4 }, { "id": "a5eb644c-5186-444b-a610-5010f042398e", "title": "Mollitia dolores molestiae consequatur.", "description": "Dicta explicabo id. Ipsam voluptates consequatur. Dolorem dolore totam.", "business_objective": "port", "compliance_threshold": 90.0, "type": "report", "os_major_version": 8, "profile_title": "Dicta blanditiis cum tempore.", "ref_id": "xccdf_org.ssgproject.content_profile_c777e7940ded07dac91968f98a117a46", "all_systems_exposed": true, "percent_compliant": 25, "assigned_system_count": 4, "compliant_system_count": 1, "unsupported_system_count": 2, "reported_system_count": 4 }, { "id": "a8dd26a4-9ab2-4af0-aa4e-cd92941af447", "title": "Quo vel nesciunt expedita.", "description": "Alias vel aliquid. Adipisci nihil consequuntur. Vero nihil quidem.", "business_objective": "card", "compliance_threshold": 90.0, "type": "report", "os_major_version": 8, "profile_title": "Sunt sapiente occaecati illo.", "ref_id": "xccdf_org.ssgproject.content_profile_ccc792a7d436513de7e79c04a3ee98c8", "all_systems_exposed": true, "percent_compliant": 25, "assigned_system_count": 4, "compliant_system_count": 1, "unsupported_system_count": 2, "reported_system_count": 4 }, { "id": "b733adaf-9a84-40ba-9366-4b1ab497d45f", "title": "Est maiores est voluptas.", "description": "Aliquid dolorem aut. Et voluptatem consequatur. Laboriosam eum quisquam.", "business_objective": "firewall", "compliance_threshold": 90.0, "type": "report", "os_major_version": 8, "profile_title": "Accusamus perferendis aliquid voluptatum.", "ref_id": "xccdf_org.ssgproject.content_profile_34a697fd9b2da38dffe90cda4131a7f2", "all_systems_exposed": true, "percent_compliant": 25, "assigned_system_count": 4, "compliant_system_count": 1, "unsupported_system_count": 2, "reported_system_count": 4 } ], "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": "551ad74f-aa50-4e14-8b21-24d793a6164c", "title": "Non et nemo suscipit.", "description": "Quaerat et et. Reprehenderit voluptatem ab. Et sunt ut.", "business_objective": "driver", "compliance_threshold": 90.0, "type": "report", "os_major_version": 8, "profile_title": "Harum ducimus molestiae laboriosam.", "ref_id": "xccdf_org.ssgproject.content_profile_4e630caaabb4e1661654a35b6eb1a067", "all_systems_exposed": true, "percent_compliant": 25, "assigned_system_count": 4, "compliant_system_count": 1, "unsupported_system_count": 2, "reported_system_count": 4 }, { "id": "b174983f-6864-4447-8f8b-a7811f5f8db4", "title": "Rerum et in similique.", "description": "Dolores optio sunt. Voluptatem et ipsum. Et quod nihil.", "business_objective": "matrix", "compliance_threshold": 90.0, "type": "report", "os_major_version": 8, "profile_title": "Non enim maxime inventore.", "ref_id": "xccdf_org.ssgproject.content_profile_49a034de5556425364fc51b85736a177", "all_systems_exposed": true, "percent_compliant": 25, "assigned_system_count": 4, "compliant_system_count": 1, "unsupported_system_count": 2, "reported_system_count": 4 }, { "id": "b64fc37e-ccb3-4f71-a500-dadc86d01f89", "title": "Dicta aperiam consectetur veniam.", "description": "Et quaerat omnis. Eos occaecati maiores. Maiores unde commodi.", "business_objective": "monitor", "compliance_threshold": 90.0, "type": "report", "os_major_version": 8, "profile_title": "Sequi sit autem ipsum.", "ref_id": "xccdf_org.ssgproject.content_profile_2779186bdee8247b917c04f5829b04a1", "all_systems_exposed": true, "percent_compliant": 25, "assigned_system_count": 4, "compliant_system_count": 1, "unsupported_system_count": 2, "reported_system_count": 4 }, { "id": "b986f4af-8dcc-49b1-a105-a8815887ad2d", "title": "Minima error ipsa quidem.", "description": "Ipsum ab ea. Soluta cupiditate praesentium. Quia quis vero.", "business_objective": "monitor", "compliance_threshold": 90.0, "type": "report", "os_major_version": 8, "profile_title": "Fugit magni est laudantium.", "ref_id": "xccdf_org.ssgproject.content_profile_85684217dcaf9ea3696c9308bd428f3e", "all_systems_exposed": true, "percent_compliant": 25, "assigned_system_count": 4, "compliant_system_count": 1, "unsupported_system_count": 2, "reported_system_count": 4 }, { "id": "d9073e82-4549-4edb-812f-4040fa3fa585", "title": "Incidunt unde commodi quae.", "description": "Est maiores aliquid. Doloremque est nobis. Modi nihil magnam.", "business_objective": "port", "compliance_threshold": 90.0, "type": "report", "os_major_version": 8, "profile_title": "Omnis qui et ipsam.", "ref_id": "xccdf_org.ssgproject.content_profile_a34e14a9c5bd4ce4f5f4950e1fbc47d3", "all_systems_exposed": true, "percent_compliant": 25, "assigned_system_count": 4, "compliant_system_count": 1, "unsupported_system_count": 2, "reported_system_count": 4 } ], "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": "38bd6f12-bb1d-448e-aaa5-6c9f5a822f77", "title": "Mollitia architecto minus ut.", "description": "Est explicabo commodi. Enim officia accusantium. Asperiores odit cupiditate.", "business_objective": "feed", "compliance_threshold": 90.0, "type": "report", "os_major_version": 9, "profile_title": "Dolores in atque voluptatem.", "ref_id": "xccdf_org.ssgproject.content_profile_da6c3791047f4d8546ba1f2574bd5cda", "all_systems_exposed": true, "percent_compliant": 25, "assigned_system_count": 4, "compliant_system_count": 1, "unsupported_system_count": 2, "reported_system_count": 4 } }, "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 47d35ae2-582a-42d4-b797-d5a30b6c0afd" ] }, "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": "5f74ce7c-9961-486a-84cb-30a77e5bcc72", "title": "Aut non sed quisquam.", "description": "Voluptas ut velit. Officiis veritatis minima. Eum id est.", "business_objective": "pixel", "compliance_threshold": 90.0, "type": "report", "os_major_version": 9, "profile_title": "Adipisci autem sequi distinctio.", "ref_id": "xccdf_org.ssgproject.content_profile_c396a88fb792eecbe95fd47f837fc4b8", "all_systems_exposed": true, "percent_compliant": 25, "assigned_system_count": 4, "compliant_system_count": 1, "unsupported_system_count": 2, "reported_system_count": 4 } }, "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 5fb02438-cea6-4057-96ef-0b1b875be20f" ] }, "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": "4c83b4a6-4d05-4dd6-994b-6980b3c46742", "title": "Aut quis voluptatem asperiores.", "description": "Et animi et. Quis dolor quos. Et possimus veniam.", "business_objective": "program", "compliance_threshold": 90.0, "type": "report", "os_major_version": 8, "profile_title": "Vel nesciunt nemo maxime.", "ref_id": "xccdf_org.ssgproject.content_profile_a9b71fe53e25afadef9176748478d64c", "all_systems_exposed": false, "percent_compliant": 0, "compliant_system_count": 0, "unsupported_system_count": 0, "reported_system_count": 0 }, { "id": "6627d125-0e9b-4e13-93a9-e53c67d464e5", "title": "Libero quis dicta rerum.", "description": "Et ratione amet. Assumenda molestias cupiditate. Ea quas et.", "business_objective": "card", "compliance_threshold": 90.0, "type": "report", "os_major_version": 8, "profile_title": "Cupiditate est velit dolor.", "ref_id": "xccdf_org.ssgproject.content_profile_5a2c7bc0a9b8d1f38edaebd2f1234faf", "all_systems_exposed": false, "percent_compliant": 0, "compliant_system_count": 0, "unsupported_system_count": 0, "reported_system_count": 0 }, { "id": "8a7ce129-473e-40d6-9498-3cdea9e01afc", "title": "Beatae voluptatem quae voluptatem.", "description": "Error est earum. Magni consequuntur quasi. Ab cum odit.", "business_objective": "hard drive", "compliance_threshold": 90.0, "type": "report", "os_major_version": 8, "profile_title": "Odit nihil vitae dolores.", "ref_id": "xccdf_org.ssgproject.content_profile_9079743385a167ba5a5cfd00e10f06ef", "all_systems_exposed": false, "percent_compliant": 0, "compliant_system_count": 0, "unsupported_system_count": 0, "reported_system_count": 0 }, { "id": "9aac9b71-c889-4a42-b5a2-11a178c7de64", "title": "Eligendi ipsum perferendis facere.", "description": "Officiis ea ducimus. Itaque excepturi aut. Modi itaque esse.", "business_objective": "port", "compliance_threshold": 90.0, "type": "report", "os_major_version": 8, "profile_title": "A iure aliquam eligendi.", "ref_id": "xccdf_org.ssgproject.content_profile_1bf275d1badf0c69bce3296d2ac60443", "all_systems_exposed": false, "percent_compliant": 0, "compliant_system_count": 0, "unsupported_system_count": 0, "reported_system_count": 0 }, { "id": "a757e1cc-0b61-4dec-b974-e1c41384d19c", "title": "A alias ipsam voluptatibus.", "description": "Nam possimus consequatur. Ut culpa sit. Eos vel rerum.", "business_objective": "pixel", "compliance_threshold": 90.0, "type": "report", "os_major_version": 8, "profile_title": "Voluptatibus sint est qui.", "ref_id": "xccdf_org.ssgproject.content_profile_5cb3f27f7f1808c2af93ef2f9853da6f", "all_systems_exposed": false, "percent_compliant": 0, "compliant_system_count": 0, "unsupported_system_count": 0, "reported_system_count": 0 } ], "meta": { "total": 5, "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/systems/6cf60085-1cbc-40ff-9265-e480cd952996/reports?limit=10&offset=0", "last": "/api/compliance/v2/systems/6cf60085-1cbc-40ff-9265-e480cd952996/reports?limit=10&offset=0" } }, "summary": "", "description": "" }, "List of Reports sorted by \"title:asc\"": { "value": { "data": [ { "id": "869b4ff8-3eb2-46d9-ab72-1c7bd0ecc7ad", "title": "Est omnis aut qui.", "description": "Amet eligendi soluta. Et ut harum. Velit aut eveniet.", "business_objective": "interface", "compliance_threshold": 90.0, "type": "report", "os_major_version": 8, "profile_title": "Provident aut est sequi.", "ref_id": "xccdf_org.ssgproject.content_profile_9332b32e7c492853f280cd491162a07d", "all_systems_exposed": false, "percent_compliant": 0, "compliant_system_count": 0, "unsupported_system_count": 0, "reported_system_count": 0 }, { "id": "d95ad1f5-10d2-4f06-ba0d-75570f8cc1c3", "title": "Et repudiandae itaque qui.", "description": "Accusantium eveniet suscipit. Autem maiores accusamus. Ipsam consequatur perferendis.", "business_objective": "hard drive", "compliance_threshold": 90.0, "type": "report", "os_major_version": 8, "profile_title": "Reiciendis in qui molestias.", "ref_id": "xccdf_org.ssgproject.content_profile_5ffdb3a99006a9fe6f70285ed5eaf306", "all_systems_exposed": false, "percent_compliant": 0, "compliant_system_count": 0, "unsupported_system_count": 0, "reported_system_count": 0 }, { "id": "4a246d7c-6db1-44b4-b87a-1e3914a28540", "title": "Excepturi aliquam consequatur ut.", "description": "Vel sunt enim. Voluptatem numquam quisquam. Tempora culpa iure.", "business_objective": "port", "compliance_threshold": 90.0, "type": "report", "os_major_version": 8, "profile_title": "Voluptatum in reiciendis sit.", "ref_id": "xccdf_org.ssgproject.content_profile_b6efda8fbefdc8ac1a8a552e1f7c6fb8", "all_systems_exposed": false, "percent_compliant": 0, "compliant_system_count": 0, "unsupported_system_count": 0, "reported_system_count": 0 }, { "id": "38b2ac69-cd70-4596-9561-e9251b5e33b8", "title": "Hic labore provident minus.", "description": "Qui quos vel. Consequatur harum aliquam. Non corrupti est.", "business_objective": "capacitor", "compliance_threshold": 90.0, "type": "report", "os_major_version": 8, "profile_title": "Molestiae aliquam sapiente consectetur.", "ref_id": "xccdf_org.ssgproject.content_profile_5e5e0c0d25d85124367733cce26c2f3f", "all_systems_exposed": false, "percent_compliant": 0, "compliant_system_count": 0, "unsupported_system_count": 0, "reported_system_count": 0 }, { "id": "12fb16e5-05f6-4bda-906c-808a888d7886", "title": "Laborum quia suscipit illum.", "description": "Qui vel tempore. Similique facilis et. Laboriosam et cum.", "business_objective": "firewall", "compliance_threshold": 90.0, "type": "report", "os_major_version": 8, "profile_title": "Rerum earum natus aperiam.", "ref_id": "xccdf_org.ssgproject.content_profile_3bbe2ba1e232ffccaec18c35e9cfe6a1", "all_systems_exposed": false, "percent_compliant": 0, "compliant_system_count": 0, "unsupported_system_count": 0, "reported_system_count": 0 } ], "meta": { "total": 5, "limit": 10, "offset": 0, "sort_by": "title" }, "links": { "first": "/api/compliance/v2/systems/5102cb2d-d069-44e7-8251-855b920a8bd2/reports?limit=10&offset=0&sort_by=title", "last": "/api/compliance/v2/systems/5102cb2d-d069-44e7-8251-855b920a8bd2/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": "1b2164b8-ec27-4236-a38c-f4d51998b723", "ref_id": "xccdf_org.ssgproject.content_rule_group_59be0d41b47d1136741d752fc94a3d44", "title": "Aut et vero omnis.", "rationale": "In nisi aut. Aut nisi et. Sequi asperiores et.", "description": "Fugit vel veritatis. Itaque ut minima. Distinctio nulla ratione.", "precedence": null, "type": "rule_group" }, { "id": "20cbda89-4b05-416b-991c-25efa37f2a0c", "ref_id": "xccdf_org.ssgproject.content_rule_group_540ff7d72090d4846cb08abcab1bd868", "title": "Qui voluptatem autem itaque.", "rationale": "Aliquam quisquam et. Exercitationem ipsa harum. Pariatur accusantium velit.", "description": "Quasi et aspernatur. Corrupti quas vel. Iste et similique.", "precedence": null, "type": "rule_group" }, { "id": "23f8847e-bb56-409b-9107-fabe069d1f71", "ref_id": "xccdf_org.ssgproject.content_rule_group_e189363ae27e385578d39c1d98ac3331", "title": "Rerum odio aut est.", "rationale": "Sint qui incidunt. Omnis rem voluptatem. Maiores officia voluptas.", "description": "Sapiente natus id. Cum nisi unde. Modi officia non.", "precedence": null, "type": "rule_group" }, { "id": "2a5106ae-0c92-43d0-a3d0-993ea28588d3", "ref_id": "xccdf_org.ssgproject.content_rule_group_413a345b52f3224588828ecdaa96f8bb", "title": "Qui explicabo ut optio.", "rationale": "Deserunt velit et. Quia quia ex. Enim occaecati eum.", "description": "Placeat earum nihil. Ratione provident fugit. Sit beatae inventore.", "precedence": null, "type": "rule_group" }, { "id": "360a37d2-ccde-4f8e-b06f-6842ffc34460", "ref_id": "xccdf_org.ssgproject.content_rule_group_65671dc89b0af9f53324b16ea166f3fb", "title": "Sit omnis reiciendis quas.", "rationale": "Et ratione et. Ad at sint. Veritatis laborum accusamus.", "description": "Voluptatem facilis molestiae. Porro quod ullam. Voluptas enim est.", "precedence": null, "type": "rule_group" }, { "id": "3e21189e-5d48-4c78-ba13-f7808506f427", "ref_id": "xccdf_org.ssgproject.content_rule_group_547ec032f53af80334ffb43a6ef1c630", "title": "Placeat nemo eligendi praesentium.", "rationale": "Dignissimos consequatur sit. Ut non in. Temporibus ipsa et.", "description": "Ipsum quia non. Doloremque aut ut. Neque omnis eum.", "precedence": null, "type": "rule_group" }, { "id": "4a16c40c-0b08-45a0-82a2-458e65350430", "ref_id": "xccdf_org.ssgproject.content_rule_group_f55b8c912247602c2efc3ee5ecbdf132", "title": "Ab magni illum est.", "rationale": "Ducimus quod non. Quibusdam adipisci non. Molestiae culpa aut.", "description": "Quia velit beatae. Porro voluptatibus eum. Accusantium consequatur iste.", "precedence": null, "type": "rule_group" }, { "id": "5505ce06-2fd8-4c2a-b47f-9de4a889841e", "ref_id": "xccdf_org.ssgproject.content_rule_group_4c39accb08fd734e1aa7372b0a2b97c9", "title": "Reprehenderit quibusdam et numquam.", "rationale": "Voluptate consequuntur molestiae. Aspernatur impedit quasi. Magni deserunt est.", "description": "Eius molestiae asperiores. Reiciendis fuga earum. Molestias ipsam autem.", "precedence": null, "type": "rule_group" }, { "id": "60f58260-3459-4d23-80ba-ff1dd7c25333", "ref_id": "xccdf_org.ssgproject.content_rule_group_af51287ced2b22f2cefe78d69a632e1b", "title": "Culpa repellendus magni ut.", "rationale": "Quo error ad. Et quis necessitatibus. Libero iste ut.", "description": "Rerum aliquid ut. Illum vero quasi. Qui sed eius.", "precedence": null, "type": "rule_group" }, { "id": "62ae6b16-e27e-4f61-9585-369f62d689a2", "ref_id": "xccdf_org.ssgproject.content_rule_group_0063552e83bd5ac920e03ce8f1cc50eb", "title": "Quo laborum nihil itaque.", "rationale": "Est dolores pariatur. Blanditiis necessitatibus voluptas. Doloribus maxime ut.", "description": "Et qui libero. Expedita odit mollitia. Quia consequuntur perspiciatis.", "precedence": null, "type": "rule_group" } ], "meta": { "total": 25, "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/security_guides/07d639b2-4a92-42c5-b93a-93ddec69901e/rule_groups?limit=10&offset=0", "last": "/api/compliance/v2/security_guides/07d639b2-4a92-42c5-b93a-93ddec69901e/rule_groups?limit=10&offset=20", "next": "/api/compliance/v2/security_guides/07d639b2-4a92-42c5-b93a-93ddec69901e/rule_groups?limit=10&offset=10" } }, "summary": "", "description": "" }, "List of Rule Groups sorted by \"precedence:asc\"": { "value": { "data": [ { "id": "117fe26b-b27a-43fb-9899-ec5faae878b8", "ref_id": "xccdf_org.ssgproject.content_rule_group_b06cdee9d27b366e4615add6f24c89a6", "title": "Cum reprehenderit dicta voluptatem.", "rationale": "Aut libero et. Corporis placeat cupiditate. Ipsa magnam impedit.", "description": "Et non pariatur. Mollitia a officiis. Est labore ut.", "precedence": null, "type": "rule_group" }, { "id": "1a1c66c2-1c77-4280-b40f-a1d41677c3f8", "ref_id": "xccdf_org.ssgproject.content_rule_group_8ed28885d296b3b613ebd1c7c03fe6be", "title": "Quia blanditiis asperiores quod.", "rationale": "Excepturi molestiae soluta. Accusantium vero quibusdam. Voluptatibus tempore sit.", "description": "Alias rerum temporibus. Quia dignissimos iste. Ullam facere minus.", "precedence": null, "type": "rule_group" }, { "id": "2174490b-f330-4973-83a0-f68b751af2a1", "ref_id": "xccdf_org.ssgproject.content_rule_group_87ba8da18c70949b11b9de52c3c64a67", "title": "Suscipit repellat esse ea.", "rationale": "Sit molestiae fuga. Blanditiis vitae aliquid. Cum sunt aut.", "description": "Maxime consequuntur consequatur. Atque neque ea. Quibusdam et sit.", "precedence": null, "type": "rule_group" }, { "id": "22d49f93-a569-47bf-b3b5-90da3d94e2fd", "ref_id": "xccdf_org.ssgproject.content_rule_group_43911dc60cf1b32af9153320f0517b09", "title": "Corrupti distinctio illum ea.", "rationale": "Quos iure deserunt. Ut deleniti voluptas. Accusamus excepturi in.", "description": "Incidunt aliquid autem. Nobis sit deleniti. Ullam veritatis assumenda.", "precedence": null, "type": "rule_group" }, { "id": "24485846-871a-4fd9-a3e4-fa82ea5e31e1", "ref_id": "xccdf_org.ssgproject.content_rule_group_f459c30ca66ae97b5fab8e6a319d54a7", "title": "Perferendis quidem sed ratione.", "rationale": "Voluptatem assumenda animi. Est dolor quia. Sed qui suscipit.", "description": "Temporibus quasi debitis. Rerum dolorem beatae. Dolores qui perspiciatis.", "precedence": null, "type": "rule_group" }, { "id": "3aa26f33-f16d-428b-8d10-bb21f941f87b", "ref_id": "xccdf_org.ssgproject.content_rule_group_00b903c7cff7ddf99670462f73ada563", "title": "Quis harum veniam tenetur.", "rationale": "Laudantium dolorum hic. Assumenda amet doloribus. Est quis mollitia.", "description": "Modi quia vitae. Natus quam in. Natus explicabo rem.", "precedence": null, "type": "rule_group" }, { "id": "40449fe5-5204-4959-ba82-cd132e247dff", "ref_id": "xccdf_org.ssgproject.content_rule_group_4e3d9a95a7222315d4eafd4fe5854c46", "title": "Voluptas architecto facere mollitia.", "rationale": "Veniam nostrum minima. Quia quia eos. Facere porro mollitia.", "description": "Harum beatae quo. Quasi voluptatem sed. Et sint pariatur.", "precedence": null, "type": "rule_group" }, { "id": "42af0545-7125-4d00-86c1-6e45c6eacb6d", "ref_id": "xccdf_org.ssgproject.content_rule_group_fc5febdb02d5db2446f2d223dd0d7245", "title": "Iusto quia beatae sapiente.", "rationale": "Eaque dicta et. Inventore voluptatibus animi. Et quas nesciunt.", "description": "Dolores voluptas dolores. Voluptatem dolorem iusto. Sit ut voluptatem.", "precedence": null, "type": "rule_group" }, { "id": "48614537-8441-41e9-8769-07882af202a5", "ref_id": "xccdf_org.ssgproject.content_rule_group_5031ce9ec31d8580fd136d2e6f0f05a8", "title": "Unde nam consequatur ut.", "rationale": "Ipsum tenetur ex. Est doloribus similique. Quod ducimus et.", "description": "Voluptatibus fugit et. Neque fugiat et. Qui fugit a.", "precedence": null, "type": "rule_group" }, { "id": "4a84fa35-c0e4-435f-ab15-37bdcc3eb96c", "ref_id": "xccdf_org.ssgproject.content_rule_group_67ce0875341b5edd959ddb68e48e7391", "title": "Itaque expedita fuga nihil.", "rationale": "Voluptates ullam soluta. Et explicabo quidem. Fugit consectetur quasi.", "description": "Molestiae et aperiam. Unde vel ducimus. Fugit perspiciatis voluptatem.", "precedence": null, "type": "rule_group" } ], "meta": { "total": 25, "limit": 10, "offset": 0, "sort_by": "precedence" }, "links": { "first": "/api/compliance/v2/security_guides/565da504-b36b-4e3a-826e-8946b1d33588/rule_groups?limit=10&offset=0&sort_by=precedence", "last": "/api/compliance/v2/security_guides/565da504-b36b-4e3a-826e-8946b1d33588/rule_groups?limit=10&offset=20&sort_by=precedence", "next": "/api/compliance/v2/security_guides/565da504-b36b-4e3a-826e-8946b1d33588/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": "d4e0f85d-7e96-42f3-a812-32f9f664e17e", "ref_id": "xccdf_org.ssgproject.content_rule_group_2dd9a9aa7d4d18476dcacfa7dcaf70ba", "title": "Odio porro amet reiciendis.", "rationale": "Consequatur aliquam facilis. Assumenda possimus corrupti. A tenetur optio.", "description": "Ut ipsum veniam. Facere fugiat non. Facilis officiis excepturi.", "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 cd2259ff-3d67-4a09-9669-d23470d1c305" ] }, "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`, and `rule_group_id`

(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": "ffd28ef6-ad41-49b0-9492-0d4705acd1bd", "result": "fail", "rule_id": "efb91e1f-23e3-4013-b2d2-50b18318a6e3", "type": "rule_result", "system_id": "edfca2a0-197b-42a5-b093-32f36fa1706a", "ref_id": "xccdf_org.ssgproject.content_rule_f3de9d1e4293348dd90d4752f9b2d501", "rule_group_id": "7f6a285f-0bea-4052-a4b6-4cd71915cba4", "title": "Dolorem iusto doloremque iste.", "rationale": "Enim quia voluptas. Atque voluptas eum. Nemo qui et.", "description": "Quasi ipsum delectus. Sed veritatis minima. Reprehenderit ratione blanditiis.", "severity": "medium", "precedence": 6445, "identifier": { "href": "http://weber-considine.example/irene", "label": "Gerda Boffin" }, "references": [ { "href": "http://moore-wolff.test/dorian", "label": "Meneldor" }, { "href": "http://gibson.test/caroline", "label": "Eofor" }, { "href": "http://rowe-rice.example/angel.mckenzie", "label": "Mimosa Bunce" }, { "href": "http://white.example/dorsey", "label": "Telchar" }, { "href": "http://keebler.test/branden", "label": "Gamil Zirak" } ], "remediation_issue_id": null } ], "meta": { "total": 1, "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/reports/12aa91eb-0e82-439c-a68f-0f444bda9748/test_results/29fb6038-c614-4e4e-ba29-b3d3003aa520/rule_results?limit=10&offset=0", "last": "/api/compliance/v2/reports/12aa91eb-0e82-439c-a68f-0f444bda9748/test_results/29fb6038-c614-4e4e-ba29-b3d3003aa520/rule_results?limit=10&offset=0" } }, "summary": "", "description": "" }, "List of Rule Results sorted by \"result:asc\"": { "value": { "data": [ { "id": "3a815034-34c0-43ee-ba31-e98abc290f83", "result": "fail", "rule_id": "ea34901e-6760-48a9-84af-ac33dc132aa4", "type": "rule_result", "system_id": "3ec556b5-0c40-4b72-84f0-4860c7604c47", "ref_id": "xccdf_org.ssgproject.content_rule_d76114d47c8d44fb959cc848b6904cbb", "rule_group_id": "ffca9704-1b7a-4862-9ac7-2de7023b7ce6", "title": "Officiis aperiam et qui.", "rationale": "Fugiat pariatur doloremque. Dolor et sunt. Impedit veritatis delectus.", "description": "Pariatur rem eum. Repudiandae unde ratione. Suscipit qui est.", "severity": "medium", "precedence": 6798, "identifier": { "href": "http://herzog.example/stefanie", "label": "Adamanta Chubb" }, "references": [ { "href": "http://spencer.test/bryant.braun", "label": "Camellia Sackville" }, { "href": "http://koch-schaefer.test/adrien", "label": "Hending" }, { "href": "http://greenholt-hirthe.example/coretta_hoeger", "label": "Gróin" }, { "href": "http://kuhic.example/aurelio.schamberger", "label": "Amarië" }, { "href": "http://marquardt-halvorson.example/romona", "label": "Fastolph Bolger" } ], "remediation_issue_id": null } ], "meta": { "total": 1, "limit": 10, "offset": 0, "sort_by": "result" }, "links": { "first": "/api/compliance/v2/reports/6da3756e-be0d-4153-908c-ea454fb4b5d0/test_results/8cea3417-6541-4d59-afcc-3b69434366fc/rule_results?limit=10&offset=0&sort_by=result", "last": "/api/compliance/v2/reports/6da3756e-be0d-4153-908c-ea454fb4b5d0/test_results/8cea3417-6541-4d59-afcc-3b69434366fc/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/06720f81-984f-4a57-87d9-d505e72424d4/test_results/e769c553-4598-4712-8092-029429941fc0/rule_results?filter=%28title%3Dfoo%29&limit=10&offset=0", "last": "/api/compliance/v2/reports/06720f81-984f-4a57-87d9-d505e72424d4/test_results/e769c553-4598-4712-8092-029429941fc0/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`, and `rule_group_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 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": "006f105f-15a9-48ee-9db2-90fd0edf5576", "ref_id": "xccdf_org.ssgproject.content_rule_8d76bcaec9d91b082ccf61c07645cbad", "title": "Qui est error voluptatum.", "rationale": "Porro harum rem. Ipsum atque qui. Aut ea sed.", "description": "Consequatur sit sed. Et velit consequatur. Accusamus ea sint.", "severity": "high", "precedence": 7491, "identifier": { "href": "http://heathcote.example/art", "label": "Smaug" }, "references": [ { "href": "http://morissette.test/alysha_collier", "label": "Mrs. Maggot" }, { "href": "http://ortiz.example/ronny", "label": "Nellas" }, { "href": "http://langosh.example/hallie_ferry", "label": "Tolman Cotton Junior" }, { "href": "http://abernathy-pollich.example/gennie.upton", "label": "Lorgan" }, { "href": "http://hand.example/necole", "label": "Ivy Goodenough" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "8dc76775-c664-405d-9769-87623d43b810", "type": "rule" }, { "id": "027fe419-efc8-436a-931c-2c4fef9133c5", "ref_id": "xccdf_org.ssgproject.content_rule_c58f9f78660c2d75140e25f565129ee0", "title": "Qui quis quisquam ad.", "rationale": "Temporibus nulla mollitia. Facilis qui quas. Reprehenderit tempore nesciunt.", "description": "Culpa voluptatum voluptatem. Quasi impedit officia. Ut et ratione.", "severity": "high", "precedence": 7851, "identifier": { "href": "http://wunsch.example/colby", "label": "Saradas Brandybuck" }, "references": [ { "href": "http://rempel-breitenberg.example/zoila", "label": "Targon" }, { "href": "http://morissette-rosenbaum.test/tia", "label": "Baldor" }, { "href": "http://leuschke.test/claris.runte", "label": "Egalmoth" }, { "href": "http://schneider.example/parker.schowalter", "label": "Daisy Gamgee" }, { "href": "http://gerlach-ernser.example/ernest", "label": "Ohtar" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "6d4d655b-c0c8-4503-8e8e-df5882595c34", "type": "rule" }, { "id": "039514bb-2d89-4d5e-8b04-13350dd8a575", "ref_id": "xccdf_org.ssgproject.content_rule_9790f96ec88c5400e3a023e4002665cc", "title": "Voluptate occaecati autem iure.", "rationale": "Mollitia dolorem distinctio. Quae velit quo. Quia impedit harum.", "description": "Eius dolore ipsam. Dolores facilis aspernatur. Ea officia natus.", "severity": "low", "precedence": 6339, "identifier": { "href": "http://morar.example/lorene_lubowitz", "label": "Rudolph Bolger" }, "references": [ { "href": "http://leuschke.test/ambrose_gutmann", "label": "Elfwine" }, { "href": "http://donnelly-hudson.example/ricky", "label": "Anardil" }, { "href": "http://welch.example/vanessa_gutkowski", "label": "Bregor" }, { "href": "http://franecki.test/julissa", "label": "Tar-Meneldur" }, { "href": "http://johns.example/german.toy", "label": "Guthláf" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "c0c1b7eb-d2c7-4b4a-8f0e-902ae6aaff34", "type": "rule" }, { "id": "153e1432-a654-47c0-b844-75df7cae7e30", "ref_id": "xccdf_org.ssgproject.content_rule_dfc28edac7ca17bf60edf58b6ea88815", "title": "Eum suscipit et praesentium.", "rationale": "Accusamus sunt ipsum. Ut odio repudiandae. A ratione temporibus.", "description": "Earum est non. Aut porro aut. Sit animi et.", "severity": "low", "precedence": 1107, "identifier": { "href": "http://schamberger.example/oswaldo", "label": "Huan" }, "references": [ { "href": "http://wilderman.example/vernie", "label": "Gundahar Bolger" }, { "href": "http://leannon-dach.test/anjelica", "label": "Amandil" }, { "href": "http://friesen-beer.example/maribel", "label": "Aldamir" }, { "href": "http://stamm-greenholt.example/taylor", "label": "Thorin Stonehelm" }, { "href": "http://oconner.test/brent", "label": "Elanor Gardner" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "0463f755-7e79-4cc2-aaf5-1fe24fe148da", "type": "rule" }, { "id": "1d0e58f2-2ef2-43fe-bd2b-c4cb8b89c42f", "ref_id": "xccdf_org.ssgproject.content_rule_1ad607bb23bada40ff4385fee8b00560", "title": "Quis corporis nobis quo.", "rationale": "Aliquid labore occaecati. Optio est delectus. Repudiandae sint tempora.", "description": "Minima nobis sunt. Inventore ad eius. Sit minus voluptatum.", "severity": "low", "precedence": 3178, "identifier": { "href": "http://lowe.test/denver.romaguera", "label": "Quennar" }, "references": [ { "href": "http://simonis-medhurst.example/jaime_donnelly", "label": "Hallatan" }, { "href": "http://brekke-pollich.test/myron.altenwerth", "label": "Great Eagle" }, { "href": "http://jones.test/carmen.yost", "label": "Cora Goodbody" }, { "href": "http://schmidt.test/alena_ernser", "label": "Bungo Baggins" }, { "href": "http://hahn.test/graham.mclaughlin", "label": "Ceorl" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "ef5795e1-ecd0-4bab-ac74-314215ae35a1", "type": "rule" }, { "id": "3737ed0a-5d1e-4caf-be54-4ff8a40528cf", "ref_id": "xccdf_org.ssgproject.content_rule_4f11ca515e61b1a0535c681cea4ab153", "title": "Corporis provident sit enim.", "rationale": "Dolores expedita quo. Quasi consequatur dolorum. Non ex eaque.", "description": "Non laboriosam nemo. Quisquam cum autem. Aut minus excepturi.", "severity": "high", "precedence": 4661, "identifier": { "href": "http://abshire.test/kelley.crona", "label": "Tolman Gardner" }, "references": [ { "href": "http://konopelski-feest.example/louise", "label": "Elrohir" }, { "href": "http://roberts.test/kathy", "label": "Myrtle Burrows" }, { "href": "http://leuschke.test/fredric", "label": "Saeros" }, { "href": "http://morissette-bins.test/mohammad", "label": "Baragund" }, { "href": "http://torp-dickens.example/jarred", "label": "Primrose Boffin" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "d1806777-0082-4047-9934-e68af8bb44dd", "type": "rule" }, { "id": "3d314f56-6316-4d68-96e0-2d0f941a687e", "ref_id": "xccdf_org.ssgproject.content_rule_96dca6822eb7f15774b5d95fe44a4d83", "title": "Ad atque reiciendis quia.", "rationale": "Et nihil saepe. Dolor veniam iure. Debitis dolorem officiis.", "description": "Adipisci totam soluta. Voluptates id possimus. Ipsa quis optio.", "severity": "medium", "precedence": 3142, "identifier": { "href": "http://stark.example/alan.vandervort", "label": "Gimli" }, "references": [ { "href": "http://hudson.test/vaughn_hermiston", "label": "Halfast Gamgee" }, { "href": "http://nader.test/kami.stroman", "label": "Sangahyando" }, { "href": "http://daniel.test/santiago_lang", "label": "Briffo Boffin" }, { "href": "http://brekke.test/teodoro", "label": "Grór" }, { "href": "http://harvey.test/jasper", "label": "Peony Baggins" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "f0f5cd15-ea13-4540-abc7-0ac614cd5295", "type": "rule" }, { "id": "4dfd00c7-8283-4731-9be9-abe32acca1d6", "ref_id": "xccdf_org.ssgproject.content_rule_d42fe1cfff51deba9068db0b0facf4fa", "title": "Reprehenderit eum eaque ut.", "rationale": "Voluptas quisquam aliquam. Nulla similique modi. Porro hic molestiae.", "description": "Beatae officiis occaecati. Aperiam magnam debitis. In voluptas aut.", "severity": "medium", "precedence": 5046, "identifier": { "href": "http://adams.example/ellis", "label": "Merry Gardner" }, "references": [ { "href": "http://lesch-rutherford.example/jerrold_wolf", "label": "Minto Burrows" }, { "href": "http://heathcote.test/miguel.volkman", "label": "Ar-Adûnakhôr" }, { "href": "http://boyle-koepp.test/cleo_langosh", "label": "Wilcome" }, { "href": "http://mckenzie-pollich.test/naomi_crona", "label": "Frerin" }, { "href": "http://runolfsdottir-dach.example/terrance.rogahn", "label": "Filibert Bolger" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "9bd47fe2-7dcf-4bc9-981b-8139761cc502", "type": "rule" }, { "id": "4f74dd42-22d9-45b5-bbde-d405f077d671", "ref_id": "xccdf_org.ssgproject.content_rule_87f55760f7238a970caa8b6dbfcd9297", "title": "Sit vitae alias in.", "rationale": "Facere alias totam. Itaque cupiditate consequatur. Aut suscipit cumque.", "description": "Eveniet sit sunt. Facere dolorum vel. Non cum voluptate.", "severity": "high", "precedence": 8722, "identifier": { "href": "http://littel.example/faustino.windler", "label": "Imin" }, "references": [ { "href": "http://kozey.example/yong", "label": "Angamaitë" }, { "href": "http://hettinger.test/lettie", "label": "Nessanië" }, { "href": "http://steuber-weber.test/wally", "label": "Ivriniel" }, { "href": "http://franecki-paucek.example/juliann", "label": "Eldacar" }, { "href": "http://kris-leffler.test/walker", "label": "Axantur" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "a0d6e8be-c2f4-48f0-8f52-01abf5879823", "type": "rule" }, { "id": "4fd11ab8-9615-4f2f-8fbc-8a34583d1f14", "ref_id": "xccdf_org.ssgproject.content_rule_9777b86ce8baae13c4aa6b3776039692", "title": "Eveniet quam veniam quia.", "rationale": "Est alias possimus. Ut corporis sit. Voluptas consequatur aut.", "description": "Autem voluptatem neque. Error fugiat ea. Incidunt voluptatem saepe.", "severity": "medium", "precedence": 8550, "identifier": { "href": "http://gibson.example/tyler", "label": "Dís" }, "references": [ { "href": "http://heaney.example/zackary", "label": "Poppy Chubb-Baggins" }, { "href": "http://reichel-breitenberg.example/kristeen", "label": "Nolondil" }, { "href": "http://romaguera-bogan.example/trey", "label": "Mentha Brandybuck" }, { "href": "http://kohler.example/gita_rowe", "label": "Skinbark" }, { "href": "http://kassulke.test/earleen", "label": "Celegorm" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "8e2ad9ce-5578-44ab-a63b-3ef6d84ee488", "type": "rule" } ], "meta": { "total": 25, "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/security_guides/ca8b1af1-6c64-45a8-aa64-6ca137582424/rules?limit=10&offset=0", "last": "/api/compliance/v2/security_guides/ca8b1af1-6c64-45a8-aa64-6ca137582424/rules?limit=10&offset=20", "next": "/api/compliance/v2/security_guides/ca8b1af1-6c64-45a8-aa64-6ca137582424/rules?limit=10&offset=10" } }, "summary": "", "description": "" }, "List of Rules sorted by \"precedence:asc\"": { "value": { "data": [ { "id": "85cc9ecc-6c73-4411-b807-d7a236e2d0a2", "ref_id": "xccdf_org.ssgproject.content_rule_c61b4d0770dfecbc55bc97fc8f33d5cc", "title": "Ducimus aut repellendus voluptas.", "rationale": "Mollitia ut ad. In soluta enim. Consequatur voluptas magnam.", "description": "Omnis assumenda cupiditate. Ex dolor laboriosam. Perferendis fugit harum.", "severity": "low", "precedence": 42, "identifier": { "href": "http://will.example/adella.flatley", "label": "Haldad" }, "references": [ { "href": "http://daugherty-schulist.example/dwain.stiedemann", "label": "Fundin" }, { "href": "http://ernser-berge.example/micheal", "label": "Hunthor" }, { "href": "http://block.example/willis.heaney", "label": "Angrim" }, { "href": "http://murazik.test/marica.nicolas", "label": "Targon" }, { "href": "http://mills.example/rickie", "label": "Frodo Gardner" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "fb382d3f-837f-4561-9ba3-53ea2c68a9c7", "type": "rule" }, { "id": "2f38d117-b1c0-4e1b-939f-f9a0d65e940f", "ref_id": "xccdf_org.ssgproject.content_rule_6f74b2027b80adf9d6da1fcfd82e3603", "title": "In fugiat quia et.", "rationale": "Quo est autem. Sed sit in. Quisquam distinctio reprehenderit.", "description": "Ratione iure ut. Non voluptatem enim. Exercitationem cumque aut.", "severity": "high", "precedence": 257, "identifier": { "href": "http://stamm-moore.test/esteban_howell", "label": "Asphodel Brandybuck" }, "references": [ { "href": "http://spinka.test/leonardo.feil", "label": "Erling" }, { "href": "http://thompson.example/ai", "label": "Turambar" }, { "href": "http://bartell-thiel.test/galen", "label": "Bandobras Took" }, { "href": "http://price-lang.example/karisa.stiedemann", "label": "Beleth" }, { "href": "http://schultz.example/rocco.schaefer", "label": "Brandir" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "5b67effe-be0e-4f82-86e4-a0a8653fb8b7", "type": "rule" }, { "id": "c3265315-a6dd-4cbc-9803-b50fe55d42de", "ref_id": "xccdf_org.ssgproject.content_rule_e65b8fa2b2a980deacf7d668d402c386", "title": "Maiores autem ad corrupti.", "rationale": "Dicta a quasi. Ex sunt ad. Sapiente quis voluptas.", "description": "Reprehenderit in soluta. Ab ut rerum. Dolores ut voluptas.", "severity": "high", "precedence": 446, "identifier": { "href": "http://grimes.example/fernande_aufderhar", "label": "Togo Goodbody" }, "references": [ { "href": "http://doyle.example/bradley", "label": "Nob" }, { "href": "http://witting.example/bebe", "label": "Hirwen" }, { "href": "http://bauch.test/margareta", "label": "Nazgûl" }, { "href": "http://dickinson-nolan.test/geoffrey_gutkowski", "label": "Saruman" }, { "href": "http://johnston-waters.test/kenneth_leuschke", "label": "Chica Chubb" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "3bb25a4c-4741-47b9-adf6-abe6416e890a", "type": "rule" }, { "id": "929c7c70-f9ba-4674-8857-40b02e616c23", "ref_id": "xccdf_org.ssgproject.content_rule_9f766ed99ab7bb1ca79a8c6fa3ec7c0b", "title": "Voluptas atque nulla rem.", "rationale": "Velit consectetur eius. Esse eius facere. Ut mollitia est.", "description": "Maiores soluta perspiciatis. Aut nulla optio. Accusantium perferendis asperiores.", "severity": "high", "precedence": 449, "identifier": { "href": "http://schimmel-jacobson.test/hipolito_kulas", "label": "Erling" }, "references": [ { "href": "http://kuhlman.test/elly", "label": "Amandil" }, { "href": "http://corkery.test/charles.schimmel", "label": "Elendur" }, { "href": "http://torp-oconnell.example/hubert.rowe", "label": "Wulf" }, { "href": "http://champlin.example/reyes", "label": "Merimas Brandybuck" }, { "href": "http://maggio-marvin.test/porfirio.ziemann", "label": "Indor" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "2a91cf2f-b989-476e-bb23-561f850f5675", "type": "rule" }, { "id": "d9c63555-8942-4ad7-944f-51bca531acc5", "ref_id": "xccdf_org.ssgproject.content_rule_833c9ea6e12d400f1b3641809f07d291", "title": "Soluta quibusdam ut consequuntur.", "rationale": "Ut vel quae. Ducimus quasi est. Nulla a consequatur.", "description": "Aut nam quisquam. Maiores numquam debitis. Consequatur natus doloribus.", "severity": "high", "precedence": 689, "identifier": { "href": "http://runte.test/chastity", "label": "Isengar Took" }, "references": [ { "href": "http://schuster-gottlieb.test/doria", "label": "Elboron" }, { "href": "http://kozey-fritsch.example/merle", "label": "Gilly Brownlock" }, { "href": "http://pfannerstill.example/sherlyn", "label": "Peeping Jack" }, { "href": "http://pagac-hegmann.test/reynalda", "label": "Imrazôr" }, { "href": "http://goyette.test/trista", "label": "Elfhelm" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "e3fd10fe-eea6-452f-8b41-4d7218742df7", "type": "rule" }, { "id": "974e3b26-e6b7-42af-9fa5-ecb0fe68e2c6", "ref_id": "xccdf_org.ssgproject.content_rule_607fbdfa5e8651be38d76922e467b486", "title": "Non nesciunt est omnis.", "rationale": "Ratione ab corporis. Aliquam quisquam provident. Pariatur eos in.", "description": "Velit exercitationem magni. Et ut qui. Aut quisquam sunt.", "severity": "high", "precedence": 1800, "identifier": { "href": "http://krajcik.test/mariella_douglas", "label": "Otto Boffin" }, "references": [ { "href": "http://kris.example/abigail", "label": "Lindir" }, { "href": "http://frami.example/charlyn.predovic", "label": "Brego" }, { "href": "http://kertzmann.test/bryanna_goyette", "label": "Hallas" }, { "href": "http://bernier.test/devin", "label": "Mosco Burrows" }, { "href": "http://hackett-marquardt.example/clemente", "label": "Meriadoc Brandybuck" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "3fad9291-4194-45bb-807a-3752e44d6960", "type": "rule" }, { "id": "5bea4533-657e-4839-87d5-cddf3dc12545", "ref_id": "xccdf_org.ssgproject.content_rule_6a7f03c08c3bfe103c7ef85e00fbfdb1", "title": "Ab voluptas ut nulla.", "rationale": "Illum ut soluta. Quos sed placeat. Recusandae delectus expedita.", "description": "Quis rerum ut. Id voluptatem ullam. Omnis porro nihil.", "severity": "medium", "precedence": 1803, "identifier": { "href": "http://leuschke.example/lauryn.nitzsche", "label": "Wulf" }, "references": [ { "href": "http://fadel.example/cletus", "label": "Hallacar" }, { "href": "http://treutel.test/lazaro", "label": "Nazgûl" }, { "href": "http://zemlak.example/joaquin.schmeler", "label": "Haldar" }, { "href": "http://berge-haag.test/evia.feeney", "label": "Ferumbras Took" }, { "href": "http://wilkinson.test/gidget", "label": "Folcwine" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "ccafbec6-a8de-430d-b2be-7d479cc47c43", "type": "rule" }, { "id": "12d25aa7-517f-4fb1-b057-2d40b33dde9c", "ref_id": "xccdf_org.ssgproject.content_rule_76776beca77d82abf43f9cc093d4702d", "title": "Beatae qui nisi deserunt.", "rationale": "Aut dolorum voluptate. Facere reprehenderit et. Aspernatur quod minima.", "description": "Tempore suscipit consequuntur. Officiis ipsum excepturi. Provident suscipit fugit.", "severity": "low", "precedence": 2087, "identifier": { "href": "http://fahey-mills.example/leonel", "label": "Aravorn" }, "references": [ { "href": "http://huel-abbott.example/vance_rolfson", "label": "Primrose Gardner" }, { "href": "http://schmeler-mante.example/georgann.king", "label": "Dírhael" }, { "href": "http://kiehn.example/joaquin", "label": "Poldor" }, { "href": "http://jaskolski-mckenzie.example/adolfo_greenfelder", "label": "Eärendil" }, { "href": "http://connelly.test/ginny", "label": "Mallor" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "9d72c0fe-1fcb-48bc-ada6-81d399d687fc", "type": "rule" }, { "id": "3a423c63-4521-45bd-867c-00b1b6136e94", "ref_id": "xccdf_org.ssgproject.content_rule_42c2783ee503bd662bf3c2030fa944b3", "title": "Quisquam sed eveniet ipsum.", "rationale": "Autem et ab. Quos possimus numquam. Saepe beatae eum.", "description": "Dolorum saepe impedit. Quas sed reprehenderit. Sed rem nesciunt.", "severity": "low", "precedence": 2429, "identifier": { "href": "http://dickinson.example/mohamed_langosh", "label": "Náli" }, "references": [ { "href": "http://gerlach-heidenreich.example/oswaldo.swift", "label": "Daisy Gardner" }, { "href": "http://kuhic.test/darron.zieme", "label": "Lóni" }, { "href": "http://mertz-herman.test/brooke_herzog", "label": "Nina Lightfoot" }, { "href": "http://legros-lubowitz.example/terry", "label": "Sador" }, { "href": "http://stiedemann-lang.test/sharen", "label": "Tar-Atanamir" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "3d921f2e-3791-4f7c-b105-713e95b3a593", "type": "rule" }, { "id": "2f630791-6d44-4ae9-81b3-c362635caf6b", "ref_id": "xccdf_org.ssgproject.content_rule_0339ab79c154679056a4529e6f4671d2", "title": "Velit adipisci et nam.", "rationale": "Neque consequatur numquam. Dolor ab eum. Odio ipsum qui.", "description": "Exercitationem ea qui. Ullam vitae et. Molestiae ut corrupti.", "severity": "high", "precedence": 2605, "identifier": { "href": "http://dibbert.test/kum", "label": "Tar-Ancalimë" }, "references": [ { "href": "http://paucek-kutch.example/angela.rohan", "label": "Vidumavi" }, { "href": "http://turner-rippin.example/ramon", "label": "Isumbras" }, { "href": "http://runolfsdottir-gutmann.test/noelle.marquardt", "label": "Poppy Chubb-Baggins" }, { "href": "http://kohler.test/george_luettgen", "label": "Ondoher" }, { "href": "http://cruickshank-runte.example/gilberto", "label": "Ardamir" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "aaa374a2-2a09-4a39-b77c-6b9c660fe571", "type": "rule" } ], "meta": { "total": 25, "limit": 10, "offset": 0, "sort_by": "precedence" }, "links": { "first": "/api/compliance/v2/security_guides/d06948c3-94fb-49a9-ad1c-2ccdfbb257f7/rules?limit=10&offset=0&sort_by=precedence", "last": "/api/compliance/v2/security_guides/d06948c3-94fb-49a9-ad1c-2ccdfbb257f7/rules?limit=10&offset=20&sort_by=precedence", "next": "/api/compliance/v2/security_guides/d06948c3-94fb-49a9-ad1c-2ccdfbb257f7/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": "5b086919-9045-4dcf-b515-3a35a512060d", "ref_id": "xccdf_org.ssgproject.content_rule_ffe10e40dc6f8d0b6194675f51053976", "title": "Similique repellendus velit quidem.", "rationale": "Explicabo ea consequatur. Quia est nihil. Reiciendis qui tempora.", "description": "Qui esse ut. Aut dolorem similique. Autem sint sed.", "severity": "low", "precedence": 8296, "identifier": { "href": "http://champlin-predovic.example/granville", "label": "Tosto Boffin" }, "references": [ { "href": "http://skiles-funk.example/dong", "label": "Hunthor" }, { "href": "http://lindgren.example/jaquelyn.farrell", "label": "Eldacar" }, { "href": "http://green.example/elmer.oconnell", "label": "Almáriel" }, { "href": "http://aufderhar.test/barney", "label": "Dís" }, { "href": "http://roob.test/sade", "label": "Finduilas" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "fe2c02e1-d4af-43fd-b8a6-386f6438c977", "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 0c49fd1b-2e2a-48b1-a477-0a52c9473de1" ] }, "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`, and `rule_group_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" } }, { "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": "039e6979-ebb1-4efa-88a1-0dedacbc110a", "ref_id": "xccdf_org.ssgproject.content_rule_ecc7dd07460bf751c056e0cb662c07a2", "title": "Temporibus fuga corporis impedit.", "rationale": "Minus ut quasi. Eum quod quo. Dolor assumenda et.", "description": "Fuga sed consequatur. Rerum quis deserunt. Aliquam eum architecto.", "severity": "medium", "precedence": 2679, "identifier": { "href": "http://nader.example/florene", "label": "Cora Goodbody" }, "references": [ { "href": "http://glover.test/bill_kertzmann", "label": "Amdír" }, { "href": "http://olson-larson.test/asha", "label": "Guilin" }, { "href": "http://schroeder-wiza.example/rosette", "label": "Ibun" }, { "href": "http://sipes.example/christia_monahan", "label": "Hardang" }, { "href": "http://ruecker.test/luther.stehr", "label": "Adalbert Bolger" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "882f5c7e-9e08-4f34-8e4b-d2a0950a7ed7", "type": "rule", "remediation_issue_id": null }, { "id": "27678b80-1095-490c-b2b3-33623c8a3561", "ref_id": "xccdf_org.ssgproject.content_rule_255f09f55c4f64b367f3f5b86819617a", "title": "Magni voluptatem quibusdam aliquid.", "rationale": "Nemo eligendi eum. Nihil praesentium unde. Facere pariatur veniam.", "description": "At culpa provident. Quas deserunt rerum. Et porro nostrum.", "severity": "medium", "precedence": 8546, "identifier": { "href": "http://mayert.test/anh.farrell", "label": "Ebor" }, "references": [ { "href": "http://dach-kovacek.test/jeanene_runolfsson", "label": "Finwë" }, { "href": "http://smith-kihn.test/carita.stehr", "label": "Ivorwen" }, { "href": "http://romaguera.example/adrianne.hills", "label": "Olo Proudfoot" }, { "href": "http://klein-shanahan.example/rory.wilderman", "label": "Vorondil" }, { "href": "http://oreilly.example/marlon", "label": "Radbug" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "3536a3a6-3fb6-4855-ae63-9b673e403e35", "type": "rule", "remediation_issue_id": null }, { "id": "2a9b6f35-7092-438c-ba36-bed492f7fd0c", "ref_id": "xccdf_org.ssgproject.content_rule_61b0ea963a378ba5b291bff2713cc6b0", "title": "Tempora deserunt minima mollitia.", "rationale": "Repudiandae ipsa quia. Veniam magnam et. Odit incidunt sed.", "description": "Inventore vel voluptatem. Qui in velit. Iusto nulla itaque.", "severity": "medium", "precedence": 8710, "identifier": { "href": "http://howell.example/trenton", "label": "Belegund" }, "references": [ { "href": "http://donnelly.test/dimple_crona", "label": "Salvia Brandybuck" }, { "href": "http://lindgren.example/delana.huel", "label": "Polo Baggins" }, { "href": "http://hills-mertz.example/hester_ullrich", "label": "Éothéod" }, { "href": "http://ullrich-kessler.example/kasey.murphy", "label": "Belemir" }, { "href": "http://gutkowski.test/shellie.gottlieb", "label": "Wiseman Gamwich" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "24e1e6f2-a037-4974-b67d-39881f02ed96", "type": "rule", "remediation_issue_id": null }, { "id": "2bc5f14f-8a54-4b89-b417-ed979cea46b6", "ref_id": "xccdf_org.ssgproject.content_rule_976e7b0632ae2ee7ffb765dc1b356617", "title": "Qui recusandae sunt quisquam.", "rationale": "Magni eum quis. Sint sint omnis. Iste exercitationem et.", "description": "Ut voluptate et. Vel illum quia. Quis porro provident.", "severity": "high", "precedence": 7865, "identifier": { "href": "http://koelpin-terry.test/ulrike", "label": "Dúnhere" }, "references": [ { "href": "http://stoltenberg.example/geneva", "label": "Dís" }, { "href": "http://schroeder.test/cecilia", "label": "Aravir" }, { "href": "http://erdman.example/lacey", "label": "Ulbar" }, { "href": "http://block.example/shonda_bednar", "label": "Bowman Cotton" }, { "href": "http://mayer.example/alex", "label": "Eärendil" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "5d33afcc-71cd-480b-b9ed-1a24d9e0e637", "type": "rule", "remediation_issue_id": null }, { "id": "2ffe7f90-dd27-4de6-bd2d-04ccf138e012", "ref_id": "xccdf_org.ssgproject.content_rule_7dca3d418413402982ed59a9ac96bf40", "title": "Quis nisi consequatur placeat.", "rationale": "Culpa eligendi aut. Mollitia id eum. Ut inventore dolore.", "description": "Quidem dolores odio. Inventore pariatur non. Veniam ut sit.", "severity": "low", "precedence": 6044, "identifier": { "href": "http://mckenzie.test/elanor", "label": "Bregolas" }, "references": [ { "href": "http://hayes.example/rafaela_leuschke", "label": "Walda" }, { "href": "http://bosco.example/nicolle.mcdermott", "label": "Erkenbrand" }, { "href": "http://weissnat.example/branda.tillman", "label": "Soronto" }, { "href": "http://leuschke.test/jack", "label": "Grimbold" }, { "href": "http://bins.test/weldon", "label": "Eluréd" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "14af3d52-5baf-4730-b2e8-22467a2df5fa", "type": "rule", "remediation_issue_id": null }, { "id": "376d5204-7533-41db-9910-50701de50dfc", "ref_id": "xccdf_org.ssgproject.content_rule_e09e9a59b000bb0d6c3fb7f229e9de83", "title": "Iste quaerat et aut.", "rationale": "Repudiandae similique non. Consequatur qui dolor. Quia maxime repellendus.", "description": "Voluptates odio autem. Aspernatur voluptatem repellendus. Ea non et.", "severity": "medium", "precedence": 4847, "identifier": { "href": "http://heathcote-williamson.test/maximo", "label": "Nazgûl" }, "references": [ { "href": "http://murazik.example/horacio.stanton", "label": "Ungoliant" }, { "href": "http://smith-kunde.example/claudio.wuckert", "label": "Bifur" }, { "href": "http://collins-collins.test/clarita", "label": "Glóredhel" }, { "href": "http://schinner-dubuque.example/chad", "label": "Soronto" }, { "href": "http://bogisich.test/marlon", "label": "Magor" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "ef6686ec-c274-41fc-94d8-2ad55ac7b773", "type": "rule", "remediation_issue_id": null }, { "id": "37da77a2-f4ff-4505-aa1b-27d095480308", "ref_id": "xccdf_org.ssgproject.content_rule_c9cbc3a549215ec61ede3740f9919d24", "title": "Cupiditate quaerat deleniti quod.", "rationale": "Accusantium qui sunt. Nihil odio esse. Minima dolorem fugit.", "description": "Aut ea ipsam. Amet ut veritatis. Nesciunt qui explicabo.", "severity": "medium", "precedence": 2908, "identifier": { "href": "http://fadel.example/erik_trantow", "label": "Bill Ferny" }, "references": [ { "href": "http://ratke.test/evan", "label": "Hildigard Took" }, { "href": "http://sauer-howell.test/miguel", "label": "Nina Lightfoot" }, { "href": "http://altenwerth.example/lieselotte_hodkiewicz", "label": "Voronwë" }, { "href": "http://huel-bernhard.example/prudence", "label": "Borthand" }, { "href": "http://padberg.test/latarsha", "label": "Zimrahin" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "8aa7c763-ebf1-4302-88a9-a903b340a6c9", "type": "rule", "remediation_issue_id": null }, { "id": "587dbd14-952d-4399-acee-0340f838499b", "ref_id": "xccdf_org.ssgproject.content_rule_eb1fd246499b86652ab0692931cc5ac4", "title": "Ad omnis et sint.", "rationale": "Optio ut laboriosam. Dicta eos voluptas. Aut quo dolore.", "description": "Magnam ex corrupti. Consequatur deserunt in. Eum ab est.", "severity": "high", "precedence": 4212, "identifier": { "href": "http://bernier.test/daisy_bechtelar", "label": "Farin" }, "references": [ { "href": "http://hauck.example/brendon_nitzsche", "label": "Dírhael" }, { "href": "http://emard.example/natashia_oconnell", "label": "Daisy Baggins" }, { "href": "http://bruen.test/carla.haag", "label": "Éothain" }, { "href": "http://brakus-collier.example/jacquelyne", "label": "Ornendil" }, { "href": "http://ankunding.test/danette", "label": "Eöl" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "20988eac-3c47-4a01-bf67-54f6990c0416", "type": "rule", "remediation_issue_id": null }, { "id": "5c3a04c7-eb8a-4d4e-a41b-2cbcae42262a", "ref_id": "xccdf_org.ssgproject.content_rule_321fe7106b50e2e15cfac22a9ad78166", "title": "Quos corporis iste expedita.", "rationale": "At reiciendis explicabo. Vel dicta iure. Commodi animi quia.", "description": "Ea est vitae. Iure recusandae dolor. Placeat ut et.", "severity": "medium", "precedence": 2814, "identifier": { "href": "http://boyle.example/van", "label": "Chica Chubb" }, "references": [ { "href": "http://schaden.test/harry", "label": "Witch-king" }, { "href": "http://bahringer.example/adella_kautzer", "label": "Erling" }, { "href": "http://willms.test/emory.bashirian", "label": "Barach" }, { "href": "http://ortiz.test/charisse", "label": "Eärnil" }, { "href": "http://ondricka-bins.example/kellee", "label": "Nár" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "fa04fef4-3374-442b-b395-01f50ab0cd7b", "type": "rule", "remediation_issue_id": null }, { "id": "6b6bb222-334e-4dc4-bd8e-f42571698ad3", "ref_id": "xccdf_org.ssgproject.content_rule_d022c5a511f702e24afcc18dc90d5fbd", "title": "Officia vel aliquid et.", "rationale": "Vero itaque ipsa. Consequuntur consequatur aperiam. Neque doloribus cumque.", "description": "Perferendis asperiores quia. Laboriosam incidunt consectetur. Rerum blanditiis quia.", "severity": "low", "precedence": 4782, "identifier": { "href": "http://trantow-klocko.test/saul.conroy", "label": "Dagnir" }, "references": [ { "href": "http://swift.example/jerry", "label": "Ruby Bolger" }, { "href": "http://schimmel.example/lewis.rippin", "label": "Amrothos" }, { "href": "http://emard.test/juan", "label": "Arador" }, { "href": "http://murray-marquardt.test/minna", "label": "Írimë" }, { "href": "http://carter.example/harry", "label": "Tar-Telperiën" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "cc965289-fb4c-4a1a-81c2-4358c976db19", "type": "rule", "remediation_issue_id": null } ], "meta": { "total": 25, "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/security_guides/04b5c8d4-2f95-4285-92c4-a69e249fa05e/profiles/de795edd-73d8-4dde-9e8b-c925a3e8f203/rules?limit=10&offset=0", "last": "/api/compliance/v2/security_guides/04b5c8d4-2f95-4285-92c4-a69e249fa05e/profiles/de795edd-73d8-4dde-9e8b-c925a3e8f203/rules?limit=10&offset=20", "next": "/api/compliance/v2/security_guides/04b5c8d4-2f95-4285-92c4-a69e249fa05e/profiles/de795edd-73d8-4dde-9e8b-c925a3e8f203/rules?limit=10&offset=10" } }, "summary": "", "description": "" }, "List of Rules sorted by \"precedence:asc\"": { "value": { "data": [ { "id": "40c12d9c-607d-446a-ad20-6122a6e278b8", "ref_id": "xccdf_org.ssgproject.content_rule_6da422958aa4c62ddd43f47c9f5ac2ea", "title": "Et dolores voluptatibus facere.", "rationale": "Ipsa maiores eveniet. Rerum porro ullam. Ut et rem.", "description": "Exercitationem explicabo voluptas. Libero reiciendis a. Veritatis nihil perferendis.", "severity": "high", "precedence": 654, "identifier": { "href": "http://oberbrunner.test/boyd", "label": "Fram" }, "references": [ { "href": "http://huels-walter.example/odis.becker", "label": "Landroval" }, { "href": "http://wuckert.example/guadalupe", "label": "Bandobras Took" }, { "href": "http://schowalter.test/sanford.fisher", "label": "Bolg" }, { "href": "http://hills-rath.test/anastasia", "label": "Melilot Brandybuck" }, { "href": "http://von.example/bridgette.hansen", "label": "Gundolpho Bolger" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "1caba462-a4f9-4d13-8bee-02fe2739b15b", "type": "rule", "remediation_issue_id": null }, { "id": "37d3a23b-4096-4362-bfb8-179b0d29dcb2", "ref_id": "xccdf_org.ssgproject.content_rule_998fb878c5978a1b923220c85220f515", "title": "Adipisci quasi nihil aliquid.", "rationale": "Excepturi id amet. Dolorem est labore. Molestiae in id.", "description": "Voluptates quam amet. Harum et quia. Doloribus ab quisquam.", "severity": "low", "precedence": 756, "identifier": { "href": "http://pfannerstill.example/victor", "label": "Finduilas" }, "references": [ { "href": "http://hirthe.example/rolanda_gorczany", "label": "Eglantine Banks" }, { "href": "http://lind.test/myles", "label": "Cemendur" }, { "href": "http://glover-sauer.test/mellisa_towne", "label": "Iago Grubb" }, { "href": "http://ritchie.example/philip.renner", "label": "Fëanor" }, { "href": "http://boyer.example/sherron_sporer", "label": "Folcwine" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "9ae8e4a5-bd78-4a2b-b3ca-fbe035876cfd", "type": "rule", "remediation_issue_id": null }, { "id": "2ca29178-3610-4a43-87c7-27542360f316", "ref_id": "xccdf_org.ssgproject.content_rule_59df190a5e645bc55c7a71e26c6fd5c0", "title": "Non corrupti nemo commodi.", "rationale": "Soluta et voluptatem. Ratione sed et. Est rerum fuga.", "description": "Aut aut inventore. Voluptatem tempora aut. Commodi non at.", "severity": "high", "precedence": 1552, "identifier": { "href": "http://prohaska.example/kathe_kemmer", "label": "Moro Burrows" }, "references": [ { "href": "http://oconner.example/aliza", "label": "Elendil" }, { "href": "http://raynor-roberts.example/elliott.baumbach", "label": "Dáin" }, { "href": "http://effertz-fritsch.test/kelly_mayert", "label": "Gildor" }, { "href": "http://wehner.example/shantae_kilback", "label": "Yávien" }, { "href": "http://wisoky-crona.example/ezra", "label": "Adamanta Chubb" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "568051b9-a310-46f0-8945-74cb6d5501a7", "type": "rule", "remediation_issue_id": null }, { "id": "a7db8787-7e35-4bbf-9639-aba32442ff0b", "ref_id": "xccdf_org.ssgproject.content_rule_42a71bc1318e2e81ac38f7cff2e83fdb", "title": "Possimus consequuntur quos et.", "rationale": "Facilis molestias est. Nihil ducimus aut. Et perferendis aut.", "description": "Enim architecto sequi. Consequuntur voluptas voluptate. Dolorem non sapiente.", "severity": "low", "precedence": 2265, "identifier": { "href": "http://hudson.test/lanelle.feil", "label": "Aravir" }, "references": [ { "href": "http://vandervort.example/marlon.emard", "label": "Rowlie Appledore" }, { "href": "http://mayer.example/tressie.denesik", "label": "Dinodas Brandybuck" }, { "href": "http://anderson.test/edith", "label": "Elfstan Fairbairn" }, { "href": "http://klocko-wisoky.test/solomon_robel", "label": "Draugluin" }, { "href": "http://denesik.example/leonard.armstrong", "label": "Pott the Mayor" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "5af63cea-3204-482f-8927-2a9f8fc1c6a2", "type": "rule", "remediation_issue_id": null }, { "id": "625554d5-fae7-494a-9a74-050959e237d1", "ref_id": "xccdf_org.ssgproject.content_rule_f897b00fcae539d5a1430b38d8675fc7", "title": "Culpa et ipsum accusantium.", "rationale": "Animi facere id. Alias dolorem itaque. Velit dolor fuga.", "description": "Quia ut qui. Numquam quo itaque. Dolor provident totam.", "severity": "high", "precedence": 2553, "identifier": { "href": "http://bergstrom-paucek.test/danita.sipes", "label": "Poppy Chubb-Baggins" }, "references": [ { "href": "http://okuneva.test/billie", "label": "Duilin" }, { "href": "http://larkin-jakubowski.test/deshawn.abernathy", "label": "Marach" }, { "href": "http://stoltenberg.example/lavonne.mann", "label": "Gilraen" }, { "href": "http://rippin.example/willow.nitzsche", "label": "Dorlas" }, { "href": "http://blick.example/annamarie", "label": "Aerin" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "0a12ce67-ae0a-41b4-9f55-8caef05969f7", "type": "rule", "remediation_issue_id": null }, { "id": "a98c1f55-6a15-4688-b4a4-1b5e4a3e3713", "ref_id": "xccdf_org.ssgproject.content_rule_168b4f854904100bc9892475691643ac", "title": "Explicabo ad ducimus rem.", "rationale": "Exercitationem necessitatibus corrupti. Enim similique odio. Vel voluptatibus et.", "description": "Sed nemo aliquid. Velit quis dolor. Et velit dolor.", "severity": "medium", "precedence": 2827, "identifier": { "href": "http://tromp-koelpin.example/roselyn", "label": "Avranc" }, "references": [ { "href": "http://ankunding-emmerich.test/nickolas", "label": "Witch-king" }, { "href": "http://schamberger-jacobson.example/deane", "label": "Caliondo" }, { "href": "http://gottlieb-hand.test/zack", "label": "Pimpernel Took" }, { "href": "http://mcclure.test/olivia", "label": "Balin" }, { "href": "http://harris-mertz.example/donnie.hermann", "label": "Theobald Bolger" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "a0297f9e-5acd-433d-95f5-9fec0616fd8e", "type": "rule", "remediation_issue_id": null }, { "id": "9c3de1f8-0491-417f-87ae-248bf54508ac", "ref_id": "xccdf_org.ssgproject.content_rule_7eae8731e79186caef0718c03d3bcbf7", "title": "Tempora praesentium facere sit.", "rationale": "Repudiandae ex ea. Optio fugiat nobis. Corrupti perspiciatis quisquam.", "description": "Labore rerum sed. Et inventore voluptatibus. Eaque nostrum temporibus.", "severity": "low", "precedence": 2934, "identifier": { "href": "http://jacobson-schumm.test/lesley_heidenreich", "label": "Baldor" }, "references": [ { "href": "http://bauch-hammes.example/bea", "label": "Déor" }, { "href": "http://mitchell-torphy.example/roger", "label": "Ragnir" }, { "href": "http://hudson.test/irena", "label": "Bodo Proudfoot" }, { "href": "http://runolfsson-hermiston.example/page", "label": "Madoc Brandybuck" }, { "href": "http://tromp.test/nettie_schiller", "label": "Goldilocks Gardner" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "2593b9dd-8712-49f3-9252-24ee16b9b9b9", "type": "rule", "remediation_issue_id": null }, { "id": "362ac6dc-807c-4174-9416-b1e6bc044f24", "ref_id": "xccdf_org.ssgproject.content_rule_ef2193e951fcf79946ea8095939ed5d8", "title": "Earum blanditiis illo enim.", "rationale": "Est quidem reprehenderit. Vitae distinctio esse. Beatae optio repudiandae.", "description": "Eum fugiat ex. Labore illum et. Et quisquam cum.", "severity": "medium", "precedence": 3145, "identifier": { "href": "http://ohara.example/amos", "label": "Hirwen" }, "references": [ { "href": "http://batz.test/earl.fahey", "label": "Celeborn" }, { "href": "http://stark.test/jesica", "label": "Gollum" }, { "href": "http://rutherford-keebler.test/judith.schoen", "label": "Estella Bolger" }, { "href": "http://cruickshank.test/charleen", "label": "Huor" }, { "href": "http://gorczany-maggio.example/christian", "label": "Merry Gardner" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "55ff5b54-68a5-4021-b6fc-5fe56b315748", "type": "rule", "remediation_issue_id": null }, { "id": "8ef84698-1ca3-40c4-996d-d6e8671cbc75", "ref_id": "xccdf_org.ssgproject.content_rule_1880df384dd9c20c2c92239a2703a1ee", "title": "Aperiam autem repellendus aut.", "rationale": "Eveniet dolorem nihil. Nam tenetur omnis. Alias quisquam ut.", "description": "Id omnis dolores. Cum et eligendi. Voluptatem rem praesentium.", "severity": "medium", "precedence": 3543, "identifier": { "href": "http://daugherty-beer.test/edmund_howe", "label": "Elendur" }, "references": [ { "href": "http://bruen.test/jerold_stroman", "label": "Ebor" }, { "href": "http://reinger-medhurst.test/mireya_okeefe", "label": "Mithrellas" }, { "href": "http://stiedemann.test/esta.marvin", "label": "Gruffo Boffin" }, { "href": "http://runolfsson-konopelski.test/mendy_fritsch", "label": "Peony Baggins" }, { "href": "http://nader-cartwright.example/ike.hudson", "label": "Mahtan" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "24a5c05a-98d0-4130-9610-6956639b1093", "type": "rule", "remediation_issue_id": null }, { "id": "7bdbc7f8-7c0c-4f6a-ab5d-a801e93917d5", "ref_id": "xccdf_org.ssgproject.content_rule_24d93c2c13d6f56a2a065a7c62dcf551", "title": "Eos corporis voluptatem aspernatur.", "rationale": "Ratione dolor quis. Aut mollitia est. Quam iure accusantium.", "description": "Ducimus asperiores nobis. Sint fugiat et. Et est rem.", "severity": "high", "precedence": 3883, "identifier": { "href": "http://nienow.example/carlos_bode", "label": "Eöl" }, "references": [ { "href": "http://tremblay.example/ted", "label": "Balin" }, { "href": "http://marquardt-paucek.test/olin.hudson", "label": "Vinitharya" }, { "href": "http://luettgen.test/greta", "label": "Thingol" }, { "href": "http://brekke.test/tomika", "label": "Hareth" }, { "href": "http://parisian-lang.test/karolyn", "label": "Frerin" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "d7117cff-c148-496c-b4d8-a4faafebb23b", "type": "rule", "remediation_issue_id": null } ], "meta": { "total": 25, "limit": 10, "offset": 0, "sort_by": "precedence" }, "links": { "first": "/api/compliance/v2/security_guides/22e4ed36-c32b-42fc-b191-327449a62c1e/profiles/4bf88cfc-3a46-4654-b5b9-bf942c42d2ab/rules?limit=10&offset=0&sort_by=precedence", "last": "/api/compliance/v2/security_guides/22e4ed36-c32b-42fc-b191-327449a62c1e/profiles/4bf88cfc-3a46-4654-b5b9-bf942c42d2ab/rules?limit=10&offset=20&sort_by=precedence", "next": "/api/compliance/v2/security_guides/22e4ed36-c32b-42fc-b191-327449a62c1e/profiles/4bf88cfc-3a46-4654-b5b9-bf942c42d2ab/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": "4769dae7-d51b-48b1-8846-8908f50b2ce4", "ref_id": "xccdf_org.ssgproject.content_rule_44a30b12e134809c42eddb92dc9449d0", "title": "Aut neque dolorum ullam.", "rationale": "Iusto facilis ipsum. Assumenda architecto consequatur. Quaerat est dolor.", "description": "Sunt quibusdam occaecati. Et omnis modi. Nostrum consequatur ab.", "severity": "low", "precedence": 6447, "identifier": { "href": "http://okeefe.example/jonna_bernhard", "label": "Éothain" }, "references": [ { "href": "http://russel-russel.test/geraldo", "label": "Madril" }, { "href": "http://armstrong-cole.example/evita_hettinger", "label": "Ar-Gimilzôr" }, { "href": "http://ward-goldner.test/josefina.prosacco", "label": "Khamûl" }, { "href": "http://deckow-marquardt.example/maragret", "label": "Galadhon" }, { "href": "http://marks-goyette.example/michael_oberbrunner", "label": "Ar-Adûnakhôr" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "b3ed2616-d377-4846-8f10-7458fa5bd3bd", "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 1ca5626d-d3f4-48b3-ba42-cce804567171" ] }, "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`, and `rule_group_id`

(e.g.: `(field_1=something AND field_2!=\"something else\") OR field_3>40`)", "schema": { "type": "string" } }, { "name": "policy_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "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": "8c9df336-6aca-4a4d-90aa-b053ce099a7c", "ref_id": "xccdf_org.ssgproject.content_rule_3084058bfc63bb682353689baa7d6615", "title": "Vel ipsam eius eum.", "rationale": "Assumenda pariatur ducimus. Eum sed enim. Ex quibusdam laboriosam.", "description": "Ipsam nisi nobis. Voluptatem omnis in. Eum saepe voluptas.", "severity": "medium", "precedence": 5707, "identifier": { "href": "http://schoen-dickens.test/dalia", "label": "Rorimac Brandybuck" }, "references": [ { "href": "http://kuhic.test/rupert", "label": "Porto Baggins" }, { "href": "http://feest.example/joeann_mcdermott", "label": "Ted Sandyman" }, { "href": "http://kris.example/aldo_kuvalis", "label": "Lagduf" }, { "href": "http://swaniawski.example/venetta", "label": "Sangahyando" }, { "href": "http://dubuque-willms.example/michal_anderson", "label": "Nellas" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "d230695a-4c35-4913-8689-45f3104be2d1", "type": "rule" } ], "meta": { "total": 1, "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/policies/c350856f-f242-4d68-bb5d-ace092fc37d2/tailorings/4f68b6e2-4710-4851-9558-3a35d6c5efa5/rules?limit=10&offset=0", "last": "/api/compliance/v2/policies/c350856f-f242-4d68-bb5d-ace092fc37d2/tailorings/4f68b6e2-4710-4851-9558-3a35d6c5efa5/rules?limit=10&offset=0" } }, "summary": "", "description": "" }, "List of Rules sorted by \"precedence:asc\"": { "value": { "data": [ { "id": "88bc6c68-9c81-4a09-97fa-1a894f387917", "ref_id": "xccdf_org.ssgproject.content_rule_4db41e36b4ccb614c779cffb41be6a3d", "title": "Odio minima ducimus doloribus.", "rationale": "Porro soluta totam. Dolores aut rerum. Dolor aut eaque.", "description": "Ea eum quasi. Ipsum excepturi nobis. Fuga neque et.", "severity": "high", "precedence": 7619, "identifier": { "href": "http://reynolds-wilkinson.example/bobby_haag", "label": "Elendil" }, "references": [ { "href": "http://witting-rau.example/garth.shields", "label": "Valandur" }, { "href": "http://wintheiser.example/danyel_turner", "label": "Barach" }, { "href": "http://luettgen-schulist.test/gertude.friesen", "label": "Gilraen" }, { "href": "http://mohr-will.example/daniella", "label": "Huor" }, { "href": "http://wunsch.test/kathyrn.mckenzie", "label": "Arassuil" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "2c65daa1-9036-484b-8fe9-95e4813a02d8", "type": "rule" } ], "meta": { "total": 1, "limit": 10, "offset": 0, "sort_by": "precedence" }, "links": { "first": "/api/compliance/v2/policies/c0fc4e1f-10fa-41b7-9543-76bc13aeed75/tailorings/6cc7ccd1-825a-43b6-9854-7e4cea21771b/rules?limit=10&offset=0&sort_by=precedence", "last": "/api/compliance/v2/policies/c0fc4e1f-10fa-41b7-9543-76bc13aeed75/tailorings/6cc7ccd1-825a-43b6-9854-7e4cea21771b/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": "1b91e965-0f86-4cb8-9fd9-a75788da7a6d", "ref_id": "xccdf_org.ssgproject.content_rule_057ad317b66a646e3e5bbc0841ca9390", "title": "Doloribus praesentium delectus eligendi.", "rationale": "Amet non aut. At rerum voluptatibus. Harum illum earum.", "description": "Est corrupti illo. Nobis expedita totam. At aut iste.", "severity": "medium", "precedence": 2172, "identifier": { "href": "http://deckow.test/devorah", "label": "Ferumbras Took" }, "references": [ { "href": "http://lynch.test/trudy", "label": "Otho Sackville-Baggins" }, { "href": "http://waters.example/columbus", "label": "Andreth" }, { "href": "http://auer.example/reuben_buckridge", "label": "Tar-Calmacil" }, { "href": "http://nolan.example/janna", "label": "Erchirion" }, { "href": "http://baumbach-huels.example/dale", "label": "Hugo Bracegirdle" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "6e261f35-df17-4145-9580-1a58e67de934", "type": "rule" }, { "id": "1ded8a22-bc65-4a25-b224-1401abd8e6fb", "ref_id": "xccdf_org.ssgproject.content_rule_858c6517f058d46d4f6cbf571e3a270e", "title": "Suscipit est quia ab.", "rationale": "Quibusdam quis quidem. Ducimus cupiditate error. Sint eveniet recusandae.", "description": "Autem harum eum. Corporis delectus similique. Temporibus perspiciatis sed.", "severity": "medium", "precedence": 5293, "identifier": { "href": "http://hodkiewicz-kuhic.example/gabriel_wyman", "label": "Halfred Greenhand" }, "references": [ { "href": "http://satterfield.example/darren.hessel", "label": "Adalbert Bolger" }, { "href": "http://gislason.test/belva_mann", "label": "Celebrindor" }, { "href": "http://herman.example/melida_ohara", "label": "Turambar" }, { "href": "http://roberts-emard.example/maud_doyle", "label": "Hirgon" }, { "href": "http://denesik-spencer.example/doyle", "label": "Gildis" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "cdd05f83-6fe1-4edf-9090-389f945149c8", "type": "rule" }, { "id": "1ecd0508-63c7-41dd-91dc-5b1742108e91", "ref_id": "xccdf_org.ssgproject.content_rule_6ed5e1b46e779203d80ebcddfb09b313", "title": "Labore soluta qui omnis.", "rationale": "Deleniti animi modi. Incidunt sunt ratione. Sunt molestias id.", "description": "Qui impedit qui. Adipisci recusandae vel. Ut expedita pariatur.", "severity": "medium", "precedence": 112, "identifier": { "href": "http://wolff.test/dreama_stracke", "label": "Gléowine" }, "references": [ { "href": "http://okon.example/reuben", "label": "Ciryandil" }, { "href": "http://fritsch.test/mose.thompson", "label": "Glóin" }, { "href": "http://ryan-rohan.test/chadwick", "label": "Marach" }, { "href": "http://stroman.test/zackary.oberbrunner", "label": "Rose Gardner" }, { "href": "http://klein.example/rea", "label": "Orodreth" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "a0be2dab-8157-4024-9547-182a73ebe3e6", "type": "rule" }, { "id": "3b0e748b-1a04-4743-9ddf-b434f3950de5", "ref_id": "xccdf_org.ssgproject.content_rule_354a2793b6f113a104d658f0ac4497e3", "title": "Consequuntur earum autem velit.", "rationale": "Exercitationem quo molestiae. Quaerat dolorum adipisci. Et autem quo.", "description": "Et voluptatem non. Qui est ut. Repellendus provident quisquam.", "severity": "medium", "precedence": 8245, "identifier": { "href": "http://koss-oconner.test/kirby", "label": "Minardil" }, "references": [ { "href": "http://rowe.test/robt", "label": "Hallatan" }, { "href": "http://williamson-koch.example/britt", "label": "Ar-Sakalthôr" }, { "href": "http://hoeger-gutmann.test/verline.spinka", "label": "Asgon" }, { "href": "http://lind.example/orville", "label": "Odo Proudfoot" }, { "href": "http://blanda.test/kendrick", "label": "Lúthien" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "ba5fdb17-1df5-406a-b451-6a3acd5cf8a1", "type": "rule" }, { "id": "3ecedd7d-b41f-45c1-b05d-371fd9b5dcae", "ref_id": "xccdf_org.ssgproject.content_rule_fe9e3caeab1f6cfd329206aae9bc7d7a", "title": "Praesentium quo nostrum est.", "rationale": "Excepturi magni omnis. Quam amet cumque. Et at ipsam.", "description": "Ut sequi id. Illo aut consectetur. Nostrum rerum optio.", "severity": "high", "precedence": 2022, "identifier": { "href": "http://kertzmann-barton.example/kendall", "label": "Beldis" }, "references": [ { "href": "http://parisian-quigley.example/darryl.gulgowski", "label": "Ciryatur" }, { "href": "http://glover-stamm.test/chang", "label": "Dior" }, { "href": "http://wolff-mcglynn.test/joe", "label": "Théoden" }, { "href": "http://wilkinson.example/genaro", "label": "Freca" }, { "href": "http://parker-dare.test/brent", "label": "Tanta Hornblower" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "79d094bd-e317-4537-9b99-edf745d560bf", "type": "rule" }, { "id": "448bfeb5-7623-46ed-83a8-e3a855b57d2f", "ref_id": "xccdf_org.ssgproject.content_rule_e54f2569a53fcdfdbd90f24798ea9da6", "title": "Ab quibusdam nihil in.", "rationale": "Aut molestiae amet. Fugiat velit quam. Molestiae dignissimos eos.", "description": "Et ut et. Libero nulla ad. Provident in sint.", "severity": "high", "precedence": 8607, "identifier": { "href": "http://bailey.example/julianna_klein", "label": "Finwë" }, "references": [ { "href": "http://okon.test/hoyt_goyette", "label": "Daisy Gamgee" }, { "href": "http://kozey.example/adam_willms", "label": "Marach" }, { "href": "http://tillman.example/mervin.oconnell", "label": "Fosco Baggins" }, { "href": "http://feeney.example/brandon", "label": "Dwalin" }, { "href": "http://huels-brekke.example/carlo", "label": "Frerin" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "29480bda-025d-494f-bb39-b656e457f1aa", "type": "rule" }, { "id": "4a99118e-f866-4116-aae3-f8ac2d39f54f", "ref_id": "xccdf_org.ssgproject.content_rule_ddb33ef03910942b712518cfee8c43f1", "title": "Corporis rerum ut dolores.", "rationale": "Tenetur exercitationem qui. Sunt et minus. Enim est minima.", "description": "Et nesciunt blanditiis. Fuga suscipit ut. Reiciendis voluptatem eligendi.", "severity": "high", "precedence": 1240, "identifier": { "href": "http://hilpert-hoppe.test/max", "label": "Dírhael" }, "references": [ { "href": "http://walsh.example/kaila.haag", "label": "Rudibert Bolger" }, { "href": "http://jacobson.example/ashton.kris", "label": "Quennar" }, { "href": "http://klocko.test/casandra", "label": "Amlach" }, { "href": "http://lueilwitz-abernathy.test/maira", "label": "Bard" }, { "href": "http://bode.example/aaron", "label": "Pervinca Took" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "49d4db5a-222d-4ccb-811c-105dbf06639e", "type": "rule" }, { "id": "51799ff2-7fbb-48b7-9d6a-6cb50999c2d6", "ref_id": "xccdf_org.ssgproject.content_rule_b6db05ac1fd6e458270fe69e8251f026", "title": "Nihil autem deleniti ab.", "rationale": "Voluptate esse incidunt. Esse dolore est. Numquam velit possimus.", "description": "Doloribus in unde. Incidunt totam quia. Veritatis adipisci possimus.", "severity": "medium", "precedence": 7009, "identifier": { "href": "http://satterfield.test/trey_abshire", "label": "Nienor" }, "references": [ { "href": "http://frami-roob.test/pasquale.streich", "label": "Chica Chubb" }, { "href": "http://ankunding.example/oliva_waters", "label": "Snaga" }, { "href": "http://kreiger.example/caitlyn_renner", "label": "Fíli" }, { "href": "http://mann.test/don", "label": "Hending" }, { "href": "http://boyer.test/randal.halvorson", "label": "Dernhelm" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "357f4779-c7fa-40f9-9e1c-081af3e352d2", "type": "rule" }, { "id": "5a4a1613-1a6c-40b0-a779-fabd969858c4", "ref_id": "xccdf_org.ssgproject.content_rule_3f36d14ccd80280b803ce51c82d295ea", "title": "Animi illo ut in.", "rationale": "Exercitationem a voluptas. Hic fugiat quo. Beatae sequi nihil.", "description": "Iure similique at. Quia consectetur explicabo. Ea dolores sit.", "severity": "medium", "precedence": 7047, "identifier": { "href": "http://koss-hane.example/augustine", "label": "Othrondir" }, "references": [ { "href": "http://boyle-rosenbaum.test/hyon", "label": "Sigismond Took" }, { "href": "http://crona-feil.example/nannette", "label": "Beorn" }, { "href": "http://hyatt.test/bonny", "label": "Belen" }, { "href": "http://lemke.test/sandy_dicki", "label": "Galadriel" }, { "href": "http://greenfelder.test/arnold", "label": "Elrond" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "690c0d8c-3430-4a4e-8922-537c2be7b544", "type": "rule" }, { "id": "68ba4df5-8b1f-42cc-80a0-59aef0380cf6", "ref_id": "xccdf_org.ssgproject.content_rule_45565b485ab21dcaf54bab248cf84afc", "title": "Ut quia voluptas voluptatem.", "rationale": "Saepe voluptate quis. Officia deleniti asperiores. Blanditiis consequatur veniam.", "description": "Eveniet a autem. Ut ut voluptate. In odio ut.", "severity": "high", "precedence": 5102, "identifier": { "href": "http://blick.test/alvin_streich", "label": "Wilibald Bolger" }, "references": [ { "href": "http://ward.example/carter", "label": "Nimloth of Doriath" }, { "href": "http://johnston.test/paola", "label": "Goldwine" }, { "href": "http://goyette.example/nathan.mante", "label": "Wilibald Bolger" }, { "href": "http://brekke-mohr.example/cory", "label": "Théodwyn" }, { "href": "http://nicolas.example/hobert", "label": "Berylla Boffin" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "ff6985df-ef7d-4981-a2f0-6cd5d079e541", "type": "rule" } ], "meta": { "total": 25, "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/policies/41dd1a93-2784-4bd3-a148-9dabb9d89a0d/tailorings/a4ad7bde-bdd0-4f4d-8aee-42105266631e/rules?limit=10&offset=0", "last": "/api/compliance/v2/policies/41dd1a93-2784-4bd3-a148-9dabb9d89a0d/tailorings/a4ad7bde-bdd0-4f4d-8aee-42105266631e/rules?limit=10&offset=20", "next": "/api/compliance/v2/policies/41dd1a93-2784-4bd3-a148-9dabb9d89a0d/tailorings/a4ad7bde-bdd0-4f4d-8aee-42105266631e/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": "2688b651-ed1e-419d-a106-0ae43aefeace", "ref_id": "xccdf_org.ssgproject.content_rule_62007b6bd3cc202262d3f5466c2f9d5f", "title": "Veritatis in eligendi voluptatem.", "rationale": "Et ab provident. Quis vel libero. Sunt voluptatum aperiam.", "description": "Aut qui officiis. Ab ut beatae. Ipsum perspiciatis enim.", "severity": "low", "precedence": 732, "identifier": { "href": "http://white.test/aldo", "label": "Hathol" }, "references": [ { "href": "http://davis-ondricka.example/rosario_maggio", "label": "Landroval" }, { "href": "http://robel.test/karl", "label": "Eluréd" }, { "href": "http://powlowski.example/hyman", "label": "Polo Baggins" }, { "href": "http://hayes.test/ciera_daniel", "label": "Vardamir" }, { "href": "http://dickens.example/glen_nicolas", "label": "Théodred" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "83f83188-f2fe-4a97-9a97-4aa72224f451", "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 08ce7f0a-aa37-4454-b3f2-6d51d905ecf7" ] }, "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": "1c21b25d-7e6f-47e0-b0d8-e15e4c3e3c9c", "ref_id": "xccdf_org.ssgproject.content_rule_8cbe493da1038097f410e4554be8acc8", "title": "Tenetur saepe voluptatem optio.", "rationale": "Earum quia non. Dolor nihil hic. Aspernatur sint aut.", "description": "Reprehenderit ducimus esse. Optio repellat dolor. Ut omnis et.", "severity": "high", "precedence": 3999, "identifier": { "href": "http://reichert.example/katia", "label": "Gwaihir" }, "references": [ { "href": "http://thompson-parker.example/felipe_abbott", "label": "Holfast Gardner" }, { "href": "http://hessel.test/tamika.hoeger", "label": "Borthand" }, { "href": "http://lind.example/jeffry_runolfsson", "label": "Malvegil" }, { "href": "http://christiansen.test/brenna", "label": "Túrin" }, { "href": "http://parker.example/hai", "label": "Saradas Brandybuck" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "9264e63c-edb2-4cfe-9322-85e909e214b8", "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 78f9e071-9b7d-49f6-9f23-5a8cb32fb5b7" ] }, "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": "05162585-b31b-405d-ae0b-165c2c3201d7", "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", "title": "Quo non deserunt neque.", "version": "100.83.8", "description": "Voluptatem iste quae. Reiciendis debitis fugit. Delectus ea omnis.", "os_major_version": 7, "type": "security_guide" }, { "id": "096f669e-736b-435c-a27a-871bbb0f8e50", "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", "title": "Rerum laboriosam nostrum quidem.", "version": "100.83.15", "description": "Esse a vero. Eligendi et modi. Ut ut tempora.", "os_major_version": 7, "type": "security_guide" }, { "id": "0aab5284-f62e-4c57-88ac-ead4e6859e98", "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", "title": "Dolor voluptatem at facere.", "version": "100.82.43", "description": "Magnam sapiente dolores. Et sint et. Incidunt iste voluptas.", "os_major_version": 7, "type": "security_guide" }, { "id": "141952be-f49b-48c3-85d9-b6e331cd4d48", "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", "title": "Iusto totam nemo reprehenderit.", "version": "100.83.16", "description": "Numquam voluptatem hic. Modi earum itaque. Autem magni et.", "os_major_version": 7, "type": "security_guide" }, { "id": "210ad79f-1969-43fe-8280-abda48bc49db", "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", "title": "Ex est eius sunt.", "version": "100.83.1", "description": "Ipsum consectetur doloremque. Rerum quo autem. Perferendis eos reiciendis.", "os_major_version": 7, "type": "security_guide" }, { "id": "26a73ee6-644b-4d01-ac6d-43f03ba621e0", "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", "title": "Rem ipsum necessitatibus ea.", "version": "100.83.3", "description": "Numquam inventore ad. Occaecati harum veritatis. Quis atque aliquam.", "os_major_version": 7, "type": "security_guide" }, { "id": "2a966333-ce03-4046-8b7a-808672fedd9b", "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", "title": "Tempore voluptate et voluptatibus.", "version": "100.82.44", "description": "Nesciunt enim iusto. Nam iure sit. Nulla tenetur omnis.", "os_major_version": 7, "type": "security_guide" }, { "id": "3aa4cbeb-445e-406d-80ee-45cfb3aafd0a", "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", "title": "Quidem quam velit sunt.", "version": "100.83.10", "description": "Sit et tempore. Magnam aliquam eum. Atque cumque quis.", "os_major_version": 7, "type": "security_guide" }, { "id": "42febb18-2f7f-4dfd-a8d4-4aae65490d61", "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", "title": "Delectus modi ut officiis.", "version": "100.83.6", "description": "Atque hic excepturi. Libero quia id. Velit et aut.", "os_major_version": 7, "type": "security_guide" }, { "id": "4efc0ac0-c807-4f27-bd93-a7c93e074629", "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", "title": "Est explicabo nulla quis.", "version": "100.83.12", "description": "Sit pariatur qui. Culpa suscipit enim. Accusamus saepe iusto.", "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": "00466a3e-ed93-4c06-b6ca-ddfcbbd22aa1", "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", "title": "Aliquid earum sed rerum.", "version": "100.83.30", "description": "Qui hic voluptates. Sit doloremque est. Possimus dolore expedita.", "os_major_version": 7, "type": "security_guide" }, { "id": "0863ce26-a85d-40aa-a633-b693011bc662", "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", "title": "Nisi voluptas sapiente perspiciatis.", "version": "100.83.37", "description": "Et voluptas voluptatem. Provident soluta id. Autem dignissimos quia.", "os_major_version": 7, "type": "security_guide" }, { "id": "165fccf8-4c3e-4d4c-9098-4224cc03b852", "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", "title": "Non ut quia quia.", "version": "100.83.36", "description": "Dolore et beatae. Omnis et ipsum. Optio eligendi nihil.", "os_major_version": 7, "type": "security_guide" }, { "id": "1a1075ca-d908-4b14-a992-26114f82eadc", "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", "title": "Velit aut temporibus assumenda.", "version": "100.83.29", "description": "Qui voluptate veniam. Sit temporibus magnam. Ut fuga in.", "os_major_version": 7, "type": "security_guide" }, { "id": "1a720e9a-d36e-4102-8779-aae4c73f1e44", "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", "title": "Quos reprehenderit alias esse.", "version": "100.83.41", "description": "In quam culpa. Illo veniam iure. Voluptatem explicabo vel.", "os_major_version": 7, "type": "security_guide" }, { "id": "212052fc-4c5e-40b1-a68f-80849ce38419", "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", "title": "Dolores ad velit ea.", "version": "100.83.28", "description": "Omnis fugit quod. Doloremque esse fuga. Ad animi molestiae.", "os_major_version": 7, "type": "security_guide" }, { "id": "22b5794c-61c8-4bd4-8500-efae4991ff6f", "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", "title": "Esse vel autem odio.", "version": "100.83.39", "description": "Animi qui corrupti. Architecto aliquam ratione. Quaerat et et.", "os_major_version": 7, "type": "security_guide" }, { "id": "260706f4-62f8-4eae-8f72-5c1f7c509049", "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", "title": "Voluptas soluta quia et.", "version": "100.83.18", "description": "Voluptatum nihil ab. Quaerat rerum aut. Iste est optio.", "os_major_version": 7, "type": "security_guide" }, { "id": "28e01b81-95bc-459f-bd73-59c14ae3db61", "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", "title": "Omnis aut non quod.", "version": "100.83.27", "description": "Temporibus non blanditiis. Vel ut doloremque. Sunt quae error.", "os_major_version": 7, "type": "security_guide" }, { "id": "2a168238-e390-48b0-bc62-ea4c76a17ebe", "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", "title": "Officia ab occaecati nostrum.", "version": "100.83.24", "description": "Quas accusantium odit. Ea et quia. Reiciendis doloremque numquam.", "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": "b33c9b6f-05c8-4d5f-9375-b4b6aeb8cb0b", "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", "title": "Accusantium quos pariatur commodi.", "version": "100.85.43", "description": "Ut nostrum facere. Enim eveniet aut. Doloremque eaque sit.", "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 4c33859a-7c16-441b-a1fc-a03fcde22a64" ] }, "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": "22835aef-1555-4312-9377-dae4fe8cf5d3", "type": "rule_group", "children": [ { "id": "c1d16875-b002-49f0-ad6e-df073ffd5e99", "type": "rule" } ] }, { "id": "b32e54a2-8231-4215-9124-23ef1d35da1b", "type": "rule_group", "children": [ { "id": "078f2766-deb7-4db2-a772-3201638f6c6d", "type": "rule" } ] }, { "id": "b872023e-32cd-4ff4-b415-e99ecb688635", "type": "rule_group", "children": [ { "id": "3d819a72-a03f-4d2f-a291-85e555ec4578", "type": "rule" } ] }, { "id": "be75c45b-979c-41bb-b41b-970841ac0edd", "type": "rule_group", "children": [ { "id": "6177ece1-0cfe-43f7-a286-a0e603383775", "type": "rule" } ] }, { "id": "6d6e43af-2b0a-445c-8c38-235ba38d0f4e", "type": "rule_group", "children": [ { "id": "986dc4e2-181c-49cd-bb55-21d947020fa1", "type": "rule" } ] }, { "id": "8e50ba96-dd9b-458d-9e01-53d2334e5da1", "type": "rule_group", "children": [ { "id": "a7118c36-e709-404b-ac8a-cc2de69b2d4a", "type": "rule" } ] }, { "id": "1bb040b6-00c8-4652-8e7a-1f24567deb31", "type": "rule_group", "children": [ { "id": "262fe46d-b6a3-48d0-99fd-b3da4f7dbc4e", "type": "rule" } ] }, { "id": "703fae9d-f169-490e-a7de-191b56b02d3d", "type": "rule_group", "children": [ { "id": "52f3c806-263d-4b27-bce9-ce5747c3f5d4", "type": "rule" } ] }, { "id": "267834f8-26a2-441a-a8bd-35a77837ccae", "type": "rule_group", "children": [ { "id": "8fa56c64-f63a-43a5-8198-2a38be046365", "type": "rule" } ] }, { "id": "f5815895-927d-4411-90a8-15ffa6739188", "type": "rule_group", "children": [ { "id": "c061a498-1d57-4190-af7e-e604b1e070bb", "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 4d9bb6a2-377f-4b0f-acbd-37c43f1a740f" ] }, "summary": "", "description": "" } }, "schema": { "$ref": "#/components/schemas/errors" } } } } } } }, "/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": "835e1843-22f4-4bac-b26e-3fce575f7f20", "title": "Voluptatem eos expedita est.", "description": "Quis natus sapiente. Et eligendi quia. Repellat ut est.", "ref_id": "xccdf_org.ssgproject.content_profile_426bab394c8c3179e64b8d7c9df706d6", "security_guide_id": "3b526888-4f54-456e-8e99-d5182a878909", "security_guide_version": "100.86.22", "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": "5274b515-4a06-4a32-943c-54900d101992", "title": "Aliquam quis ut qui.", "description": "Ratione et in. Sint aut et. Consequatur officiis optio.", "ref_id": "xccdf_org.ssgproject.content_profile_d394f4d9c14161d2c3f55b62353b402f", "security_guide_id": "902a78c9-c9b8-47d4-b1c5-b6a46f65997f", "security_guide_version": "100.86.23", "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": "095406ee-c1fc-4b0c-97b5-042a65da4a15", "display_name": "gulgowski.example", "groups": [], "culled_timestamp": "2035-05-01T11:49:16.985Z", "stale_timestamp": "2035-04-17T11:49:16.985Z", "stale_warning_timestamp": "2035-04-24T11:49:16.985Z", "updated": "2025-04-17T11:49:16.986Z", "insights_id": null, "tags": [ { "key": "array", "value": "primary", "namespace": "transmitting" }, { "key": "driver", "value": "virtual", "namespace": "calculating" }, { "key": "matrix", "value": "neural", "namespace": "indexing" }, { "key": "feed", "value": "1080p", "namespace": "programming" }, { "key": "feed", "value": "primary", "namespace": "synthesizing" } ], "type": "system", "last_check_in": "2035-04-25T11:49:16.985Z", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "0964e6ba-a1b4-427d-9f47-6d3a618949de", "display_name": "sporer-hayes.example", "groups": [], "culled_timestamp": "2035-05-01T11:49:17.027Z", "stale_timestamp": "2035-04-17T11:49:17.027Z", "stale_warning_timestamp": "2035-04-24T11:49:17.027Z", "updated": "2025-04-17T11:49:17.027Z", "insights_id": null, "tags": [ { "key": "circuit", "value": "neural", "namespace": "calculating" }, { "key": "firewall", "value": "virtual", "namespace": "quantifying" }, { "key": "capacitor", "value": "online", "namespace": "programming" }, { "key": "program", "value": "multi-byte", "namespace": "transmitting" }, { "key": "monitor", "value": "open-source", "namespace": "overriding" } ], "type": "system", "last_check_in": "2035-04-25T11:49:17.027Z", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "0f3cdb19-06a5-45fd-b08a-b714d5580208", "display_name": "pacocha.example", "groups": [], "culled_timestamp": "2035-05-01T11:49:16.969Z", "stale_timestamp": "2035-04-17T11:49:16.969Z", "stale_warning_timestamp": "2035-04-24T11:49:16.969Z", "updated": "2025-04-17T11:49:16.969Z", "insights_id": null, "tags": [ { "key": "pixel", "value": "solid state", "namespace": "bypassing" }, { "key": "panel", "value": "auxiliary", "namespace": "quantifying" }, { "key": "port", "value": "multi-byte", "namespace": "generating" }, { "key": "program", "value": "primary", "namespace": "hacking" }, { "key": "bus", "value": "multi-byte", "namespace": "connecting" } ], "type": "system", "last_check_in": "2035-04-25T11:49:16.969Z", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "19d69fe7-f16f-453b-98ee-b241016d07eb", "display_name": "casper-bayer.test", "groups": [], "culled_timestamp": "2035-05-01T11:49:17.001Z", "stale_timestamp": "2035-04-17T11:49:17.001Z", "stale_warning_timestamp": "2035-04-24T11:49:17.001Z", "updated": "2025-04-17T11:49:17.001Z", "insights_id": null, "tags": [ { "key": "program", "value": "digital", "namespace": "bypassing" }, { "key": "pixel", "value": "bluetooth", "namespace": "synthesizing" }, { "key": "interface", "value": "solid state", "namespace": "navigating" }, { "key": "feed", "value": "neural", "namespace": "connecting" }, { "key": "feed", "value": "multi-byte", "namespace": "indexing" } ], "type": "system", "last_check_in": "2035-04-25T11:49:17.001Z", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "2857916d-dc11-43fe-b96c-740b12c946b7", "display_name": "goldner.example", "groups": [], "culled_timestamp": "2035-05-01T11:49:17.004Z", "stale_timestamp": "2035-04-17T11:49:17.004Z", "stale_warning_timestamp": "2035-04-24T11:49:17.004Z", "updated": "2025-04-17T11:49:17.004Z", "insights_id": null, "tags": [ { "key": "protocol", "value": "open-source", "namespace": "transmitting" }, { "key": "system", "value": "bluetooth", "namespace": "compressing" }, { "key": "sensor", "value": "bluetooth", "namespace": "backing up" }, { "key": "program", "value": "open-source", "namespace": "calculating" }, { "key": "application", "value": "digital", "namespace": "hacking" } ], "type": "system", "last_check_in": "2035-04-25T11:49:17.004Z", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "29e611b3-330f-443a-8eda-d278adda7cd2", "display_name": "hermiston-rohan.example", "groups": [], "culled_timestamp": "2035-05-01T11:49:16.995Z", "stale_timestamp": "2035-04-17T11:49:16.995Z", "stale_warning_timestamp": "2035-04-24T11:49:16.995Z", "updated": "2025-04-17T11:49:16.996Z", "insights_id": null, "tags": [ { "key": "capacitor", "value": "digital", "namespace": "overriding" }, { "key": "interface", "value": "mobile", "namespace": "backing up" }, { "key": "monitor", "value": "back-end", "namespace": "programming" }, { "key": "matrix", "value": "mobile", "namespace": "overriding" }, { "key": "capacitor", "value": "auxiliary", "namespace": "backing up" } ], "type": "system", "last_check_in": "2035-04-25T11:49:16.995Z", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "324c4943-4ea4-4bd6-8d54-f9ca3eb46d33", "display_name": "kiehn.test", "groups": [], "culled_timestamp": "2035-05-01T11:49:16.971Z", "stale_timestamp": "2035-04-17T11:49:16.971Z", "stale_warning_timestamp": "2035-04-24T11:49:16.971Z", "updated": "2025-04-17T11:49:16.971Z", "insights_id": null, "tags": [ { "key": "port", "value": "cross-platform", "namespace": "backing up" }, { "key": "microchip", "value": "redundant", "namespace": "backing up" }, { "key": "pixel", "value": "solid state", "namespace": "indexing" }, { "key": "monitor", "value": "haptic", "namespace": "copying" }, { "key": "bus", "value": "digital", "namespace": "synthesizing" } ], "type": "system", "last_check_in": "2035-04-25T11:49:16.971Z", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "39226c5e-9941-4713-8975-d032e522de91", "display_name": "bogan.example", "groups": [], "culled_timestamp": "2035-05-01T11:49:16.973Z", "stale_timestamp": "2035-04-17T11:49:16.973Z", "stale_warning_timestamp": "2035-04-24T11:49:16.973Z", "updated": "2025-04-17T11:49:16.973Z", "insights_id": null, "tags": [ { "key": "driver", "value": "1080p", "namespace": "programming" }, { "key": "microchip", "value": "bluetooth", "namespace": "calculating" }, { "key": "array", "value": "auxiliary", "namespace": "backing up" }, { "key": "circuit", "value": "cross-platform", "namespace": "compressing" }, { "key": "array", "value": "redundant", "namespace": "calculating" } ], "type": "system", "last_check_in": "2035-04-25T11:49:16.973Z", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "40c1ac56-c687-4fd8-b474-f15485ab0510", "display_name": "littel.example", "groups": [], "culled_timestamp": "2035-05-01T11:49:17.017Z", "stale_timestamp": "2035-04-17T11:49:17.017Z", "stale_warning_timestamp": "2035-04-24T11:49:17.017Z", "updated": "2025-04-17T11:49:17.017Z", "insights_id": null, "tags": [ { "key": "microchip", "value": "online", "namespace": "calculating" }, { "key": "application", "value": "1080p", "namespace": "indexing" }, { "key": "interface", "value": "back-end", "namespace": "backing up" }, { "key": "matrix", "value": "mobile", "namespace": "connecting" }, { "key": "interface", "value": "optical", "namespace": "programming" } ], "type": "system", "last_check_in": "2035-04-25T11:49:17.017Z", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "41006059-00ce-40c5-98ab-4667976c0d4d", "display_name": "graham.example", "groups": [], "culled_timestamp": "2035-05-01T11:49:17.015Z", "stale_timestamp": "2035-04-17T11:49:17.015Z", "stale_warning_timestamp": "2035-04-24T11:49:17.015Z", "updated": "2025-04-17T11:49:17.015Z", "insights_id": null, "tags": [ { "key": "array", "value": "mobile", "namespace": "compressing" }, { "key": "card", "value": "digital", "namespace": "calculating" }, { "key": "system", "value": "open-source", "namespace": "calculating" }, { "key": "bandwidth", "value": "primary", "namespace": "parsing" }, { "key": "port", "value": "wireless", "namespace": "indexing" } ], "type": "system", "last_check_in": "2035-04-25T11:49:17.015Z", "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": "010b0778-50f5-4f2e-80fd-079f45a1b3bc", "display_name": "batz.test", "groups": [], "culled_timestamp": "2035-05-01T11:49:17.092Z", "stale_timestamp": "2035-04-17T11:49:17.092Z", "stale_warning_timestamp": "2035-04-24T11:49:17.092Z", "updated": "2025-04-17T11:49:17.092Z", "insights_id": null, "tags": [ { "key": "application", "value": "open-source", "namespace": "synthesizing" }, { "key": "firewall", "value": "optical", "namespace": "connecting" }, { "key": "bandwidth", "value": "optical", "namespace": "navigating" }, { "key": "panel", "value": "optical", "namespace": "hacking" }, { "key": "bus", "value": "redundant", "namespace": "quantifying" } ], "type": "system", "last_check_in": "2035-04-25T11:49:17.092Z", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "017c23c7-277f-456c-98d9-b47dcc59caf5", "display_name": "howell-casper.example", "groups": [], "culled_timestamp": "2035-05-01T11:49:17.059Z", "stale_timestamp": "2035-04-17T11:49:17.059Z", "stale_warning_timestamp": "2035-04-24T11:49:17.059Z", "updated": "2025-04-17T11:49:17.059Z", "insights_id": null, "tags": [ { "key": "sensor", "value": "neural", "namespace": "copying" }, { "key": "card", "value": "open-source", "namespace": "connecting" }, { "key": "driver", "value": "online", "namespace": "hacking" }, { "key": "feed", "value": "1080p", "namespace": "transmitting" }, { "key": "microchip", "value": "solid state", "namespace": "compressing" } ], "type": "system", "last_check_in": "2035-04-25T11:49:17.059Z", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "22037ff7-ba34-410f-93c4-1f2ed2f41dd3", "display_name": "witting.example", "groups": [], "culled_timestamp": "2035-05-01T11:49:17.097Z", "stale_timestamp": "2035-04-17T11:49:17.097Z", "stale_warning_timestamp": "2035-04-24T11:49:17.097Z", "updated": "2025-04-17T11:49:17.097Z", "insights_id": null, "tags": [ { "key": "array", "value": "open-source", "namespace": "navigating" }, { "key": "pixel", "value": "virtual", "namespace": "connecting" }, { "key": "port", "value": "back-end", "namespace": "parsing" }, { "key": "interface", "value": "mobile", "namespace": "calculating" }, { "key": "monitor", "value": "optical", "namespace": "calculating" } ], "type": "system", "last_check_in": "2035-04-25T11:49:17.097Z", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "2439fd61-b8cd-4439-aeeb-af24078e1aa7", "display_name": "nienow.test", "groups": [], "culled_timestamp": "2035-05-01T11:49:17.073Z", "stale_timestamp": "2035-04-17T11:49:17.073Z", "stale_warning_timestamp": "2035-04-24T11:49:17.073Z", "updated": "2025-04-17T11:49:17.073Z", "insights_id": null, "tags": [ { "key": "port", "value": "bluetooth", "namespace": "connecting" }, { "key": "transmitter", "value": "solid state", "namespace": "parsing" }, { "key": "pixel", "value": "mobile", "namespace": "connecting" }, { "key": "pixel", "value": "primary", "namespace": "programming" }, { "key": "application", "value": "haptic", "namespace": "synthesizing" } ], "type": "system", "last_check_in": "2035-04-25T11:49:17.073Z", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "280685c4-3cbe-4c51-9975-4e56d083eb77", "display_name": "gleichner-fisher.example", "groups": [], "culled_timestamp": "2035-05-01T11:49:17.068Z", "stale_timestamp": "2035-04-17T11:49:17.068Z", "stale_warning_timestamp": "2035-04-24T11:49:17.068Z", "updated": "2025-04-17T11:49:17.068Z", "insights_id": null, "tags": [ { "key": "array", "value": "online", "namespace": "compressing" }, { "key": "sensor", "value": "multi-byte", "namespace": "hacking" }, { "key": "matrix", "value": "haptic", "namespace": "parsing" }, { "key": "card", "value": "cross-platform", "namespace": "navigating" }, { "key": "pixel", "value": "virtual", "namespace": "connecting" } ], "type": "system", "last_check_in": "2035-04-25T11:49:17.068Z", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "2a9c4042-44ed-4caf-ab66-de8c24cf0b22", "display_name": "jacobson.test", "groups": [], "culled_timestamp": "2035-05-01T11:49:17.094Z", "stale_timestamp": "2035-04-17T11:49:17.094Z", "stale_warning_timestamp": "2035-04-24T11:49:17.094Z", "updated": "2025-04-17T11:49:17.094Z", "insights_id": null, "tags": [ { "key": "panel", "value": "digital", "namespace": "connecting" }, { "key": "circuit", "value": "bluetooth", "namespace": "programming" }, { "key": "microchip", "value": "bluetooth", "namespace": "compressing" }, { "key": "protocol", "value": "mobile", "namespace": "copying" }, { "key": "sensor", "value": "primary", "namespace": "connecting" } ], "type": "system", "last_check_in": "2035-04-25T11:49:17.094Z", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "3486ae2f-8490-4c02-ba73-34b628bdbfcf", "display_name": "hirthe.test", "groups": [], "culled_timestamp": "2035-05-01T11:49:17.060Z", "stale_timestamp": "2035-04-17T11:49:17.060Z", "stale_warning_timestamp": "2035-04-24T11:49:17.060Z", "updated": "2025-04-17T11:49:17.060Z", "insights_id": null, "tags": [ { "key": "card", "value": "neural", "namespace": "connecting" }, { "key": "bandwidth", "value": "back-end", "namespace": "copying" }, { "key": "pixel", "value": "1080p", "namespace": "parsing" }, { "key": "monitor", "value": "virtual", "namespace": "hacking" }, { "key": "transmitter", "value": "online", "namespace": "copying" } ], "type": "system", "last_check_in": "2035-04-25T11:49:17.060Z", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "3b94888f-2cf5-47f9-80c4-d90d54f033e0", "display_name": "reichert-wilderman.example", "groups": [], "culled_timestamp": "2035-05-01T11:49:17.080Z", "stale_timestamp": "2035-04-17T11:49:17.080Z", "stale_warning_timestamp": "2035-04-24T11:49:17.080Z", "updated": "2025-04-17T11:49:17.080Z", "insights_id": null, "tags": [ { "key": "bus", "value": "auxiliary", "namespace": "calculating" }, { "key": "port", "value": "auxiliary", "namespace": "parsing" }, { "key": "firewall", "value": "solid state", "namespace": "copying" }, { "key": "circuit", "value": "neural", "namespace": "compressing" }, { "key": "panel", "value": "open-source", "namespace": "transmitting" } ], "type": "system", "last_check_in": "2035-04-25T11:49:17.080Z", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "4c0ad47a-40dc-4b2f-a7a1-ae2cbf70c7ec", "display_name": "goyette.example", "groups": [], "culled_timestamp": "2035-05-01T11:49:17.057Z", "stale_timestamp": "2035-04-17T11:49:17.057Z", "stale_warning_timestamp": "2035-04-24T11:49:17.057Z", "updated": "2025-04-17T11:49:17.057Z", "insights_id": null, "tags": [ { "key": "card", "value": "primary", "namespace": "overriding" }, { "key": "bus", "value": "virtual", "namespace": "overriding" }, { "key": "panel", "value": "online", "namespace": "compressing" }, { "key": "transmitter", "value": "open-source", "namespace": "calculating" }, { "key": "panel", "value": "open-source", "namespace": "connecting" } ], "type": "system", "last_check_in": "2035-04-25T11:49:17.057Z", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "5908eeea-8e3c-4648-9893-e8b8314fc0ad", "display_name": "sawayn.example", "groups": [], "culled_timestamp": "2035-05-01T11:49:17.077Z", "stale_timestamp": "2035-04-17T11:49:17.077Z", "stale_warning_timestamp": "2035-04-24T11:49:17.077Z", "updated": "2025-04-17T11:49:17.077Z", "insights_id": null, "tags": [ { "key": "sensor", "value": "redundant", "namespace": "synthesizing" }, { "key": "matrix", "value": "mobile", "namespace": "programming" }, { "key": "application", "value": "primary", "namespace": "synthesizing" }, { "key": "matrix", "value": "back-end", "namespace": "navigating" }, { "key": "feed", "value": "multi-byte", "namespace": "parsing" } ], "type": "system", "last_check_in": "2035-04-25T11:49:17.077Z", "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": "027ebfd3-efd1-4b09-a6f4-a75ed5b6be3d", "display_name": "wuckert-ankunding.example", "groups": [], "culled_timestamp": "2035-05-01T11:49:17.164Z", "stale_timestamp": "2035-04-17T11:49:17.164Z", "stale_warning_timestamp": "2035-04-24T11:49:17.164Z", "updated": "2025-04-17T11:49:17.164Z", "insights_id": null, "tags": [ { "key": "bus", "value": "mobile", "namespace": "calculating" }, { "key": "panel", "value": "haptic", "namespace": "copying" }, { "key": "sensor", "value": "online", "namespace": "compressing" }, { "key": "bandwidth", "value": "multi-byte", "namespace": "programming" }, { "key": "program", "value": "online", "namespace": "transmitting" } ], "type": "system", "last_check_in": "2035-04-25T11:49:17.164Z", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "0e308c38-f22f-49a3-9a1d-550e65f148d8", "display_name": "donnelly-beier.test", "groups": [], "culled_timestamp": "2035-05-01T11:49:17.124Z", "stale_timestamp": "2035-04-17T11:49:17.124Z", "stale_warning_timestamp": "2035-04-24T11:49:17.124Z", "updated": "2025-04-17T11:49:17.124Z", "insights_id": null, "tags": [ { "key": "program", "value": "haptic", "namespace": "generating" }, { "key": "application", "value": "bluetooth", "namespace": "compressing" }, { "key": "interface", "value": "1080p", "namespace": "backing up" }, { "key": "array", "value": "virtual", "namespace": "compressing" }, { "key": "alarm", "value": "1080p", "namespace": "parsing" } ], "type": "system", "last_check_in": "2035-04-25T11:49:17.124Z", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "0f8ea7b2-20e3-4c5a-953b-991110fcf922", "display_name": "waelchi.example", "groups": [], "culled_timestamp": "2035-05-01T11:49:17.156Z", "stale_timestamp": "2035-04-17T11:49:17.156Z", "stale_warning_timestamp": "2035-04-24T11:49:17.156Z", "updated": "2025-04-17T11:49:17.156Z", "insights_id": null, "tags": [ { "key": "array", "value": "redundant", "namespace": "synthesizing" }, { "key": "circuit", "value": "optical", "namespace": "bypassing" }, { "key": "bandwidth", "value": "1080p", "namespace": "hacking" }, { "key": "port", "value": "1080p", "namespace": "indexing" }, { "key": "pixel", "value": "cross-platform", "namespace": "copying" } ], "type": "system", "last_check_in": "2035-04-25T11:49:17.156Z", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "369ebf30-2d70-4a4d-8a6b-266aec43b695", "display_name": "hayes.example", "groups": [], "culled_timestamp": "2035-05-01T11:49:17.153Z", "stale_timestamp": "2035-04-17T11:49:17.153Z", "stale_warning_timestamp": "2035-04-24T11:49:17.153Z", "updated": "2025-04-17T11:49:17.153Z", "insights_id": null, "tags": [ { "key": "port", "value": "digital", "namespace": "compressing" }, { "key": "alarm", "value": "1080p", "namespace": "compressing" }, { "key": "port", "value": "1080p", "namespace": "compressing" }, { "key": "monitor", "value": "primary", "namespace": "programming" }, { "key": "card", "value": "optical", "namespace": "synthesizing" } ], "type": "system", "last_check_in": "2035-04-25T11:49:17.153Z", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "3e4424ac-7763-41db-a029-e3119e6fae8a", "display_name": "jones-mohr.test", "groups": [], "culled_timestamp": "2035-05-01T11:49:17.135Z", "stale_timestamp": "2035-04-17T11:49:17.135Z", "stale_warning_timestamp": "2035-04-24T11:49:17.135Z", "updated": "2025-04-17T11:49:17.135Z", "insights_id": null, "tags": [ { "key": "bus", "value": "auxiliary", "namespace": "copying" }, { "key": "monitor", "value": "mobile", "namespace": "calculating" }, { "key": "sensor", "value": "1080p", "namespace": "backing up" }, { "key": "feed", "value": "optical", "namespace": "bypassing" }, { "key": "card", "value": "digital", "namespace": "backing up" } ], "type": "system", "last_check_in": "2035-04-25T11:49:17.135Z", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "428ba845-6ccb-4bce-b4b7-8b85cad4bea3", "display_name": "prohaska.example", "groups": [], "culled_timestamp": "2035-05-01T11:49:17.167Z", "stale_timestamp": "2035-04-17T11:49:17.167Z", "stale_warning_timestamp": "2035-04-24T11:49:17.167Z", "updated": "2025-04-17T11:49:17.167Z", "insights_id": null, "tags": [ { "key": "bus", "value": "mobile", "namespace": "connecting" }, { "key": "pixel", "value": "primary", "namespace": "calculating" }, { "key": "driver", "value": "virtual", "namespace": "quantifying" }, { "key": "interface", "value": "cross-platform", "namespace": "calculating" }, { "key": "system", "value": "online", "namespace": "synthesizing" } ], "type": "system", "last_check_in": "2035-04-25T11:49:17.167Z", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "4315153c-7434-4ad5-94f4-fd33cef72476", "display_name": "price.example", "groups": [], "culled_timestamp": "2035-05-01T11:49:17.144Z", "stale_timestamp": "2035-04-17T11:49:17.144Z", "stale_warning_timestamp": "2035-04-24T11:49:17.144Z", "updated": "2025-04-17T11:49:17.144Z", "insights_id": null, "tags": [ { "key": "microchip", "value": "solid state", "namespace": "indexing" }, { "key": "driver", "value": "auxiliary", "namespace": "parsing" }, { "key": "capacitor", "value": "back-end", "namespace": "compressing" }, { "key": "panel", "value": "bluetooth", "namespace": "transmitting" }, { "key": "panel", "value": "wireless", "namespace": "programming" } ], "type": "system", "last_check_in": "2035-04-25T11:49:17.144Z", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "5476cbcd-2969-4c88-9e3b-011e4c1e9927", "display_name": "walker.example", "groups": [], "culled_timestamp": "2035-05-01T11:49:17.139Z", "stale_timestamp": "2035-04-17T11:49:17.139Z", "stale_warning_timestamp": "2035-04-24T11:49:17.139Z", "updated": "2025-04-17T11:49:17.139Z", "insights_id": null, "tags": [ { "key": "sensor", "value": "back-end", "namespace": "connecting" }, { "key": "firewall", "value": "back-end", "namespace": "parsing" }, { "key": "circuit", "value": "optical", "namespace": "programming" }, { "key": "microchip", "value": "wireless", "namespace": "parsing" }, { "key": "bus", "value": "back-end", "namespace": "bypassing" } ], "type": "system", "last_check_in": "2035-04-25T11:49:17.139Z", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "5548df50-286c-49f1-bbaa-db9e57a17cc7", "display_name": "lind.test", "groups": [], "culled_timestamp": "2035-05-01T11:49:17.169Z", "stale_timestamp": "2035-04-17T11:49:17.169Z", "stale_warning_timestamp": "2035-04-24T11:49:17.169Z", "updated": "2025-04-17T11:49:17.169Z", "insights_id": null, "tags": [ { "key": "alarm", "value": "neural", "namespace": "indexing" }, { "key": "transmitter", "value": "1080p", "namespace": "overriding" }, { "key": "program", "value": "bluetooth", "namespace": "overriding" }, { "key": "firewall", "value": "1080p", "namespace": "calculating" }, { "key": "bus", "value": "1080p", "namespace": "synthesizing" } ], "type": "system", "last_check_in": "2035-04-25T11:49:17.169Z", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "5634e65c-02a9-4050-8331-799ff7619a5f", "display_name": "morissette-stoltenberg.example", "groups": [], "culled_timestamp": "2035-05-01T11:49:17.141Z", "stale_timestamp": "2035-04-17T11:49:17.141Z", "stale_warning_timestamp": "2035-04-24T11:49:17.141Z", "updated": "2025-04-17T11:49:17.141Z", "insights_id": null, "tags": [ { "key": "circuit", "value": "optical", "namespace": "transmitting" }, { "key": "feed", "value": "mobile", "namespace": "calculating" }, { "key": "panel", "value": "cross-platform", "namespace": "indexing" }, { "key": "circuit", "value": "primary", "namespace": "connecting" }, { "key": "bandwidth", "value": "back-end", "namespace": "transmitting" } ], "type": "system", "last_check_in": "2035-04-25T11:49:17.141Z", "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": "1b214511-b569-4cfa-8feb-8b8073e4d77d", "display_name": "cormier.test", "groups": [], "culled_timestamp": "2035-05-01T11:49:17.520Z", "stale_timestamp": "2035-04-17T11:49:17.520Z", "stale_warning_timestamp": "2035-04-24T11:49:17.520Z", "updated": "2025-04-17T11:49:17.520Z", "insights_id": null, "tags": [ { "key": "feed", "value": "1080p", "namespace": "backing up" }, { "key": "protocol", "value": "haptic", "namespace": "connecting" }, { "key": "feed", "value": "open-source", "namespace": "hacking" }, { "key": "firewall", "value": "solid state", "namespace": "bypassing" }, { "key": "program", "value": "haptic", "namespace": "overriding" } ], "type": "system", "last_check_in": "2035-04-25T11:49:17.520Z", "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 2caa6742-2cdd-4247-a0dd-b0422a28fe6e" ] }, "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": "00b0ebe8-4784-455a-aa84-cd2d0be93b26", "display_name": "mueller.test", "groups": [], "culled_timestamp": "2035-05-01T11:49:17.672Z", "stale_timestamp": "2035-04-17T11:49:17.672Z", "stale_warning_timestamp": "2035-04-24T11:49:17.672Z", "updated": "2025-04-17T11:49:17.672Z", "insights_id": null, "tags": [ { "key": "circuit", "value": "digital", "namespace": "copying" }, { "key": "interface", "value": "cross-platform", "namespace": "copying" }, { "key": "pixel", "value": "haptic", "namespace": "synthesizing" }, { "key": "program", "value": "optical", "namespace": "backing up" }, { "key": "microchip", "value": "bluetooth", "namespace": "copying" } ], "type": "system", "last_check_in": "2035-04-25T11:49:17.672Z", "os_major_version": 8, "os_minor_version": 0 }, { "id": "0c2e1075-8559-425b-bd7a-a22f9c66f9d0", "display_name": "schinner.test", "groups": [], "culled_timestamp": "2035-05-01T11:49:17.596Z", "stale_timestamp": "2035-04-17T11:49:17.596Z", "stale_warning_timestamp": "2035-04-24T11:49:17.596Z", "updated": "2025-04-17T11:49:17.596Z", "insights_id": null, "tags": [ { "key": "bus", "value": "online", "namespace": "bypassing" }, { "key": "program", "value": "virtual", "namespace": "transmitting" }, { "key": "bus", "value": "back-end", "namespace": "synthesizing" }, { "key": "transmitter", "value": "mobile", "namespace": "quantifying" }, { "key": "transmitter", "value": "bluetooth", "namespace": "navigating" } ], "type": "system", "last_check_in": "2035-04-25T11:49:17.596Z", "os_major_version": 8, "os_minor_version": 0 }, { "id": "160d3c0e-85dd-4f4a-b6b7-4cda7afc413b", "display_name": "gottlieb-dubuque.test", "groups": [], "culled_timestamp": "2035-05-01T11:49:17.757Z", "stale_timestamp": "2035-04-17T11:49:17.757Z", "stale_warning_timestamp": "2035-04-24T11:49:17.757Z", "updated": "2025-04-17T11:49:17.757Z", "insights_id": null, "tags": [ { "key": "panel", "value": "primary", "namespace": "parsing" }, { "key": "monitor", "value": "neural", "namespace": "hacking" }, { "key": "sensor", "value": "online", "namespace": "overriding" }, { "key": "system", "value": "redundant", "namespace": "calculating" }, { "key": "circuit", "value": "multi-byte", "namespace": "synthesizing" } ], "type": "system", "last_check_in": "2035-04-25T11:49:17.757Z", "os_major_version": 8, "os_minor_version": 0 }, { "id": "259fd8f6-e193-45a3-b7b1-2309ff60bcc6", "display_name": "wisoky.test", "groups": [], "culled_timestamp": "2035-05-01T11:49:17.607Z", "stale_timestamp": "2035-04-17T11:49:17.607Z", "stale_warning_timestamp": "2035-04-24T11:49:17.607Z", "updated": "2025-04-17T11:49:17.607Z", "insights_id": null, "tags": [ { "key": "panel", "value": "wireless", "namespace": "backing up" }, { "key": "sensor", "value": "haptic", "namespace": "hacking" }, { "key": "hard drive", "value": "wireless", "namespace": "calculating" }, { "key": "circuit", "value": "back-end", "namespace": "copying" }, { "key": "pixel", "value": "haptic", "namespace": "parsing" } ], "type": "system", "last_check_in": "2035-04-25T11:49:17.607Z", "os_major_version": 8, "os_minor_version": 0 }, { "id": "2cd0f854-8115-4171-b8b7-707fd7f0e974", "display_name": "zieme.test", "groups": [], "culled_timestamp": "2035-05-01T11:49:17.557Z", "stale_timestamp": "2035-04-17T11:49:17.557Z", "stale_warning_timestamp": "2035-04-24T11:49:17.557Z", "updated": "2025-04-17T11:49:17.557Z", "insights_id": null, "tags": [ { "key": "bandwidth", "value": "mobile", "namespace": "compressing" }, { "key": "bus", "value": "wireless", "namespace": "compressing" }, { "key": "pixel", "value": "multi-byte", "namespace": "indexing" }, { "key": "circuit", "value": "auxiliary", "namespace": "hacking" }, { "key": "program", "value": "neural", "namespace": "parsing" } ], "type": "system", "last_check_in": "2035-04-25T11:49:17.557Z", "os_major_version": 8, "os_minor_version": 0 }, { "id": "2fec6942-5f98-4aea-af2d-5c74401febd6", "display_name": "connelly.test", "groups": [], "culled_timestamp": "2035-05-01T11:49:17.745Z", "stale_timestamp": "2035-04-17T11:49:17.745Z", "stale_warning_timestamp": "2035-04-24T11:49:17.745Z", "updated": "2025-04-17T11:49:17.746Z", "insights_id": null, "tags": [ { "key": "pixel", "value": "open-source", "namespace": "copying" }, { "key": "protocol", "value": "primary", "namespace": "generating" }, { "key": "bus", "value": "online", "namespace": "quantifying" }, { "key": "sensor", "value": "auxiliary", "namespace": "calculating" }, { "key": "panel", "value": "digital", "namespace": "parsing" } ], "type": "system", "last_check_in": "2035-04-25T11:49:17.745Z", "os_major_version": 8, "os_minor_version": 0 }, { "id": "427a6c96-ce60-476c-9e21-6b8745a35c48", "display_name": "volkman.example", "groups": [], "culled_timestamp": "2035-05-01T11:49:17.714Z", "stale_timestamp": "2035-04-17T11:49:17.714Z", "stale_warning_timestamp": "2035-04-24T11:49:17.714Z", "updated": "2025-04-17T11:49:17.714Z", "insights_id": null, "tags": [ { "key": "alarm", "value": "primary", "namespace": "backing up" }, { "key": "array", "value": "redundant", "namespace": "quantifying" }, { "key": "sensor", "value": "back-end", "namespace": "indexing" }, { "key": "sensor", "value": "neural", "namespace": "transmitting" }, { "key": "port", "value": "redundant", "namespace": "synthesizing" } ], "type": "system", "last_check_in": "2035-04-25T11:49:17.714Z", "os_major_version": 8, "os_minor_version": 0 }, { "id": "44f15598-a0aa-4e1f-a727-336a76107ff4", "display_name": "kulas-schaden.test", "groups": [], "culled_timestamp": "2035-05-01T11:49:17.725Z", "stale_timestamp": "2035-04-17T11:49:17.725Z", "stale_warning_timestamp": "2035-04-24T11:49:17.725Z", "updated": "2025-04-17T11:49:17.725Z", "insights_id": null, "tags": [ { "key": "matrix", "value": "haptic", "namespace": "copying" }, { "key": "port", "value": "1080p", "namespace": "programming" }, { "key": "program", "value": "haptic", "namespace": "generating" }, { "key": "feed", "value": "wireless", "namespace": "calculating" }, { "key": "driver", "value": "cross-platform", "namespace": "parsing" } ], "type": "system", "last_check_in": "2035-04-25T11:49:17.725Z", "os_major_version": 8, "os_minor_version": 0 }, { "id": "475b347e-b280-4017-bd0b-c383c15ffa8f", "display_name": "king.test", "groups": [], "culled_timestamp": "2035-05-01T11:49:17.767Z", "stale_timestamp": "2035-04-17T11:49:17.767Z", "stale_warning_timestamp": "2035-04-24T11:49:17.767Z", "updated": "2025-04-17T11:49:17.767Z", "insights_id": null, "tags": [ { "key": "sensor", "value": "mobile", "namespace": "generating" }, { "key": "matrix", "value": "wireless", "namespace": "calculating" }, { "key": "panel", "value": "open-source", "namespace": "transmitting" }, { "key": "system", "value": "primary", "namespace": "programming" }, { "key": "transmitter", "value": "mobile", "namespace": "parsing" } ], "type": "system", "last_check_in": "2035-04-25T11:49:17.767Z", "os_major_version": 8, "os_minor_version": 0 }, { "id": "48b2b4ba-710b-4586-a251-40f1693becc1", "display_name": "hessel.test", "groups": [], "culled_timestamp": "2035-05-01T11:49:17.788Z", "stale_timestamp": "2035-04-17T11:49:17.788Z", "stale_warning_timestamp": "2035-04-24T11:49:17.788Z", "updated": "2025-04-17T11:49:17.788Z", "insights_id": null, "tags": [ { "key": "bus", "value": "open-source", "namespace": "hacking" }, { "key": "driver", "value": "back-end", "namespace": "connecting" }, { "key": "panel", "value": "mobile", "namespace": "backing up" }, { "key": "circuit", "value": "digital", "namespace": "compressing" }, { "key": "monitor", "value": "neural", "namespace": "transmitting" } ], "type": "system", "last_check_in": "2035-04-25T11:49:17.788Z", "os_major_version": 8, "os_minor_version": 0 } ], "meta": { "total": 25, "tags": [], "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/policies/90a7be96-12c3-430d-a7ea-2a3d4a9c110e/systems?limit=10&offset=0", "last": "/api/compliance/v2/policies/90a7be96-12c3-430d-a7ea-2a3d4a9c110e/systems?limit=10&offset=20", "next": "/api/compliance/v2/policies/90a7be96-12c3-430d-a7ea-2a3d4a9c110e/systems?limit=10&offset=10" } }, "summary": "", "description": "" }, "List of Systems sorted by \"os_minor_version:asc\"": { "value": { "data": [ { "id": "04c833be-e1ff-4302-bc63-9b0301a60691", "display_name": "rodriguez-jakubowski.test", "groups": [], "culled_timestamp": "2035-05-01T11:49:17.991Z", "stale_timestamp": "2035-04-17T11:49:17.991Z", "stale_warning_timestamp": "2035-04-24T11:49:17.991Z", "updated": "2025-04-17T11:49:17.991Z", "insights_id": null, "tags": [ { "key": "capacitor", "value": "online", "namespace": "indexing" }, { "key": "pixel", "value": "redundant", "namespace": "bypassing" }, { "key": "pixel", "value": "digital", "namespace": "generating" }, { "key": "protocol", "value": "optical", "namespace": "connecting" }, { "key": "interface", "value": "digital", "namespace": "hacking" } ], "type": "system", "last_check_in": "2035-04-25T11:49:17.991Z", "os_major_version": 8, "os_minor_version": 0 }, { "id": "1ec805eb-2e9e-4147-b7a7-4e3aeb850ec7", "display_name": "daugherty.test", "groups": [], "culled_timestamp": "2035-05-01T11:49:17.954Z", "stale_timestamp": "2035-04-17T11:49:17.954Z", "stale_warning_timestamp": "2035-04-24T11:49:17.954Z", "updated": "2025-04-17T11:49:17.954Z", "insights_id": null, "tags": [ { "key": "circuit", "value": "neural", "namespace": "transmitting" }, { "key": "alarm", "value": "solid state", "namespace": "copying" }, { "key": "transmitter", "value": "back-end", "namespace": "navigating" }, { "key": "pixel", "value": "neural", "namespace": "hacking" }, { "key": "interface", "value": "1080p", "namespace": "calculating" } ], "type": "system", "last_check_in": "2035-04-25T11:49:17.954Z", "os_major_version": 8, "os_minor_version": 0 }, { "id": "29034aad-9a59-457d-97b0-346d84484700", "display_name": "bartell.test", "groups": [], "culled_timestamp": "2035-05-01T11:49:17.927Z", "stale_timestamp": "2035-04-17T11:49:17.927Z", "stale_warning_timestamp": "2035-04-24T11:49:17.927Z", "updated": "2025-04-17T11:49:17.927Z", "insights_id": null, "tags": [ { "key": "array", "value": "cross-platform", "namespace": "synthesizing" }, { "key": "circuit", "value": "bluetooth", "namespace": "compressing" }, { "key": "firewall", "value": "primary", "namespace": "parsing" }, { "key": "system", "value": "optical", "namespace": "hacking" }, { "key": "feed", "value": "virtual", "namespace": "indexing" } ], "type": "system", "last_check_in": "2035-04-25T11:49:17.927Z", "os_major_version": 8, "os_minor_version": 0 }, { "id": "36a81342-baba-47ce-a459-bc4b64c2057a", "display_name": "mohr.test", "groups": [], "culled_timestamp": "2035-05-01T11:49:18.033Z", "stale_timestamp": "2035-04-17T11:49:18.033Z", "stale_warning_timestamp": "2035-04-24T11:49:18.033Z", "updated": "2025-04-17T11:49:18.033Z", "insights_id": null, "tags": [ { "key": "matrix", "value": "haptic", "namespace": "parsing" }, { "key": "matrix", "value": "multi-byte", "namespace": "parsing" }, { "key": "transmitter", "value": "bluetooth", "namespace": "programming" }, { "key": "alarm", "value": "mobile", "namespace": "navigating" }, { "key": "microchip", "value": "haptic", "namespace": "generating" } ], "type": "system", "last_check_in": "2035-04-25T11:49:18.033Z", "os_major_version": 8, "os_minor_version": 0 }, { "id": "40387b9a-a817-445a-a564-9845cd8ac756", "display_name": "grimes-bahringer.example", "groups": [], "culled_timestamp": "2035-05-01T11:49:18.095Z", "stale_timestamp": "2035-04-17T11:49:18.095Z", "stale_warning_timestamp": "2035-04-24T11:49:18.095Z", "updated": "2025-04-17T11:49:18.095Z", "insights_id": null, "tags": [ { "key": "bus", "value": "1080p", "namespace": "backing up" }, { "key": "circuit", "value": "multi-byte", "namespace": "copying" }, { "key": "pixel", "value": "optical", "namespace": "calculating" }, { "key": "system", "value": "redundant", "namespace": "indexing" }, { "key": "port", "value": "virtual", "namespace": "synthesizing" } ], "type": "system", "last_check_in": "2035-04-25T11:49:18.095Z", "os_major_version": 8, "os_minor_version": 0 }, { "id": "4622115a-64c7-4d95-8ba5-510b94c34fa2", "display_name": "hessel.example", "groups": [], "culled_timestamp": "2035-05-01T11:49:17.966Z", "stale_timestamp": "2035-04-17T11:49:17.966Z", "stale_warning_timestamp": "2035-04-24T11:49:17.966Z", "updated": "2025-04-17T11:49:17.966Z", "insights_id": null, "tags": [ { "key": "system", "value": "digital", "namespace": "synthesizing" }, { "key": "firewall", "value": "cross-platform", "namespace": "calculating" }, { "key": "matrix", "value": "solid state", "namespace": "quantifying" }, { "key": "circuit", "value": "solid state", "namespace": "hacking" }, { "key": "hard drive", "value": "virtual", "namespace": "transmitting" } ], "type": "system", "last_check_in": "2035-04-25T11:49:17.966Z", "os_major_version": 8, "os_minor_version": 0 }, { "id": "4b807915-a574-460f-a516-befe6b028226", "display_name": "veum-runte.test", "groups": [], "culled_timestamp": "2035-05-01T11:49:18.086Z", "stale_timestamp": "2035-04-17T11:49:18.086Z", "stale_warning_timestamp": "2035-04-24T11:49:18.086Z", "updated": "2025-04-17T11:49:18.086Z", "insights_id": null, "tags": [ { "key": "pixel", "value": "digital", "namespace": "quantifying" }, { "key": "card", "value": "bluetooth", "namespace": "connecting" }, { "key": "matrix", "value": "wireless", "namespace": "generating" }, { "key": "bus", "value": "optical", "namespace": "parsing" }, { "key": "feed", "value": "wireless", "namespace": "synthesizing" } ], "type": "system", "last_check_in": "2035-04-25T11:49:18.086Z", "os_major_version": 8, "os_minor_version": 0 }, { "id": "4eb35c85-b385-419d-96ca-3c38b59250af", "display_name": "bode.example", "groups": [], "culled_timestamp": "2035-05-01T11:49:18.075Z", "stale_timestamp": "2035-04-17T11:49:18.075Z", "stale_warning_timestamp": "2035-04-24T11:49:18.075Z", "updated": "2025-04-17T11:49:18.075Z", "insights_id": null, "tags": [ { "key": "monitor", "value": "virtual", "namespace": "copying" }, { "key": "panel", "value": "primary", "namespace": "transmitting" }, { "key": "monitor", "value": "haptic", "namespace": "transmitting" }, { "key": "monitor", "value": "mobile", "namespace": "synthesizing" }, { "key": "card", "value": "optical", "namespace": "transmitting" } ], "type": "system", "last_check_in": "2035-04-25T11:49:18.075Z", "os_major_version": 8, "os_minor_version": 0 }, { "id": "565b403c-a5da-4861-a921-6512c42741bd", "display_name": "schimmel-hartmann.example", "groups": [], "culled_timestamp": "2035-05-01T11:49:18.001Z", "stale_timestamp": "2035-04-17T11:49:18.001Z", "stale_warning_timestamp": "2035-04-24T11:49:18.001Z", "updated": "2025-04-17T11:49:18.001Z", "insights_id": null, "tags": [ { "key": "interface", "value": "cross-platform", "namespace": "parsing" }, { "key": "firewall", "value": "wireless", "namespace": "synthesizing" }, { "key": "system", "value": "neural", "namespace": "synthesizing" }, { "key": "capacitor", "value": "haptic", "namespace": "overriding" }, { "key": "protocol", "value": "primary", "namespace": "generating" } ], "type": "system", "last_check_in": "2035-04-25T11:49:18.001Z", "os_major_version": 8, "os_minor_version": 0 }, { "id": "5ca9840f-6c10-4b1c-8db0-d40f97bf4742", "display_name": "larson-prohaska.example", "groups": [], "culled_timestamp": "2035-05-01T11:49:18.135Z", "stale_timestamp": "2035-04-17T11:49:18.135Z", "stale_warning_timestamp": "2035-04-24T11:49:18.135Z", "updated": "2025-04-17T11:49:18.136Z", "insights_id": null, "tags": [ { "key": "port", "value": "digital", "namespace": "calculating" }, { "key": "application", "value": "digital", "namespace": "navigating" }, { "key": "interface", "value": "open-source", "namespace": "calculating" }, { "key": "port", "value": "1080p", "namespace": "navigating" }, { "key": "monitor", "value": "open-source", "namespace": "hacking" } ], "type": "system", "last_check_in": "2035-04-25T11:49:18.135Z", "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/7e31f6ab-b24e-403e-aac4-5f1dbf2c9cdd/systems?limit=10&offset=0&sort_by=os_minor_version", "last": "/api/compliance/v2/policies/7e31f6ab-b24e-403e-aac4-5f1dbf2c9cdd/systems?limit=10&offset=20&sort_by=os_minor_version", "next": "/api/compliance/v2/policies/7e31f6ab-b24e-403e-aac4-5f1dbf2c9cdd/systems?limit=10&offset=10&sort_by=os_minor_version" } }, "summary": "", "description": "" }, "List of Systems filtered by \"(os_minor_version=0)\"": { "value": { "data": [ { "id": "0bcbe1fa-886d-4d15-8bee-dbed68f648fc", "display_name": "ullrich-ritchie.example", "groups": [], "culled_timestamp": "2035-05-01T11:49:18.211Z", "stale_timestamp": "2035-04-17T11:49:18.211Z", "stale_warning_timestamp": "2035-04-24T11:49:18.211Z", "updated": "2025-04-17T11:49:18.211Z", "insights_id": null, "tags": [ { "key": "protocol", "value": "open-source", "namespace": "calculating" }, { "key": "matrix", "value": "neural", "namespace": "hacking" }, { "key": "bus", "value": "multi-byte", "namespace": "calculating" }, { "key": "capacitor", "value": "multi-byte", "namespace": "connecting" }, { "key": "circuit", "value": "optical", "namespace": "bypassing" } ], "type": "system", "last_check_in": "2035-04-25T11:49:18.211Z", "os_major_version": 8, "os_minor_version": 0 }, { "id": "13b2593c-3b11-48f9-8d07-e8c7c81a5902", "display_name": "altenwerth-farrell.example", "groups": [], "culled_timestamp": "2035-05-01T11:49:18.333Z", "stale_timestamp": "2035-04-17T11:49:18.333Z", "stale_warning_timestamp": "2035-04-24T11:49:18.333Z", "updated": "2025-04-17T11:49:18.333Z", "insights_id": null, "tags": [ { "key": "array", "value": "wireless", "namespace": "bypassing" }, { "key": "circuit", "value": "bluetooth", "namespace": "copying" }, { "key": "transmitter", "value": "virtual", "namespace": "parsing" }, { "key": "microchip", "value": "open-source", "namespace": "transmitting" }, { "key": "driver", "value": "multi-byte", "namespace": "generating" } ], "type": "system", "last_check_in": "2035-04-25T11:49:18.333Z", "os_major_version": 8, "os_minor_version": 0 }, { "id": "20f39def-147f-4439-ab2d-655877978323", "display_name": "quigley.example", "groups": [], "culled_timestamp": "2035-05-01T11:49:18.293Z", "stale_timestamp": "2035-04-17T11:49:18.293Z", "stale_warning_timestamp": "2035-04-24T11:49:18.293Z", "updated": "2025-04-17T11:49:18.293Z", "insights_id": null, "tags": [ { "key": "capacitor", "value": "redundant", "namespace": "transmitting" }, { "key": "application", "value": "cross-platform", "namespace": "calculating" }, { "key": "feed", "value": "cross-platform", "namespace": "parsing" }, { "key": "bandwidth", "value": "virtual", "namespace": "calculating" }, { "key": "interface", "value": "open-source", "namespace": "generating" } ], "type": "system", "last_check_in": "2035-04-25T11:49:18.293Z", "os_major_version": 8, "os_minor_version": 0 }, { "id": "422d3837-9ac7-4f6b-80a2-db0ffb629a12", "display_name": "murray.test", "groups": [], "culled_timestamp": "2035-05-01T11:49:18.401Z", "stale_timestamp": "2035-04-17T11:49:18.401Z", "stale_warning_timestamp": "2035-04-24T11:49:18.401Z", "updated": "2025-04-17T11:49:18.401Z", "insights_id": null, "tags": [ { "key": "port", "value": "1080p", "namespace": "connecting" }, { "key": "firewall", "value": "multi-byte", "namespace": "indexing" }, { "key": "transmitter", "value": "solid state", "namespace": "copying" }, { "key": "protocol", "value": "auxiliary", "namespace": "copying" }, { "key": "system", "value": "multi-byte", "namespace": "programming" } ], "type": "system", "last_check_in": "2035-04-25T11:49:18.401Z", "os_major_version": 8, "os_minor_version": 0 }, { "id": "43269bf8-14b9-49cb-99e1-aa0b09407bfe", "display_name": "conroy-hauck.test", "groups": [], "culled_timestamp": "2035-05-01T11:49:18.433Z", "stale_timestamp": "2035-04-17T11:49:18.433Z", "stale_warning_timestamp": "2035-04-24T11:49:18.433Z", "updated": "2025-04-17T11:49:18.433Z", "insights_id": null, "tags": [ { "key": "bus", "value": "mobile", "namespace": "copying" }, { "key": "monitor", "value": "auxiliary", "namespace": "connecting" }, { "key": "circuit", "value": "cross-platform", "namespace": "generating" }, { "key": "protocol", "value": "wireless", "namespace": "connecting" }, { "key": "panel", "value": "multi-byte", "namespace": "connecting" } ], "type": "system", "last_check_in": "2035-04-25T11:49:18.433Z", "os_major_version": 8, "os_minor_version": 0 }, { "id": "461bed03-bbb9-4b33-940d-23bebc3863f7", "display_name": "lueilwitz.test", "groups": [], "culled_timestamp": "2035-05-01T11:49:18.363Z", "stale_timestamp": "2035-04-17T11:49:18.363Z", "stale_warning_timestamp": "2035-04-24T11:49:18.363Z", "updated": "2025-04-17T11:49:18.363Z", "insights_id": null, "tags": [ { "key": "pixel", "value": "solid state", "namespace": "generating" }, { "key": "transmitter", "value": "redundant", "namespace": "overriding" }, { "key": "firewall", "value": "back-end", "namespace": "bypassing" }, { "key": "firewall", "value": "redundant", "namespace": "indexing" }, { "key": "system", "value": "back-end", "namespace": "hacking" } ], "type": "system", "last_check_in": "2035-04-25T11:49:18.363Z", "os_major_version": 8, "os_minor_version": 0 }, { "id": "4930e30b-8728-4083-b503-df83e942b209", "display_name": "gutkowski.test", "groups": [], "culled_timestamp": "2035-05-01T11:49:18.185Z", "stale_timestamp": "2035-04-17T11:49:18.185Z", "stale_warning_timestamp": "2035-04-24T11:49:18.185Z", "updated": "2025-04-17T11:49:18.185Z", "insights_id": null, "tags": [ { "key": "sensor", "value": "redundant", "namespace": "transmitting" }, { "key": "interface", "value": "primary", "namespace": "compressing" }, { "key": "panel", "value": "solid state", "namespace": "backing up" }, { "key": "monitor", "value": "mobile", "namespace": "generating" }, { "key": "monitor", "value": "solid state", "namespace": "calculating" } ], "type": "system", "last_check_in": "2035-04-25T11:49:18.185Z", "os_major_version": 8, "os_minor_version": 0 }, { "id": "5acff4fc-d626-4c4b-8774-03c97c8bb926", "display_name": "murazik-kihn.test", "groups": [], "culled_timestamp": "2035-05-01T11:49:18.444Z", "stale_timestamp": "2035-04-17T11:49:18.444Z", "stale_warning_timestamp": "2035-04-24T11:49:18.444Z", "updated": "2025-04-17T11:49:18.444Z", "insights_id": null, "tags": [ { "key": "sensor", "value": "multi-byte", "namespace": "parsing" }, { "key": "driver", "value": "auxiliary", "namespace": "quantifying" }, { "key": "circuit", "value": "mobile", "namespace": "navigating" }, { "key": "card", "value": "haptic", "namespace": "hacking" }, { "key": "protocol", "value": "1080p", "namespace": "connecting" } ], "type": "system", "last_check_in": "2035-04-25T11:49:18.444Z", "os_major_version": 8, "os_minor_version": 0 }, { "id": "928f30a8-414b-4306-92a3-10032369bfb6", "display_name": "stamm.test", "groups": [], "culled_timestamp": "2035-05-01T11:49:18.312Z", "stale_timestamp": "2035-04-17T11:49:18.312Z", "stale_warning_timestamp": "2035-04-24T11:49:18.312Z", "updated": "2025-04-17T11:49:18.312Z", "insights_id": null, "tags": [ { "key": "bandwidth", "value": "auxiliary", "namespace": "transmitting" }, { "key": "capacitor", "value": "wireless", "namespace": "generating" }, { "key": "monitor", "value": "open-source", "namespace": "bypassing" }, { "key": "sensor", "value": "virtual", "namespace": "calculating" }, { "key": "capacitor", "value": "optical", "namespace": "quantifying" } ], "type": "system", "last_check_in": "2035-04-25T11:49:18.312Z", "os_major_version": 8, "os_minor_version": 0 }, { "id": "94fbe75a-f03f-49b7-8d64-10d326c138bf", "display_name": "hand.example", "groups": [], "culled_timestamp": "2035-05-01T11:49:18.303Z", "stale_timestamp": "2035-04-17T11:49:18.303Z", "stale_warning_timestamp": "2035-04-24T11:49:18.303Z", "updated": "2025-04-17T11:49:18.303Z", "insights_id": null, "tags": [ { "key": "microchip", "value": "1080p", "namespace": "copying" }, { "key": "capacitor", "value": "redundant", "namespace": "indexing" }, { "key": "panel", "value": "redundant", "namespace": "connecting" }, { "key": "monitor", "value": "neural", "namespace": "calculating" }, { "key": "bus", "value": "back-end", "namespace": "connecting" } ], "type": "system", "last_check_in": "2035-04-25T11:49:18.303Z", "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/ad6deb96-eaf8-432d-a67a-e2250a6e8764/systems?filter=%28os_minor_version%3D0%29&limit=10&offset=0", "last": "/api/compliance/v2/policies/ad6deb96-eaf8-432d-a67a-e2250a6e8764/systems?filter=%28os_minor_version%3D0%29&limit=10&offset=20", "next": "/api/compliance/v2/policies/ad6deb96-eaf8-432d-a67a-e2250a6e8764/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": "0228f5d8-6c91-4f55-ad47-ff170ea9aa0e", "display_name": "turcotte.example", "groups": [], "culled_timestamp": "2035-05-01T11:49:19.436Z", "stale_timestamp": "2035-04-17T11:49:19.436Z", "stale_warning_timestamp": "2035-04-24T11:49:19.436Z", "updated": "2025-04-17T11:49:19.436Z", "insights_id": null, "tags": [ { "key": "panel", "value": "wireless", "namespace": "connecting" }, { "key": "capacitor", "value": "multi-byte", "namespace": "indexing" }, { "key": "pixel", "value": "cross-platform", "namespace": "navigating" }, { "key": "interface", "value": "redundant", "namespace": "hacking" }, { "key": "system", "value": "haptic", "namespace": "backing up" } ], "type": "system", "last_check_in": "2035-04-25T11:49:19.436Z", "os_major_version": 8, "os_minor_version": 0 }, { "id": "0f051989-b696-48e7-a239-c22c640b98ac", "display_name": "hirthe.example", "groups": [], "culled_timestamp": "2035-05-01T11:49:19.447Z", "stale_timestamp": "2035-04-17T11:49:19.447Z", "stale_warning_timestamp": "2035-04-24T11:49:19.447Z", "updated": "2025-04-17T11:49:19.447Z", "insights_id": null, "tags": [ { "key": "interface", "value": "primary", "namespace": "hacking" }, { "key": "hard drive", "value": "solid state", "namespace": "navigating" }, { "key": "panel", "value": "mobile", "namespace": "bypassing" }, { "key": "alarm", "value": "solid state", "namespace": "synthesizing" }, { "key": "driver", "value": "neural", "namespace": "quantifying" } ], "type": "system", "last_check_in": "2035-04-25T11:49:19.447Z", "os_major_version": 8, "os_minor_version": 0 }, { "id": "1dc4a86e-52ae-4228-b32f-692e696f974b", "display_name": "goodwin-romaguera.test", "groups": [], "culled_timestamp": "2035-05-01T11:49:19.442Z", "stale_timestamp": "2035-04-17T11:49:19.442Z", "stale_warning_timestamp": "2035-04-24T11:49:19.442Z", "updated": "2025-04-17T11:49:19.442Z", "insights_id": null, "tags": [ { "key": "feed", "value": "cross-platform", "namespace": "backing up" }, { "key": "panel", "value": "wireless", "namespace": "navigating" }, { "key": "circuit", "value": "redundant", "namespace": "backing up" }, { "key": "hard drive", "value": "back-end", "namespace": "quantifying" }, { "key": "capacitor", "value": "optical", "namespace": "copying" } ], "type": "system", "last_check_in": "2035-04-25T11:49:19.442Z", "os_major_version": 8, "os_minor_version": 0 }, { "id": "2420b443-ea84-48e4-a058-622cb5aee1f0", "display_name": "cole-williamson.example", "groups": [], "culled_timestamp": "2035-05-01T11:49:19.459Z", "stale_timestamp": "2035-04-17T11:49:19.459Z", "stale_warning_timestamp": "2035-04-24T11:49:19.459Z", "updated": "2025-04-17T11:49:19.459Z", "insights_id": null, "tags": [ { "key": "monitor", "value": "open-source", "namespace": "overriding" }, { "key": "monitor", "value": "haptic", "namespace": "generating" }, { "key": "panel", "value": "back-end", "namespace": "parsing" }, { "key": "monitor", "value": "bluetooth", "namespace": "connecting" }, { "key": "port", "value": "wireless", "namespace": "synthesizing" } ], "type": "system", "last_check_in": "2035-04-25T11:49:19.459Z", "os_major_version": 8, "os_minor_version": 0 }, { "id": "26de9105-8ddb-4cfa-bbb2-3863594058bb", "display_name": "morar.example", "groups": [], "culled_timestamp": "2035-05-01T11:49:19.460Z", "stale_timestamp": "2035-04-17T11:49:19.460Z", "stale_warning_timestamp": "2035-04-24T11:49:19.460Z", "updated": "2025-04-17T11:49:19.460Z", "insights_id": null, "tags": [ { "key": "monitor", "value": "optical", "namespace": "calculating" }, { "key": "circuit", "value": "multi-byte", "namespace": "indexing" }, { "key": "application", "value": "haptic", "namespace": "synthesizing" }, { "key": "firewall", "value": "auxiliary", "namespace": "compressing" }, { "key": "bus", "value": "auxiliary", "namespace": "compressing" } ], "type": "system", "last_check_in": "2035-04-25T11:49:19.460Z", "os_major_version": 8, "os_minor_version": 0 }, { "id": "45c3d12d-983a-48df-b419-1c8ef50b4540", "display_name": "fahey.test", "groups": [], "culled_timestamp": "2035-05-01T11:49:19.456Z", "stale_timestamp": "2035-04-17T11:49:19.456Z", "stale_warning_timestamp": "2035-04-24T11:49:19.456Z", "updated": "2025-04-17T11:49:19.456Z", "insights_id": null, "tags": [ { "key": "microchip", "value": "mobile", "namespace": "connecting" }, { "key": "bus", "value": "primary", "namespace": "programming" }, { "key": "sensor", "value": "redundant", "namespace": "compressing" }, { "key": "pixel", "value": "wireless", "namespace": "copying" }, { "key": "matrix", "value": "wireless", "namespace": "quantifying" } ], "type": "system", "last_check_in": "2035-04-25T11:49:19.456Z", "os_major_version": 8, "os_minor_version": 0 }, { "id": "4a465a58-c47e-481b-8251-9c1fefc9b89c", "display_name": "stamm.test", "groups": [], "culled_timestamp": "2035-05-01T11:49:19.457Z", "stale_timestamp": "2035-04-17T11:49:19.457Z", "stale_warning_timestamp": "2035-04-24T11:49:19.457Z", "updated": "2025-04-17T11:49:19.457Z", "insights_id": null, "tags": [ { "key": "monitor", "value": "back-end", "namespace": "transmitting" }, { "key": "card", "value": "optical", "namespace": "calculating" }, { "key": "card", "value": "virtual", "namespace": "quantifying" }, { "key": "monitor", "value": "back-end", "namespace": "indexing" }, { "key": "transmitter", "value": "online", "namespace": "programming" } ], "type": "system", "last_check_in": "2035-04-25T11:49:19.457Z", "os_major_version": 8, "os_minor_version": 0 }, { "id": "4f202d7c-c552-4f89-97c0-931077adefe2", "display_name": "rau-mitchell.example", "groups": [], "culled_timestamp": "2035-05-01T11:49:19.462Z", "stale_timestamp": "2035-04-17T11:49:19.462Z", "stale_warning_timestamp": "2035-04-24T11:49:19.462Z", "updated": "2025-04-17T11:49:19.462Z", "insights_id": null, "tags": [ { "key": "panel", "value": "bluetooth", "namespace": "overriding" }, { "key": "capacitor", "value": "multi-byte", "namespace": "programming" }, { "key": "system", "value": "wireless", "namespace": "quantifying" }, { "key": "port", "value": "haptic", "namespace": "indexing" }, { "key": "sensor", "value": "primary", "namespace": "copying" } ], "type": "system", "last_check_in": "2035-04-25T11:49:19.462Z", "os_major_version": 8, "os_minor_version": 0 }, { "id": "53281be1-2596-4434-a63b-c64ddd139b0e", "display_name": "maggio-hamill.example", "groups": [], "culled_timestamp": "2035-05-01T11:49:19.434Z", "stale_timestamp": "2035-04-17T11:49:19.434Z", "stale_warning_timestamp": "2035-04-24T11:49:19.434Z", "updated": "2025-04-17T11:49:19.434Z", "insights_id": null, "tags": [ { "key": "microchip", "value": "haptic", "namespace": "hacking" }, { "key": "interface", "value": "wireless", "namespace": "programming" }, { "key": "application", "value": "mobile", "namespace": "quantifying" }, { "key": "transmitter", "value": "online", "namespace": "calculating" }, { "key": "firewall", "value": "redundant", "namespace": "bypassing" } ], "type": "system", "last_check_in": "2035-04-25T11:49:19.434Z", "os_major_version": 8, "os_minor_version": 0 }, { "id": "55bff9c6-ab8a-47de-a9c7-e677ac8acc38", "display_name": "will.test", "groups": [], "culled_timestamp": "2035-05-01T11:49:19.432Z", "stale_timestamp": "2035-04-17T11:49:19.432Z", "stale_warning_timestamp": "2035-04-24T11:49:19.432Z", "updated": "2025-04-17T11:49:19.432Z", "insights_id": null, "tags": [ { "key": "protocol", "value": "1080p", "namespace": "calculating" }, { "key": "bus", "value": "wireless", "namespace": "calculating" }, { "key": "protocol", "value": "haptic", "namespace": "backing up" }, { "key": "microchip", "value": "back-end", "namespace": "parsing" }, { "key": "bandwidth", "value": "cross-platform", "namespace": "parsing" } ], "type": "system", "last_check_in": "2035-04-25T11:49:19.432Z", "os_major_version": 8, "os_minor_version": 0 } ], "meta": { "total": 25, "tags": [], "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/policies/aba5be64-ae18-4344-a5ae-8dedd795dc6b/systems?limit=10&offset=0", "last": "/api/compliance/v2/policies/aba5be64-ae18-4344-a5ae-8dedd795dc6b/systems?limit=10&offset=20", "next": "/api/compliance/v2/policies/aba5be64-ae18-4344-a5ae-8dedd795dc6b/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": [ "565220d4-0a0e-424b-ae75-b48fc0e528a4" ] } } } } } } } } }, "/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": "a08e7c76-6046-49cf-99ae-7d40e6e8cf8b", "display_name": "ruecker.test", "groups": [], "culled_timestamp": "2035-05-01T11:49:19.791Z", "stale_timestamp": "2035-04-17T11:49:19.791Z", "stale_warning_timestamp": "2035-04-24T11:49:19.791Z", "updated": "2025-04-17T11:49:19.791Z", "insights_id": null, "tags": [ { "key": "interface", "value": "open-source", "namespace": "backing up" }, { "key": "transmitter", "value": "back-end", "namespace": "indexing" }, { "key": "alarm", "value": "back-end", "namespace": "transmitting" }, { "key": "array", "value": "haptic", "namespace": "synthesizing" }, { "key": "monitor", "value": "online", "namespace": "generating" } ], "type": "system", "last_check_in": "2035-04-25T11:49:19.791Z", "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 a29428bc-2405-4513-9c80-c569aa93dffb" ] }, "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": "210f27db-3a51-4b33-9965-8b3f3ee53c19", "display_name": "jakubowski.example", "groups": [], "culled_timestamp": "2035-05-01T11:49:19.861Z", "stale_timestamp": "2035-04-17T11:49:19.861Z", "stale_warning_timestamp": "2035-04-24T11:49:19.861Z", "updated": "2025-04-17T11:49:19.861Z", "insights_id": null, "tags": [ { "key": "panel", "value": "mobile", "namespace": "overriding" }, { "key": "feed", "value": "1080p", "namespace": "compressing" }, { "key": "protocol", "value": "virtual", "namespace": "bypassing" }, { "key": "array", "value": "bluetooth", "namespace": "synthesizing" }, { "key": "sensor", "value": "virtual", "namespace": "compressing" } ], "type": "system", "last_check_in": "2035-04-25T11:49:19.861Z", "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 9bf5cfd2-0d81-49b8-81b1-b4a537bcfce7" ] }, "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": "07d5071c-93fc-4cb0-bf93-971bd3b8ba60", "display_name": "stoltenberg-mitchell.example", "groups": [], "culled_timestamp": "2035-05-01T11:49:20.307Z", "stale_timestamp": "2035-04-17T11:49:20.307Z", "stale_warning_timestamp": "2035-04-24T11:49:20.307Z", "updated": "2025-04-17T11:49:20.307Z", "insights_id": null, "tags": [ { "key": "card", "value": "wireless", "namespace": "connecting" }, { "key": "panel", "value": "neural", "namespace": "transmitting" }, { "key": "pixel", "value": "bluetooth", "namespace": "hacking" }, { "key": "firewall", "value": "mobile", "namespace": "navigating" }, { "key": "capacitor", "value": "digital", "namespace": "navigating" } ], "type": "system", "last_check_in": "2035-04-25T11:49:20.307Z", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "3a132f22-cee9-431c-9312-52be86f0f2b5", "title": "Placeat consequatur in maiores." } ] }, { "id": "0a3203ca-003c-419b-9d66-63b613e11d97", "display_name": "schamberger.test", "groups": [], "culled_timestamp": "2035-05-01T11:49:20.287Z", "stale_timestamp": "2035-04-17T11:49:20.287Z", "stale_warning_timestamp": "2035-04-24T11:49:20.287Z", "updated": "2025-04-17T11:49:20.287Z", "insights_id": null, "tags": [ { "key": "firewall", "value": "bluetooth", "namespace": "parsing" }, { "key": "system", "value": "virtual", "namespace": "indexing" }, { "key": "matrix", "value": "cross-platform", "namespace": "quantifying" }, { "key": "application", "value": "bluetooth", "namespace": "generating" }, { "key": "firewall", "value": "redundant", "namespace": "indexing" } ], "type": "system", "last_check_in": "2035-04-25T11:49:20.287Z", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "3a132f22-cee9-431c-9312-52be86f0f2b5", "title": "Placeat consequatur in maiores." } ] }, { "id": "10305272-6038-4277-a7cf-db22ea111c6b", "display_name": "mayer.example", "groups": [], "culled_timestamp": "2035-05-01T11:49:20.368Z", "stale_timestamp": "2035-04-17T11:49:20.368Z", "stale_warning_timestamp": "2035-04-24T11:49:20.368Z", "updated": "2025-04-17T11:49:20.368Z", "insights_id": null, "tags": [ { "key": "transmitter", "value": "primary", "namespace": "connecting" }, { "key": "protocol", "value": "solid state", "namespace": "programming" }, { "key": "pixel", "value": "back-end", "namespace": "connecting" }, { "key": "feed", "value": "primary", "namespace": "bypassing" }, { "key": "bandwidth", "value": "neural", "namespace": "connecting" } ], "type": "system", "last_check_in": "2035-04-25T11:49:20.368Z", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "3a132f22-cee9-431c-9312-52be86f0f2b5", "title": "Placeat consequatur in maiores." } ] }, { "id": "13045e5f-ccaa-4721-8488-938802281621", "display_name": "dietrich-crona.test", "groups": [], "culled_timestamp": "2035-05-01T11:49:20.500Z", "stale_timestamp": "2035-04-17T11:49:20.500Z", "stale_warning_timestamp": "2035-04-24T11:49:20.500Z", "updated": "2025-04-17T11:49:20.500Z", "insights_id": null, "tags": [ { "key": "microchip", "value": "open-source", "namespace": "quantifying" }, { "key": "card", "value": "virtual", "namespace": "generating" }, { "key": "firewall", "value": "bluetooth", "namespace": "parsing" }, { "key": "application", "value": "solid state", "namespace": "quantifying" }, { "key": "pixel", "value": "primary", "namespace": "backing up" } ], "type": "system", "last_check_in": "2035-04-25T11:49:20.500Z", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "3a132f22-cee9-431c-9312-52be86f0f2b5", "title": "Placeat consequatur in maiores." } ] }, { "id": "2cf24058-09e4-4c03-a5a4-39965276666c", "display_name": "abshire.example", "groups": [], "culled_timestamp": "2035-05-01T11:49:20.479Z", "stale_timestamp": "2035-04-17T11:49:20.479Z", "stale_warning_timestamp": "2035-04-24T11:49:20.479Z", "updated": "2025-04-17T11:49:20.479Z", "insights_id": null, "tags": [ { "key": "protocol", "value": "neural", "namespace": "compressing" }, { "key": "driver", "value": "primary", "namespace": "generating" }, { "key": "application", "value": "back-end", "namespace": "bypassing" }, { "key": "interface", "value": "haptic", "namespace": "overriding" }, { "key": "card", "value": "cross-platform", "namespace": "calculating" } ], "type": "system", "last_check_in": "2035-04-25T11:49:20.479Z", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "3a132f22-cee9-431c-9312-52be86f0f2b5", "title": "Placeat consequatur in maiores." } ] }, { "id": "3fe0f282-3a62-4851-a686-68e761be241d", "display_name": "marquardt.test", "groups": [], "culled_timestamp": "2035-05-01T11:49:20.246Z", "stale_timestamp": "2035-04-17T11:49:20.246Z", "stale_warning_timestamp": "2035-04-24T11:49:20.246Z", "updated": "2025-04-17T11:49:20.246Z", "insights_id": null, "tags": [ { "key": "port", "value": "1080p", "namespace": "overriding" }, { "key": "driver", "value": "virtual", "namespace": "hacking" }, { "key": "panel", "value": "optical", "namespace": "calculating" }, { "key": "monitor", "value": "cross-platform", "namespace": "indexing" }, { "key": "sensor", "value": "online", "namespace": "generating" } ], "type": "system", "last_check_in": "2035-04-25T11:49:20.246Z", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "3a132f22-cee9-431c-9312-52be86f0f2b5", "title": "Placeat consequatur in maiores." } ] }, { "id": "528cc4b6-fc67-42ec-844b-557e26e3edcd", "display_name": "labadie-waters.test", "groups": [], "culled_timestamp": "2035-05-01T11:49:20.418Z", "stale_timestamp": "2035-04-17T11:49:20.418Z", "stale_warning_timestamp": "2035-04-24T11:49:20.418Z", "updated": "2025-04-17T11:49:20.418Z", "insights_id": null, "tags": [ { "key": "transmitter", "value": "cross-platform", "namespace": "overriding" }, { "key": "system", "value": "primary", "namespace": "parsing" }, { "key": "program", "value": "bluetooth", "namespace": "overriding" }, { "key": "application", "value": "auxiliary", "namespace": "compressing" }, { "key": "hard drive", "value": "auxiliary", "namespace": "overriding" } ], "type": "system", "last_check_in": "2035-04-25T11:49:20.418Z", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "3a132f22-cee9-431c-9312-52be86f0f2b5", "title": "Placeat consequatur in maiores." } ] }, { "id": "58605dc6-8da7-498e-b4ed-910727493969", "display_name": "huels-ernser.test", "groups": [], "culled_timestamp": "2035-05-01T11:49:20.337Z", "stale_timestamp": "2035-04-17T11:49:20.337Z", "stale_warning_timestamp": "2035-04-24T11:49:20.337Z", "updated": "2025-04-17T11:49:20.337Z", "insights_id": null, "tags": [ { "key": "protocol", "value": "1080p", "namespace": "copying" }, { "key": "card", "value": "redundant", "namespace": "programming" }, { "key": "card", "value": "wireless", "namespace": "navigating" }, { "key": "circuit", "value": "redundant", "namespace": "connecting" }, { "key": "interface", "value": "haptic", "namespace": "generating" } ], "type": "system", "last_check_in": "2035-04-25T11:49:20.337Z", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "3a132f22-cee9-431c-9312-52be86f0f2b5", "title": "Placeat consequatur in maiores." } ] }, { "id": "660ace40-8d0e-433d-b608-dd368547ffc6", "display_name": "goodwin-marvin.example", "groups": [], "culled_timestamp": "2035-05-01T11:49:20.490Z", "stale_timestamp": "2035-04-17T11:49:20.490Z", "stale_warning_timestamp": "2035-04-24T11:49:20.490Z", "updated": "2025-04-17T11:49:20.490Z", "insights_id": null, "tags": [ { "key": "circuit", "value": "virtual", "namespace": "programming" }, { "key": "microchip", "value": "solid state", "namespace": "navigating" }, { "key": "capacitor", "value": "cross-platform", "namespace": "hacking" }, { "key": "matrix", "value": "haptic", "namespace": "backing up" }, { "key": "driver", "value": "multi-byte", "namespace": "connecting" } ], "type": "system", "last_check_in": "2035-04-25T11:49:20.490Z", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "3a132f22-cee9-431c-9312-52be86f0f2b5", "title": "Placeat consequatur in maiores." } ] }, { "id": "6bca070f-edf1-48e6-aaa1-f3ab40547a5a", "display_name": "will.example", "groups": [], "culled_timestamp": "2035-05-01T11:49:20.469Z", "stale_timestamp": "2035-04-17T11:49:20.469Z", "stale_warning_timestamp": "2035-04-24T11:49:20.469Z", "updated": "2025-04-17T11:49:20.469Z", "insights_id": null, "tags": [ { "key": "hard drive", "value": "open-source", "namespace": "connecting" }, { "key": "driver", "value": "online", "namespace": "quantifying" }, { "key": "bus", "value": "online", "namespace": "bypassing" }, { "key": "driver", "value": "mobile", "namespace": "indexing" }, { "key": "microchip", "value": "online", "namespace": "hacking" } ], "type": "system", "last_check_in": "2035-04-25T11:49:20.469Z", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "3a132f22-cee9-431c-9312-52be86f0f2b5", "title": "Placeat consequatur in maiores." } ] } ], "meta": { "total": 25, "tags": [], "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/reports/3a132f22-cee9-431c-9312-52be86f0f2b5/systems?limit=10&offset=0", "last": "/api/compliance/v2/reports/3a132f22-cee9-431c-9312-52be86f0f2b5/systems?limit=10&offset=20", "next": "/api/compliance/v2/reports/3a132f22-cee9-431c-9312-52be86f0f2b5/systems?limit=10&offset=10" } }, "summary": "", "description": "" }, "List of Systems sorted by \"os_minor_version:asc\"": { "value": { "data": [ { "id": "23c858e8-d89e-4d80-8c14-eb44e30cfac1", "display_name": "roob.example", "groups": [], "culled_timestamp": "2035-05-01T11:49:20.998Z", "stale_timestamp": "2035-04-17T11:49:20.998Z", "stale_warning_timestamp": "2035-04-24T11:49:20.998Z", "updated": "2025-04-17T11:49:20.998Z", "insights_id": null, "tags": [ { "key": "array", "value": "haptic", "namespace": "synthesizing" }, { "key": "microchip", "value": "mobile", "namespace": "parsing" }, { "key": "sensor", "value": "back-end", "namespace": "programming" }, { "key": "array", "value": "haptic", "namespace": "hacking" }, { "key": "application", "value": "wireless", "namespace": "bypassing" } ], "type": "system", "last_check_in": "2035-04-25T11:49:20.998Z", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "e812cc1e-8961-4232-aa1e-75d7204fe70f", "title": "Et provident hic natus." } ] }, { "id": "3baf6701-03d8-4855-9c6a-8e4885a1d70f", "display_name": "barton.example", "groups": [], "culled_timestamp": "2035-05-01T11:49:21.074Z", "stale_timestamp": "2035-04-17T11:49:21.074Z", "stale_warning_timestamp": "2035-04-24T11:49:21.074Z", "updated": "2025-04-17T11:49:21.074Z", "insights_id": null, "tags": [ { "key": "application", "value": "redundant", "namespace": "programming" }, { "key": "capacitor", "value": "primary", "namespace": "calculating" }, { "key": "circuit", "value": "bluetooth", "namespace": "bypassing" }, { "key": "interface", "value": "wireless", "namespace": "navigating" }, { "key": "panel", "value": "virtual", "namespace": "overriding" } ], "type": "system", "last_check_in": "2035-04-25T11:49:21.074Z", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "e812cc1e-8961-4232-aa1e-75d7204fe70f", "title": "Et provident hic natus." } ] }, { "id": "3e7028b4-a0cb-4280-a0ca-2992541d6737", "display_name": "turcotte.test", "groups": [], "culled_timestamp": "2035-05-01T11:49:21.092Z", "stale_timestamp": "2035-04-17T11:49:21.092Z", "stale_warning_timestamp": "2035-04-24T11:49:21.092Z", "updated": "2025-04-17T11:49:21.092Z", "insights_id": null, "tags": [ { "key": "hard drive", "value": "online", "namespace": "bypassing" }, { "key": "firewall", "value": "multi-byte", "namespace": "synthesizing" }, { "key": "firewall", "value": "redundant", "namespace": "calculating" }, { "key": "system", "value": "cross-platform", "namespace": "synthesizing" }, { "key": "alarm", "value": "cross-platform", "namespace": "quantifying" } ], "type": "system", "last_check_in": "2035-04-25T11:49:21.092Z", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "e812cc1e-8961-4232-aa1e-75d7204fe70f", "title": "Et provident hic natus." } ] }, { "id": "425c7cc9-31f1-4c44-ac65-435dc7f32f11", "display_name": "gislason.test", "groups": [], "culled_timestamp": "2035-05-01T11:49:21.056Z", "stale_timestamp": "2035-04-17T11:49:21.056Z", "stale_warning_timestamp": "2035-04-24T11:49:21.056Z", "updated": "2025-04-17T11:49:21.056Z", "insights_id": null, "tags": [ { "key": "interface", "value": "mobile", "namespace": "quantifying" }, { "key": "pixel", "value": "back-end", "namespace": "overriding" }, { "key": "bus", "value": "open-source", "namespace": "connecting" }, { "key": "port", "value": "online", "namespace": "connecting" }, { "key": "protocol", "value": "digital", "namespace": "calculating" } ], "type": "system", "last_check_in": "2035-04-25T11:49:21.056Z", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "e812cc1e-8961-4232-aa1e-75d7204fe70f", "title": "Et provident hic natus." } ] }, { "id": "44094191-c7af-41bb-8564-f6796687fed3", "display_name": "keebler.example", "groups": [], "culled_timestamp": "2035-05-01T11:49:21.045Z", "stale_timestamp": "2035-04-17T11:49:21.045Z", "stale_warning_timestamp": "2035-04-24T11:49:21.045Z", "updated": "2025-04-17T11:49:21.045Z", "insights_id": null, "tags": [ { "key": "sensor", "value": "wireless", "namespace": "overriding" }, { "key": "bus", "value": "multi-byte", "namespace": "transmitting" }, { "key": "system", "value": "digital", "namespace": "hacking" }, { "key": "alarm", "value": "optical", "namespace": "bypassing" }, { "key": "hard drive", "value": "optical", "namespace": "parsing" } ], "type": "system", "last_check_in": "2035-04-25T11:49:21.045Z", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "e812cc1e-8961-4232-aa1e-75d7204fe70f", "title": "Et provident hic natus." } ] }, { "id": "4f5996f9-9855-4e72-94b4-2ab0ddce2ef1", "display_name": "jacobson.example", "groups": [], "culled_timestamp": "2035-05-01T11:49:21.142Z", "stale_timestamp": "2035-04-17T11:49:21.142Z", "stale_warning_timestamp": "2035-04-24T11:49:21.142Z", "updated": "2025-04-17T11:49:21.142Z", "insights_id": null, "tags": [ { "key": "panel", "value": "back-end", "namespace": "programming" }, { "key": "bandwidth", "value": "solid state", "namespace": "programming" }, { "key": "program", "value": "haptic", "namespace": "compressing" }, { "key": "program", "value": "wireless", "namespace": "copying" }, { "key": "feed", "value": "online", "namespace": "calculating" } ], "type": "system", "last_check_in": "2035-04-25T11:49:21.142Z", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "e812cc1e-8961-4232-aa1e-75d7204fe70f", "title": "Et provident hic natus." } ] }, { "id": "561b5192-dd81-4657-9230-d023e549d122", "display_name": "roob.test", "groups": [], "culled_timestamp": "2035-05-01T11:49:21.036Z", "stale_timestamp": "2035-04-17T11:49:21.036Z", "stale_warning_timestamp": "2035-04-24T11:49:21.036Z", "updated": "2025-04-17T11:49:21.036Z", "insights_id": null, "tags": [ { "key": "protocol", "value": "1080p", "namespace": "programming" }, { "key": "interface", "value": "redundant", "namespace": "transmitting" }, { "key": "protocol", "value": "multi-byte", "namespace": "connecting" }, { "key": "transmitter", "value": "solid state", "namespace": "synthesizing" }, { "key": "panel", "value": "digital", "namespace": "bypassing" } ], "type": "system", "last_check_in": "2035-04-25T11:49:21.036Z", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "e812cc1e-8961-4232-aa1e-75d7204fe70f", "title": "Et provident hic natus." } ] }, { "id": "5ddfa11e-1583-4ea0-997d-09ceb85fec5e", "display_name": "auer.test", "groups": [], "culled_timestamp": "2035-05-01T11:49:21.152Z", "stale_timestamp": "2035-04-17T11:49:21.152Z", "stale_warning_timestamp": "2035-04-24T11:49:21.152Z", "updated": "2025-04-17T11:49:21.152Z", "insights_id": null, "tags": [ { "key": "transmitter", "value": "neural", "namespace": "programming" }, { "key": "circuit", "value": "primary", "namespace": "copying" }, { "key": "bandwidth", "value": "1080p", "namespace": "hacking" }, { "key": "matrix", "value": "primary", "namespace": "indexing" }, { "key": "monitor", "value": "virtual", "namespace": "bypassing" } ], "type": "system", "last_check_in": "2035-04-25T11:49:21.152Z", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "e812cc1e-8961-4232-aa1e-75d7204fe70f", "title": "Et provident hic natus." } ] }, { "id": "60d4a6f2-3ddc-4eee-9eb6-47a51356e6e1", "display_name": "pfeffer.example", "groups": [], "culled_timestamp": "2035-05-01T11:49:20.989Z", "stale_timestamp": "2035-04-17T11:49:20.989Z", "stale_warning_timestamp": "2035-04-24T11:49:20.989Z", "updated": "2025-04-17T11:49:20.989Z", "insights_id": null, "tags": [ { "key": "transmitter", "value": "cross-platform", "namespace": "navigating" }, { "key": "bandwidth", "value": "back-end", "namespace": "bypassing" }, { "key": "sensor", "value": "bluetooth", "namespace": "synthesizing" }, { "key": "bus", "value": "multi-byte", "namespace": "generating" }, { "key": "system", "value": "neural", "namespace": "hacking" } ], "type": "system", "last_check_in": "2035-04-25T11:49:20.989Z", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "e812cc1e-8961-4232-aa1e-75d7204fe70f", "title": "Et provident hic natus." } ] }, { "id": "71a957c0-ef33-4314-bd83-33a283cca843", "display_name": "frami.example", "groups": [], "culled_timestamp": "2035-05-01T11:49:20.969Z", "stale_timestamp": "2035-04-17T11:49:20.969Z", "stale_warning_timestamp": "2035-04-24T11:49:20.969Z", "updated": "2025-04-17T11:49:20.969Z", "insights_id": null, "tags": [ { "key": "port", "value": "optical", "namespace": "programming" }, { "key": "interface", "value": "haptic", "namespace": "copying" }, { "key": "hard drive", "value": "haptic", "namespace": "transmitting" }, { "key": "hard drive", "value": "mobile", "namespace": "calculating" }, { "key": "array", "value": "cross-platform", "namespace": "overriding" } ], "type": "system", "last_check_in": "2035-04-25T11:49:20.969Z", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "e812cc1e-8961-4232-aa1e-75d7204fe70f", "title": "Et provident hic natus." } ] } ], "meta": { "total": 25, "tags": [], "limit": 10, "offset": 0, "sort_by": "os_minor_version" }, "links": { "first": "/api/compliance/v2/reports/e812cc1e-8961-4232-aa1e-75d7204fe70f/systems?limit=10&offset=0&sort_by=os_minor_version", "last": "/api/compliance/v2/reports/e812cc1e-8961-4232-aa1e-75d7204fe70f/systems?limit=10&offset=20&sort_by=os_minor_version", "next": "/api/compliance/v2/reports/e812cc1e-8961-4232-aa1e-75d7204fe70f/systems?limit=10&offset=10&sort_by=os_minor_version" } }, "summary": "", "description": "" }, "List of Systems filtered by \"(os_minor_version=0)\"": { "value": { "data": [ { "id": "05312f8b-3402-4599-b64d-9342d8807e82", "display_name": "stiedemann-nolan.example", "groups": [], "culled_timestamp": "2035-05-01T11:49:21.663Z", "stale_timestamp": "2035-04-17T11:49:21.663Z", "stale_warning_timestamp": "2035-04-24T11:49:21.663Z", "updated": "2025-04-17T11:49:21.663Z", "insights_id": null, "tags": [ { "key": "alarm", "value": "primary", "namespace": "connecting" }, { "key": "bandwidth", "value": "virtual", "namespace": "programming" }, { "key": "array", "value": "digital", "namespace": "bypassing" }, { "key": "circuit", "value": "online", "namespace": "overriding" }, { "key": "bandwidth", "value": "multi-byte", "namespace": "connecting" } ], "type": "system", "last_check_in": "2035-04-25T11:49:21.663Z", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "4017f0d3-f8f8-46b6-8ba6-80c5d3866772", "title": "Fugiat quo tempore ullam." } ] }, { "id": "0d9e6920-7ee4-43af-9e2d-b5338f41916f", "display_name": "pfeffer.test", "groups": [], "culled_timestamp": "2035-05-01T11:49:21.711Z", "stale_timestamp": "2035-04-17T11:49:21.711Z", "stale_warning_timestamp": "2035-04-24T11:49:21.711Z", "updated": "2025-04-17T11:49:21.711Z", "insights_id": null, "tags": [ { "key": "microchip", "value": "wireless", "namespace": "connecting" }, { "key": "transmitter", "value": "auxiliary", "namespace": "quantifying" }, { "key": "application", "value": "cross-platform", "namespace": "synthesizing" }, { "key": "bandwidth", "value": "bluetooth", "namespace": "transmitting" }, { "key": "circuit", "value": "online", "namespace": "navigating" } ], "type": "system", "last_check_in": "2035-04-25T11:49:21.711Z", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "4017f0d3-f8f8-46b6-8ba6-80c5d3866772", "title": "Fugiat quo tempore ullam." } ] }, { "id": "0dbbbbae-e3da-4533-9198-7f15484180cd", "display_name": "runte.example", "groups": [], "culled_timestamp": "2035-05-01T11:49:21.653Z", "stale_timestamp": "2035-04-17T11:49:21.653Z", "stale_warning_timestamp": "2035-04-24T11:49:21.653Z", "updated": "2025-04-17T11:49:21.653Z", "insights_id": null, "tags": [ { "key": "monitor", "value": "bluetooth", "namespace": "programming" }, { "key": "transmitter", "value": "solid state", "namespace": "generating" }, { "key": "alarm", "value": "virtual", "namespace": "programming" }, { "key": "driver", "value": "bluetooth", "namespace": "quantifying" }, { "key": "panel", "value": "multi-byte", "namespace": "bypassing" } ], "type": "system", "last_check_in": "2035-04-25T11:49:21.653Z", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "4017f0d3-f8f8-46b6-8ba6-80c5d3866772", "title": "Fugiat quo tempore ullam." } ] }, { "id": "373e8824-fbc2-4694-85f8-7de77731f61b", "display_name": "windler.test", "groups": [], "culled_timestamp": "2035-05-01T11:49:21.643Z", "stale_timestamp": "2035-04-17T11:49:21.643Z", "stale_warning_timestamp": "2035-04-24T11:49:21.643Z", "updated": "2025-04-17T11:49:21.643Z", "insights_id": null, "tags": [ { "key": "array", "value": "neural", "namespace": "generating" }, { "key": "circuit", "value": "mobile", "namespace": "calculating" }, { "key": "matrix", "value": "bluetooth", "namespace": "backing up" }, { "key": "transmitter", "value": "cross-platform", "namespace": "calculating" }, { "key": "pixel", "value": "wireless", "namespace": "quantifying" } ], "type": "system", "last_check_in": "2035-04-25T11:49:21.643Z", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "4017f0d3-f8f8-46b6-8ba6-80c5d3866772", "title": "Fugiat quo tempore ullam." } ] }, { "id": "3a0c34ba-72a9-43fb-bf4c-6a345dd7d72e", "display_name": "connelly.test", "groups": [], "culled_timestamp": "2035-05-01T11:49:21.580Z", "stale_timestamp": "2035-04-17T11:49:21.580Z", "stale_warning_timestamp": "2035-04-24T11:49:21.580Z", "updated": "2025-04-17T11:49:21.581Z", "insights_id": null, "tags": [ { "key": "sensor", "value": "1080p", "namespace": "overriding" }, { "key": "panel", "value": "online", "namespace": "copying" }, { "key": "pixel", "value": "back-end", "namespace": "copying" }, { "key": "transmitter", "value": "redundant", "namespace": "connecting" }, { "key": "card", "value": "neural", "namespace": "compressing" } ], "type": "system", "last_check_in": "2035-04-25T11:49:21.580Z", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "4017f0d3-f8f8-46b6-8ba6-80c5d3866772", "title": "Fugiat quo tempore ullam." } ] }, { "id": "3bdfa7ce-c1cb-42f0-9529-874d6193991e", "display_name": "stanton.example", "groups": [], "culled_timestamp": "2035-05-01T11:49:21.793Z", "stale_timestamp": "2035-04-17T11:49:21.793Z", "stale_warning_timestamp": "2035-04-24T11:49:21.793Z", "updated": "2025-04-17T11:49:21.793Z", "insights_id": null, "tags": [ { "key": "matrix", "value": "bluetooth", "namespace": "programming" }, { "key": "circuit", "value": "virtual", "namespace": "synthesizing" }, { "key": "monitor", "value": "optical", "namespace": "navigating" }, { "key": "monitor", "value": "online", "namespace": "compressing" }, { "key": "monitor", "value": "bluetooth", "namespace": "navigating" } ], "type": "system", "last_check_in": "2035-04-25T11:49:21.793Z", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "4017f0d3-f8f8-46b6-8ba6-80c5d3866772", "title": "Fugiat quo tempore ullam." } ] }, { "id": "44f86917-db1c-47a0-b7b1-667026248ced", "display_name": "bayer-reynolds.example", "groups": [], "culled_timestamp": "2035-05-01T11:49:21.558Z", "stale_timestamp": "2035-04-17T11:49:21.558Z", "stale_warning_timestamp": "2035-04-24T11:49:21.558Z", "updated": "2025-04-17T11:49:21.558Z", "insights_id": null, "tags": [ { "key": "microchip", "value": "mobile", "namespace": "quantifying" }, { "key": "driver", "value": "bluetooth", "namespace": "calculating" }, { "key": "circuit", "value": "solid state", "namespace": "connecting" }, { "key": "capacitor", "value": "auxiliary", "namespace": "calculating" }, { "key": "sensor", "value": "mobile", "namespace": "connecting" } ], "type": "system", "last_check_in": "2035-04-25T11:49:21.558Z", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "4017f0d3-f8f8-46b6-8ba6-80c5d3866772", "title": "Fugiat quo tempore ullam." } ] }, { "id": "53c7fe23-c2f4-4354-b5bd-fe47567dae33", "display_name": "tremblay-bogan.example", "groups": [], "culled_timestamp": "2035-05-01T11:49:21.673Z", "stale_timestamp": "2035-04-17T11:49:21.673Z", "stale_warning_timestamp": "2035-04-24T11:49:21.673Z", "updated": "2025-04-17T11:49:21.673Z", "insights_id": null, "tags": [ { "key": "array", "value": "optical", "namespace": "generating" }, { "key": "monitor", "value": "wireless", "namespace": "navigating" }, { "key": "interface", "value": "solid state", "namespace": "parsing" }, { "key": "alarm", "value": "primary", "namespace": "navigating" }, { "key": "array", "value": "auxiliary", "namespace": "quantifying" } ], "type": "system", "last_check_in": "2035-04-25T11:49:21.673Z", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "4017f0d3-f8f8-46b6-8ba6-80c5d3866772", "title": "Fugiat quo tempore ullam." } ] }, { "id": "58f5b724-26d7-4172-b64a-52c0aedd9d0f", "display_name": "mann-leuschke.example", "groups": [], "culled_timestamp": "2035-05-01T11:49:21.683Z", "stale_timestamp": "2035-04-17T11:49:21.683Z", "stale_warning_timestamp": "2035-04-24T11:49:21.683Z", "updated": "2025-04-17T11:49:21.683Z", "insights_id": null, "tags": [ { "key": "program", "value": "optical", "namespace": "navigating" }, { "key": "transmitter", "value": "multi-byte", "namespace": "transmitting" }, { "key": "bandwidth", "value": "back-end", "namespace": "connecting" }, { "key": "firewall", "value": "bluetooth", "namespace": "synthesizing" }, { "key": "firewall", "value": "digital", "namespace": "transmitting" } ], "type": "system", "last_check_in": "2035-04-25T11:49:21.683Z", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "4017f0d3-f8f8-46b6-8ba6-80c5d3866772", "title": "Fugiat quo tempore ullam." } ] }, { "id": "5b9fbe75-8e9a-49dc-849f-5662590d18f8", "display_name": "price.example", "groups": [], "culled_timestamp": "2035-05-01T11:49:21.771Z", "stale_timestamp": "2035-04-17T11:49:21.771Z", "stale_warning_timestamp": "2035-04-24T11:49:21.771Z", "updated": "2025-04-17T11:49:21.771Z", "insights_id": null, "tags": [ { "key": "protocol", "value": "back-end", "namespace": "transmitting" }, { "key": "array", "value": "wireless", "namespace": "quantifying" }, { "key": "circuit", "value": "redundant", "namespace": "calculating" }, { "key": "monitor", "value": "virtual", "namespace": "synthesizing" }, { "key": "pixel", "value": "optical", "namespace": "hacking" } ], "type": "system", "last_check_in": "2035-04-25T11:49:21.771Z", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "4017f0d3-f8f8-46b6-8ba6-80c5d3866772", "title": "Fugiat quo tempore ullam." } ] } ], "meta": { "total": 25, "filter": "(os_minor_version=0)", "tags": [], "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/reports/4017f0d3-f8f8-46b6-8ba6-80c5d3866772/systems?filter=%28os_minor_version%3D0%29&limit=10&offset=0", "last": "/api/compliance/v2/reports/4017f0d3-f8f8-46b6-8ba6-80c5d3866772/systems?filter=%28os_minor_version%3D0%29&limit=10&offset=20", "next": "/api/compliance/v2/reports/4017f0d3-f8f8-46b6-8ba6-80c5d3866772/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": "d3ae7cc2-f9e1-4657-9354-1bad7cc57cec", "display_name": "dibbert-smitham.example", "groups": [], "culled_timestamp": "2035-05-01T11:49:24.136Z", "stale_timestamp": "2035-04-17T11:49:24.136Z", "stale_warning_timestamp": "2035-04-24T11:49:24.136Z", "updated": "2025-04-17T11:49:24.136Z", "insights_id": null, "tags": [ { "key": "driver", "value": "auxiliary", "namespace": "indexing" }, { "key": "matrix", "value": "primary", "namespace": "transmitting" }, { "key": "system", "value": "1080p", "namespace": "indexing" }, { "key": "sensor", "value": "1080p", "namespace": "indexing" }, { "key": "bandwidth", "value": "digital", "namespace": "generating" } ], "type": "system", "last_check_in": "2035-04-25T11:49:24.136Z", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "c71a0ebc-513b-4181-bd57-a0cf2f7042c4", "title": "Rem quam officiis ut." } ] } }, "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 e9553558-9064-4d25-b613-e32ddd076cd0" ] }, "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": "02b710bd-746d-40f6-b9cb-c8a000dd592a", "profile_id": "119853c5-7893-4149-9970-84c6884cbf3f", "os_minor_version": 2, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "736a0eae-3eb2-4c9c-b5e1-7a7038d2a7ed", "security_guide_version": "100.96.22" }, { "id": "063364f6-161d-452a-9413-635e71a3909d", "profile_id": "8bd5b376-a810-4cd7-8b4f-508f8291c135", "os_minor_version": 10, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "b031c24e-42e0-4a4f-85d2-29049c2faae1", "security_guide_version": "100.96.30" }, { "id": "0b34aec0-d2c9-4b0b-9b01-768c70a82bec", "profile_id": "6cc15abe-4b11-4db4-bf44-45ec843e6262", "os_minor_version": 7, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "fdb7140c-b1c1-48bb-96c2-b6bde9887da5", "security_guide_version": "100.96.27" }, { "id": "17486379-b1f6-4b40-a8cf-8a03df40d1a3", "profile_id": "b0b5571c-4de2-4d70-9e1a-32e3425fc576", "os_minor_version": 6, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "43b0feca-f2ef-4299-b2c6-8e6dbc1e8bc0", "security_guide_version": "100.96.26" }, { "id": "19ae8bfb-b7ae-4b84-8fc0-27e734eb96ef", "profile_id": "4a6c7063-b080-46a0-be7b-cee5e202b4bd", "os_minor_version": 3, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "3ac3b2f9-1084-4f82-9136-a5622a4faa54", "security_guide_version": "100.96.23" }, { "id": "23ade012-9c40-4b6d-9286-fbc0c952e823", "profile_id": "26431292-3f2a-48ad-b3a9-d6a7eae0455d", "os_minor_version": 12, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "d927fd11-de88-4e8b-bb59-cc631c7032b7", "security_guide_version": "100.96.32" }, { "id": "25a5f011-f444-4970-8f25-1d73b7fb3a67", "profile_id": "2eb0489d-4de0-40f8-af9a-9ae634e206f8", "os_minor_version": 1, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "5827fa3f-762c-44cd-96fe-f5c825c74630", "security_guide_version": "100.96.21" }, { "id": "340a02cb-bee4-4d61-b75e-acee92ec999d", "profile_id": "2cbba1e5-1b3d-4349-ac24-c4f3beffe1a2", "os_minor_version": 15, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "dcb01c0f-ebf4-4027-8717-13b448a66f22", "security_guide_version": "100.96.35" }, { "id": "41da9a4e-b9a3-439d-98cc-ebac225b9564", "profile_id": "f0634158-7ca6-4791-a9d0-0748ba11691e", "os_minor_version": 9, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "2ab1cec4-abc1-4a99-9707-66e3456bce0b", "security_guide_version": "100.96.29" }, { "id": "48d79b76-8ed8-44a9-abd4-a95e60e0c1c1", "profile_id": "ec16d9ee-1bd6-4fb7-8d6b-1e920081115a", "os_minor_version": 13, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "2b24e482-2824-4532-8f0e-d4da66a1d160", "security_guide_version": "100.96.33" } ], "meta": { "total": 25, "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/policies/43e1c6f8-9d92-46c6-82cd-2a1e32de5120/tailorings?limit=10&offset=0", "last": "/api/compliance/v2/policies/43e1c6f8-9d92-46c6-82cd-2a1e32de5120/tailorings?limit=10&offset=20", "next": "/api/compliance/v2/policies/43e1c6f8-9d92-46c6-82cd-2a1e32de5120/tailorings?limit=10&offset=10" } }, "summary": "", "description": "" }, "List of Tailorings sorted by \"os_minor_version:asc\"": { "value": { "data": [ { "id": "c83b5639-12aa-472d-9c43-ad6e32dad199", "profile_id": "091d3c34-678f-4f40-88f6-e1fa27d2e7d6", "os_minor_version": 0, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "cc012333-a47d-450d-8195-9e1b4b75974a", "security_guide_version": "100.96.45" }, { "id": "a6d2e236-ad66-422b-a68f-79fedecb49c0", "profile_id": "74c98e9f-bccf-40a3-a18b-238af507b0b2", "os_minor_version": 1, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "2bd4cfd7-9636-4814-bd1d-a3f7e730cf08", "security_guide_version": "100.96.46" }, { "id": "bb640746-cb4d-44c3-83ca-7f5408fa21e7", "profile_id": "c0a7b6a2-5352-4c7c-9d02-eecd88598fad", "os_minor_version": 2, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "2391df51-418d-4180-98b1-b741b6689fb6", "security_guide_version": "100.96.47" }, { "id": "b94b2cad-2207-490e-b3fe-2c43cde8ded3", "profile_id": "22471e26-481c-407e-85bb-6527b3eae85f", "os_minor_version": 3, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "f7d53201-531f-4129-8696-eb08305d0842", "security_guide_version": "100.96.48" }, { "id": "4b0a9db7-9cdb-4650-a50e-c1a7bcfb0bcc", "profile_id": "139f3a5c-21c2-44bc-b0c4-35395d0af85e", "os_minor_version": 4, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "b4ebdb39-640e-40ec-ab86-8fcdaac207d0", "security_guide_version": "100.96.49" }, { "id": "756038e5-1c8a-4da7-8317-07785640963c", "profile_id": "05b921a9-6f0d-41b1-a8ea-49af941ede74", "os_minor_version": 5, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "4f0879f2-941c-4f05-9375-db659ce1a0fe", "security_guide_version": "100.97.0" }, { "id": "0041d3c6-87cf-4aec-bca9-3aea8fac7bfe", "profile_id": "4d8ef4e9-6fcf-475a-8be5-3b8ead923bf4", "os_minor_version": 6, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "15861e94-5b17-4a5a-b1ce-4f38dbd54112", "security_guide_version": "100.97.1" }, { "id": "53af788b-0663-417d-8b6e-7eaffda45424", "profile_id": "8d178059-e554-4a11-a5c5-e356fbb00ea0", "os_minor_version": 7, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "90db5eaa-7f32-48dc-892c-8d61d1fc4dbc", "security_guide_version": "100.97.2" }, { "id": "610af76a-fc28-43b6-bd0f-16968cba4de0", "profile_id": "dd7b7558-adcb-4cf3-a0d1-a07cdab06968", "os_minor_version": 8, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "de65bc1e-601e-4100-9d7f-1529eac7928c", "security_guide_version": "100.97.3" }, { "id": "039d1e28-d351-46e9-b7ad-3c100abb9602", "profile_id": "3d1fdcc0-932f-435c-ab76-336df9cc32af", "os_minor_version": 9, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "5a7704ae-c3ac-4013-ad5f-2a8fbe4c4722", "security_guide_version": "100.97.4" } ], "meta": { "total": 25, "limit": 10, "offset": 0, "sort_by": "os_minor_version" }, "links": { "first": "/api/compliance/v2/policies/acb098ee-ac97-4e37-a63e-40bece7ce1b1/tailorings?limit=10&offset=0&sort_by=os_minor_version", "last": "/api/compliance/v2/policies/acb098ee-ac97-4e37-a63e-40bece7ce1b1/tailorings?limit=10&offset=20&sort_by=os_minor_version", "next": "/api/compliance/v2/policies/acb098ee-ac97-4e37-a63e-40bece7ce1b1/tailorings?limit=10&offset=10&sort_by=os_minor_version" } }, "summary": "", "description": "" }, "List of Tailorings filtered by '(os_minor_version=22)'": { "value": { "data": [ { "id": "01f03819-c26e-4f55-b83a-dd7a37b4ba7a", "profile_id": "763969f9-a7f4-44af-9894-3f0d6ce52977", "os_minor_version": 22, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "979ce9da-0790-4bb8-935c-3381836cd1d7", "security_guide_version": "100.97.42" } ], "meta": { "total": 1, "filter": "(os_minor_version=22)", "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/policies/c8d24264-a043-4d77-b2cd-be9e73c84aa6/tailorings?filter=%28os_minor_version%3D22%29&limit=10&offset=0", "last": "/api/compliance/v2/policies/c8d24264-a043-4d77-b2cd-be9e73c84aa6/tailorings?filter=%28os_minor_version%3D22%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": "82a4a052-3e2e-47d5-9ca2-330085bf21ff", "profile_id": "e6fa39ec-690f-4ec1-950b-51d879eb17bc", "os_minor_version": 1, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "ebc7120c-44e7-4769-a0b0-dd1a8076ec6c", "security_guide_version": "100.98.45" } }, "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": "51296c4e-df01-4378-9e3a-940af1281c55", "profile_id": "09ac1a78-f0ce-44db-a00a-7543e4dda2cc", "os_minor_version": 1, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "b6840d89-3eab-4739-8d26-efc55fdaa049", "security_guide_version": "100.98.46" } }, "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 09b48253-de16-4740-80bc-74d6601cbf7f" ] }, "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": "d246d700-62df-4175-8d3d-37ea363af80f", "profile_id": "64751566-f9a7-4dfd-bf28-d33551f2b8da", "os_minor_version": 1, "value_overrides": { "c2d68aa8-fc72-4c5a-9492-c92297f26dc5": "123" }, "type": "tailoring", "os_major_version": 7, "security_guide_id": "0112b166-5391-40b5-a277-d49bc216e534", "security_guide_version": "100.98.47" } }, "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": "c145d4bc-de4e-4f70-92fc-c131b699a462", "type": "rule_group", "children": [ { "id": "1899da0a-1c6f-4516-bb73-a42825332de4", "type": "rule" } ] }, { "id": "fb6da019-c792-460d-8585-3340e67af609", "type": "rule_group", "children": [ { "id": "448049d3-b44a-4f62-b386-ec022075b421", "type": "rule" } ] }, { "id": "24e32286-0793-4657-91ec-7691964b0c45", "type": "rule_group", "children": [ { "id": "c40e1772-474f-4cd9-8042-a7b5ba00443e", "type": "rule" } ] }, { "id": "ef9b62c2-e4b8-4b70-83ef-4acea0420fbc", "type": "rule_group", "children": [ { "id": "2aff31eb-6edd-4121-a8bc-ec46959bb1d2", "type": "rule" } ] }, { "id": "54edc299-2e67-4fec-822f-0526780e3051", "type": "rule_group", "children": [ { "id": "5a6c276c-7d34-4f7c-a7a0-734de71c0c70", "type": "rule" } ] }, { "id": "2f2a218d-17af-4218-9fae-f0f515471342", "type": "rule_group", "children": [ { "id": "85b4fb87-4477-4f1f-a47d-970214bc80c0", "type": "rule" } ] }, { "id": "9a00fdac-86a9-4dd3-899d-18c2a37900c7", "type": "rule_group", "children": [ { "id": "82404904-5f2d-4f1c-af93-85524296f4da", "type": "rule" } ] }, { "id": "99033993-1934-4c8e-9ba9-5e91c81372df", "type": "rule_group", "children": [ { "id": "feb695ed-a723-4644-bd96-c7e689cb53ae", "type": "rule" } ] }, { "id": "6eb02c34-5afa-4052-9e39-0d194fe40e96", "type": "rule_group", "children": [ { "id": "7fff3879-2104-4783-8bde-951b89e50b2f", "type": "rule" } ] }, { "id": "7e9a95e6-934f-447a-9ea1-5b11f8cb6223", "type": "rule_group", "children": [ { "id": "0aff8b8a-452f-475b-877e-1a5b83bd626a", "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 a6cd5480-54cc-4184-bddb-ef48fc575792" ] }, "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": "TailoringFile", "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_4c6d0969f381d405c9fcc0bdccb00fb7", "title": "Ex placeat in reiciendis.", "groups": {}, "rules": {}, "variables": { "foo_value_2f0456b1-940e-45ea-87f4-6844a1a5b622": { "value": "755072" }, "foo_value_394ce4f1-5b99-43ae-baf0-fb9f3188d7b9": { "value": "858842" } } } ] }, "summary": "", "description": "" } }, "schema": { "$ref": "#/components/schemas/tailoring_file" } } } } } } }, "/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": "07150f64-e0f7-4b48-b2f9-66f1ded37ee8", "end_time": "2025-04-17T11:48:27.792Z", "failed_rule_count": 0, "supported": true, "score": 7.942933803943008, "type": "test_result", "display_name": "kuhn.example", "groups": [], "tags": [ { "key": "matrix", "value": "solid state", "namespace": "navigating" }, { "key": "matrix", "value": "mobile", "namespace": "synthesizing" }, { "key": "array", "value": "redundant", "namespace": "indexing" }, { "key": "port", "value": "cross-platform", "namespace": "transmitting" }, { "key": "port", "value": "back-end", "namespace": "indexing" } ], "os_major_version": 8, "os_minor_version": 0, "compliant": false, "system_id": "fee61419-7fbc-49c0-8e2b-2ec711074d16", "security_guide_version": "100.101.18" }, { "id": "32b40af7-9eb9-47c3-93de-e6fe37d2dae1", "end_time": "2025-04-17T11:48:27.861Z", "failed_rule_count": 0, "supported": true, "score": 85.61426956214434, "type": "test_result", "display_name": "gerhold.example", "groups": [], "tags": [ { "key": "interface", "value": "open-source", "namespace": "programming" }, { "key": "sensor", "value": "digital", "namespace": "quantifying" }, { "key": "matrix", "value": "bluetooth", "namespace": "parsing" }, { "key": "program", "value": "1080p", "namespace": "hacking" }, { "key": "protocol", "value": "neural", "namespace": "overriding" } ], "os_major_version": 8, "os_minor_version": 0, "compliant": false, "system_id": "e595c0ed-bc17-4ca2-a2eb-b8371380b3f4", "security_guide_version": "100.101.18" }, { "id": "36256d2d-4161-44fb-9741-7de96427d935", "end_time": "2025-04-17T11:48:27.689Z", "failed_rule_count": 0, "supported": true, "score": 4.205883811246036, "type": "test_result", "display_name": "boyle-ferry.test", "groups": [], "tags": [ { "key": "application", "value": "haptic", "namespace": "parsing" }, { "key": "bus", "value": "auxiliary", "namespace": "backing up" }, { "key": "capacitor", "value": "optical", "namespace": "transmitting" }, { "key": "sensor", "value": "mobile", "namespace": "overriding" }, { "key": "driver", "value": "mobile", "namespace": "transmitting" } ], "os_major_version": 8, "os_minor_version": 0, "compliant": false, "system_id": "8f028ff4-33d8-4b8b-adea-51858fa3dcf2", "security_guide_version": "100.101.18" }, { "id": "3a31e93c-6adc-4ee6-ba80-b0cc32e28be9", "end_time": "2025-04-17T11:48:27.745Z", "failed_rule_count": 0, "supported": true, "score": 68.12744348799109, "type": "test_result", "display_name": "breitenberg.test", "groups": [], "tags": [ { "key": "transmitter", "value": "online", "namespace": "compressing" }, { "key": "interface", "value": "cross-platform", "namespace": "programming" }, { "key": "firewall", "value": "open-source", "namespace": "compressing" }, { "key": "capacitor", "value": "auxiliary", "namespace": "calculating" }, { "key": "capacitor", "value": "optical", "namespace": "compressing" } ], "os_major_version": 8, "os_minor_version": 0, "compliant": false, "system_id": "dc3e7f0f-3183-44a4-a490-647b93b394e7", "security_guide_version": "100.101.18" }, { "id": "51f731b4-82ab-4006-8c3a-903e23b19e93", "end_time": "2025-04-17T11:48:27.667Z", "failed_rule_count": 0, "supported": true, "score": 83.82241590383677, "type": "test_result", "display_name": "satterfield.test", "groups": [], "tags": [ { "key": "card", "value": "optical", "namespace": "synthesizing" }, { "key": "driver", "value": "mobile", "namespace": "connecting" }, { "key": "system", "value": "primary", "namespace": "navigating" }, { "key": "capacitor", "value": "digital", "namespace": "copying" }, { "key": "array", "value": "multi-byte", "namespace": "compressing" } ], "os_major_version": 8, "os_minor_version": 0, "compliant": false, "system_id": "a795e22c-cb04-4dc4-873a-fc6c9f71fad8", "security_guide_version": "100.101.18" }, { "id": "5b79b8be-1ef3-4b8c-ad86-bb7af1099378", "end_time": "2025-04-17T11:48:27.757Z", "failed_rule_count": 0, "supported": true, "score": 8.044548934234419, "type": "test_result", "display_name": "treutel.test", "groups": [], "tags": [ { "key": "program", "value": "haptic", "namespace": "copying" }, { "key": "matrix", "value": "wireless", "namespace": "programming" }, { "key": "program", "value": "back-end", "namespace": "quantifying" }, { "key": "circuit", "value": "primary", "namespace": "calculating" }, { "key": "monitor", "value": "virtual", "namespace": "navigating" } ], "os_major_version": 8, "os_minor_version": 0, "compliant": false, "system_id": "fade4033-b4b9-4fb7-98f9-88eb90819b40", "security_guide_version": "100.101.18" }, { "id": "6463fcb5-22a8-4136-b327-f6c4202ed93f", "end_time": "2025-04-17T11:48:27.633Z", "failed_rule_count": 0, "supported": true, "score": 28.0152666639477, "type": "test_result", "display_name": "kassulke.test", "groups": [], "tags": [ { "key": "hard drive", "value": "wireless", "namespace": "indexing" }, { "key": "sensor", "value": "1080p", "namespace": "parsing" }, { "key": "card", "value": "online", "namespace": "connecting" }, { "key": "hard drive", "value": "primary", "namespace": "indexing" }, { "key": "alarm", "value": "optical", "namespace": "programming" } ], "os_major_version": 8, "os_minor_version": 0, "compliant": false, "system_id": "cd0959d1-7e00-4679-a5d5-146ba9b797ed", "security_guide_version": "100.101.18" }, { "id": "677325f1-159b-4e7d-a63b-dcd5f308ed37", "end_time": "2025-04-17T11:48:27.712Z", "failed_rule_count": 0, "supported": true, "score": 66.8254138012402, "type": "test_result", "display_name": "fritsch-runolfsson.example", "groups": [], "tags": [ { "key": "circuit", "value": "digital", "namespace": "parsing" }, { "key": "circuit", "value": "redundant", "namespace": "navigating" }, { "key": "protocol", "value": "solid state", "namespace": "connecting" }, { "key": "panel", "value": "haptic", "namespace": "hacking" }, { "key": "bandwidth", "value": "back-end", "namespace": "overriding" } ], "os_major_version": 8, "os_minor_version": 0, "compliant": false, "system_id": "598f9576-b4d1-4cac-988d-78b78ca7caf3", "security_guide_version": "100.101.18" }, { "id": "7af38fa6-78f7-4acd-95c5-cb85fed1ec43", "end_time": "2025-04-17T11:48:27.838Z", "failed_rule_count": 0, "supported": true, "score": 47.06889881278796, "type": "test_result", "display_name": "lynch.example", "groups": [], "tags": [ { "key": "alarm", "value": "auxiliary", "namespace": "parsing" }, { "key": "bandwidth", "value": "online", "namespace": "parsing" }, { "key": "bus", "value": "digital", "namespace": "synthesizing" }, { "key": "interface", "value": "haptic", "namespace": "navigating" }, { "key": "hard drive", "value": "wireless", "namespace": "hacking" } ], "os_major_version": 8, "os_minor_version": 0, "compliant": false, "system_id": "49a55737-8bf0-4481-8a11-ffc1ee8867fd", "security_guide_version": "100.101.18" }, { "id": "862ab7d2-1984-460b-8087-d52f14af16b1", "end_time": "2025-04-17T11:48:27.768Z", "failed_rule_count": 0, "supported": true, "score": 1.771767249737466, "type": "test_result", "display_name": "fahey-crist.example", "groups": [], "tags": [ { "key": "port", "value": "wireless", "namespace": "programming" }, { "key": "firewall", "value": "redundant", "namespace": "generating" }, { "key": "transmitter", "value": "back-end", "namespace": "parsing" }, { "key": "interface", "value": "cross-platform", "namespace": "synthesizing" }, { "key": "panel", "value": "auxiliary", "namespace": "synthesizing" } ], "os_major_version": 8, "os_minor_version": 0, "compliant": false, "system_id": "1c9f10b9-afba-4751-a1dc-8a383b3a688a", "security_guide_version": "100.101.18" } ], "meta": { "total": 25, "tags": [], "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/reports/e3852aa4-7b5c-4769-8504-ee3a43d9b2f7/test_results?limit=10&offset=0", "last": "/api/compliance/v2/reports/e3852aa4-7b5c-4769-8504-ee3a43d9b2f7/test_results?limit=10&offset=20", "next": "/api/compliance/v2/reports/e3852aa4-7b5c-4769-8504-ee3a43d9b2f7/test_results?limit=10&offset=10" } }, "summary": "", "description": "" }, "List of Test Results sorted by \"score:asc\"": { "value": { "data": [ { "id": "58a84cc4-d531-4348-a002-685920624539", "end_time": "2025-04-17T11:48:28.565Z", "failed_rule_count": 0, "supported": true, "score": 0.18418392844598, "type": "test_result", "display_name": "ernser-lebsack.test", "groups": [], "tags": [ { "key": "bus", "value": "digital", "namespace": "compressing" }, { "key": "system", "value": "back-end", "namespace": "compressing" }, { "key": "bus", "value": "bluetooth", "namespace": "transmitting" }, { "key": "pixel", "value": "digital", "namespace": "transmitting" }, { "key": "program", "value": "auxiliary", "namespace": "quantifying" } ], "os_major_version": 8, "os_minor_version": 0, "compliant": false, "system_id": "c3327c2b-b97b-4e34-85bc-e1146ccae6ec", "security_guide_version": "100.102.28" }, { "id": "7fe2d894-914f-47ba-80bc-0475e77053cd", "end_time": "2025-04-17T11:48:28.428Z", "failed_rule_count": 0, "supported": true, "score": 10.41062429866279, "type": "test_result", "display_name": "daugherty-dare.test", "groups": [], "tags": [ { "key": "monitor", "value": "bluetooth", "namespace": "bypassing" }, { "key": "sensor", "value": "bluetooth", "namespace": "parsing" }, { "key": "bus", "value": "optical", "namespace": "calculating" }, { "key": "feed", "value": "virtual", "namespace": "connecting" }, { "key": "system", "value": "digital", "namespace": "synthesizing" } ], "os_major_version": 8, "os_minor_version": 0, "compliant": false, "system_id": "3b74ea2f-e6eb-429d-8521-f76a81b3c754", "security_guide_version": "100.102.28" }, { "id": "f4398c97-92a4-400c-a9c6-a3257330525e", "end_time": "2025-04-17T11:48:28.541Z", "failed_rule_count": 0, "supported": true, "score": 12.0856908804786, "type": "test_result", "display_name": "schneider.test", "groups": [], "tags": [ { "key": "array", "value": "redundant", "namespace": "quantifying" }, { "key": "firewall", "value": "multi-byte", "namespace": "generating" }, { "key": "interface", "value": "primary", "namespace": "quantifying" }, { "key": "port", "value": "wireless", "namespace": "transmitting" }, { "key": "bandwidth", "value": "wireless", "namespace": "synthesizing" } ], "os_major_version": 8, "os_minor_version": 0, "compliant": false, "system_id": "83fc3f1a-785f-411d-bee6-d5154436eae7", "security_guide_version": "100.102.28" }, { "id": "fa4e017f-becc-4a86-8125-1be814a42b58", "end_time": "2025-04-17T11:48:28.528Z", "failed_rule_count": 0, "supported": true, "score": 14.67878952432154, "type": "test_result", "display_name": "botsford.test", "groups": [], "tags": [ { "key": "matrix", "value": "wireless", "namespace": "synthesizing" }, { "key": "system", "value": "virtual", "namespace": "quantifying" }, { "key": "sensor", "value": "mobile", "namespace": "synthesizing" }, { "key": "panel", "value": "virtual", "namespace": "connecting" }, { "key": "driver", "value": "redundant", "namespace": "copying" } ], "os_major_version": 8, "os_minor_version": 0, "compliant": false, "system_id": "97c90349-999f-4de6-82bb-c914296035e4", "security_guide_version": "100.102.28" }, { "id": "1b8b7b72-9ad7-4ba3-a09b-ca375a586081", "end_time": "2025-04-17T11:48:28.577Z", "failed_rule_count": 0, "supported": true, "score": 15.16112296320871, "type": "test_result", "display_name": "huels.test", "groups": [], "tags": [ { "key": "protocol", "value": "open-source", "namespace": "hacking" }, { "key": "card", "value": "back-end", "namespace": "compressing" }, { "key": "feed", "value": "open-source", "namespace": "generating" }, { "key": "array", "value": "neural", "namespace": "bypassing" }, { "key": "driver", "value": "optical", "namespace": "connecting" } ], "os_major_version": 8, "os_minor_version": 0, "compliant": false, "system_id": "9a371b94-b743-49e4-9711-6f16450eb734", "security_guide_version": "100.102.28" }, { "id": "b2be27cc-92b9-4320-8479-0146ce129bf5", "end_time": "2025-04-17T11:48:28.400Z", "failed_rule_count": 0, "supported": true, "score": 19.91511615659336, "type": "test_result", "display_name": "streich.example", "groups": [], "tags": [ { "key": "driver", "value": "auxiliary", "namespace": "navigating" }, { "key": "monitor", "value": "open-source", "namespace": "parsing" }, { "key": "system", "value": "online", "namespace": "synthesizing" }, { "key": "capacitor", "value": "digital", "namespace": "connecting" }, { "key": "card", "value": "bluetooth", "namespace": "overriding" } ], "os_major_version": 8, "os_minor_version": 0, "compliant": false, "system_id": "edd4fd65-ffc3-4e78-b6e6-52b4fb9a5bc0", "security_guide_version": "100.102.28" }, { "id": "7c07bcb0-9557-4c69-a6d4-7918c4163783", "end_time": "2025-04-17T11:48:28.455Z", "failed_rule_count": 0, "supported": true, "score": 25.2676410138287, "type": "test_result", "display_name": "spencer-hoppe.example", "groups": [], "tags": [ { "key": "matrix", "value": "redundant", "namespace": "bypassing" }, { "key": "array", "value": "digital", "namespace": "programming" }, { "key": "bandwidth", "value": "online", "namespace": "generating" }, { "key": "driver", "value": "1080p", "namespace": "generating" }, { "key": "sensor", "value": "redundant", "namespace": "compressing" } ], "os_major_version": 8, "os_minor_version": 0, "compliant": false, "system_id": "6af74cd0-12c6-466a-b519-b080fed13c2e", "security_guide_version": "100.102.28" }, { "id": "e2a5839f-ed5c-49d8-9120-8bfecd43f078", "end_time": "2025-04-17T11:48:28.478Z", "failed_rule_count": 0, "supported": true, "score": 28.05846665632422, "type": "test_result", "display_name": "wilderman.test", "groups": [], "tags": [ { "key": "feed", "value": "haptic", "namespace": "indexing" }, { "key": "panel", "value": "haptic", "namespace": "bypassing" }, { "key": "matrix", "value": "multi-byte", "namespace": "backing up" }, { "key": "application", "value": "auxiliary", "namespace": "programming" }, { "key": "driver", "value": "mobile", "namespace": "connecting" } ], "os_major_version": 8, "os_minor_version": 0, "compliant": false, "system_id": "2c1c2c75-0eeb-4f45-a4d4-5951d4bba8f9", "security_guide_version": "100.102.28" }, { "id": "4d5a16d4-5592-46b1-8af1-e90e88ef5176", "end_time": "2025-04-17T11:48:28.491Z", "failed_rule_count": 0, "supported": true, "score": 30.22428256095794, "type": "test_result", "display_name": "torp-bauch.example", "groups": [], "tags": [ { "key": "bus", "value": "bluetooth", "namespace": "transmitting" }, { "key": "firewall", "value": "auxiliary", "namespace": "backing up" }, { "key": "system", "value": "primary", "namespace": "quantifying" }, { "key": "bus", "value": "open-source", "namespace": "compressing" }, { "key": "microchip", "value": "open-source", "namespace": "copying" } ], "os_major_version": 8, "os_minor_version": 0, "compliant": false, "system_id": "7c622478-05a3-4e4d-912e-11fb209474cd", "security_guide_version": "100.102.28" }, { "id": "16871757-5710-4974-b847-ad1d8f40cfa1", "end_time": "2025-04-17T11:48:28.389Z", "failed_rule_count": 0, "supported": true, "score": 32.53274996235959, "type": "test_result", "display_name": "trantow.example", "groups": [], "tags": [ { "key": "bandwidth", "value": "multi-byte", "namespace": "overriding" }, { "key": "card", "value": "open-source", "namespace": "backing up" }, { "key": "sensor", "value": "open-source", "namespace": "indexing" }, { "key": "monitor", "value": "neural", "namespace": "indexing" }, { "key": "pixel", "value": "auxiliary", "namespace": "bypassing" } ], "os_major_version": 8, "os_minor_version": 0, "compliant": false, "system_id": "475147e8-5e89-4362-9872-bb7b315d99d2", "security_guide_version": "100.102.28" } ], "meta": { "total": 25, "tags": [], "limit": 10, "offset": 0, "sort_by": "score" }, "links": { "first": "/api/compliance/v2/reports/800cea5c-8aa5-4e43-9446-4f4e188c0a72/test_results?limit=10&offset=0&sort_by=score", "last": "/api/compliance/v2/reports/800cea5c-8aa5-4e43-9446-4f4e188c0a72/test_results?limit=10&offset=20&sort_by=score", "next": "/api/compliance/v2/reports/800cea5c-8aa5-4e43-9446-4f4e188c0a72/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/d76e0a3b-2d6f-4243-a420-3e15bafdb9ff/test_results?filter=%28os_minor_version%3D8%29&limit=10&offset=0", "last": "/api/compliance/v2/reports/d76e0a3b-2d6f-4243-a420-3e15bafdb9ff/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.108.20" ], "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": "189f38b6-47df-42d3-bae0-e57714dd95c7", "end_time": "2025-04-17T11:48:32.949Z", "failed_rule_count": 0, "supported": true, "score": 4.572102569812841, "type": "test_result", "display_name": "streich.test", "groups": [], "tags": [ { "key": "system", "value": "bluetooth", "namespace": "navigating" }, { "key": "microchip", "value": "bluetooth", "namespace": "synthesizing" }, { "key": "program", "value": "bluetooth", "namespace": "overriding" }, { "key": "circuit", "value": "virtual", "namespace": "overriding" }, { "key": "card", "value": "optical", "namespace": "compressing" } ], "os_major_version": 8, "os_minor_version": 0, "compliant": false, "system_id": "6622b662-c9fd-46eb-a402-55b94481ba1b", "security_guide_version": "100.109.36" } }, "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 159c5527-6232-482f-9a57-9fc93a29e4c7" ] }, "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": "0520716a-ee31-4549-8431-e9d0fe8d7d1b", "ref_id": "foo_value_800c458f-3b4d-4b92-bc14-59d34010fab4", "title": "Quidem et accusamus sequi.", "description": "Dolorem non neque. Et quaerat facilis. Iusto ut ex.", "value_type": "number", "default_value": "0.30564241140585313", "type": "value_definition" }, { "id": "0ebeefaf-862d-47c7-9b2c-e63efc6de835", "ref_id": "foo_value_db36b895-ea81-4649-a57c-1524194b9f63", "title": "Ut quia non ex.", "description": "Magnam atque veritatis. Et rerum placeat. Velit minima ut.", "value_type": "number", "default_value": "0.11972968764362624", "type": "value_definition" }, { "id": "1367a267-fa7d-417f-b2f5-048a765352ef", "ref_id": "foo_value_ad7cc9c5-c960-49b1-90bc-69284c958aa5", "title": "Ex in commodi minus.", "description": "Quidem voluptatem eius. Accusantium vitae est. Rerum aut itaque.", "value_type": "number", "default_value": "0.7598861441027798", "type": "value_definition" }, { "id": "15d754f0-9c0b-4536-9a1f-860f7b41c9c6", "ref_id": "foo_value_7fd4c50b-5568-45db-9253-cfbcc8a9d42f", "title": "Id dolor omnis ipsum.", "description": "Ipsum illum exercitationem. Voluptatem ipsa voluptate. Quo beatae et.", "value_type": "number", "default_value": "0.18447449106790792", "type": "value_definition" }, { "id": "17cb7cbb-221f-436b-9c46-958f8f727708", "ref_id": "foo_value_bf260328-174d-467a-af69-2d027c25ee05", "title": "Voluptatibus doloribus qui pariatur.", "description": "Unde ut quibusdam. Incidunt quia nisi. Vitae harum asperiores.", "value_type": "number", "default_value": "0.18627700715206041", "type": "value_definition" }, { "id": "1ad5157d-a329-4d56-b456-ed98e5813a85", "ref_id": "foo_value_ba618376-ef4f-45f4-a76b-c4f09bfca36d", "title": "Omnis cumque odit facilis.", "description": "Totam doloremque quia. Culpa similique tempore. Amet deserunt est.", "value_type": "number", "default_value": "0.3623214604594782", "type": "value_definition" }, { "id": "21421231-1519-4b02-8ee6-fc4fa5648f10", "ref_id": "foo_value_bd1c4239-7ede-43dc-826b-144712721e7e", "title": "Quia neque error blanditiis.", "description": "Quisquam sequi doloribus. Blanditiis voluptates ad. Quam provident aut.", "value_type": "number", "default_value": "0.8578627192053798", "type": "value_definition" }, { "id": "2bca6bdf-f3e3-4d26-8a1f-9b9a78d57b75", "ref_id": "foo_value_3a063381-a6be-42f5-bd2b-1398b2e6c002", "title": "Voluptates officiis et ea.", "description": "Magni sit voluptates. Natus iusto et. Nisi dolor repellendus.", "value_type": "number", "default_value": "0.4442064226635942", "type": "value_definition" }, { "id": "305ba7d0-9799-4cde-ab7d-b1bd89967bd6", "ref_id": "foo_value_afb0b435-4ba9-4794-a8db-387dd099e6d2", "title": "Ut repellendus minus sit.", "description": "Magnam quas nobis. Rerum facilis ad. Nisi vitae beatae.", "value_type": "number", "default_value": "0.7188821353015122", "type": "value_definition" }, { "id": "44b17131-9c32-4fcd-bfd2-9af577572c25", "ref_id": "foo_value_346dbf1c-d530-433b-ab4e-37909c26f6a6", "title": "Magni sit rem ab.", "description": "Doloremque officia qui. Et ab reiciendis. Tempora et deserunt.", "value_type": "number", "default_value": "0.857276471247882", "type": "value_definition" } ], "meta": { "total": 25, "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/security_guides/8c945a49-75c3-4dce-8a95-adce1008c6ed/value_definitions?limit=10&offset=0", "last": "/api/compliance/v2/security_guides/8c945a49-75c3-4dce-8a95-adce1008c6ed/value_definitions?limit=10&offset=20", "next": "/api/compliance/v2/security_guides/8c945a49-75c3-4dce-8a95-adce1008c6ed/value_definitions?limit=10&offset=10" } }, "summary": "", "description": "" }, "List of Value Definitions sorted by \"title:asc\"": { "value": { "data": [ { "id": "91d14507-40a8-4bfd-8395-3444ab676f40", "ref_id": "foo_value_d713c08b-7981-4ade-83bc-bf03886ae21c", "title": "At non qui non.", "description": "Natus amet sapiente. Expedita omnis consectetur. Laudantium neque quibusdam.", "value_type": "number", "default_value": "0.2285234439975904", "type": "value_definition" }, { "id": "b1f9e129-8ef3-41e8-bfd0-8ff58dbc7cab", "ref_id": "foo_value_6c9bf3a9-e377-46d6-8bc4-8a9e62da5aa2", "title": "Commodi quibusdam dolores quo.", "description": "Modi et praesentium. Exercitationem fugiat similique. At est aut.", "value_type": "number", "default_value": "0.6576561892131595", "type": "value_definition" }, { "id": "918fab2a-83de-4ecb-a6b1-fc7f8f36b05f", "ref_id": "foo_value_7dc968bc-4a58-4286-a263-679846713cd9", "title": "Consequuntur voluptas nostrum accusamus.", "description": "Vero autem quod. Quis iste officia. Voluptatem ex aliquid.", "value_type": "number", "default_value": "0.9535744364447897", "type": "value_definition" }, { "id": "d8e1a022-dd17-4a74-9a39-28419d330f98", "ref_id": "foo_value_7d022fb5-0ddd-4fc2-bb05-186834d0c1a2", "title": "Debitis recusandae qui architecto.", "description": "In natus iure. Iure ut nisi. Beatae est perferendis.", "value_type": "number", "default_value": "0.9539895247499673", "type": "value_definition" }, { "id": "35b00af9-c4d2-4b20-a711-c1bbb6b0a0de", "ref_id": "foo_value_11cf3ee9-33ac-4a88-99a6-ab2332f7cbc1", "title": "Distinctio earum et itaque.", "description": "Porro sint molestias. Adipisci corrupti velit. Minima suscipit eius.", "value_type": "number", "default_value": "0.12355069585734524", "type": "value_definition" }, { "id": "3ba4e580-53f5-42a1-9381-5f3fbd2632ec", "ref_id": "foo_value_5b2d6c30-06c3-40a9-9e73-2d865dfe96df", "title": "Dolor molestiae modi sapiente.", "description": "Consequatur repellendus mollitia. Perspiciatis tenetur sapiente. Ipsa ullam similique.", "value_type": "number", "default_value": "0.7244121372201825", "type": "value_definition" }, { "id": "6f4a2850-9d69-4f3a-8e2f-1af850d6e6ed", "ref_id": "foo_value_85c188af-61ff-44f0-9ee0-afc6aae299cf", "title": "Dolor quas et facilis.", "description": "In rem voluptates. Quis quod mollitia. Sunt ut magni.", "value_type": "number", "default_value": "0.8104222252150413", "type": "value_definition" }, { "id": "e065bab4-5147-4720-b482-10571955bea8", "ref_id": "foo_value_2f6dc9a6-489d-4616-a806-d117e2ab2796", "title": "Dolore ad voluptate iure.", "description": "Consequatur necessitatibus illum. Sed possimus autem. Minima qui et.", "value_type": "number", "default_value": "0.7478943286685453", "type": "value_definition" }, { "id": "ed440768-69a7-4180-82c0-b1819b010a7a", "ref_id": "foo_value_05711f3a-b538-4bb6-9e66-1acfaba0b671", "title": "Dolorem fuga magnam sed.", "description": "Explicabo vitae et. Adipisci tempora amet. Consequatur unde non.", "value_type": "number", "default_value": "0.9600157457034818", "type": "value_definition" }, { "id": "f83451fb-7c39-4c85-964f-1575b60955cf", "ref_id": "foo_value_72e4bda6-7c6f-4e73-95f9-ce128a63aab8", "title": "Earum officia cum et.", "description": "Sit ipsam enim. Eaque accusamus culpa. Dolor atque itaque.", "value_type": "number", "default_value": "0.03731280565415673", "type": "value_definition" } ], "meta": { "total": 25, "limit": 10, "offset": 0, "sort_by": "title" }, "links": { "first": "/api/compliance/v2/security_guides/08549b82-399f-4373-91bd-4caf6e105440/value_definitions?limit=10&offset=0&sort_by=title", "last": "/api/compliance/v2/security_guides/08549b82-399f-4373-91bd-4caf6e105440/value_definitions?limit=10&offset=20&sort_by=title", "next": "/api/compliance/v2/security_guides/08549b82-399f-4373-91bd-4caf6e105440/value_definitions?limit=10&offset=10&sort_by=title" } }, "summary": "", "description": "" }, "List of Value Definitions filtered by '(title=Fuga natus exercitationem quasi.)'": { "value": { "data": [ { "id": "09ed409a-8dcb-47f3-be95-0fcafe273ffd", "ref_id": "foo_value_0c94d000-67a7-4498-8004-49f55fb17668", "title": "Fuga natus exercitationem quasi.", "description": "Et eos enim. Recusandae eum quis. Aspernatur vel ipsam.", "value_type": "number", "default_value": "0.9432507446868649", "type": "value_definition" } ], "meta": { "total": 1, "filter": "(title=\"Fuga natus exercitationem quasi.\")", "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/security_guides/a5261732-5820-4c03-8f29-57b6d0d7b42e/value_definitions?filter=%28title%3D%22Fuga+natus+exercitationem+quasi.%22%29&limit=10&offset=0", "last": "/api/compliance/v2/security_guides/a5261732-5820-4c03-8f29-57b6d0d7b42e/value_definitions?filter=%28title%3D%22Fuga+natus+exercitationem+quasi.%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": "a4cb6aca-41bc-448a-9d9f-30768050ca96", "ref_id": "foo_value_66053736-370d-4de6-a6a8-05fe41e86c2d", "title": "Id est illum totam.", "description": "Rerum sunt ex. Aliquid et necessitatibus. At et tempore.", "value_type": "number", "default_value": "0.23679280802456693", "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 5a8deb38-fa92-44c1-80ca-5f32e7b8793e" ] }, "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" } } }, "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": [ { "f7ed6d40-d519-4033-8e2b-314dcab6f724": "foo", "9c8bce0b-b9ac-4f1f-b600-9c7708a4e53c": "123", "39f376e8-29b5-4d7b-95d7-59f057deb74a": "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": { "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'" } } } } } } } } }, "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" } ] }