{ "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": "0990aa76-2ef9-475d-9054-a4d239dc19fe", "title": "Id repellat iure qui.", "description": "Commodi dolor voluptatem. Eveniet qui vero. Beatae non iure.", "business_objective": null, "compliance_threshold": 10.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Nemo vitae adipisci sint.", "ref_id": "xccdf_org.ssgproject.content_profile_63071a98e16e01a81a6bdd4434de40cf" }, { "id": "0c071ddb-113a-4441-aaef-ef3180e6891a", "title": "Voluptatem rerum repellat ut.", "description": "Quasi aut dolor. Dolorem sit error. Culpa provident maiores.", "business_objective": null, "compliance_threshold": 23.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Ducimus ea sint quia.", "ref_id": "xccdf_org.ssgproject.content_profile_245a48ad0b7d262f5abdd037d7af76af" }, { "id": "0eeccab7-a518-459e-836d-ed9da35fb8c3", "title": "Adipisci quia dolores et.", "description": "Tempora ex minus. Enim aliquam quisquam. Voluptatem magni blanditiis.", "business_objective": null, "compliance_threshold": 49.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Sint est consequuntur quas.", "ref_id": "xccdf_org.ssgproject.content_profile_5acf87174393220bc81c9c6d3f4fca5b" }, { "id": "28edce87-63f7-4cf9-beab-507deb3556f2", "title": "Autem vel laudantium exercitationem.", "description": "Et ipsa non. Eos reiciendis soluta. Qui omnis iure.", "business_objective": null, "compliance_threshold": 66.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Unde autem possimus ipsam.", "ref_id": "xccdf_org.ssgproject.content_profile_4f416f0b6b07cc2ddaa24a346ae2d811" }, { "id": "2bd8a569-55f6-48ef-8e86-f5fa28aa5d78", "title": "Possimus ipsam reprehenderit non.", "description": "Ex voluptas sed. Voluptate neque praesentium. Autem ipsam consequatur.", "business_objective": null, "compliance_threshold": 51.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Et quo libero repellat.", "ref_id": "xccdf_org.ssgproject.content_profile_476aeed88bb6887a8235e53c1c9eeed8" }, { "id": "334a08a4-c0d0-4b00-806f-033ea3d492c0", "title": "Quia consequuntur sint necessitatibus.", "description": "Accusantium minima et. Reprehenderit rerum quisquam. Quos ut in.", "business_objective": null, "compliance_threshold": 92.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Unde est error sit.", "ref_id": "xccdf_org.ssgproject.content_profile_387d9689fcf0f29ef44c3430c1a6dc82" }, { "id": "348ebab8-129c-4051-97a7-acbb1d1bd8e3", "title": "Harum nemo repellat libero.", "description": "Sunt autem consectetur. Ea earum qui. Quia est eaque.", "business_objective": null, "compliance_threshold": 82.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Architecto sed ut vel.", "ref_id": "xccdf_org.ssgproject.content_profile_ea682656d8f578c3bfe064a5f5539216" }, { "id": "3580f4ad-260a-453c-8b18-abd30b8bb0f3", "title": "Nobis voluptatem earum necessitatibus.", "description": "Accusantium sint ex. Officiis delectus fugit. Error odio aliquam.", "business_objective": null, "compliance_threshold": 49.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Amet quia voluptas atque.", "ref_id": "xccdf_org.ssgproject.content_profile_6a57e626e9c5adba12c5dc820d701043" }, { "id": "390b4fc7-71d9-446e-b920-99139dc4210c", "title": "Aut quia hic iure.", "description": "Et aut quisquam. Eos doloribus nihil. Non sequi non.", "business_objective": null, "compliance_threshold": 41.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Rerum consequatur explicabo aspernatur.", "ref_id": "xccdf_org.ssgproject.content_profile_ee5f572824c12144f8284f6b821d4227" }, { "id": "40461be3-c8fe-404e-94de-6a991b80d8e1", "title": "Reiciendis sunt doloribus dolorum.", "description": "Placeat ratione et. Nulla expedita eos. Adipisci a nihil.", "business_objective": null, "compliance_threshold": 89.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Distinctio sit blanditiis ducimus.", "ref_id": "xccdf_org.ssgproject.content_profile_6548891ced849710b49f968cf5067f87" } ], "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": "302485d1-3f07-433d-a22f-290f0bdf3f79", "title": "Est nostrum numquam quis.", "description": "Qui aut explicabo. Sequi ut dolorem. Praesentium non sed.", "business_objective": null, "compliance_threshold": 65.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Id totam provident enim.", "ref_id": "xccdf_org.ssgproject.content_profile_497677e2e61a3fd6c512baa6ccd34560" }, { "id": "429ceb90-2753-45af-94f6-487062a785a5", "title": "Sint quia nihil quis.", "description": "Quia ullam fuga. Rerum qui nihil. Quos dicta vero.", "business_objective": null, "compliance_threshold": 46.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Sit incidunt nemo vel.", "ref_id": "xccdf_org.ssgproject.content_profile_feb09c31c9c553a696f20f8655bc26e7" }, { "id": "4525d696-2af3-42a1-a62a-2e15b7c7d092", "title": "Libero et doloribus assumenda.", "description": "Officiis molestiae aut. Quibusdam a cupiditate. Minus voluptates non.", "business_objective": null, "compliance_threshold": 60.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Eos nesciunt praesentium omnis.", "ref_id": "xccdf_org.ssgproject.content_profile_3ef8dd278d591399834ad716d3f6f51d" }, { "id": "45d7ab17-b765-455a-a020-1e17019f05be", "title": "Perferendis sapiente et consequatur.", "description": "Libero iste quod. Dolores consequatur rerum. Deserunt unde labore.", "business_objective": null, "compliance_threshold": 31.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Eos at in accusamus.", "ref_id": "xccdf_org.ssgproject.content_profile_15df05d9701e39aab7be8f8b4e60b3fa" }, { "id": "47a89231-1357-4078-a67d-a1e67223fd42", "title": "Labore doloribus molestiae quisquam.", "description": "Itaque cupiditate fugiat. Et delectus nam. Explicabo magnam est.", "business_objective": null, "compliance_threshold": 39.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Autem molestiae fugit alias.", "ref_id": "xccdf_org.ssgproject.content_profile_d310a053262cad8f8c8edceaef0578d4" }, { "id": "4c7cabae-23df-4318-aa22-ba3ac02caf68", "title": "Tempore similique illum aliquid.", "description": "Maiores placeat dignissimos. Nisi iste est. Magnam et enim.", "business_objective": null, "compliance_threshold": 29.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Animi ab dolor et.", "ref_id": "xccdf_org.ssgproject.content_profile_2fdbb1a5bd0ef4cc52f6634098875bb8" }, { "id": "51806dca-5a0c-423f-8895-e3fec274e968", "title": "Hic voluptatem tempora officiis.", "description": "Deleniti est molestiae. Voluptatem nisi soluta. Doloribus nemo saepe.", "business_objective": null, "compliance_threshold": 13.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Officiis rerum unde voluptas.", "ref_id": "xccdf_org.ssgproject.content_profile_6b523f80b303c3f9d48e94e2f5703a89" }, { "id": "5a786df3-2c95-4885-8954-cbdd2020f5f6", "title": "Ut repellat velit eligendi.", "description": "Voluptatum ut sint. Tempore voluptatem amet. Perferendis et aspernatur.", "business_objective": null, "compliance_threshold": 54.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Esse explicabo delectus ipsum.", "ref_id": "xccdf_org.ssgproject.content_profile_a6be4b81cff0ac5d31d03de10461c15f" }, { "id": "663612dd-90a3-46f1-bfc2-b0e20645818c", "title": "Placeat sequi delectus qui.", "description": "Laboriosam est debitis. Provident iusto optio. Atque quis saepe.", "business_objective": null, "compliance_threshold": 25.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Aut exercitationem adipisci et.", "ref_id": "xccdf_org.ssgproject.content_profile_fe0537254b6bb4957219c813c0575a7f" }, { "id": "76dca7cf-704d-4e1a-b54b-b68a58a8f3d9", "title": "Blanditiis dolorem ut eos.", "description": "Dolor qui esse. Dolore sit cumque. Qui quia aut.", "business_objective": null, "compliance_threshold": 90.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Et aliquid ea vel.", "ref_id": "xccdf_org.ssgproject.content_profile_30242815dee87cd7576bceb07212bed9" } ], "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": "47bd4d66-eee2-4341-ad67-87b239343aaf", "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": "Alias non blanditiis quo.", "ref_id": "xccdf_org.ssgproject.content_profile_2ecf004ec13348bd9fdcde36b3534048" } }, "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": "6a9ad61b-aec1-4167-82c5-facd25a3833b", "title": "Voluptas sit sit non.", "description": "Quia inventore ipsum. Consequatur maiores ratione. Rerum error sint.", "business_objective": null, "compliance_threshold": 66.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Mollitia enim placeat asperiores.", "ref_id": "xccdf_org.ssgproject.content_profile_d707ce24bfa3498aa98e837bce9af612" } }, "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 27416cde-0adb-494a-9c4e-44bbcfefc818" ] }, "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": "8faebe67-dfff-48bd-a1aa-69bf9b10271e", "title": "Dicta ex laudantium commodi.", "description": "Ut dolor aspernatur. Voluptatem inventore voluptatibus. Cumque deserunt eos.", "business_objective": null, "compliance_threshold": 100.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Consequatur odio distinctio iusto.", "ref_id": "xccdf_org.ssgproject.content_profile_b922137c2eecaeb1cf03eb96a6a2f69c" } }, "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": "6e030ef3-6d07-4b43-b793-351015b52026", "title": "Vero magnam et non.", "description": "Id earum tempora. Laboriosam pariatur sunt. Nihil asperiores rerum.", "business_objective": null, "compliance_threshold": 44.0, "total_system_count": 0, "type": "policy", "os_major_version": 7, "profile_title": "Autem sint error inventore.", "ref_id": "xccdf_org.ssgproject.content_profile_8dbe1a5a1c9d4029b6183a087289c5ee" } }, "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": "07ea6fdf-9c56-4852-9969-5470663f5272", "title": "Aliquid enim nesciunt dignissimos.", "description": "Tenetur qui amet. Neque laboriosam blanditiis. Omnis dolorum est.", "business_objective": null, "compliance_threshold": 87.0, "total_system_count": 1, "type": "policy", "os_major_version": 7, "profile_title": "Aut quia rerum magnam.", "ref_id": "xccdf_org.ssgproject.content_profile_fd5b746a4b48f74b6e997ea09feb1b3a" }, { "id": "0a6cecf9-043c-41c6-83a1-f2152ef6cb98", "title": "Deserunt officia harum alias.", "description": "Dolores quisquam ratione. Laboriosam id maiores. Qui vel harum.", "business_objective": null, "compliance_threshold": 57.0, "total_system_count": 1, "type": "policy", "os_major_version": 7, "profile_title": "Blanditiis quaerat repellendus est.", "ref_id": "xccdf_org.ssgproject.content_profile_6ae0bae57baf10328a803d98bd8e946e" }, { "id": "1e6fbe32-403a-4cfb-85c4-575a7b73a3c0", "title": "Et saepe dolores maxime.", "description": "Architecto ipsam et. Ipsa aut non. Maxime ea enim.", "business_objective": null, "compliance_threshold": 71.0, "total_system_count": 1, "type": "policy", "os_major_version": 7, "profile_title": "Ipsam et quisquam ad.", "ref_id": "xccdf_org.ssgproject.content_profile_07316282dc2778ba1212cd52f1f1cac5" }, { "id": "29f2a4fb-a855-425d-964e-99322fc02b77", "title": "Voluptates quia voluptatem sed.", "description": "Laborum ipsa fugit. Blanditiis culpa adipisci. Eum perspiciatis magni.", "business_objective": null, "compliance_threshold": 38.0, "total_system_count": 1, "type": "policy", "os_major_version": 7, "profile_title": "Modi soluta non amet.", "ref_id": "xccdf_org.ssgproject.content_profile_a5e94c9fe48a36e63086e3ac3cd306e2" }, { "id": "3608c6af-9614-4da2-9fae-c9542af8a9d4", "title": "Neque et doloremque rerum.", "description": "Necessitatibus ullam consequatur. Itaque voluptas commodi. Minima non sit.", "business_objective": null, "compliance_threshold": 51.0, "total_system_count": 1, "type": "policy", "os_major_version": 7, "profile_title": "Modi velit quam nisi.", "ref_id": "xccdf_org.ssgproject.content_profile_5277b1cca06358dcd7b4d90f5aa52fa8" }, { "id": "3b14ce71-fbe2-4e2e-a5ff-36b7b1f53bd6", "title": "Magni in sed repellat.", "description": "Sed quibusdam itaque. Neque voluptatum tenetur. Qui quia hic.", "business_objective": null, "compliance_threshold": 9.0, "total_system_count": 1, "type": "policy", "os_major_version": 7, "profile_title": "Accusantium maxime voluptatem facere.", "ref_id": "xccdf_org.ssgproject.content_profile_ba9273cad74e57a3a85790073acf2618" }, { "id": "6796b6d7-9979-4499-b9fd-50cc918e6e9a", "title": "Quis neque et ipsum.", "description": "Repudiandae quis optio. Iusto sequi qui. Qui autem quia.", "business_objective": null, "compliance_threshold": 1.0, "total_system_count": 1, "type": "policy", "os_major_version": 7, "profile_title": "Qui deserunt totam minima.", "ref_id": "xccdf_org.ssgproject.content_profile_6e0b39b8b841fded9c71fcf6855e5805" }, { "id": "6bd5adfc-1e9c-453a-9cbe-97da8a1b1e60", "title": "Est eos in voluptatem.", "description": "At omnis quos. Totam sint assumenda. Molestias voluptas atque.", "business_objective": null, "compliance_threshold": 77.0, "total_system_count": 1, "type": "policy", "os_major_version": 7, "profile_title": "Eaque nemo ipsam alias.", "ref_id": "xccdf_org.ssgproject.content_profile_07ffe0bd037c715785e701bbafc6bc64" }, { "id": "7b54be7c-2b4f-4d04-818a-c1cf5c5f46af", "title": "Id molestiae adipisci odio.", "description": "Eos soluta placeat. Est qui labore. Aliquid voluptas in.", "business_objective": null, "compliance_threshold": 45.0, "total_system_count": 1, "type": "policy", "os_major_version": 7, "profile_title": "Facilis deleniti quia eos.", "ref_id": "xccdf_org.ssgproject.content_profile_d103aba340ab8c38e86f0c4f3416c369" }, { "id": "7e79379a-3711-4a1f-8f91-a46d19d06e38", "title": "Ut odio reiciendis quas.", "description": "Et nihil inventore. Aut est eos. Officiis ut et.", "business_objective": null, "compliance_threshold": 33.0, "total_system_count": 1, "type": "policy", "os_major_version": 7, "profile_title": "Ut nostrum asperiores non.", "ref_id": "xccdf_org.ssgproject.content_profile_9e8712f4a2776beac6d93c3698de5aab" } ], "meta": { "total": 25, "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/systems/5645de5c-7deb-4066-80f9-aad63355f095/policies?limit=10&offset=0", "last": "/api/compliance/v2/systems/5645de5c-7deb-4066-80f9-aad63355f095/policies?limit=10&offset=20", "next": "/api/compliance/v2/systems/5645de5c-7deb-4066-80f9-aad63355f095/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": "07d65b35-1668-4280-96ed-0cd3a0407d1c", "ref_id": "xccdf_org.ssgproject.content_profile_5db606d0895cb34012faeea217ff61ab", "title": "Qui ut asperiores voluptatem.", "description": "Voluptatibus sequi aliquam. Consectetur nisi vero. Dolores ex fuga.", "value_overrides": {}, "type": "profile" }, { "id": "1627d0d1-99ac-4970-ba32-e1124403da90", "ref_id": "xccdf_org.ssgproject.content_profile_14af14565ba6a59a86ec094d2a057b84", "title": "Dignissimos sint suscipit corrupti.", "description": "Qui iusto id. Eos culpa eveniet. Magni earum commodi.", "value_overrides": {}, "type": "profile" }, { "id": "1dca85a9-fa5c-482b-8d7c-f428d056b7d1", "ref_id": "xccdf_org.ssgproject.content_profile_6f6b0770b8b95b3205d02625a94cec8f", "title": "Omnis eos quos consequatur.", "description": "Nobis sed alias. Qui est sequi. Saepe dignissimos autem.", "value_overrides": {}, "type": "profile" }, { "id": "2899c76a-c868-4e5d-8d92-355b3a1869d1", "ref_id": "xccdf_org.ssgproject.content_profile_8567923df1cafafda4b3555bbd4849e1", "title": "Dolore rem ut eaque.", "description": "Laboriosam voluptatem dolores. Dignissimos ullam enim. Velit modi quis.", "value_overrides": {}, "type": "profile" }, { "id": "29f6ef31-14c7-4556-b955-005c0eb440e9", "ref_id": "xccdf_org.ssgproject.content_profile_c1dbf01254c2144f9ff6fd9b2835c7ad", "title": "Voluptas autem ex temporibus.", "description": "Fuga provident et. Ullam aut similique. Est illum inventore.", "value_overrides": {}, "type": "profile" }, { "id": "43e72c4f-f368-428b-a780-fef166048d7b", "ref_id": "xccdf_org.ssgproject.content_profile_04450c5f388181248ce6d0ae9453cf45", "title": "Laudantium qui repellendus maiores.", "description": "Velit ipsa fugiat. Dicta fuga optio. Consequatur commodi rerum.", "value_overrides": {}, "type": "profile" }, { "id": "4efd738f-d97c-4573-98d7-0acba76b95ee", "ref_id": "xccdf_org.ssgproject.content_profile_e6fa7d7c275a0151e24f74acf61ccfeb", "title": "Blanditiis qui a quisquam.", "description": "Vero voluptas iusto. Earum sit eum. Maxime qui ratione.", "value_overrides": {}, "type": "profile" }, { "id": "6bfe4997-c5d1-4ba3-85e4-9b9c4377c898", "ref_id": "xccdf_org.ssgproject.content_profile_ddb18836b5f5d83fa6d2029eeca05e6f", "title": "Quo illum cumque exercitationem.", "description": "Voluptas quis dolorum. Asperiores maxime et. Vero voluptatum ut.", "value_overrides": {}, "type": "profile" }, { "id": "6d04cd02-31de-43f4-ab0c-9cc0e33d5b9c", "ref_id": "xccdf_org.ssgproject.content_profile_0e559b1264a53b03a2c256a76cd5a3ca", "title": "Aut culpa est ratione.", "description": "Ipsam enim rerum. Et voluptatem aut. Exercitationem nihil non.", "value_overrides": {}, "type": "profile" }, { "id": "87d0969e-747d-4fdd-a4ea-721468c4dd3e", "ref_id": "xccdf_org.ssgproject.content_profile_dea3b30708f4a28bb65f397dd63f1130", "title": "Voluptatem provident assumenda voluptatem.", "description": "Consequatur amet voluptas. Omnis tenetur voluptas. Assumenda minus totam.", "value_overrides": {}, "type": "profile" } ], "meta": { "total": 25, "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/security_guides/8f2e3379-a58e-42f5-9a90-dbe9f6301bad/profiles?limit=10&offset=0", "last": "/api/compliance/v2/security_guides/8f2e3379-a58e-42f5-9a90-dbe9f6301bad/profiles?limit=10&offset=20", "next": "/api/compliance/v2/security_guides/8f2e3379-a58e-42f5-9a90-dbe9f6301bad/profiles?limit=10&offset=10" } }, "summary": "", "description": "" }, "List of Profiles sorted by \"title:asc\"": { "value": { "data": [ { "id": "cd0adc92-8fa1-4724-a466-80c3820c1279", "ref_id": "xccdf_org.ssgproject.content_profile_4912a087debf2f56674a15ad9b1c9fe8", "title": "Aliquid quisquam ut in.", "description": "Ut ad minima. Enim voluptates optio. Aperiam mollitia id.", "value_overrides": {}, "type": "profile" }, { "id": "5995d4f1-052b-45f7-9ed5-03acc3c94a89", "ref_id": "xccdf_org.ssgproject.content_profile_ed245fb9ebae710320af30f3f263f94d", "title": "Animi omnis molestiae dolores.", "description": "Enim nemo dolores. Aliquam quaerat dignissimos. Quos ea fugiat.", "value_overrides": {}, "type": "profile" }, { "id": "96e7abba-7fd8-43b2-bb3b-e9445e07b28b", "ref_id": "xccdf_org.ssgproject.content_profile_8263349ba6ae24f2a6de63c75d36baf5", "title": "Aut ut aspernatur nemo.", "description": "Provident error aut. Quam voluptatem neque. Neque ducimus dolor.", "value_overrides": {}, "type": "profile" }, { "id": "771216aa-7aa1-4b54-8689-8052084d226f", "ref_id": "xccdf_org.ssgproject.content_profile_563eacbcbd97cd364b50e9a176f2bcc1", "title": "Blanditiis ipsam molestiae quidem.", "description": "Enim nemo eum. Atque illum vitae. Sit assumenda minus.", "value_overrides": {}, "type": "profile" }, { "id": "65238cdc-1b71-4ce7-9617-8b44659e55c1", "ref_id": "xccdf_org.ssgproject.content_profile_149299735be04c9ecc45d3993fa909a8", "title": "Dignissimos quia quidem ipsam.", "description": "Perferendis repellat nihil. Laudantium suscipit alias. Deserunt ut ut.", "value_overrides": {}, "type": "profile" }, { "id": "3a69f01d-d25d-4216-89f5-222bf377bcb7", "ref_id": "xccdf_org.ssgproject.content_profile_d6d83c7137258c91a7bf9dbdf8f00e6f", "title": "Distinctio sit sunt quaerat.", "description": "Magnam velit et. Debitis exercitationem soluta. Itaque debitis ducimus.", "value_overrides": {}, "type": "profile" }, { "id": "bb382e31-e998-45a8-8be2-68a2fc233f9b", "ref_id": "xccdf_org.ssgproject.content_profile_692542bc3ba54fc37ebc0c288e68e8ec", "title": "Dolores assumenda animi omnis.", "description": "Molestias culpa in. Porro et quia. Quam sequi occaecati.", "value_overrides": {}, "type": "profile" }, { "id": "389d4d53-7842-480c-8216-dd560cd170d3", "ref_id": "xccdf_org.ssgproject.content_profile_35584f020de1f8070daea8b59c09c4ee", "title": "Ea assumenda et omnis.", "description": "Ex eum debitis. Maiores ut tempore. Esse officiis suscipit.", "value_overrides": {}, "type": "profile" }, { "id": "b7a8dd90-3c5f-4868-879e-f725416e9637", "ref_id": "xccdf_org.ssgproject.content_profile_7257f624790936bb870438ab21adaf20", "title": "Earum ut non et.", "description": "Deleniti aliquid at. Eligendi ipsum necessitatibus. Delectus et ad.", "value_overrides": {}, "type": "profile" }, { "id": "7b48429e-3c1c-4079-9022-98ce8bfacdfb", "ref_id": "xccdf_org.ssgproject.content_profile_a3a6fd43444e8bc0aaaa3491c6baf67e", "title": "Et qui qui natus.", "description": "Consequatur earum consequuntur. A eos velit. Adipisci consequatur nostrum.", "value_overrides": {}, "type": "profile" } ], "meta": { "total": 25, "limit": 10, "offset": 0, "sort_by": "title" }, "links": { "first": "/api/compliance/v2/security_guides/d376b00a-7bdf-4a47-adc7-005633d94d2e/profiles?limit=10&offset=0&sort_by=title", "last": "/api/compliance/v2/security_guides/d376b00a-7bdf-4a47-adc7-005633d94d2e/profiles?limit=10&offset=20&sort_by=title", "next": "/api/compliance/v2/security_guides/d376b00a-7bdf-4a47-adc7-005633d94d2e/profiles?limit=10&offset=10&sort_by=title" } }, "summary": "", "description": "" }, "List of Profiles filtered by '(title=Voluptates corporis soluta quo.)'": { "value": { "data": [ { "id": "070c60e6-847c-4788-935a-769e4701f548", "ref_id": "xccdf_org.ssgproject.content_profile_e7f84c1951a5107f5383618c4c314d2f", "title": "Voluptates corporis soluta quo.", "description": "Aliquid minima voluptatem. Eum est fuga. Maxime et aliquid.", "value_overrides": {}, "type": "profile" } ], "meta": { "total": 1, "filter": "(title=\"Voluptates corporis soluta quo.\")", "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/security_guides/d74924e0-2048-4f99-aed7-712db8ed7fb7/profiles?filter=%28title%3D%22Voluptates+corporis+soluta+quo.%22%29&limit=10&offset=0", "last": "/api/compliance/v2/security_guides/d74924e0-2048-4f99-aed7-712db8ed7fb7/profiles?filter=%28title%3D%22Voluptates+corporis+soluta+quo.%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": "122538af-96d9-4e29-93eb-6a0f987535f0", "ref_id": "xccdf_org.ssgproject.content_profile_2b15d0dd2c3657415c5bc35bd906bba5", "title": "Aut autem qui molestiae.", "description": "Repudiandae expedita aut. Maiores autem ratione. Vitae ipsam 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 d9974252-35ae-4a19-b5b1-02cfa930950f" ] }, "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": "4f2742a4-21c8-4802-9070-677267d089a0", "type": "rule_group", "children": [ { "id": "362fdc78-bf18-4cd0-8e17-e0d3ed9dadf9", "type": "rule" } ] }, { "id": "722868cc-b215-43f3-825e-b1afea4fb686", "type": "rule_group", "children": [ { "id": "3accb4b8-0802-498b-8830-df6819ddd753", "type": "rule" } ] }, { "id": "0c85372a-26dc-4839-b165-b34f6b63afce", "type": "rule_group", "children": [ { "id": "e164946c-cd14-4c0d-9398-3bc04b87c986", "type": "rule" } ] }, { "id": "110074dc-f557-4495-84f2-0f823d21dd5f", "type": "rule_group", "children": [ { "id": "28af52d9-eb1c-499e-ade2-0d45e305e40a", "type": "rule" } ] }, { "id": "9e94d5ee-c2c1-421f-a6bb-3023cbda0d28", "type": "rule_group", "children": [ { "id": "f5acbcec-4f3a-40ad-a9f2-5baf2f7244e8", "type": "rule" } ] }, { "id": "1df84d9a-c5b5-4d51-93d1-2deb17f82a98", "type": "rule_group", "children": [ { "id": "d39d2614-4153-4416-9e86-24267751f2e4", "type": "rule" } ] }, { "id": "bc89c44a-be59-4e65-813b-d5c5e6ed6de0", "type": "rule_group", "children": [ { "id": "982405f3-b324-44da-962d-4d50b7b19b7d", "type": "rule" } ] }, { "id": "5f9d49fd-bf78-4680-925a-d8813706890d", "type": "rule_group", "children": [ { "id": "7a5ef937-33c5-4ed9-a00e-916c74eb0124", "type": "rule" } ] }, { "id": "6b10f416-b378-43af-ab0d-e3fa7ee3b210", "type": "rule_group", "children": [ { "id": "18296152-da13-4fa1-9e6c-46bb0ee651db", "type": "rule" } ] }, { "id": "726d7730-4f23-4c17-aad9-334fcd2d4222", "type": "rule_group", "children": [ { "id": "be498731-0ebf-4ca6-930d-48937a2cde37", "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 071e763e-f8c2-4e72-895b-464caeee3117" ] }, "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": "5d9b991a-25c6-44ba-b2f5-ab38beb5a71d", "title": "Voluptas ullam autem enim.", "description": "Rem esse facere. Placeat voluptatem dignissimos. Excepturi maiores inventore.", "business_objective": "bus", "compliance_threshold": 90.0, "type": "report", "os_major_version": 8, "profile_title": "Numquam eos ut eligendi.", "ref_id": "xccdf_org.ssgproject.content_profile_bf9ea1d9c302d2c0c5046f3614d0cae9", "all_systems_exposed": true, "percent_compliant": 25, "assigned_system_count": 4, "compliant_system_count": 1, "unsupported_system_count": 2, "reported_system_count": 4 }, { "id": "5df7cfb6-5944-4de9-927a-70a8ddb3ca8d", "title": "Alias quisquam quia ea.", "description": "Quasi similique numquam. Soluta nulla libero. Aut animi eligendi.", "business_objective": "monitor", "compliance_threshold": 90.0, "type": "report", "os_major_version": 8, "profile_title": "Debitis quae ut necessitatibus.", "ref_id": "xccdf_org.ssgproject.content_profile_a2e3078148410d4a27a79a3da2a0bdd8", "all_systems_exposed": true, "percent_compliant": 25, "assigned_system_count": 4, "compliant_system_count": 1, "unsupported_system_count": 2, "reported_system_count": 4 }, { "id": "8b14d568-26e7-46db-a507-79b82f0f5e5f", "title": "Sint sed tempora vitae.", "description": "Odit laborum eaque. Sunt et veritatis. Mollitia hic cum.", "business_objective": "panel", "compliance_threshold": 90.0, "type": "report", "os_major_version": 8, "profile_title": "Quis in error consequatur.", "ref_id": "xccdf_org.ssgproject.content_profile_0f6c6af82b22dc74db630c262ff56071", "all_systems_exposed": true, "percent_compliant": 25, "assigned_system_count": 4, "compliant_system_count": 1, "unsupported_system_count": 2, "reported_system_count": 4 }, { "id": "8e45f5f4-68d6-42e1-8078-6ee34e66be30", "title": "Nam deleniti aspernatur quis.", "description": "Corporis omnis dolorum. Sed quo maxime. Nobis qui voluptates.", "business_objective": "port", "compliance_threshold": 90.0, "type": "report", "os_major_version": 8, "profile_title": "Nemo quia magni ad.", "ref_id": "xccdf_org.ssgproject.content_profile_22643e3f11aa1d14444fff6e470a9b19", "all_systems_exposed": true, "percent_compliant": 25, "assigned_system_count": 4, "compliant_system_count": 1, "unsupported_system_count": 2, "reported_system_count": 4 }, { "id": "f0cf8e2f-0e0e-45c8-b622-d5eab9dd669e", "title": "Modi libero harum illum.", "description": "Nemo voluptatum vel. Explicabo in id. Et vero aut.", "business_objective": "card", "compliance_threshold": 90.0, "type": "report", "os_major_version": 8, "profile_title": "Debitis est soluta consequatur.", "ref_id": "xccdf_org.ssgproject.content_profile_062e80211d5ffdf2693f77bdac1ecc55", "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": "4feb0f0e-f093-4d5b-8927-a7ea4e0f3aa0", "title": "Nemo quod repellendus explicabo.", "description": "Et accusantium et. Est repellendus ratione. In unde aut.", "business_objective": "transmitter", "compliance_threshold": 90.0, "type": "report", "os_major_version": 8, "profile_title": "Error tenetur excepturi cupiditate.", "ref_id": "xccdf_org.ssgproject.content_profile_25871e4537ce2c8b475c69118f80e2e0", "all_systems_exposed": true, "percent_compliant": 25, "assigned_system_count": 4, "compliant_system_count": 1, "unsupported_system_count": 2, "reported_system_count": 4 }, { "id": "9f124d21-1efc-443c-a860-f7cf4890a1fc", "title": "Quo sequi distinctio voluptatem.", "description": "Reiciendis omnis ducimus. Numquam eveniet occaecati. Voluptas quisquam velit.", "business_objective": "pixel", "compliance_threshold": 90.0, "type": "report", "os_major_version": 8, "profile_title": "Dolor amet recusandae adipisci.", "ref_id": "xccdf_org.ssgproject.content_profile_2cdaa157fe0f0b328c615aa50378b8dd", "all_systems_exposed": true, "percent_compliant": 25, "assigned_system_count": 4, "compliant_system_count": 1, "unsupported_system_count": 2, "reported_system_count": 4 }, { "id": "b41212fa-53d9-4b69-b63d-143114656b6e", "title": "Voluptate alias quam porro.", "description": "Doloremque et quia. Facere et occaecati. Sunt tenetur esse.", "business_objective": "hard drive", "compliance_threshold": 90.0, "type": "report", "os_major_version": 8, "profile_title": "Inventore nihil facilis debitis.", "ref_id": "xccdf_org.ssgproject.content_profile_ea45d3acd06e409de4b827f25a503f1b", "all_systems_exposed": true, "percent_compliant": 25, "assigned_system_count": 4, "compliant_system_count": 1, "unsupported_system_count": 2, "reported_system_count": 4 }, { "id": "c7f552e9-fb6c-40eb-9ff3-cc1ede70dd34", "title": "Aut facilis repellat quia.", "description": "Est animi minima. Consequatur blanditiis aut. Beatae et vero.", "business_objective": "capacitor", "compliance_threshold": 90.0, "type": "report", "os_major_version": 8, "profile_title": "Corporis et placeat quasi.", "ref_id": "xccdf_org.ssgproject.content_profile_48a70c88caee6a1c81564e23f857ac92", "all_systems_exposed": true, "percent_compliant": 25, "assigned_system_count": 4, "compliant_system_count": 1, "unsupported_system_count": 2, "reported_system_count": 4 }, { "id": "fd51e8a6-8ed7-4db1-b46f-f36010df3eb0", "title": "Occaecati qui officiis saepe.", "description": "Cumque sint reprehenderit. Earum et ex. Rem non velit.", "business_objective": "protocol", "compliance_threshold": 90.0, "type": "report", "os_major_version": 8, "profile_title": "Exercitationem illo est tempore.", "ref_id": "xccdf_org.ssgproject.content_profile_9454924d5b4a02098893d2f8506d269d", "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": "52da2f6f-2f81-4a50-9f9a-0de4ce58127a", "title": "Error excepturi est voluptatibus.", "description": "Incidunt maiores mollitia. Non velit totam. Tenetur sint eos.", "business_objective": "pixel", "compliance_threshold": 90.0, "type": "report", "os_major_version": 9, "profile_title": "Molestiae nesciunt dolores fugit.", "ref_id": "xccdf_org.ssgproject.content_profile_c98098558c117df3e171921bdd6887dc", "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 389fab5c-813d-4f95-8513-f86f6823c45d" ] }, "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": "d9a507c2-09b8-4fc0-9fda-7ea6156cc2a4", "title": "Repellat est reiciendis corporis.", "description": "Omnis sint qui. Aliquam repellat est. Occaecati est eaque.", "business_objective": "array", "compliance_threshold": 90.0, "type": "report", "os_major_version": 9, "profile_title": "Ut similique facere cupiditate.", "ref_id": "xccdf_org.ssgproject.content_profile_cdb9efa3105777c0eda11f4521861606", "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 2383bbd2-694f-4d7e-a57e-afff8f094fd0" ] }, "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": "1045540e-6c46-4b70-8ef2-0e43457eb7c8", "title": "Ad molestiae nihil saepe.", "description": "Rerum veniam voluptatem. Corporis ipsum enim. Minima magni magnam.", "business_objective": "card", "compliance_threshold": 90.0, "type": "report", "os_major_version": 8, "profile_title": "Iste est sint quam.", "ref_id": "xccdf_org.ssgproject.content_profile_4201c73cd85f16b064332e9cb5e51eac", "all_systems_exposed": false, "percent_compliant": 0, "compliant_system_count": 0, "unsupported_system_count": 0, "reported_system_count": 0 }, { "id": "2f165d0d-356d-4518-95fd-a8cd03339593", "title": "Laudantium ut quasi officiis.", "description": "Cupiditate et et. Atque consequatur doloribus. Delectus sit dolore.", "business_objective": "feed", "compliance_threshold": 90.0, "type": "report", "os_major_version": 8, "profile_title": "Enim molestiae suscipit expedita.", "ref_id": "xccdf_org.ssgproject.content_profile_d88a67bdccffbcebc1e6e21e46a4f226", "all_systems_exposed": false, "percent_compliant": 0, "compliant_system_count": 0, "unsupported_system_count": 0, "reported_system_count": 0 }, { "id": "49acfb05-3c0b-4b9b-a6ed-1f28bce50b9d", "title": "Eos temporibus et consectetur.", "description": "Vero natus qui. Porro sunt illum. Voluptas modi quia.", "business_objective": "hard drive", "compliance_threshold": 90.0, "type": "report", "os_major_version": 8, "profile_title": "Aut ut molestias et.", "ref_id": "xccdf_org.ssgproject.content_profile_6d096c2019e6275822ef2816ba4d3c22", "all_systems_exposed": false, "percent_compliant": 0, "compliant_system_count": 0, "unsupported_system_count": 0, "reported_system_count": 0 }, { "id": "b87ca013-80ca-46df-bb60-a3a69f540a33", "title": "Aut dolor consectetur sunt.", "description": "Dolores est voluptatum. Minus ipsa velit. Cumque rerum voluptate.", "business_objective": "driver", "compliance_threshold": 90.0, "type": "report", "os_major_version": 8, "profile_title": "Officiis enim praesentium sed.", "ref_id": "xccdf_org.ssgproject.content_profile_faf092eaf73f32312dcc58e8d7a6d7f1", "all_systems_exposed": false, "percent_compliant": 0, "compliant_system_count": 0, "unsupported_system_count": 0, "reported_system_count": 0 }, { "id": "d2debf24-a6eb-429a-8d96-a02dd6551520", "title": "Sit nobis earum aut.", "description": "Eligendi mollitia illum. Maiores aut debitis. Facere tempore ut.", "business_objective": "program", "compliance_threshold": 90.0, "type": "report", "os_major_version": 8, "profile_title": "Omnis nulla quod tenetur.", "ref_id": "xccdf_org.ssgproject.content_profile_e2b98652448b001f4e91443ca5fcc4fa", "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/0b67edf2-d8f5-496f-9fd2-12eb2e6be8a9/reports?limit=10&offset=0", "last": "/api/compliance/v2/systems/0b67edf2-d8f5-496f-9fd2-12eb2e6be8a9/reports?limit=10&offset=0" } }, "summary": "", "description": "" }, "List of Reports sorted by \"title:asc\"": { "value": { "data": [ { "id": "b1c5cd71-0a27-4f8a-bc4a-4ffde66fab4d", "title": "Aspernatur nisi libero adipisci.", "description": "Optio qui consequuntur. Debitis ex fugiat. Tempore molestiae et.", "business_objective": "transmitter", "compliance_threshold": 90.0, "type": "report", "os_major_version": 8, "profile_title": "Hic omnis in quas.", "ref_id": "xccdf_org.ssgproject.content_profile_a9bdd251a8ebc6cbe0dcb85d5f31948e", "all_systems_exposed": false, "percent_compliant": 0, "compliant_system_count": 0, "unsupported_system_count": 0, "reported_system_count": 0 }, { "id": "9940b4a6-533a-44c3-b93b-619205203eca", "title": "Culpa et facere minus.", "description": "Rem sint deleniti. Et itaque tenetur. Non rem ut.", "business_objective": "pixel", "compliance_threshold": 90.0, "type": "report", "os_major_version": 8, "profile_title": "Blanditiis soluta qui quam.", "ref_id": "xccdf_org.ssgproject.content_profile_9bd4519e9ee7957886ad76196a2a6729", "all_systems_exposed": false, "percent_compliant": 0, "compliant_system_count": 0, "unsupported_system_count": 0, "reported_system_count": 0 }, { "id": "ea29e699-7192-42a4-968b-f7b9c21ac5a8", "title": "Dolorem iste nulla officia.", "description": "Quibusdam nemo dolore. Et delectus quae. Excepturi odit blanditiis.", "business_objective": "firewall", "compliance_threshold": 90.0, "type": "report", "os_major_version": 8, "profile_title": "Dolores voluptas et inventore.", "ref_id": "xccdf_org.ssgproject.content_profile_7d8ffdd1ee0468f11fa8b0a6b9551b66", "all_systems_exposed": false, "percent_compliant": 0, "compliant_system_count": 0, "unsupported_system_count": 0, "reported_system_count": 0 }, { "id": "1474f93d-c000-4ac6-afbf-b1e36618eb41", "title": "Explicabo id unde omnis.", "description": "Aut molestiae incidunt. Aut qui numquam. Nesciunt ipsa dolorem.", "business_objective": "driver", "compliance_threshold": 90.0, "type": "report", "os_major_version": 8, "profile_title": "Odit quas doloribus omnis.", "ref_id": "xccdf_org.ssgproject.content_profile_cbfbb4677100e80f8afde92e022f8466", "all_systems_exposed": false, "percent_compliant": 0, "compliant_system_count": 0, "unsupported_system_count": 0, "reported_system_count": 0 }, { "id": "aac1d7cb-67f0-4e2a-871a-7f6fd24d71a7", "title": "Libero et consequatur et.", "description": "Dolorem ad voluptatem. Voluptatem itaque quo. Sit molestiae vitae.", "business_objective": "protocol", "compliance_threshold": 90.0, "type": "report", "os_major_version": 8, "profile_title": "Molestiae consequatur id aut.", "ref_id": "xccdf_org.ssgproject.content_profile_2edc6352f875fb708a83efea52403f67", "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/c11e5a81-e792-45dc-9d45-eb0796278fb2/reports?limit=10&offset=0&sort_by=title", "last": "/api/compliance/v2/systems/c11e5a81-e792-45dc-9d45-eb0796278fb2/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": "Rule Groups", "responses": { "200": { "description": "Lists Rule Groups", "content": { "application/vnd.api+json": { "examples": { "List of Rule Groups": { "value": { "data": [ { "id": "078ef155-6843-4256-a4e7-c6dd4aae3059", "ref_id": "xccdf_org.ssgproject.content_rule_group_83a98e4e596653d4536e33e41280a425", "title": "Dicta veniam dolor itaque.", "rationale": "Quas autem nihil. At rerum excepturi. Velit atque et.", "description": "Voluptas veniam tenetur. Ut et sapiente. Et aliquid et.", "precedence": null, "type": "rule_group" }, { "id": "208cc49a-b210-4bee-b85a-dffc79ca794e", "ref_id": "xccdf_org.ssgproject.content_rule_group_acdf81816a4240ffa409a7830e4d5f97", "title": "Exercitationem rerum quisquam quis.", "rationale": "Et ea distinctio. Quo est dolorum. Voluptas sit assumenda.", "description": "Dolores omnis consequatur. Iste provident ratione. Et dicta aut.", "precedence": null, "type": "rule_group" }, { "id": "2e52897b-8a7e-4c86-8722-e09190c4b8d8", "ref_id": "xccdf_org.ssgproject.content_rule_group_3c41faac6966ab204e3c5e42b234f6bd", "title": "Sed sequi dignissimos eum.", "rationale": "Sed veritatis error. Aut error optio. Quos nobis quisquam.", "description": "Error saepe nesciunt. Est esse et. Aut exercitationem ratione.", "precedence": null, "type": "rule_group" }, { "id": "425fad25-9a69-4cd9-8e39-72ee0ff252dd", "ref_id": "xccdf_org.ssgproject.content_rule_group_2c92b609a358ff15e4b1edfcfadbe22d", "title": "Qui est dolor cum.", "rationale": "Nihil explicabo laudantium. Mollitia repellat sunt. A aut libero.", "description": "Quia ullam assumenda. Atque et eligendi. Eos reiciendis esse.", "precedence": null, "type": "rule_group" }, { "id": "462928f6-28fe-4050-a75a-13044923b790", "ref_id": "xccdf_org.ssgproject.content_rule_group_3f0faeb00c96a234267237da265dab98", "title": "Illo nisi reprehenderit molestias.", "rationale": "Iste eligendi excepturi. Iusto distinctio aspernatur. Ut et consequatur.", "description": "Cupiditate et inventore. Nostrum sunt corrupti. Dolor adipisci dolorem.", "precedence": null, "type": "rule_group" }, { "id": "4c8c6028-ab9c-401d-9800-754d7e26cea3", "ref_id": "xccdf_org.ssgproject.content_rule_group_cd1e0490da35d0107af41ee37ab1d1ed", "title": "Nihil dolorum qui explicabo.", "rationale": "Soluta totam eos. Accusamus dignissimos occaecati. Unde odit est.", "description": "Ipsa modi occaecati. Dignissimos mollitia commodi. Veritatis provident iure.", "precedence": null, "type": "rule_group" }, { "id": "598803d3-2a01-4e28-b4b8-277960790213", "ref_id": "xccdf_org.ssgproject.content_rule_group_2033f094c9472d9fcebdaf6ff516a776", "title": "Repudiandae voluptas ex at.", "rationale": "Explicabo asperiores velit. Consequatur rerum repellat. Animi nihil ipsam.", "description": "Mollitia omnis laudantium. Aspernatur amet et. Fugiat dolorem molestias.", "precedence": null, "type": "rule_group" }, { "id": "5fad53f8-b0c5-441a-8b06-bd2eb2c85102", "ref_id": "xccdf_org.ssgproject.content_rule_group_299e76bb5596c7290e9f7dec8e7ccc0e", "title": "Tenetur accusamus error autem.", "rationale": "Sed mollitia suscipit. Praesentium architecto occaecati. Eius necessitatibus minus.", "description": "Est voluptatibus eaque. Quis enim omnis. Qui enim ut.", "precedence": null, "type": "rule_group" }, { "id": "84cc51e2-ae8c-4a9b-bf54-759f0a4cdbdd", "ref_id": "xccdf_org.ssgproject.content_rule_group_66da208d7411088dad9670ed0b5de186", "title": "Qui hic pariatur perspiciatis.", "rationale": "Unde consectetur rerum. Sit nam vel. Laudantium unde quam.", "description": "Sunt neque occaecati. Ut quod illum. Qui necessitatibus aut.", "precedence": null, "type": "rule_group" }, { "id": "8a8ec3ba-7f54-4868-bf92-db90ffc01d4e", "ref_id": "xccdf_org.ssgproject.content_rule_group_887b8a41a1171a24a60b6d38ebbfa1cc", "title": "Magni doloremque beatae nisi.", "rationale": "Corrupti aspernatur non. Necessitatibus omnis dolor. In voluptates velit.", "description": "Tempore velit incidunt. Dolore quisquam aut. Aperiam minus consectetur.", "precedence": null, "type": "rule_group" } ], "meta": { "total": 25, "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/security_guides/74aef497-7112-43b4-8cf1-5aba9b69292f/rule_groups?limit=10&offset=0", "last": "/api/compliance/v2/security_guides/74aef497-7112-43b4-8cf1-5aba9b69292f/rule_groups?limit=10&offset=20", "next": "/api/compliance/v2/security_guides/74aef497-7112-43b4-8cf1-5aba9b69292f/rule_groups?limit=10&offset=10" } }, "summary": "", "description": "" }, "List of Rule Groups sorted by \"precedence:asc\"": { "value": { "data": [ { "id": "0110d29a-069e-432e-b0bf-b229ae4e25b1", "ref_id": "xccdf_org.ssgproject.content_rule_group_8d04f32c96a0396de4683c1a0c2ef3e6", "title": "Neque in sunt quia.", "rationale": "Rem nostrum reiciendis. Cum rem qui. Esse autem occaecati.", "description": "Quis cum necessitatibus. Neque eos est. Voluptas sequi aspernatur.", "precedence": null, "type": "rule_group" }, { "id": "042329d6-ed03-4f24-b7ee-561e9b9d6826", "ref_id": "xccdf_org.ssgproject.content_rule_group_cf909dceb48ee572edff5acd535eefcf", "title": "Aliquid tempore id animi.", "rationale": "Accusantium laborum voluptas. Exercitationem est quasi. Itaque doloribus ullam.", "description": "Architecto beatae nobis. Enim quis ut. Aut sed aut.", "precedence": null, "type": "rule_group" }, { "id": "0c47410b-38f9-45d2-a5bf-0400d70d06d8", "ref_id": "xccdf_org.ssgproject.content_rule_group_aeae14ac6ba873afe3c5137cc81807e4", "title": "Qui quas harum earum.", "rationale": "Vitae eos ratione. Tempore ab ex. Dolore similique reprehenderit.", "description": "Commodi possimus vel. Accusamus fuga voluptatem. Magnam vel eveniet.", "precedence": null, "type": "rule_group" }, { "id": "11eda7af-2c97-45b1-9f04-4a381058e264", "ref_id": "xccdf_org.ssgproject.content_rule_group_2b86ba7d0a9e9c3a6181ca98cee2090b", "title": "Fuga dolores cupiditate quo.", "rationale": "Dolores nihil ea. Officiis neque voluptatem. Similique modi eum.", "description": "Molestiae sed nesciunt. Unde et temporibus. Qui consequatur laboriosam.", "precedence": null, "type": "rule_group" }, { "id": "14482e58-27ff-47aa-86bf-9c66fb69806e", "ref_id": "xccdf_org.ssgproject.content_rule_group_de07c90abbe998b92cb4fe3623c8401c", "title": "Velit porro et incidunt.", "rationale": "Aperiam sed rerum. Fugiat dolores totam. Et minima autem.", "description": "Nisi velit provident. Voluptatem ipsam ut. Quasi laudantium vero.", "precedence": null, "type": "rule_group" }, { "id": "3ebbd4dc-11c6-4d6f-a9ab-59de76af1274", "ref_id": "xccdf_org.ssgproject.content_rule_group_901b04677739d5b9ce926fe90a14c15c", "title": "Veritatis quis architecto unde.", "rationale": "Dolorem in eligendi. Aut enim deserunt. Magnam sit necessitatibus.", "description": "Aliquam nemo molestias. Quod consequatur quasi. Corporis tempore dolor.", "precedence": null, "type": "rule_group" }, { "id": "40dd7b9c-1aa7-4eca-b708-df4523af3b0a", "ref_id": "xccdf_org.ssgproject.content_rule_group_b23dac92f5225e17d13787e6e66357e7", "title": "Nisi ullam omnis totam.", "rationale": "Itaque beatae voluptatibus. Dolore blanditiis unde. Est rerum at.", "description": "Non necessitatibus consequatur. Excepturi sequi dolorem. Quia ab est.", "precedence": null, "type": "rule_group" }, { "id": "48d6c641-5567-4948-92db-83c8fb6ef6c6", "ref_id": "xccdf_org.ssgproject.content_rule_group_fd019f22d521dfd9324e13bcdfe0072b", "title": "Aut deserunt placeat id.", "rationale": "Et voluptatem sed. Aut qui eos. Et voluptatem rem.", "description": "Ducimus a officiis. Cum minus quae. In natus ipsam.", "precedence": null, "type": "rule_group" }, { "id": "4d43801c-9277-41db-908f-e521f878081b", "ref_id": "xccdf_org.ssgproject.content_rule_group_0a936931819a923ae4bc8f4c6ba8232c", "title": "Accusamus esse omnis ea.", "rationale": "Sequi id sed. Itaque fugiat minima. Et et tenetur.", "description": "Deleniti tempora consequatur. Eius consequatur natus. At ea omnis.", "precedence": null, "type": "rule_group" }, { "id": "5066781f-75b1-40f1-bd6d-f5cc76e29a85", "ref_id": "xccdf_org.ssgproject.content_rule_group_6887cb166c7385f803e365f26b527e18", "title": "Aspernatur illum asperiores ut.", "rationale": "Aut similique omnis. Iure voluptas asperiores. Commodi omnis quidem.", "description": "Non aliquam architecto. Distinctio maxime ullam. Voluptatibus eum et.", "precedence": null, "type": "rule_group" } ], "meta": { "total": 25, "limit": 10, "offset": 0, "sort_by": "precedence" }, "links": { "first": "/api/compliance/v2/security_guides/45bf4927-78ac-42e5-bdc2-753b5f4f60ab/rule_groups?limit=10&offset=0&sort_by=precedence", "last": "/api/compliance/v2/security_guides/45bf4927-78ac-42e5-bdc2-753b5f4f60ab/rule_groups?limit=10&offset=20&sort_by=precedence", "next": "/api/compliance/v2/security_guides/45bf4927-78ac-42e5-bdc2-753b5f4f60ab/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": "a6658d06-d2b4-4b23-b257-f12355f6688c", "ref_id": "xccdf_org.ssgproject.content_rule_group_71922db513036645467d0b0c1585c111", "title": "Quia voluptatem repellat consectetur.", "rationale": "Inventore enim voluptas. Dignissimos et reprehenderit. Nemo voluptas maiores.", "description": "Aut dolores inventore. Enim tempora autem. Rerum odio nihil.", "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 847e156a-cfd7-4f6b-b91f-44f515661b8c" ] }, "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": [], "meta": { "total": 0, "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/reports/7a5013da-d4ee-49e0-9871-03e6158f3fc9/test_results/696754a8-10ae-4ac1-8e0e-8c4085b7027c/rule_results?limit=10&offset=0", "last": "/api/compliance/v2/reports/7a5013da-d4ee-49e0-9871-03e6158f3fc9/test_results/696754a8-10ae-4ac1-8e0e-8c4085b7027c/rule_results?limit=10&offset=0" } }, "summary": "", "description": "" }, "List of Rule Results sorted by \"result:asc\"": { "value": { "data": [], "meta": { "total": 0, "limit": 10, "offset": 0, "sort_by": "result" }, "links": { "first": "/api/compliance/v2/reports/808cc829-83bf-4b37-a4ce-49041f9043d6/test_results/71b6c0f3-0947-45f2-a903-439c2221868b/rule_results?limit=10&offset=0&sort_by=result", "last": "/api/compliance/v2/reports/808cc829-83bf-4b37-a4ce-49041f9043d6/test_results/71b6c0f3-0947-45f2-a903-439c2221868b/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/3b57140e-5a78-4b1e-bb87-b8ddeab39d73/test_results/814a0992-7185-49a3-abc8-e1de54d38f9e/rule_results?filter=%28title%3Dfoo%29&limit=10&offset=0", "last": "/api/compliance/v2/reports/3b57140e-5a78-4b1e-bb87-b8ddeab39d73/test_results/814a0992-7185-49a3-abc8-e1de54d38f9e/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": "0ccb1695-2aae-403b-9f4b-1af47246f707", "ref_id": "xccdf_org.ssgproject.content_rule_bf0e184f0269219e83eadd934ef14324", "title": "Sit provident sint quis.", "rationale": "Voluptatem illum unde. Rem nam repellendus. Vero occaecati aperiam.", "description": "Dolore iusto neque. Tenetur magnam facilis. Qui hic error.", "severity": "medium", "precedence": 3541, "identifier": { "href": "http://keeling.test/eloise", "label": "Uffo Boffin" }, "references": [ { "href": "http://gusikowski-vonrueden.example/lea.stark", "label": "Angrod" }, { "href": "http://mccullough-labadie.test/garry.bruen", "label": "Huan" }, { "href": "http://hartmann-corwin.test/franklyn", "label": "Aratan" }, { "href": "http://hickle-daniel.test/shelba", "label": "Togo Goodbody" }, { "href": "http://gorczany-ullrich.example/erasmo_wolff", "label": "Faramir Took" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "79a481a6-fcc3-4378-8ff5-86831ee3580e", "type": "rule" }, { "id": "11af15c7-bb6a-4f18-a493-fdfbd5a97ae7", "ref_id": "xccdf_org.ssgproject.content_rule_f95019aa8c71d7f1b9e2e30e3b2fce0a", "title": "Dolor ipsa sunt voluptates.", "rationale": "Nihil sunt non. Ab earum explicabo. Officiis eveniet id.", "description": "Magni accusamus odit. Eius voluptas quod. Ut voluptatum consequuntur.", "severity": "low", "precedence": 7915, "identifier": { "href": "http://schuster-spencer.test/maisha.kuvalis", "label": "Nurwë" }, "references": [ { "href": "http://lesch-cummings.test/clifford", "label": "Indis" }, { "href": "http://grimes-miller.test/leonida_christiansen", "label": "Harding of the Hill" }, { "href": "http://dach.test/adalberto", "label": "Valandur" }, { "href": "http://smith.example/dean_kuhlman", "label": "Hazad" }, { "href": "http://moen.example/arlette.harvey", "label": "Buffo Boffin" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "dc867ad7-026b-4ac7-bb18-f46362cb7f86", "type": "rule" }, { "id": "174d62cb-6472-42a5-9cff-7a9e45ae0c98", "ref_id": "xccdf_org.ssgproject.content_rule_3e318c7246858ea9d60162d4d4df2abf", "title": "Distinctio impedit et ut.", "rationale": "Dolor rerum voluptas. Qui in tempore. Rerum tempore autem.", "description": "Impedit iste pariatur. Accusantium sed et. Nesciunt molestiae et.", "severity": "high", "precedence": 5357, "identifier": { "href": "http://ondricka-hudson.example/adrian", "label": "Tar-Meneldur" }, "references": [ { "href": "http://stokes-roob.test/nanette", "label": "Calimmacil" }, { "href": "http://mann.example/carmen_reinger", "label": "Lothíriel" }, { "href": "http://lowe.example/jeannetta.zboncak", "label": "Elmo" }, { "href": "http://bernier.test/bridget_okuneva", "label": "Araglas" }, { "href": "http://wilkinson.example/luisa", "label": "Artamir" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "c2e61530-05f3-44c0-9e2e-dda25b483a55", "type": "rule" }, { "id": "186a512c-79de-4f3f-aecd-2a34e20a1876", "ref_id": "xccdf_org.ssgproject.content_rule_bde2089f5500e53c95bc98ee1a2b7e4d", "title": "Mollitia itaque quasi consequatur.", "rationale": "Iste expedita quia. Facere ut est. Illo quos nobis.", "description": "Tempore quidem eos. Facilis occaecati culpa. Quas vero sequi.", "severity": "high", "precedence": 5844, "identifier": { "href": "http://dickinson-jones.test/jina.boyer", "label": "Asphodel Brandybuck" }, "references": [ { "href": "http://pollich.example/malka", "label": "Ivorwen" }, { "href": "http://brakus.test/cristie", "label": "Arahad" }, { "href": "http://weimann-hand.test/lynwood.blanda", "label": "Otho Sackville-Baggins" }, { "href": "http://gibson.example/antoine", "label": "Gerda Boffin" }, { "href": "http://mills.test/wei", "label": "Núneth" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "c637cd63-8e28-47d6-94e0-b33346fd290e", "type": "rule" }, { "id": "1b0b6ae3-2b9d-49dc-8854-639dc5b22634", "ref_id": "xccdf_org.ssgproject.content_rule_0e889ecb697d2e5fdaef1c72cd5a7beb", "title": "Et eligendi autem quidem.", "rationale": "Autem dolore minus. Ut temporibus inventore. Aut aut esse.", "description": "Quos in libero. Aut reiciendis quibusdam. Pariatur quia et.", "severity": "high", "precedence": 4945, "identifier": { "href": "http://keeling.test/eddie", "label": "Robin Smallburrow" }, "references": [ { "href": "http://moen.example/andrea", "label": "Aranuir" }, { "href": "http://johns.example/maranda.mcdermott", "label": "Folco Burrowes" }, { "href": "http://auer.example/micheal", "label": "Salvia Brandybuck" }, { "href": "http://rohan.test/alton", "label": "Ragnir" }, { "href": "http://goldner-barton.test/chadwick_littel", "label": "Ondoher" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "7e898e11-e64c-4a6e-81ca-156370647f30", "type": "rule" }, { "id": "281d4c0a-b952-4e8d-ba9d-97f38f3ec57a", "ref_id": "xccdf_org.ssgproject.content_rule_2f4ddd3851e0c0440381f15d6f62dfc2", "title": "Dolore totam cupiditate sint.", "rationale": "Eligendi reiciendis eos. Ut assumenda ex. Est et repudiandae.", "description": "Temporibus magnam voluptatem. Aut eos aspernatur. Enim voluptates qui.", "severity": "medium", "precedence": 6682, "identifier": { "href": "http://howe.test/neely", "label": "Gwaihir" }, "references": [ { "href": "http://gislason.test/bettyann_bergnaum", "label": "Porto Baggins" }, { "href": "http://hahn-mueller.example/betsy", "label": "Maglor" }, { "href": "http://damore.example/stephan", "label": "Nora Bolger" }, { "href": "http://wehner.test/marybelle", "label": "Anborn" }, { "href": "http://kuphal.example/claud", "label": "Erkenbrand" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "58e34cab-14db-4944-b527-2b073a2e8906", "type": "rule" }, { "id": "29c80c2c-ffc4-4f98-aba2-797aae3db7a0", "ref_id": "xccdf_org.ssgproject.content_rule_d38236e85017d29a1b1af4688bdf8d5f", "title": "Asperiores dignissimos quis aspernatur.", "rationale": "Aut labore aut. Culpa repellat aliquid. Sed quo deserunt.", "description": "Aut voluptas vitae. Voluptas voluptatem harum. Repellendus molestiae et.", "severity": "high", "precedence": 582, "identifier": { "href": "http://boyle.test/morgan", "label": "Adelard Took" }, "references": [ { "href": "http://casper.test/salome", "label": "Polo Baggins" }, { "href": "http://powlowski.test/william_robel", "label": "Thorin" }, { "href": "http://ryan-treutel.example/bruce", "label": "Amrod" }, { "href": "http://marquardt.example/vanna", "label": "Caranthir" }, { "href": "http://reynolds.example/milo", "label": "Calimehtar" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "2cbdec98-6930-4d7d-8406-e0731850b86c", "type": "rule" }, { "id": "3e75dc18-03cb-4304-9dea-c9af7b013b38", "ref_id": "xccdf_org.ssgproject.content_rule_bc4e777bff480f656a9ca0f8e8a01e77", "title": "Officiis eveniet eum cupiditate.", "rationale": "Tenetur natus similique. Ut corrupti et. Possimus quidem non.", "description": "Pariatur nulla dolores. Eos doloribus repellendus. Sit enim quidem.", "severity": "high", "precedence": 4174, "identifier": { "href": "http://kirlin-bruen.example/yolande", "label": "Erien" }, "references": [ { "href": "http://crooks-dooley.test/darnell", "label": "Ivorwen" }, { "href": "http://blanda.test/ema", "label": "Lúthien" }, { "href": "http://kuhn-wunsch.example/joe", "label": "Moro Burrows" }, { "href": "http://hettinger.test/rickey.weimann", "label": "Nori" }, { "href": "http://nienow.example/kenton", "label": "Ornil" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "78aaee66-0408-41cd-a12b-c29171cc346c", "type": "rule" }, { "id": "6b2a6b34-d246-4b82-bc8d-1361d17e19e8", "ref_id": "xccdf_org.ssgproject.content_rule_544db98aa1cb53756d0122c8fa37d717", "title": "Quia non ut doloremque.", "rationale": "Ea dolorum sunt. Ut in debitis. Officia iusto autem.", "description": "Sed optio illo. Consequatur sit rerum. Officiis quae nesciunt.", "severity": "high", "precedence": 3542, "identifier": { "href": "http://bogisich.example/nada_skiles", "label": "Amdír" }, "references": [ { "href": "http://ritchie.example/joseph", "label": "Mogru" }, { "href": "http://jenkins-monahan.example/elda", "label": "Adrahil" }, { "href": "http://quitzon-kreiger.example/jeremy", "label": "Estelmo" }, { "href": "http://graham.test/amber_schmidt", "label": "Otto Boffin" }, { "href": "http://maggio-gusikowski.example/lou_krajcik", "label": "Náin" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "6c9221d4-c0ac-4e22-9ba8-e1a5862c60d2", "type": "rule" }, { "id": "6f4e1876-896e-45d9-8d10-d1870cad27ce", "ref_id": "xccdf_org.ssgproject.content_rule_922b1b704fc84d74a50cdcd84ffcff06", "title": "Porro velit eveniet culpa.", "rationale": "Fugit in ut. Et quidem distinctio. Omnis necessitatibus commodi.", "description": "Esse nemo corrupti. Dignissimos ipsam asperiores. Sint cum maiores.", "severity": "medium", "precedence": 8229, "identifier": { "href": "http://hirthe.test/merilyn", "label": "Fastred" }, "references": [ { "href": "http://lemke.example/bob_schneider", "label": "Argeleb" }, { "href": "http://kohler.test/krysten", "label": "Valacar" }, { "href": "http://beahan.test/leta", "label": "Ban" }, { "href": "http://powlowski.example/jacquetta_corkery", "label": "Bilbo Gardner" }, { "href": "http://hagenes.test/jerilyn.marvin", "label": "Nimrodel" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "0d51ee35-7a54-4c8c-9cf0-0f8062e397f5", "type": "rule" } ], "meta": { "total": 25, "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/security_guides/292e1a0e-bf83-4c6f-9c6c-2757f345f1f0/rules?limit=10&offset=0", "last": "/api/compliance/v2/security_guides/292e1a0e-bf83-4c6f-9c6c-2757f345f1f0/rules?limit=10&offset=20", "next": "/api/compliance/v2/security_guides/292e1a0e-bf83-4c6f-9c6c-2757f345f1f0/rules?limit=10&offset=10" } }, "summary": "", "description": "" }, "List of Rules sorted by \"precedence:asc\"": { "value": { "data": [ { "id": "63aaa894-3a1d-4650-b127-5c33886a809f", "ref_id": "xccdf_org.ssgproject.content_rule_d3b01c1707e5a74167eaa9056ac90c1e", "title": "Repellendus ad quo et.", "rationale": "Asperiores ex sed. Et autem est. Sed nemo eum.", "description": "Omnis voluptatibus sint. Quia deserunt voluptatum. Rerum et earum.", "severity": "high", "precedence": 18, "identifier": { "href": "http://upton.example/quinton", "label": "Tar-Anárion" }, "references": [ { "href": "http://sauer.example/stephani.bergnaum", "label": "Flói" }, { "href": "http://ryan.example/moises", "label": "Duilin" }, { "href": "http://witting.test/trula_stamm", "label": "Bereg" }, { "href": "http://rohan-bartell.test/roland_reinger", "label": "Iago Grubb" }, { "href": "http://gutkowski-wiegand.test/somer_tromp", "label": "Gríma" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "5290606d-ec5c-48d8-b645-fdcafc6b9d25", "type": "rule" }, { "id": "31b6e1b5-5089-4a38-ad78-b3e4423563fc", "ref_id": "xccdf_org.ssgproject.content_rule_595502b985289467e83ef8e0a7fb9bd5", "title": "Molestias laborum accusamus dolorem.", "rationale": "Et alias sed. Voluptatem ipsa praesentium. Id possimus ea.", "description": "Est at harum. Et maxime fuga. Dolores rem magni.", "severity": "low", "precedence": 516, "identifier": { "href": "http://hagenes.test/aron", "label": "Eärendur" }, "references": [ { "href": "http://oreilly.test/magdalene", "label": "Saradoc Brandybuck" }, { "href": "http://robel.test/manuel", "label": "Amdír" }, { "href": "http://reinger-tremblay.test/hans", "label": "Déor" }, { "href": "http://labadie-kirlin.test/ileana", "label": "Bungo Baggins" }, { "href": "http://treutel-kassulke.example/jayson", "label": "Minardil" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "cc6768b0-b50e-444c-b105-e8117618ab9a", "type": "rule" }, { "id": "6104987b-16cb-462c-b993-8bcc76e523f0", "ref_id": "xccdf_org.ssgproject.content_rule_ed73427b0426bcbee8f6900d51cbf640", "title": "Sit aut commodi voluptatem.", "rationale": "Eaque delectus omnis. Modi eos enim. Aut et consequatur.", "description": "Quos reiciendis voluptatem. Beatae tempore sequi. Porro debitis asperiores.", "severity": "high", "precedence": 625, "identifier": { "href": "http://russel-durgan.test/arlena", "label": "Mrs. Bunce" }, "references": [ { "href": "http://shanahan-deckow.test/gregg", "label": "Rowan" }, { "href": "http://erdman.test/kirk", "label": "Dairuin" }, { "href": "http://mayer.test/shayla.harber", "label": "Théodwyn" }, { "href": "http://zulauf.example/elden", "label": "Landroval" }, { "href": "http://muller.test/janis.smith", "label": "Forthwini" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "f991d9d1-15fe-42b5-a71a-803dfba806f5", "type": "rule" }, { "id": "1fb16959-48f2-44e1-b4dd-f6a6ee45bf7f", "ref_id": "xccdf_org.ssgproject.content_rule_01f5a3b43b096c3434eea30c2b1c799b", "title": "Rerum aut quidem tempore.", "rationale": "Fugiat fugit facere. Maxime aliquam ex. Quasi quas provident.", "description": "Id delectus ipsam. Molestiae totam autem. Delectus doloribus est.", "severity": "high", "precedence": 1449, "identifier": { "href": "http://bosco-grimes.test/javier", "label": "Blodren" }, "references": [ { "href": "http://zboncak.example/vernita.lakin", "label": "Edrahil" }, { "href": "http://vandervort.test/laurence.tillman", "label": "Angrod" }, { "href": "http://mayer.example/roberto.dibbert", "label": "Eärwen" }, { "href": "http://gibson-bode.example/percy", "label": "Mirabella Took" }, { "href": "http://herman.test/rocky", "label": "Amlaith" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "b6c5e9a0-2730-4e64-b749-c6b59316bfa6", "type": "rule" }, { "id": "68147c11-9a5f-4d4b-b2ab-b237b3bed879", "ref_id": "xccdf_org.ssgproject.content_rule_3dc100c6ad680d4111c759b628c54a1a", "title": "Rerum qui quasi illo.", "rationale": "Autem sed eum. Rerum quia qui. Quisquam et est.", "description": "Laborum atque aspernatur. Consequatur et voluptas. Accusantium sit vitae.", "severity": "low", "precedence": 2259, "identifier": { "href": "http://kilback-brakus.example/gena_rau", "label": "Dís" }, "references": [ { "href": "http://paucek.test/abby_johnston", "label": "Hathaldir" }, { "href": "http://koelpin.test/hans.hintz", "label": "Leaflock" }, { "href": "http://rempel.example/ebony", "label": "Carl Cotton" }, { "href": "http://botsford.test/rocky.cummings", "label": "Grimbold" }, { "href": "http://gerhold.test/noble", "label": "Belba Baggins" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "6827c1fb-1af8-4c36-b8fd-e04a158bac1f", "type": "rule" }, { "id": "8c8a635b-1d8c-4383-84fe-59687cd77d74", "ref_id": "xccdf_org.ssgproject.content_rule_00bcdd56bbcb773212ce5c44c48bdec2", "title": "Cupiditate modi non ab.", "rationale": "Incidunt soluta et. Voluptas facere dolorem. Harum deserunt quod.", "description": "Tenetur qui eos. Reprehenderit dolorem esse. Minima sapiente et.", "severity": "high", "precedence": 2671, "identifier": { "href": "http://borer.test/milan.berge", "label": "Tosto Boffin" }, "references": [ { "href": "http://bartell.example/gary.hamill", "label": "Flambard Took" }, { "href": "http://brakus.test/cuc.prosacco", "label": "Dernhelm" }, { "href": "http://moen.example/damion.gleason", "label": "Hildibrand Took" }, { "href": "http://kerluke.example/nelle_kihn", "label": "Tar-Súrion" }, { "href": "http://gutkowski-jones.test/annika.abernathy", "label": "Ostoher" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "01baf9c9-6e2b-41d7-a93c-ffbd1e8ac0e3", "type": "rule" }, { "id": "44a4391e-81ba-47b1-a815-0c6dc1943666", "ref_id": "xccdf_org.ssgproject.content_rule_61a32e2abe2cb2846fbccda0ce92fbd1", "title": "Quia dolor veniam quo.", "rationale": "Eos excepturi cupiditate. Voluptatibus eos non. Fugit debitis molestias.", "description": "At magnam nisi. Natus suscipit culpa. Repudiandae eum explicabo.", "severity": "low", "precedence": 2928, "identifier": { "href": "http://parker.test/guadalupe_mertz", "label": "Beregar" }, "references": [ { "href": "http://berge-hickle.example/kaley_oreilly", "label": "Mrs. Bunce" }, { "href": "http://wunsch.example/denise.johns", "label": "Gorbadoc Brandybuck" }, { "href": "http://schroeder-lynch.test/rupert", "label": "Farmer Cotton" }, { "href": "http://steuber-glover.test/tammie", "label": "Angrim" }, { "href": "http://okeefe-bode.test/branden", "label": "Camellia Sackville" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "68650a94-c1c3-4b27-9324-e17709bef454", "type": "rule" }, { "id": "593e9eb1-4266-41ad-9e3f-b98c3a98ad34", "ref_id": "xccdf_org.ssgproject.content_rule_2b77d99596ea1d83775f5ca9b873918a", "title": "Consequatur asperiores quas dolor.", "rationale": "Qui enim quos. Ea distinctio voluptatem. Dolor non modi.", "description": "Earum libero corporis. Inventore reiciendis culpa. Porro et eum.", "severity": "high", "precedence": 2996, "identifier": { "href": "http://connelly-beahan.example/lanita.simonis", "label": "Ivriniel" }, "references": [ { "href": "http://denesik.example/rhett", "label": "Elemmírë" }, { "href": "http://walter-torphy.example/rudolph.hessel", "label": "Bór" }, { "href": "http://schroeder.example/warren_gorczany", "label": "Théodred" }, { "href": "http://heller.test/casey", "label": "Lindissë" }, { "href": "http://baumbach-dietrich.test/corrin", "label": "Anairë" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "62d97dd8-ce8a-438b-a6f4-2a37dbacb967", "type": "rule" }, { "id": "33faa775-859f-4d70-9cff-214ddf2becc2", "ref_id": "xccdf_org.ssgproject.content_rule_2b37c1aa9cb85d1fab3ec8875b2a0858", "title": "Et laborum perspiciatis nesciunt.", "rationale": "Quae ad aperiam. Nihil molestiae doloremque. Sunt voluptatum alias.", "description": "Ipsum occaecati hic. Qui non magnam. Doloremque laudantium incidunt.", "severity": "high", "precedence": 3724, "identifier": { "href": "http://cormier.example/mercy", "label": "Valacar" }, "references": [ { "href": "http://daugherty.test/gino", "label": "Shelob" }, { "href": "http://pfeffer.example/edmundo.damore", "label": "Uffo Boffin" }, { "href": "http://windler.example/ramiro", "label": "Pansy Baggins" }, { "href": "http://upton-reynolds.example/zackary", "label": "Tata" }, { "href": "http://weissnat.test/dalene", "label": "Ciryon" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "0202e057-0873-487d-8aac-297faa88965b", "type": "rule" }, { "id": "7f414ff6-3721-400a-b383-7dd3d8a8659e", "ref_id": "xccdf_org.ssgproject.content_rule_ed88aa237278422787d2c142618a73f9", "title": "Deserunt nostrum incidunt nemo.", "rationale": "Occaecati velit corrupti. Iure aut qui. Quibusdam omnis minus.", "description": "At ut unde. Aut quia nostrum. Voluptates quod odit.", "severity": "low", "precedence": 3739, "identifier": { "href": "http://shanahan.example/jay", "label": "Pansy Baggins" }, "references": [ { "href": "http://marvin.test/maia", "label": "Belen" }, { "href": "http://runolfsson-blanda.test/arlene", "label": "Goldberry" }, { "href": "http://cruickshank.test/isaac_emmerich", "label": "Malantur" }, { "href": "http://green.example/oscar_langworth", "label": "Ungoliant" }, { "href": "http://mills-hane.example/ralph", "label": "Khamûl" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "8e9ac00f-26b5-4e9b-a9d6-29041a3f7ad4", "type": "rule" } ], "meta": { "total": 25, "limit": 10, "offset": 0, "sort_by": "precedence" }, "links": { "first": "/api/compliance/v2/security_guides/fcf01d0c-e1a1-4b2d-a952-b4c50e1b1e15/rules?limit=10&offset=0&sort_by=precedence", "last": "/api/compliance/v2/security_guides/fcf01d0c-e1a1-4b2d-a952-b4c50e1b1e15/rules?limit=10&offset=20&sort_by=precedence", "next": "/api/compliance/v2/security_guides/fcf01d0c-e1a1-4b2d-a952-b4c50e1b1e15/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": "08b54df0-c55f-4ed2-acea-dc9ac2d99d67", "ref_id": "xccdf_org.ssgproject.content_rule_a6559cc6f6f67536dc33e105fa1d2ae8", "title": "Ut nobis aut cupiditate.", "rationale": "Libero aut autem. Saepe eius dolorum. Dolores cupiditate sed.", "description": "Totam delectus aut. Et ab inventore. Omnis optio delectus.", "severity": "medium", "precedence": 5750, "identifier": { "href": "http://lemke-ernser.test/mammie", "label": "Elrond" }, "references": [ { "href": "http://huel-reynolds.example/selma", "label": "Bard" }, { "href": "http://cormier-heidenreich.example/jimmie", "label": "Larnach" }, { "href": "http://weissnat-jenkins.example/rigoberto", "label": "Almarian" }, { "href": "http://hane.example/natosha", "label": "Aratan" }, { "href": "http://ryan.test/reda_anderson", "label": "Dinodas Brandybuck" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "b2f2fc76-677c-4726-b5bb-410ad7ce8071", "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 73245bc0-5bd6-49e2-a40a-0025dcafa74d" ] }, "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": "006cffc7-6ac9-4668-88ff-a952db0d1c6d", "ref_id": "xccdf_org.ssgproject.content_rule_3418846fa3da94c8332ccc1f6422c6f3", "title": "Porro nihil dolores voluptatum.", "rationale": "Quia debitis odio. Nulla assumenda sunt. Minus repellendus et.", "description": "Et blanditiis eveniet. Officiis ea quam. Quia numquam sequi.", "severity": "low", "precedence": 6763, "identifier": { "href": "http://thiel.example/ruben", "label": "Willie Banks" }, "references": [ { "href": "http://spinka.test/jarrod", "label": "Old Noakes" }, { "href": "http://dickinson.test/janette", "label": "Soronto" }, { "href": "http://zulauf.test/vance.douglas", "label": "Ulfast" }, { "href": "http://cummings.example/maxwell.stroman", "label": "Ardamir" }, { "href": "http://tremblay-bergnaum.test/marvel.durgan", "label": "Ingold" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "62b05a6e-c14f-4859-93e8-b33b85e91aac", "type": "rule", "remediation_issue_id": null }, { "id": "0521fe25-57c1-41c1-b71f-b688c2579db3", "ref_id": "xccdf_org.ssgproject.content_rule_3d155fa5ede4d57f23f9f6ece09df054", "title": "Voluptates temporibus est in.", "rationale": "Quo cupiditate facilis. Voluptate nulla et. Illum aut eum.", "description": "Non sunt amet. Omnis doloribus numquam. Temporibus facere ipsam.", "severity": "low", "precedence": 2403, "identifier": { "href": "http://morissette.example/brett", "label": "Celebrían" }, "references": [ { "href": "http://nikolaus-kub.example/casie_rau", "label": "Angelimir" }, { "href": "http://hane-dare.test/gregorio_ward", "label": "Belba Baggins" }, { "href": "http://waters-doyle.example/arnold_walsh", "label": "Posco Baggins" }, { "href": "http://padberg.test/micheal.ankunding", "label": "Léod" }, { "href": "http://hirthe-quigley.example/eugene", "label": "Malva Headstrong" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "7414f2df-291f-4cda-b8ff-66146b7cb83c", "type": "rule", "remediation_issue_id": null }, { "id": "14fff630-b579-42ee-ba49-20cb437c88cf", "ref_id": "xccdf_org.ssgproject.content_rule_95ae8cfe8099c3630ef929b717f9d849", "title": "Hic officia qui dicta.", "rationale": "Ut veniam sed. Vel maiores laudantium. Velit dolor dolorum.", "description": "Voluptatem dolorem consequatur. Reiciendis sequi tempora. Fugiat impedit atque.", "severity": "low", "precedence": 3594, "identifier": { "href": "http://kuhn.example/vanesa", "label": "Khîm" }, "references": [ { "href": "http://hoppe.test/lavon", "label": "Gelmir" }, { "href": "http://gutkowski.test/lynda.lind", "label": "Rúmil" }, { "href": "http://treutel-bradtke.test/marion_carter", "label": "Oropher" }, { "href": "http://leffler-bode.test/paul", "label": "Rowan" }, { "href": "http://dooley.example/tennie.lynch", "label": "Valandil" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "fac5a5f2-ab27-4b53-99a1-88ed1229780f", "type": "rule", "remediation_issue_id": null }, { "id": "1517b56a-611e-46e5-8aed-780d42c583cd", "ref_id": "xccdf_org.ssgproject.content_rule_494a23471d3b7c69fd4ca9e82f65e23f", "title": "Numquam vero illum odit.", "rationale": "Omnis omnis dignissimos. Numquam minus impedit. Dolores magnam aut.", "description": "Autem molestias perspiciatis. Sint provident officiis. Corrupti nihil vitae.", "severity": "medium", "precedence": 3145, "identifier": { "href": "http://bogisich-beahan.test/alden", "label": "Bungo Baggins" }, "references": [ { "href": "http://christiansen.example/carmelo", "label": "Telumehtar Umbardacil" }, { "href": "http://schumm-mann.test/alita_denesik", "label": "Orgulas Brandybuck" }, { "href": "http://denesik-heller.test/mazie_hodkiewicz", "label": "Elendur" }, { "href": "http://mosciski.test/marcel", "label": "Freca" }, { "href": "http://zemlak-rippin.example/savanna.luettgen", "label": "Imin" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "2e528b02-9205-4266-9ed9-09dea61e1cc1", "type": "rule", "remediation_issue_id": null }, { "id": "17f5f188-82f8-4c74-a42c-b85f82f8e5e9", "ref_id": "xccdf_org.ssgproject.content_rule_56230486fd0e5782a9da3b65f409bd0d", "title": "Ut cupiditate reiciendis porro.", "rationale": "Atque nostrum saepe. Quia ut numquam. Dolores deleniti tempore.", "description": "Unde perspiciatis molestiae. Veritatis vel qui. Sunt voluptates sed.", "severity": "high", "precedence": 3586, "identifier": { "href": "http://ondricka.example/alphonse_haag", "label": "Dírhaval" }, "references": [ { "href": "http://fritsch.example/colin", "label": "Borlas" }, { "href": "http://kessler.example/willow.herman", "label": "Poldor" }, { "href": "http://bayer-casper.test/kristopher", "label": "Bodruith" }, { "href": "http://cruickshank-wehner.example/cari", "label": "Olo Proudfoot" }, { "href": "http://harber.test/dewayne_mcdermott", "label": "Ardamir" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "d7392c08-21de-45d9-a2da-ad1b0a1fe24c", "type": "rule", "remediation_issue_id": null }, { "id": "31ce0475-f128-4723-8f22-7221ddc24ae7", "ref_id": "xccdf_org.ssgproject.content_rule_28bd29ba44a9f30853bfde40c92c8b4a", "title": "Nisi provident minus voluptatibus.", "rationale": "Velit quisquam aperiam. Quam dicta et. Et officiis sit.", "description": "Tenetur aut repudiandae. Quo architecto est. Magni repudiandae eligendi.", "severity": "medium", "precedence": 1504, "identifier": { "href": "http://gulgowski.test/otha.gleichner", "label": "Gwaihir" }, "references": [ { "href": "http://mccullough-rice.example/dorethea.bradtke", "label": "Imin" }, { "href": "http://braun-ward.example/earl", "label": "Enerdhil" }, { "href": "http://nitzsche-bosco.example/chae.ledner", "label": "Cora Goodbody" }, { "href": "http://vandervort.test/hipolito.smitham", "label": "Vidugavia" }, { "href": "http://jacobson.test/xavier", "label": "Marhwini" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "dca87a6c-a4cb-4883-9ca6-a45dee2b3dcc", "type": "rule", "remediation_issue_id": null }, { "id": "4a53e165-1960-4972-95a0-fb3dc072449d", "ref_id": "xccdf_org.ssgproject.content_rule_29672637868cf8c6bedf82830a746a95", "title": "Totam quo ducimus autem.", "rationale": "Consequatur aut quos. Sed cumque rerum. Ut dolorem quaerat.", "description": "Eum tempora non. Et voluptates vel. Maiores quia sint.", "severity": "low", "precedence": 1835, "identifier": { "href": "http://hodkiewicz-cronin.test/alfredo", "label": "Nina Lightfoot" }, "references": [ { "href": "http://ohara.test/meghan_stehr", "label": "Bell Goodchild" }, { "href": "http://smitham.test/guillermo_jacobi", "label": "Eärnil" }, { "href": "http://upton.test/kathryne", "label": "Bandobras Took" }, { "href": "http://bartell.test/stephan_yost", "label": "Aravir" }, { "href": "http://schoen.test/deandre_hoppe", "label": "Glaurung" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "c519a6d1-75b7-4418-9590-38ab472edb5e", "type": "rule", "remediation_issue_id": null }, { "id": "4a612d49-7fa3-4258-b612-999a7a783282", "ref_id": "xccdf_org.ssgproject.content_rule_2e14b83cd143baf955adee522813bf30", "title": "Est voluptatem et ut.", "rationale": "Quidem ut omnis. Hic exercitationem dolore. Impedit quasi hic.", "description": "Dolorem ipsum totam. Corporis saepe eum. Voluptas aspernatur dolore.", "severity": "medium", "precedence": 1774, "identifier": { "href": "http://bosco.example/gavin", "label": "Glirhuin" }, "references": [ { "href": "http://pagac.test/junior", "label": "Forhend" }, { "href": "http://brakus-bayer.example/oscar_kulas", "label": "Orchaldor" }, { "href": "http://goldner.example/roger", "label": "Ostoher" }, { "href": "http://marquardt.test/brunilda", "label": "Yávien" }, { "href": "http://schimmel.example/hassie", "label": "Erestor" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "05c484a5-02f3-46a6-95b5-7a11e37cfcb7", "type": "rule", "remediation_issue_id": null }, { "id": "59567a1d-09c2-439c-a3c5-1060a9a42b4f", "ref_id": "xccdf_org.ssgproject.content_rule_87725fe152a02e7d45c54b906e1a62a2", "title": "Totam cum sequi illo.", "rationale": "Magni blanditiis velit. Illum deleniti ut. Quasi dicta dolore.", "description": "Ut neque impedit. Eveniet perspiciatis quas. Ipsum molestias et.", "severity": "medium", "precedence": 8841, "identifier": { "href": "http://schinner-reilly.test/mary", "label": "Fundin" }, "references": [ { "href": "http://murazik-mraz.test/buck_graham", "label": "Landroval" }, { "href": "http://deckow-zemlak.example/coleman", "label": "Almiel" }, { "href": "http://zboncak.test/tommy_mcdermott", "label": "Enthor" }, { "href": "http://shields.test/devon", "label": "Marigold Gamgee" }, { "href": "http://brown-langworth.example/rosalinda", "label": "Iago Grubb" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "632f1140-7515-4041-8fb2-10b688be7eb2", "type": "rule", "remediation_issue_id": null }, { "id": "5ba80e1e-83f7-4176-b423-7fd8aa381925", "ref_id": "xccdf_org.ssgproject.content_rule_7c57b1333be32ef7f02fa773f2f5c6de", "title": "Veritatis accusantium quas voluptas.", "rationale": "Neque fugit nobis. Explicabo fugit minima. Aut voluptatem nam.", "description": "Et et officia. Porro tempore et. Quasi assumenda deleniti.", "severity": "medium", "precedence": 1002, "identifier": { "href": "http://corkery-rolfson.example/deedee.lockman", "label": "Théoden" }, "references": [ { "href": "http://parisian-cartwright.example/takisha_hermann", "label": "Saeros" }, { "href": "http://deckow.example/lisette_flatley", "label": "Castamir" }, { "href": "http://kessler.example/quintin", "label": "Aldor" }, { "href": "http://murray.example/jacob", "label": "Haldar" }, { "href": "http://rempel.example/emeline.kuvalis", "label": "Ferumbras Took" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "251da085-a0fa-4025-b38f-07b7785cd327", "type": "rule", "remediation_issue_id": null } ], "meta": { "total": 25, "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/security_guides/df3b3deb-e941-4e4e-b7c1-025b425dc103/profiles/0e796fbc-db37-4526-8752-f8846369e89d/rules?limit=10&offset=0", "last": "/api/compliance/v2/security_guides/df3b3deb-e941-4e4e-b7c1-025b425dc103/profiles/0e796fbc-db37-4526-8752-f8846369e89d/rules?limit=10&offset=20", "next": "/api/compliance/v2/security_guides/df3b3deb-e941-4e4e-b7c1-025b425dc103/profiles/0e796fbc-db37-4526-8752-f8846369e89d/rules?limit=10&offset=10" } }, "summary": "", "description": "" }, "List of Rules sorted by \"precedence:asc\"": { "value": { "data": [ { "id": "9ab0c01f-8562-4fe5-9933-77cd30cd7497", "ref_id": "xccdf_org.ssgproject.content_rule_f70a25ae275f3a465182589c4890a720", "title": "Deleniti eius quibusdam in.", "rationale": "Illo quos nostrum. Rerum veniam recusandae. Deleniti rerum pariatur.", "description": "Sed similique modi. Possimus aut ipsa. Nostrum quod est.", "severity": "low", "precedence": 21, "identifier": { "href": "http://schaden-buckridge.example/donte.hirthe", "label": "Gollum" }, "references": [ { "href": "http://schuster.test/kaley", "label": "Castamir" }, { "href": "http://mayert.test/walter", "label": "Ori" }, { "href": "http://gorczany-cruickshank.test/aurelia.heidenreich", "label": "Alphros" }, { "href": "http://dach-kub.example/nicholas", "label": "Durin" }, { "href": "http://maggio.test/devon.reichel", "label": "Arador" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "a981905c-9d04-4cad-b607-b6b7d1704412", "type": "rule", "remediation_issue_id": null }, { "id": "e4800f80-ef9e-4174-b327-457fe56df8c3", "ref_id": "xccdf_org.ssgproject.content_rule_cbcb5ab3495db2dc56a26cf5a9b524d8", "title": "Voluptatem deleniti quia omnis.", "rationale": "Magnam voluptas atque. Qui adipisci est. Eum omnis quasi.", "description": "Repellendus in aut. Rerum ut facilis. Quidem dolor placeat.", "severity": "medium", "precedence": 114, "identifier": { "href": "http://damore.test/neely", "label": "Finwë" }, "references": [ { "href": "http://moore.example/otis", "label": "Hob Gammidge" }, { "href": "http://hyatt-corkery.test/ashly", "label": "Olo Proudfoot" }, { "href": "http://gislason.example/leanne.keebler", "label": "Déor" }, { "href": "http://hickle.example/lorna_hahn", "label": "Gethron" }, { "href": "http://fadel-white.test/tyrone", "label": "Dúnhere" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "89f81e4f-7d45-4346-8c59-955b94aa4eb4", "type": "rule", "remediation_issue_id": null }, { "id": "df3ea966-0cc0-49c5-85f5-253c6c744503", "ref_id": "xccdf_org.ssgproject.content_rule_9c29df41e1b08833a60d9090fee25d8c", "title": "Similique asperiores accusantium alias.", "rationale": "Hic dolores architecto. Ut eligendi dolor. Est ut doloremque.", "description": "Vero consequatur ut. Sed adipisci blanditiis. Adipisci culpa quam.", "severity": "low", "precedence": 379, "identifier": { "href": "http://wolf-kerluke.test/debbra.corwin", "label": "Wiseman Gamwich" }, "references": [ { "href": "http://beer.example/ranee_vandervort", "label": "Finduilas" }, { "href": "http://rogahn.test/andrew.mccullough", "label": "Déorwine" }, { "href": "http://bayer.example/giuseppe", "label": "Radagast" }, { "href": "http://reynolds-sauer.example/sheryl_dickinson", "label": "Everard Took" }, { "href": "http://wolff-hand.test/iona", "label": "Borin" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "73eda76a-8a28-42df-b354-1d4d42b873ff", "type": "rule", "remediation_issue_id": null }, { "id": "e06fc5a8-731f-4ade-a2a6-7893305b87aa", "ref_id": "xccdf_org.ssgproject.content_rule_2edde6470a21f674924d299514fb9dfc", "title": "At dolorum commodi delectus.", "rationale": "Voluptatem sapiente doloremque. Maiores sunt voluptatem. Dolor quis recusandae.", "description": "Enim et animi. Molestias corporis consequuntur. Quas animi qui.", "severity": "medium", "precedence": 534, "identifier": { "href": "http://bednar-kuvalis.test/edmond_stark", "label": "Gundahad Bolger" }, "references": [ { "href": "http://langworth.test/cara", "label": "Ori" }, { "href": "http://reichert.test/brooks", "label": "Tolman Cotton Junior" }, { "href": "http://douglas.test/mitzi", "label": "Daddy Twofoot" }, { "href": "http://schroeder.test/trinidad", "label": "Angbor" }, { "href": "http://larson-mohr.example/stephan", "label": "Walda" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "c02e3aff-9007-4b74-9715-394898e478e0", "type": "rule", "remediation_issue_id": null }, { "id": "1e910adf-b1de-4c98-a3c7-2efbdb648597", "ref_id": "xccdf_org.ssgproject.content_rule_374a6cc59cc154b1d3c0b99f75d48449", "title": "Voluptas qui nostrum nihil.", "rationale": "Id omnis sunt. Quasi neque in. Ipsum assumenda ut.", "description": "Aut hic corrupti. Ut quam quaerat. Voluptatibus natus omnis.", "severity": "medium", "precedence": 865, "identifier": { "href": "http://schowalter.test/mickey", "label": "Manwendil" }, "references": [ { "href": "http://metz.example/iva.shanahan", "label": "Dori" }, { "href": "http://jenkins.test/corie", "label": "Agathor" }, { "href": "http://mueller.example/bong", "label": "Tata" }, { "href": "http://sipes.test/jesica_rogahn", "label": "Dudo Baggins" }, { "href": "http://kling-mccullough.example/hettie.schroeder", "label": "Arwen" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "5936b36b-6f52-4a41-b4b8-0c718e6a9ccf", "type": "rule", "remediation_issue_id": null }, { "id": "afa573ff-0ac7-440b-a413-a540af7696af", "ref_id": "xccdf_org.ssgproject.content_rule_0b85d182322ca249e33366facb10193c", "title": "Ab ut debitis vel.", "rationale": "Omnis dolores non. Ad enim occaecati. Mollitia eveniet voluptate.", "description": "Quas in rerum. Autem et ipsa. Aspernatur suscipit consequatur.", "severity": "low", "precedence": 1270, "identifier": { "href": "http://kuhic-bayer.test/adan", "label": "Fredegar Bolger" }, "references": [ { "href": "http://osinski.test/berry.senger", "label": "Pippin Gardner" }, { "href": "http://torphy.test/maurita.hodkiewicz", "label": "Îbal" }, { "href": "http://lowe-pfeffer.test/stefan.cruickshank", "label": "Borthand" }, { "href": "http://wintheiser-ritchie.test/adaline", "label": "Rómendacil" }, { "href": "http://kunze-waelchi.test/yolonda", "label": "Gorlim" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "5bb609ae-1ba8-4957-98ba-bf85a437c055", "type": "rule", "remediation_issue_id": null }, { "id": "7cc57b47-34b4-433b-8a31-4210eee70c87", "ref_id": "xccdf_org.ssgproject.content_rule_4ce5792861aa2214384377602159afd7", "title": "Aut molestias vel nihil.", "rationale": "Consequuntur laboriosam eos. Modi rem ut. Consequatur ratione sequi.", "description": "Magni dicta aut. Natus expedita et. Ad occaecati voluptatem.", "severity": "low", "precedence": 1443, "identifier": { "href": "http://doyle.example/michael_purdy", "label": "Tarannon Falastur" }, "references": [ { "href": "http://veum.test/isobel", "label": "Yávien" }, { "href": "http://hyatt.test/sergio", "label": "Farmer Maggot" }, { "href": "http://rau-kautzer.example/oren", "label": "Frerin" }, { "href": "http://bartoletti.example/kenny_bode", "label": "Brand" }, { "href": "http://grant-lindgren.test/forest_kunze", "label": "Rufus Burrows" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "57b93273-a01a-4243-9d7b-7a12ab0be0cd", "type": "rule", "remediation_issue_id": null }, { "id": "a8704d72-aae3-415b-99f7-b357270f68d5", "ref_id": "xccdf_org.ssgproject.content_rule_4c8fd20bc7ea5a9a12647bf74e9c3e91", "title": "Eum perferendis ut commodi.", "rationale": "Sint aliquid veniam. Cumque nisi facilis. Sit quo harum.", "description": "Hic aut explicabo. Et hic expedita. Non dolorum voluptatibus.", "severity": "high", "precedence": 1690, "identifier": { "href": "http://renner-kirlin.test/adella", "label": "Hannar" }, "references": [ { "href": "http://oconner-bednar.test/ernesto", "label": "Herubrand" }, { "href": "http://smith.test/kasey", "label": "Amlach" }, { "href": "http://parisian-schroeder.test/sherwood_cole", "label": "Elwing" }, { "href": "http://sipes-littel.example/ebony.blick", "label": "Anborn" }, { "href": "http://torphy-rau.test/daniella", "label": "Ragnor" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "7674ec94-a271-48c1-9f67-0f976ebc9b63", "type": "rule", "remediation_issue_id": null }, { "id": "76d06f75-69fd-451f-b4eb-8c9cb5989d68", "ref_id": "xccdf_org.ssgproject.content_rule_92c3362b0e1c028a86083fce73972cd8", "title": "Facilis accusantium sint harum.", "rationale": "In ut dignissimos. Sit veniam et. Et ut aut.", "description": "Sit minima tenetur. Iure dignissimos aspernatur. Animi ut dolore.", "severity": "high", "precedence": 2798, "identifier": { "href": "http://harvey-kohler.test/erika.hauck", "label": "Minardil" }, "references": [ { "href": "http://wuckert-stark.test/ehtel", "label": "Elemmírë" }, { "href": "http://mcglynn.example/abigail_kris", "label": "Forweg" }, { "href": "http://hessel-gulgowski.example/lucien", "label": "Tar-Vanimeldë" }, { "href": "http://stiedemann-ledner.example/lacresha_daniel", "label": "Hazad" }, { "href": "http://willms-kuhlman.example/glenna_lemke", "label": "Orchaldor" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "6a157b31-7789-4213-9a4f-5eaac83f2bf0", "type": "rule", "remediation_issue_id": null }, { "id": "4e5030df-d287-4188-b3ca-5f9a9316f08b", "ref_id": "xccdf_org.ssgproject.content_rule_339c9b3d182164160d21592590dfaa7c", "title": "Rerum est quae nisi.", "rationale": "Corrupti nisi minus. Qui laborum atque. Officiis velit nesciunt.", "description": "Qui quam aliquid. Qui doloremque est. In aut et.", "severity": "medium", "precedence": 3152, "identifier": { "href": "http://parisian.test/rhett", "label": "Eluréd" }, "references": [ { "href": "http://schultz-lebsack.example/allison.gottlieb", "label": "Merimac Brandybuck" }, { "href": "http://lubowitz.test/trisha.friesen", "label": "Ingwion" }, { "href": "http://abshire.test/margurite", "label": "Eilinel" }, { "href": "http://lang.example/desmond", "label": "Sapphira Brockhouse" }, { "href": "http://walker-macejkovic.test/rosalie", "label": "Beleg" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "021a9880-5c46-469f-8853-62ab5aec73da", "type": "rule", "remediation_issue_id": null } ], "meta": { "total": 25, "limit": 10, "offset": 0, "sort_by": "precedence" }, "links": { "first": "/api/compliance/v2/security_guides/930201f4-66ba-425c-b161-4a9bd171e70c/profiles/5840a5e9-06c2-4b49-a081-f554122896d5/rules?limit=10&offset=0&sort_by=precedence", "last": "/api/compliance/v2/security_guides/930201f4-66ba-425c-b161-4a9bd171e70c/profiles/5840a5e9-06c2-4b49-a081-f554122896d5/rules?limit=10&offset=20&sort_by=precedence", "next": "/api/compliance/v2/security_guides/930201f4-66ba-425c-b161-4a9bd171e70c/profiles/5840a5e9-06c2-4b49-a081-f554122896d5/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": "b23b367e-0d38-47cc-ae4e-3a012525d69c", "ref_id": "xccdf_org.ssgproject.content_rule_aec06cf7c8b739f8cc9c0af836408b9e", "title": "Explicabo distinctio veniam numquam.", "rationale": "Enim sed itaque. Beatae blanditiis rem. Expedita sint earum.", "description": "Tenetur itaque incidunt. Suscipit voluptatem eum. Enim saepe aut.", "severity": "high", "precedence": 227, "identifier": { "href": "http://johns.test/roy", "label": "Arahad" }, "references": [ { "href": "http://hartmann-rowe.example/josiah", "label": "Lily Baggins" }, { "href": "http://bradtke.test/talia", "label": "Malva Headstrong" }, { "href": "http://goldner-von.test/sanda_glover", "label": "Annael" }, { "href": "http://damore.test/harris_barrows", "label": "Idril" }, { "href": "http://purdy.test/romelia_morar", "label": "King of the Dead" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "db7d9cea-fe27-4f36-a07d-fd13f4fbfb01", "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 06f20a37-b83e-481a-81dc-f3c94dbc03dd" ] }, "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": "6b45bd23-7e9f-4ac0-bd8c-56ea81cb807f", "ref_id": "xccdf_org.ssgproject.content_rule_16b164eabba56ca201c00f81efef2369", "title": "Voluptates et itaque eius.", "rationale": "Totam iure culpa. Esse excepturi reiciendis. Quibusdam quo aut.", "description": "Ea ut eius. Voluptatem voluptatem optio. Sit perferendis in.", "severity": "medium", "precedence": 9343, "identifier": { "href": "http://lindgren-larkin.example/tiera.shields", "label": "Thengel" }, "references": [ { "href": "http://abbott.test/armand.lind", "label": "Porto Baggins" }, { "href": "http://mccullough-wiza.example/marilynn", "label": "Eärendur" }, { "href": "http://reilly.test/garfield", "label": "Ibun" }, { "href": "http://bernier.test/young", "label": "Aragost" }, { "href": "http://king.test/forest", "label": "Tarciryan" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "ada2b6d4-0c87-45da-8ab4-f31406c739a7", "type": "rule" } ], "meta": { "total": 1, "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/policies/ad4a5530-a11a-4116-9b7e-6f0284875722/tailorings/1a1d41bd-f7b3-4633-b82b-50d442d307de/rules?limit=10&offset=0", "last": "/api/compliance/v2/policies/ad4a5530-a11a-4116-9b7e-6f0284875722/tailorings/1a1d41bd-f7b3-4633-b82b-50d442d307de/rules?limit=10&offset=0" } }, "summary": "", "description": "" }, "List of Rules sorted by \"precedence:asc\"": { "value": { "data": [ { "id": "5a9ccc7b-0ed2-4dc9-9348-b868dee6ddfe", "ref_id": "xccdf_org.ssgproject.content_rule_78efc2269072e8d57d72679aebc708cc", "title": "Quasi aliquam sunt aut.", "rationale": "Porro culpa voluptas. Ut distinctio ea. Sint eius magni.", "description": "Ea molestiae amet. Sunt magnam eaque. Debitis temporibus et.", "severity": "high", "precedence": 2974, "identifier": { "href": "http://wiegand-huel.example/jaime_mraz", "label": "Amroth" }, "references": [ { "href": "http://labadie.example/gertha", "label": "Almarian" }, { "href": "http://franecki.test/marcelina_prosacco", "label": "Idis" }, { "href": "http://jones.example/monroe", "label": "Tobold Hornblower" }, { "href": "http://dietrich-keeling.test/florencio_zieme", "label": "Daisy Baggins" }, { "href": "http://marks.test/alberto", "label": "Legolas" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "15de67ac-48b8-48dd-a6d4-ac5a441675df", "type": "rule" } ], "meta": { "total": 1, "limit": 10, "offset": 0, "sort_by": "precedence" }, "links": { "first": "/api/compliance/v2/policies/7225ba52-6178-4daf-a0e4-0c52f58556f6/tailorings/0a633736-5ccf-4caa-a4ae-dc7b46ca4c8d/rules?limit=10&offset=0&sort_by=precedence", "last": "/api/compliance/v2/policies/7225ba52-6178-4daf-a0e4-0c52f58556f6/tailorings/0a633736-5ccf-4caa-a4ae-dc7b46ca4c8d/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": "013b252c-5ee4-4693-b870-1901bcd958ca", "ref_id": "xccdf_org.ssgproject.content_rule_e05376eff2424720dcc2f3daa2f9b4b0", "title": "Nam exercitationem laborum doloribus.", "rationale": "Saepe ex autem. Ut non magni. Quae est eos.", "description": "Excepturi iste nemo. Omnis nobis dolor. Quod aut sed.", "severity": "low", "precedence": 2769, "identifier": { "href": "http://harber.test/savanna.bartell", "label": "Halfred Greenhand" }, "references": [ { "href": "http://lehner.example/cathie", "label": "Hobson" }, { "href": "http://hahn.example/floria.west", "label": "Lonely Troll" }, { "href": "http://sauer-gerhold.example/monet", "label": "Barliman Butterbur" }, { "href": "http://hamill.test/alan", "label": "Ruby Gardner" }, { "href": "http://lowe-lynch.example/xochitl.barton", "label": "Muzgash" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "c5c82668-f381-4920-980b-26ecc9045c56", "type": "rule" }, { "id": "15248ada-01b3-4bbb-83ce-c4d231d48fed", "ref_id": "xccdf_org.ssgproject.content_rule_b9ec4c3098dccd565d2f96e1b00ffb94", "title": "Est eveniet voluptatem deleniti.", "rationale": "Laborum adipisci consequatur. Voluptatum error inventore. Nesciunt dolores officia.", "description": "Vel perspiciatis quia. Autem qui asperiores. Perspiciatis reprehenderit cupiditate.", "severity": "medium", "precedence": 7814, "identifier": { "href": "http://veum-weber.example/juliann", "label": "Fram" }, "references": [ { "href": "http://strosin.test/james_morissette", "label": "Aegnor" }, { "href": "http://brakus-christiansen.example/zachariah", "label": "Fréaláf" }, { "href": "http://runte-robel.test/ninfa", "label": "Ar-Adûnakhôr" }, { "href": "http://bergnaum-glover.test/burl_ondricka", "label": "Larnach" }, { "href": "http://dubuque.example/antonette", "label": "Gildis" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "382f94c1-3346-433b-a1c1-675d0e9ade15", "type": "rule" }, { "id": "199f5682-68d9-40a3-b1eb-8583e2eee7b7", "ref_id": "xccdf_org.ssgproject.content_rule_71006c4d3aa93d890a29f03d3c1a5bbe", "title": "Et suscipit occaecati aut.", "rationale": "Maxime labore nisi. Quis qui maxime. Animi explicabo voluptatibus.", "description": "Consequatur nobis repellat. Totam aspernatur quaerat. Et soluta ducimus.", "severity": "low", "precedence": 2797, "identifier": { "href": "http://jast-weissnat.test/jody.hagenes", "label": "Prisca Baggins" }, "references": [ { "href": "http://mertz-ernser.example/simon", "label": "Gorhendad Oldbuck" }, { "href": "http://jones.example/moon.gerlach", "label": "Ostoher" }, { "href": "http://purdy.example/guy", "label": "Mat Heathertoes" }, { "href": "http://kihn-fahey.example/angel", "label": "Arantar" }, { "href": "http://sporer.example/hal_johnson", "label": "Argeleb" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "5019c74d-c952-4b72-b6d4-3fda7b7708ad", "type": "rule" }, { "id": "2074e056-9a15-4755-9500-d1166d316122", "ref_id": "xccdf_org.ssgproject.content_rule_42a4ac72eac6dfbf97e34e70f147711a", "title": "Voluptas perspiciatis explicabo omnis.", "rationale": "Minima eius vitae. Consequatur ab dolorem. Id molestiae doloremque.", "description": "Dolorum perspiciatis saepe. Ullam quia vitae. Est nulla in.", "severity": "high", "precedence": 8546, "identifier": { "href": "http://roob-schmidt.test/douglas", "label": "Hugo Bracegirdle" }, "references": [ { "href": "http://will.test/marlyn", "label": "Halfred Greenhand" }, { "href": "http://legros.example/bethel_russel", "label": "Araglas" }, { "href": "http://heller.test/keeley_cronin", "label": "Inziladûn" }, { "href": "http://kshlerin.example/lou", "label": "Merimas Brandybuck" }, { "href": "http://renner-wisoky.example/margarite", "label": "Elurín" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "1bc26057-87c0-426e-b9f2-523c0eba1826", "type": "rule" }, { "id": "20a8ac7a-1814-4a64-96f2-764b60dcfc40", "ref_id": "xccdf_org.ssgproject.content_rule_3fdf6a4cb6c086b482211313162bf1b1", "title": "Minus est aut magni.", "rationale": "Et voluptatem molestiae. Explicabo et eum. Dolores tempora ipsam.", "description": "Odio commodi quisquam. Culpa aperiam quidem. Quia amet voluptate.", "severity": "high", "precedence": 8900, "identifier": { "href": "http://daniel.test/judson", "label": "Mauhúr" }, "references": [ { "href": "http://bashirian-kozey.example/lesley_glover", "label": "Carc" }, { "href": "http://ebert.example/angeles_kuvalis", "label": "Ciryatur" }, { "href": "http://oconnell-kihn.example/viva", "label": "Mithrellas" }, { "href": "http://stoltenberg.test/roosevelt_hauck", "label": "Myrtle Burrows" }, { "href": "http://kautzer.example/penney.hagenes", "label": "Eärendil" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "b2ac72fd-ad3c-4cd9-8f10-0ddd4ffe7295", "type": "rule" }, { "id": "220e226c-adf0-465d-849b-461e760ba6f1", "ref_id": "xccdf_org.ssgproject.content_rule_5f352636e7281dfb7bf2cf37515b9ee3", "title": "Ullam minus perferendis quia.", "rationale": "Error facilis voluptatibus. Amet ut ipsa. Sapiente repellat voluptas.", "description": "Omnis et amet. Et natus porro. Sed et impedit.", "severity": "medium", "precedence": 55, "identifier": { "href": "http://dubuque-klocko.test/alfredo.goyette", "label": "Fosco Baggins" }, "references": [ { "href": "http://parisian.example/alfredo", "label": "Snaga" }, { "href": "http://hauck-gorczany.example/korey.kohler", "label": "Argon" }, { "href": "http://price-reichert.test/karren", "label": "Valandil" }, { "href": "http://kuhn-feeney.example/malcolm_senger", "label": "Dáin" }, { "href": "http://hermann.test/michaela.simonis", "label": "Rían" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "adf3bfa5-e809-4354-aeae-4e836fd90afe", "type": "rule" }, { "id": "24c68d1d-0241-44f9-8c36-d03e321673a1", "ref_id": "xccdf_org.ssgproject.content_rule_abad5e336dfb8846b06b5fc6c439e465", "title": "Eaque accusantium pariatur laudantium.", "rationale": "Distinctio eos ut. Et repellendus voluptatem. Sapiente ratione harum.", "description": "Blanditiis qui dolor. Voluptatem beatae perferendis. Quia aperiam et.", "severity": "medium", "precedence": 4217, "identifier": { "href": "http://wyman.test/rocco_bartoletti", "label": "Iorlas" }, "references": [ { "href": "http://hegmann-koelpin.example/ollie_predovic", "label": "Minohtar" }, { "href": "http://medhurst.test/pearly", "label": "Isengrim" }, { "href": "http://gleichner-pfannerstill.example/billie.haley", "label": "Brego" }, { "href": "http://borer-dooley.example/laverne", "label": "Walda" }, { "href": "http://waters-smith.test/brittany_durgan", "label": "Elwing" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "4ef67299-23ff-4351-ada1-9103133abdb2", "type": "rule" }, { "id": "31a9f544-e695-47ba-a9f7-109ff84ee35a", "ref_id": "xccdf_org.ssgproject.content_rule_ab2e22663c0377fc35a1c18e68aec6b5", "title": "Quo aperiam fuga voluptate.", "rationale": "Itaque nam illo. Rem molestias est. Soluta assumenda voluptatibus.", "description": "Occaecati et eveniet. Quo et atque. Tempora itaque sint.", "severity": "medium", "precedence": 4833, "identifier": { "href": "http://gislason.test/raleigh", "label": "Pippin Gardner" }, "references": [ { "href": "http://rosenbaum.test/grady", "label": "Mrs. Bunce" }, { "href": "http://damore-beier.test/adrian_weimann", "label": "Bandobras Took" }, { "href": "http://heaney.test/azzie_franecki", "label": "Gwindor" }, { "href": "http://nader.test/melonie.cronin", "label": "Mallor" }, { "href": "http://kuhic-wintheiser.test/lahoma", "label": "Hanna Goldworthy" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "eb3d6404-a968-4321-87b3-d3522d008825", "type": "rule" }, { "id": "4c319c41-0d6f-4087-aa75-c81b8259e2d6", "ref_id": "xccdf_org.ssgproject.content_rule_f19438b3df077948e18e35c15017e533", "title": "Commodi molestiae quae sequi.", "rationale": "Quis eos architecto. Fuga quisquam accusantium. Distinctio voluptas doloremque.", "description": "Accusantium et harum. Ut vel dolorem. Nihil molestiae accusamus.", "severity": "low", "precedence": 2587, "identifier": { "href": "http://beier-thiel.example/micheline.altenwerth", "label": "Axantur" }, "references": [ { "href": "http://hauck.test/ernest_boyle", "label": "Hilda Bracegirdle" }, { "href": "http://franecki-dickens.example/tim", "label": "Farmer Cotton" }, { "href": "http://howell.example/letty", "label": "Alphros" }, { "href": "http://ziemann.example/mervin.graham", "label": "Halfred Greenhand" }, { "href": "http://okeefe.example/june.hoeger", "label": "Marigold Gamgee" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "a5517577-e327-4a87-84b0-eecf126c2d04", "type": "rule" }, { "id": "5ec95381-899b-422f-8604-1b83537d67f6", "ref_id": "xccdf_org.ssgproject.content_rule_71c297818e969c42ac685fffdaeb88df", "title": "Ex voluptas expedita consequuntur.", "rationale": "Aut magni dicta. Dolor explicabo et. Rerum nemo est.", "description": "Et cumque voluptas. Doloribus aut et. Vel fugiat ducimus.", "severity": "high", "precedence": 5151, "identifier": { "href": "http://friesen.example/jannet", "label": "Bregor" }, "references": [ { "href": "http://auer.example/kristopher_robel", "label": "Amandil" }, { "href": "http://moore-hane.example/alanna_kautzer", "label": "Marhari" }, { "href": "http://muller-heathcote.example/rudolph", "label": "Gothmog" }, { "href": "http://swift-sanford.test/marquita.carter", "label": "Kíli" }, { "href": "http://ryan-beer.test/norberto", "label": "Gilraen" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "7213c5e0-b457-43d8-9402-6e2c6b45235a", "type": "rule" } ], "meta": { "total": 25, "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/policies/d5c9c85e-a2ae-49a8-b95b-162e94723148/tailorings/3fbfcd5b-69cc-4cc4-93ea-e6213a3580bf/rules?limit=10&offset=0", "last": "/api/compliance/v2/policies/d5c9c85e-a2ae-49a8-b95b-162e94723148/tailorings/3fbfcd5b-69cc-4cc4-93ea-e6213a3580bf/rules?limit=10&offset=20", "next": "/api/compliance/v2/policies/d5c9c85e-a2ae-49a8-b95b-162e94723148/tailorings/3fbfcd5b-69cc-4cc4-93ea-e6213a3580bf/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": "7b7562c5-4030-42a9-99de-297328b7cea6", "ref_id": "xccdf_org.ssgproject.content_rule_2dc58996780307d234f2497a1de033d4", "title": "Aut error distinctio pariatur.", "rationale": "Non laboriosam praesentium. Repellendus exercitationem tenetur. Tempore voluptatum expedita.", "description": "Perferendis provident unde. Possimus sed quidem. Corporis ab cumque.", "severity": "medium", "precedence": 7152, "identifier": { "href": "http://rath.example/tomiko", "label": "Sagroth" }, "references": [ { "href": "http://frami.test/modesto", "label": "Thrór" }, { "href": "http://daugherty.test/matthew.ritchie", "label": "Tar-Súrion" }, { "href": "http://lowe.example/ahmed_monahan", "label": "Baldor" }, { "href": "http://klocko.test/mildred_feeney", "label": "Muzgash" }, { "href": "http://lebsack.test/delsie.kiehn", "label": "Bill Butcher" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "c0100a3d-0480-4d2d-9db1-f0ba27bf66eb", "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 6a6dc020-6a9f-4615-bc8d-adf4b7bd2750" ] }, "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": "95462941-f328-4a55-afc5-83b08acb6c90", "ref_id": "xccdf_org.ssgproject.content_rule_451ba303d3a9bca742f793436c203216", "title": "Est quod eligendi tenetur.", "rationale": "Corporis cumque quidem. Labore neque assumenda. Eos qui aut.", "description": "Ab iste sint. Aut error distinctio. Illum architecto quisquam.", "severity": "low", "precedence": 8606, "identifier": { "href": "http://greenholt.example/toshiko", "label": "Fíli" }, "references": [ { "href": "http://dibbert.test/jonas", "label": "Lobelia Sackville-Baggins" }, { "href": "http://hills.example/jacques", "label": "Menegilda Goold" }, { "href": "http://casper-macejkovic.test/catina.will", "label": "Gwindor" }, { "href": "http://block-dicki.example/melodee", "label": "Aulendil" }, { "href": "http://cronin.test/kimiko", "label": "Haldar" } ], "value_checks": null, "remediation_available": false, "rule_group_id": "91dd65d7-1b6d-49ab-8235-35b456a0004a", "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 07c155cf-c491-49fb-8573-10db919568dc" ] }, "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": "1bb442f5-0d59-4f01-9ce0-066b20b8b4a1", "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", "title": "Numquam quo voluptatem vel.", "version": "100.82.6", "description": "Quos omnis corporis. Accusantium sapiente temporibus. Fuga officia repellendus.", "os_major_version": 7, "type": "security_guide" }, { "id": "37ff2248-36bb-4326-a041-3dff8700a716", "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", "title": "Rem non qui eveniet.", "version": "100.82.14", "description": "Rerum blanditiis autem. Consectetur mollitia qui. Labore impedit soluta.", "os_major_version": 7, "type": "security_guide" }, { "id": "3de81f54-c649-4a56-b8ce-99199dd83ad1", "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", "title": "Dolores iste commodi repellat.", "version": "100.82.13", "description": "Ducimus maxime nesciunt. Maiores possimus doloremque. Rerum dignissimos consequatur.", "os_major_version": 7, "type": "security_guide" }, { "id": "547be6c3-f86d-4eef-adc9-311867363545", "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", "title": "Accusamus voluptatem perspiciatis dolores.", "version": "100.82.17", "description": "Quia beatae ut. Accusamus ut corrupti. Repellat ut consequuntur.", "os_major_version": 7, "type": "security_guide" }, { "id": "564e1a8a-9134-4b31-ba74-09f57f97534e", "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", "title": "Aliquam molestias dolor sit.", "version": "100.82.7", "description": "Repellat neque aut. Expedita iusto neque. Qui sed dolore.", "os_major_version": 7, "type": "security_guide" }, { "id": "59dd7a81-dcaf-4831-9ff1-0f5e03899e40", "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", "title": "Et qui molestias autem.", "version": "100.82.1", "description": "Odit reprehenderit aut. Est magni consequatur. Et magnam reiciendis.", "os_major_version": 7, "type": "security_guide" }, { "id": "784d1d13-86cc-4c1f-8012-2f71f256ef6a", "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", "title": "Ipsum corrupti nihil sint.", "version": "100.81.47", "description": "Ea minus adipisci. Laboriosam et dolorem. Illum numquam voluptate.", "os_major_version": 7, "type": "security_guide" }, { "id": "7d14f199-d550-44bc-8931-32d55cf247be", "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", "title": "Et consequuntur omnis velit.", "version": "100.82.10", "description": "Harum fugiat quam. Et sint accusamus. Adipisci deserunt quisquam.", "os_major_version": 7, "type": "security_guide" }, { "id": "831d9422-50a2-43df-9062-a5f739a7ec0c", "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", "title": "Autem officia ratione fugit.", "version": "100.81.48", "description": "Ea dolor ea. Soluta ut eligendi. Modi dolor laboriosam.", "os_major_version": 7, "type": "security_guide" }, { "id": "8ea5eced-aac3-4be5-94a9-8d23a7a11c59", "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", "title": "Earum in enim est.", "version": "100.82.19", "description": "Dolorum qui consequatur. Tempore qui repellat. Dolores sint cupiditate.", "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": "08061444-eab6-416d-be88-a652f9732c7d", "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", "title": "Est eum soluta autem.", "version": "100.82.43", "description": "Necessitatibus et dicta. Officia minima enim. Sint et aut.", "os_major_version": 7, "type": "security_guide" }, { "id": "13f30d78-2a38-4ffe-969e-10a86fa6a21d", "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", "title": "Nobis unde aut molestiae.", "version": "100.82.21", "description": "Saepe amet necessitatibus. Facere enim qui. Et corporis in.", "os_major_version": 7, "type": "security_guide" }, { "id": "1fbc80b3-e3ca-42b4-825b-a7c69d9705d7", "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", "title": "Eius eos nobis ut.", "version": "100.82.37", "description": "Inventore in omnis. Temporibus non et. Culpa suscipit eaque.", "os_major_version": 7, "type": "security_guide" }, { "id": "2330bf62-b95d-40ac-a5ef-3d59f498d958", "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", "title": "Sit dolores voluptatibus nulla.", "version": "100.82.32", "description": "Quis assumenda sint. Sed ut atque. A voluptas quisquam.", "os_major_version": 7, "type": "security_guide" }, { "id": "2391ab70-b41e-4045-b544-9caa55dca422", "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", "title": "Aut assumenda accusamus architecto.", "version": "100.82.23", "description": "Temporibus blanditiis totam. Consequatur rerum rem. Sunt unde sed.", "os_major_version": 7, "type": "security_guide" }, { "id": "3eec89cb-7d63-4f99-8ac5-37c2b2906fb9", "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", "title": "Est culpa vitae eius.", "version": "100.82.42", "description": "Vel porro id. Ut magni magnam. Repudiandae soluta minus.", "os_major_version": 7, "type": "security_guide" }, { "id": "4e76c2e9-f9e8-4699-b94e-441840abcd41", "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", "title": "Sed debitis minus nobis.", "version": "100.82.34", "description": "Magnam consequuntur excepturi. Quam neque doloremque. Et voluptatem et.", "os_major_version": 7, "type": "security_guide" }, { "id": "533dad4c-b66d-4a0b-be00-47ec1de8169e", "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", "title": "Sequi est iusto vitae.", "version": "100.82.35", "description": "Hic ullam similique. Dolores dolore tempora. Dolor et nulla.", "os_major_version": 7, "type": "security_guide" }, { "id": "5841e6ea-6cac-4ffd-acb7-c5c12edc9bd9", "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", "title": "Ut qui dolores nemo.", "version": "100.82.40", "description": "Enim deserunt et. Numquam commodi qui. Illum quibusdam quia.", "os_major_version": 7, "type": "security_guide" }, { "id": "5b49c624-0992-4a5f-86c0-98a791c40f87", "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", "title": "Tenetur eum est animi.", "version": "100.82.28", "description": "Voluptatem quaerat nihil. Sit quo corrupti. Et inventore sequi.", "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": "a2f32164-690e-48da-b33f-eb68e8546a20", "ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7", "title": "Pariatur esse labore vel.", "version": "100.84.46", "description": "Aut autem quo. Voluptatum exercitationem ea. Earum error incidunt.", "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 c763bd06-aabc-48f5-9b51-3320c2bf41db" ] }, "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": "db7bac32-8045-4cd5-a819-4bc52096335e", "type": "rule_group", "children": [ { "id": "7637f74a-853e-4486-a9a1-cfac5d502a96", "type": "rule" } ] }, { "id": "316a36e8-7449-4768-a0f6-26ae7c1a86c5", "type": "rule_group", "children": [ { "id": "fcffebd3-26e0-450c-b25d-586e06187722", "type": "rule" } ] }, { "id": "ecc039b0-a964-4f88-849e-a57e51401375", "type": "rule_group", "children": [ { "id": "b0f04074-3902-4b43-8c9d-34ba0da6ff80", "type": "rule" } ] }, { "id": "5b21d879-ac6c-48e8-a951-e1ba4c0deafb", "type": "rule_group", "children": [ { "id": "894c6827-e8f7-4e41-97e1-4aa3878206d0", "type": "rule" } ] }, { "id": "4dfd32e4-5696-416f-9295-98dcdd10977f", "type": "rule_group", "children": [ { "id": "718e572f-6288-4ca8-9d44-8d1bd0274b55", "type": "rule" } ] }, { "id": "22802c68-1b00-472d-b9bf-868887d8bb89", "type": "rule_group", "children": [ { "id": "5c2c72fd-b626-48af-85d4-67be814063e6", "type": "rule" } ] }, { "id": "2b49d2ac-3019-41fa-b32d-fed23bf272ca", "type": "rule_group", "children": [ { "id": "7929170b-0478-4f5e-b540-4f4e8fd6c88f", "type": "rule" } ] }, { "id": "92b4a7de-12fb-435d-89bc-a43ffa407500", "type": "rule_group", "children": [ { "id": "e2cfa4c4-2db7-4a1c-97a8-1e7b413f7446", "type": "rule" } ] }, { "id": "71fca18d-f6a0-4092-9d6c-a3344dce6b94", "type": "rule_group", "children": [ { "id": "f9efb361-4c67-4519-850e-00293a271e6b", "type": "rule" } ] }, { "id": "2c49f09d-d710-4fa8-b9f6-8f25d478888f", "type": "rule_group", "children": [ { "id": "21abaceb-1ab4-460e-abe6-016ed77f9cdd", "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 4b84b6e2-ee16-4f40-b868-eab24f0aa65d" ] }, "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": "02669ae8-fbf4-432a-b33d-a36ecf993a5a", "title": "Aperiam sunt perferendis sunt.", "description": "Voluptatibus officia rerum. Quia recusandae reiciendis. Illum soluta nihil.", "ref_id": "xccdf_org.ssgproject.content_profile_1ce77e1fc03c8bf202cd608c406c37bb", "security_guide_id": "f1644a45-a376-47bf-8951-e3e12c343323", "security_guide_version": "100.85.32", "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": "10350845-9120-4015-93b8-1cfa7ee88d4e", "title": "Reiciendis est ducimus voluptatem.", "description": "Qui enim sit. Sequi porro eligendi. Veritatis fugit incidunt.", "ref_id": "xccdf_org.ssgproject.content_profile_fda0ecfc2e837d6840447ae139535628", "security_guide_id": "c7f71bb4-0a76-442f-bc0d-38e5f278f485", "security_guide_version": "100.85.33", "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": "0af14c82-e5f7-44b7-993c-8e0394993ee3", "display_name": "klein.test", "groups": [], "culled_timestamp": "2034-12-12T14:44:45.756Z", "stale_timestamp": "2034-11-28T14:44:45.756Z", "stale_warning_timestamp": "2034-12-05T14:44:45.756Z", "updated": "2024-11-28T14:44:45.756Z", "insights_id": null, "tags": [ { "key": "driver", "value": "bluetooth", "namespace": "connecting" }, { "key": "driver", "value": "wireless", "namespace": "copying" }, { "key": "microchip", "value": "mobile", "namespace": "navigating" }, { "key": "bandwidth", "value": "open-source", "namespace": "connecting" }, { "key": "port", "value": "virtual", "namespace": "synthesizing" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "14b945dc-a61e-4e83-b50b-82f8e4e614a4", "display_name": "mcdermott.test", "groups": [], "culled_timestamp": "2034-12-12T14:44:45.754Z", "stale_timestamp": "2034-11-28T14:44:45.754Z", "stale_warning_timestamp": "2034-12-05T14:44:45.754Z", "updated": "2024-11-28T14:44:45.754Z", "insights_id": null, "tags": [ { "key": "hard drive", "value": "open-source", "namespace": "quantifying" }, { "key": "application", "value": "primary", "namespace": "quantifying" }, { "key": "program", "value": "virtual", "namespace": "quantifying" }, { "key": "feed", "value": "1080p", "namespace": "programming" }, { "key": "monitor", "value": "back-end", "namespace": "programming" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "1be2d94e-02bd-400c-9663-eacda4418457", "display_name": "mcdermott-windler.test", "groups": [], "culled_timestamp": "2034-12-12T14:44:45.753Z", "stale_timestamp": "2034-11-28T14:44:45.753Z", "stale_warning_timestamp": "2034-12-05T14:44:45.753Z", "updated": "2024-11-28T14:44:45.753Z", "insights_id": null, "tags": [ { "key": "monitor", "value": "virtual", "namespace": "parsing" }, { "key": "monitor", "value": "wireless", "namespace": "backing up" }, { "key": "driver", "value": "solid state", "namespace": "connecting" }, { "key": "transmitter", "value": "primary", "namespace": "hacking" }, { "key": "bandwidth", "value": "primary", "namespace": "synthesizing" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "2107468c-776d-465f-9c5d-491794e301a1", "display_name": "veum.example", "groups": [], "culled_timestamp": "2034-12-12T14:44:45.760Z", "stale_timestamp": "2034-11-28T14:44:45.760Z", "stale_warning_timestamp": "2034-12-05T14:44:45.760Z", "updated": "2024-11-28T14:44:45.760Z", "insights_id": null, "tags": [ { "key": "bandwidth", "value": "wireless", "namespace": "parsing" }, { "key": "alarm", "value": "solid state", "namespace": "compressing" }, { "key": "driver", "value": "primary", "namespace": "indexing" }, { "key": "interface", "value": "neural", "namespace": "programming" }, { "key": "capacitor", "value": "online", "namespace": "generating" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "2230669d-1008-425c-9980-3241ba291995", "display_name": "koelpin.example", "groups": [], "culled_timestamp": "2034-12-12T14:44:45.761Z", "stale_timestamp": "2034-11-28T14:44:45.761Z", "stale_warning_timestamp": "2034-12-05T14:44:45.761Z", "updated": "2024-11-28T14:44:45.761Z", "insights_id": null, "tags": [ { "key": "capacitor", "value": "neural", "namespace": "backing up" }, { "key": "matrix", "value": "multi-byte", "namespace": "overriding" }, { "key": "bus", "value": "virtual", "namespace": "generating" }, { "key": "capacitor", "value": "haptic", "namespace": "generating" }, { "key": "array", "value": "multi-byte", "namespace": "parsing" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "23e41e62-65dd-41f1-87fc-88758dbb31aa", "display_name": "zemlak.test", "groups": [], "culled_timestamp": "2034-12-12T14:44:45.755Z", "stale_timestamp": "2034-11-28T14:44:45.755Z", "stale_warning_timestamp": "2034-12-05T14:44:45.755Z", "updated": "2024-11-28T14:44:45.755Z", "insights_id": null, "tags": [ { "key": "microchip", "value": "primary", "namespace": "synthesizing" }, { "key": "capacitor", "value": "cross-platform", "namespace": "backing up" }, { "key": "application", "value": "multi-byte", "namespace": "synthesizing" }, { "key": "interface", "value": "neural", "namespace": "connecting" }, { "key": "sensor", "value": "solid state", "namespace": "quantifying" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "273fa47f-4d86-4783-926c-666f8ea53394", "display_name": "ondricka.test", "groups": [], "culled_timestamp": "2034-12-12T14:44:45.749Z", "stale_timestamp": "2034-11-28T14:44:45.749Z", "stale_warning_timestamp": "2034-12-05T14:44:45.749Z", "updated": "2024-11-28T14:44:45.749Z", "insights_id": null, "tags": [ { "key": "pixel", "value": "solid state", "namespace": "parsing" }, { "key": "bandwidth", "value": "neural", "namespace": "calculating" }, { "key": "capacitor", "value": "mobile", "namespace": "quantifying" }, { "key": "panel", "value": "cross-platform", "namespace": "programming" }, { "key": "interface", "value": "cross-platform", "namespace": "overriding" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "2fdefcfb-85f2-4bff-a90e-dc31d77169db", "display_name": "fritsch.test", "groups": [], "culled_timestamp": "2034-12-12T14:44:45.758Z", "stale_timestamp": "2034-11-28T14:44:45.758Z", "stale_warning_timestamp": "2034-12-05T14:44:45.758Z", "updated": "2024-11-28T14:44:45.758Z", "insights_id": null, "tags": [ { "key": "application", "value": "digital", "namespace": "bypassing" }, { "key": "matrix", "value": "online", "namespace": "programming" }, { "key": "port", "value": "multi-byte", "namespace": "transmitting" }, { "key": "program", "value": "wireless", "namespace": "backing up" }, { "key": "matrix", "value": "multi-byte", "namespace": "quantifying" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "4347a3ba-cb66-45dc-bc32-abd3c7711e98", "display_name": "waters.example", "groups": [], "culled_timestamp": "2034-12-12T14:44:45.747Z", "stale_timestamp": "2034-11-28T14:44:45.747Z", "stale_warning_timestamp": "2034-12-05T14:44:45.747Z", "updated": "2024-11-28T14:44:45.747Z", "insights_id": null, "tags": [ { "key": "firewall", "value": "solid state", "namespace": "backing up" }, { "key": "alarm", "value": "digital", "namespace": "copying" }, { "key": "transmitter", "value": "haptic", "namespace": "overriding" }, { "key": "sensor", "value": "haptic", "namespace": "quantifying" }, { "key": "capacitor", "value": "solid state", "namespace": "hacking" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "4a21a90a-3786-46b9-a6f4-e6b0183d661a", "display_name": "corkery.test", "groups": [], "culled_timestamp": "2034-12-12T14:44:45.757Z", "stale_timestamp": "2034-11-28T14:44:45.757Z", "stale_warning_timestamp": "2034-12-05T14:44:45.757Z", "updated": "2024-11-28T14:44:45.757Z", "insights_id": null, "tags": [ { "key": "monitor", "value": "open-source", "namespace": "connecting" }, { "key": "monitor", "value": "solid state", "namespace": "overriding" }, { "key": "alarm", "value": "back-end", "namespace": "indexing" }, { "key": "application", "value": "open-source", "namespace": "indexing" }, { "key": "monitor", "value": "1080p", "namespace": "programming" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] } ], "meta": { "total": 25, "tags": [], "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/systems?limit=10&offset=0", "last": "/api/compliance/v2/systems?limit=10&offset=20", "next": "/api/compliance/v2/systems?limit=10&offset=10" } }, "summary": "", "description": "" }, "List of Systems sorted by \"os_major_version:asc\"": { "value": { "data": [ { "id": "18478a70-5916-4e3c-9c57-b568ccdcc094", "display_name": "stamm-mclaughlin.example", "groups": [], "culled_timestamp": "2034-12-12T14:44:45.812Z", "stale_timestamp": "2034-11-28T14:44:45.812Z", "stale_warning_timestamp": "2034-12-05T14:44:45.812Z", "updated": "2024-11-28T14:44:45.812Z", "insights_id": null, "tags": [ { "key": "driver", "value": "open-source", "namespace": "copying" }, { "key": "transmitter", "value": "back-end", "namespace": "generating" }, { "key": "card", "value": "solid state", "namespace": "overriding" }, { "key": "circuit", "value": "virtual", "namespace": "transmitting" }, { "key": "interface", "value": "bluetooth", "namespace": "overriding" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "1caa0074-bfe4-4191-b238-89eccb42acc2", "display_name": "kuphal.test", "groups": [], "culled_timestamp": "2034-12-12T14:44:45.811Z", "stale_timestamp": "2034-11-28T14:44:45.811Z", "stale_warning_timestamp": "2034-12-05T14:44:45.811Z", "updated": "2024-11-28T14:44:45.811Z", "insights_id": null, "tags": [ { "key": "transmitter", "value": "cross-platform", "namespace": "indexing" }, { "key": "card", "value": "optical", "namespace": "indexing" }, { "key": "sensor", "value": "redundant", "namespace": "quantifying" }, { "key": "application", "value": "1080p", "namespace": "overriding" }, { "key": "pixel", "value": "neural", "namespace": "overriding" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "331b4221-4b24-43a3-bbfb-894c2925893a", "display_name": "harber.example", "groups": [], "culled_timestamp": "2034-12-12T14:44:45.801Z", "stale_timestamp": "2034-11-28T14:44:45.801Z", "stale_warning_timestamp": "2034-12-05T14:44:45.801Z", "updated": "2024-11-28T14:44:45.801Z", "insights_id": null, "tags": [ { "key": "feed", "value": "solid state", "namespace": "copying" }, { "key": "capacitor", "value": "redundant", "namespace": "overriding" }, { "key": "capacitor", "value": "primary", "namespace": "overriding" }, { "key": "transmitter", "value": "digital", "namespace": "navigating" }, { "key": "firewall", "value": "bluetooth", "namespace": "generating" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "3d0c315e-1913-4699-bc17-33f87b0df8a6", "display_name": "hayes.test", "groups": [], "culled_timestamp": "2034-12-12T14:44:45.798Z", "stale_timestamp": "2034-11-28T14:44:45.798Z", "stale_warning_timestamp": "2034-12-05T14:44:45.798Z", "updated": "2024-11-28T14:44:45.798Z", "insights_id": null, "tags": [ { "key": "transmitter", "value": "open-source", "namespace": "backing up" }, { "key": "capacitor", "value": "multi-byte", "namespace": "synthesizing" }, { "key": "panel", "value": "open-source", "namespace": "quantifying" }, { "key": "feed", "value": "virtual", "namespace": "connecting" }, { "key": "firewall", "value": "1080p", "namespace": "transmitting" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "3f41ce07-0dd5-4950-ae82-3d004b0c3e73", "display_name": "wuckert.test", "groups": [], "culled_timestamp": "2034-12-12T14:44:45.788Z", "stale_timestamp": "2034-11-28T14:44:45.788Z", "stale_warning_timestamp": "2034-12-05T14:44:45.788Z", "updated": "2024-11-28T14:44:45.788Z", "insights_id": null, "tags": [ { "key": "protocol", "value": "primary", "namespace": "compressing" }, { "key": "port", "value": "solid state", "namespace": "transmitting" }, { "key": "pixel", "value": "digital", "namespace": "hacking" }, { "key": "microchip", "value": "bluetooth", "namespace": "calculating" }, { "key": "transmitter", "value": "mobile", "namespace": "overriding" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "4512fd77-dfbb-4bca-9430-df132100fe19", "display_name": "crist.example", "groups": [], "culled_timestamp": "2034-12-12T14:44:45.799Z", "stale_timestamp": "2034-11-28T14:44:45.799Z", "stale_warning_timestamp": "2034-12-05T14:44:45.799Z", "updated": "2024-11-28T14:44:45.799Z", "insights_id": null, "tags": [ { "key": "array", "value": "digital", "namespace": "overriding" }, { "key": "bandwidth", "value": "haptic", "namespace": "quantifying" }, { "key": "circuit", "value": "virtual", "namespace": "navigating" }, { "key": "program", "value": "online", "namespace": "bypassing" }, { "key": "protocol", "value": "redundant", "namespace": "programming" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "4752f810-e316-41b0-aabd-85531f16c4b0", "display_name": "medhurst.example", "groups": [], "culled_timestamp": "2034-12-12T14:44:45.789Z", "stale_timestamp": "2034-11-28T14:44:45.789Z", "stale_warning_timestamp": "2034-12-05T14:44:45.789Z", "updated": "2024-11-28T14:44:45.789Z", "insights_id": null, "tags": [ { "key": "driver", "value": "redundant", "namespace": "generating" }, { "key": "program", "value": "redundant", "namespace": "compressing" }, { "key": "circuit", "value": "online", "namespace": "synthesizing" }, { "key": "interface", "value": "digital", "namespace": "parsing" }, { "key": "matrix", "value": "mobile", "namespace": "transmitting" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "52677641-fbcb-4895-958c-062e2056d9e3", "display_name": "fay-considine.test", "groups": [], "culled_timestamp": "2034-12-12T14:44:45.793Z", "stale_timestamp": "2034-11-28T14:44:45.793Z", "stale_warning_timestamp": "2034-12-05T14:44:45.793Z", "updated": "2024-11-28T14:44:45.793Z", "insights_id": null, "tags": [ { "key": "alarm", "value": "digital", "namespace": "compressing" }, { "key": "bus", "value": "bluetooth", "namespace": "generating" }, { "key": "bandwidth", "value": "solid state", "namespace": "programming" }, { "key": "firewall", "value": "online", "namespace": "programming" }, { "key": "firewall", "value": "back-end", "namespace": "bypassing" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "555150d5-c1ac-459b-b51b-713cf9b988f7", "display_name": "waelchi-pollich.example", "groups": [], "culled_timestamp": "2034-12-12T14:44:45.800Z", "stale_timestamp": "2034-11-28T14:44:45.800Z", "stale_warning_timestamp": "2034-12-05T14:44:45.800Z", "updated": "2024-11-28T14:44:45.800Z", "insights_id": null, "tags": [ { "key": "bus", "value": "auxiliary", "namespace": "indexing" }, { "key": "feed", "value": "bluetooth", "namespace": "copying" }, { "key": "driver", "value": "open-source", "namespace": "programming" }, { "key": "interface", "value": "back-end", "namespace": "overriding" }, { "key": "array", "value": "digital", "namespace": "bypassing" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "5d6c8c81-5cfe-4002-af41-e2b9e6a98e82", "display_name": "murphy.example", "groups": [], "culled_timestamp": "2034-12-12T14:44:45.794Z", "stale_timestamp": "2034-11-28T14:44:45.794Z", "stale_warning_timestamp": "2034-12-05T14:44:45.794Z", "updated": "2024-11-28T14:44:45.794Z", "insights_id": null, "tags": [ { "key": "monitor", "value": "virtual", "namespace": "compressing" }, { "key": "program", "value": "back-end", "namespace": "programming" }, { "key": "transmitter", "value": "bluetooth", "namespace": "copying" }, { "key": "program", "value": "online", "namespace": "transmitting" }, { "key": "interface", "value": "auxiliary", "namespace": "generating" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] } ], "meta": { "total": 25, "tags": [], "limit": 10, "offset": 0, "sort_by": "os_major_version" }, "links": { "first": "/api/compliance/v2/systems?limit=10&offset=0&sort_by=os_major_version", "last": "/api/compliance/v2/systems?limit=10&offset=20&sort_by=os_major_version", "next": "/api/compliance/v2/systems?limit=10&offset=10&sort_by=os_major_version" } }, "summary": "", "description": "" }, "List of Systems filtered by \"(os_major_version=8)\"": { "value": { "data": [ { "id": "0aff5551-0155-44de-b736-9e744d0d8128", "display_name": "lebsack.example", "groups": [], "culled_timestamp": "2034-12-12T14:44:45.844Z", "stale_timestamp": "2034-11-28T14:44:45.844Z", "stale_warning_timestamp": "2034-12-05T14:44:45.844Z", "updated": "2024-11-28T14:44:45.844Z", "insights_id": null, "tags": [ { "key": "alarm", "value": "open-source", "namespace": "indexing" }, { "key": "system", "value": "bluetooth", "namespace": "bypassing" }, { "key": "matrix", "value": "open-source", "namespace": "indexing" }, { "key": "bandwidth", "value": "optical", "namespace": "compressing" }, { "key": "sensor", "value": "redundant", "namespace": "backing up" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "0e33315a-16d3-422c-89be-a7b5ad0acaea", "display_name": "corkery.example", "groups": [], "culled_timestamp": "2034-12-12T14:44:45.833Z", "stale_timestamp": "2034-11-28T14:44:45.833Z", "stale_warning_timestamp": "2034-12-05T14:44:45.833Z", "updated": "2024-11-28T14:44:45.833Z", "insights_id": null, "tags": [ { "key": "interface", "value": "open-source", "namespace": "synthesizing" }, { "key": "bandwidth", "value": "multi-byte", "namespace": "programming" }, { "key": "port", "value": "redundant", "namespace": "connecting" }, { "key": "bandwidth", "value": "online", "namespace": "synthesizing" }, { "key": "circuit", "value": "multi-byte", "namespace": "hacking" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "13c5693c-4c07-4edf-9130-725383253b2d", "display_name": "kshlerin.test", "groups": [], "culled_timestamp": "2034-12-12T14:44:45.838Z", "stale_timestamp": "2034-11-28T14:44:45.838Z", "stale_warning_timestamp": "2034-12-05T14:44:45.838Z", "updated": "2024-11-28T14:44:45.838Z", "insights_id": null, "tags": [ { "key": "feed", "value": "multi-byte", "namespace": "backing up" }, { "key": "feed", "value": "back-end", "namespace": "hacking" }, { "key": "capacitor", "value": "auxiliary", "namespace": "programming" }, { "key": "port", "value": "open-source", "namespace": "transmitting" }, { "key": "microchip", "value": "open-source", "namespace": "parsing" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "23d8e2c2-432d-4f1c-8084-90f444286b76", "display_name": "konopelski.test", "groups": [], "culled_timestamp": "2034-12-12T14:44:45.842Z", "stale_timestamp": "2034-11-28T14:44:45.842Z", "stale_warning_timestamp": "2034-12-05T14:44:45.842Z", "updated": "2024-11-28T14:44:45.842Z", "insights_id": null, "tags": [ { "key": "capacitor", "value": "digital", "namespace": "calculating" }, { "key": "bandwidth", "value": "primary", "namespace": "indexing" }, { "key": "application", "value": "neural", "namespace": "hacking" }, { "key": "application", "value": "back-end", "namespace": "calculating" }, { "key": "application", "value": "multi-byte", "namespace": "overriding" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "242505cd-fa83-4d72-ac3e-664317f81de7", "display_name": "emard.test", "groups": [], "culled_timestamp": "2034-12-12T14:44:45.840Z", "stale_timestamp": "2034-11-28T14:44:45.840Z", "stale_warning_timestamp": "2034-12-05T14:44:45.840Z", "updated": "2024-11-28T14:44:45.840Z", "insights_id": null, "tags": [ { "key": "feed", "value": "mobile", "namespace": "copying" }, { "key": "array", "value": "optical", "namespace": "compressing" }, { "key": "circuit", "value": "open-source", "namespace": "programming" }, { "key": "microchip", "value": "optical", "namespace": "programming" }, { "key": "hard drive", "value": "bluetooth", "namespace": "navigating" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "29ebee90-afb3-4899-942a-d563aa182318", "display_name": "emmerich.example", "groups": [], "culled_timestamp": "2034-12-12T14:44:45.847Z", "stale_timestamp": "2034-11-28T14:44:45.847Z", "stale_warning_timestamp": "2034-12-05T14:44:45.847Z", "updated": "2024-11-28T14:44:45.847Z", "insights_id": null, "tags": [ { "key": "capacitor", "value": "multi-byte", "namespace": "hacking" }, { "key": "hard drive", "value": "open-source", "namespace": "quantifying" }, { "key": "microchip", "value": "multi-byte", "namespace": "calculating" }, { "key": "program", "value": "back-end", "namespace": "hacking" }, { "key": "port", "value": "redundant", "namespace": "transmitting" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "35f46c64-d646-41e7-8b9c-6b9576602489", "display_name": "schowalter-graham.example", "groups": [], "culled_timestamp": "2034-12-12T14:44:45.849Z", "stale_timestamp": "2034-11-28T14:44:45.849Z", "stale_warning_timestamp": "2034-12-05T14:44:45.849Z", "updated": "2024-11-28T14:44:45.849Z", "insights_id": null, "tags": [ { "key": "feed", "value": "mobile", "namespace": "parsing" }, { "key": "panel", "value": "neural", "namespace": "calculating" }, { "key": "transmitter", "value": "digital", "namespace": "quantifying" }, { "key": "panel", "value": "digital", "namespace": "programming" }, { "key": "protocol", "value": "primary", "namespace": "backing up" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "36368d5b-a95a-4061-a9b7-2a68b24f3de0", "display_name": "johns-schoen.example", "groups": [], "culled_timestamp": "2034-12-12T14:44:45.848Z", "stale_timestamp": "2034-11-28T14:44:45.848Z", "stale_warning_timestamp": "2034-12-05T14:44:45.848Z", "updated": "2024-11-28T14:44:45.848Z", "insights_id": null, "tags": [ { "key": "feed", "value": "digital", "namespace": "calculating" }, { "key": "monitor", "value": "redundant", "namespace": "calculating" }, { "key": "capacitor", "value": "open-source", "namespace": "copying" }, { "key": "transmitter", "value": "online", "namespace": "connecting" }, { "key": "program", "value": "solid state", "namespace": "compressing" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "48ba339a-8ebe-47a4-aee8-979fb7703b7a", "display_name": "kunze-jones.example", "groups": [], "culled_timestamp": "2034-12-12T14:44:45.839Z", "stale_timestamp": "2034-11-28T14:44:45.839Z", "stale_warning_timestamp": "2034-12-05T14:44:45.839Z", "updated": "2024-11-28T14:44:45.839Z", "insights_id": null, "tags": [ { "key": "bandwidth", "value": "solid state", "namespace": "bypassing" }, { "key": "panel", "value": "cross-platform", "namespace": "generating" }, { "key": "capacitor", "value": "1080p", "namespace": "navigating" }, { "key": "transmitter", "value": "open-source", "namespace": "generating" }, { "key": "sensor", "value": "back-end", "namespace": "bypassing" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] }, { "id": "5ad2d160-87f7-44a8-a27c-2e3af8d95cef", "display_name": "shanahan.test", "groups": [], "culled_timestamp": "2034-12-12T14:44:45.832Z", "stale_timestamp": "2034-11-28T14:44:45.832Z", "stale_warning_timestamp": "2034-12-05T14:44:45.832Z", "updated": "2024-11-28T14:44:45.832Z", "insights_id": null, "tags": [ { "key": "firewall", "value": "neural", "namespace": "transmitting" }, { "key": "pixel", "value": "wireless", "namespace": "bypassing" }, { "key": "application", "value": "mobile", "namespace": "hacking" }, { "key": "sensor", "value": "virtual", "namespace": "parsing" }, { "key": "program", "value": "auxiliary", "namespace": "bypassing" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] } ], "meta": { "total": 25, "filter": "(os_major_version=8)", "tags": [], "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/systems?filter=%28os_major_version%3D8%29&limit=10&offset=0", "last": "/api/compliance/v2/systems?filter=%28os_major_version%3D8%29&limit=10&offset=20", "next": "/api/compliance/v2/systems?filter=%28os_major_version%3D8%29&limit=10&offset=10" } }, "summary": "", "description": "" } }, "schema": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/metadata" }, "links": { "$ref": "#/components/schemas/links" }, "data": { "type": "array", "items": { "properties": { "schema": { "$ref": "#/components/schemas/system" } } } } } } } } }, "422": { "description": "Returns with Unprocessable Content", "content": { "application/vnd.api+json": { "examples": { "Description of an error when sorting by incorrect parameter": { "value": { "errors": [ "Result cannot be sorted by the 'description' column." ] }, "summary": "", "description": "" }, "Description of an error when requesting higher limit than supported": { "value": { "errors": [ "Invalid parameter: limit must be less than or equal to 100" ] }, "summary": "", "description": "" } }, "schema": { "$ref": "#/components/schemas/errors" } } } } } } }, "/systems/os_versions": { "get": { "summary": "Request the list of available OS versions", "parameters": [ { "name": "X-RH-IDENTITY", "in": "header", "schema": { "type": "string" }, "description": "For internal use only" }, { "name": "filter", "in": "query", "required": false, "description": "Query string to filter items by their attributes. Compliant with scoped_search query language. However, only `=` or `!=` (resp. `<>`) operators are supported.

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

(e.g.: `(field_1=something AND field_2!=\"something else\") OR field_3>40`)", "schema": { "type": "string" } } ], "tags": [ "Systems" ], "description": "This feature is exclusively used by the frontend.", "operationId": "SystemsOS", "deprecated": true, "responses": { "200": { "description": "Lists available OS versions", "content": { "application/vnd.api+json": { "examples": { "List of available OS versions": { "value": [ "8.0" ], "summary": "", "description": "" } }, "schema": { "type": "array", "items": { "type": "string" } } } } } } } }, "/systems/{system_id}": { "get": { "summary": "Request a System", "parameters": [ { "name": "X-RH-IDENTITY", "in": "header", "schema": { "type": "string" }, "description": "For internal use only" }, { "name": "system_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "Systems" ], "description": "Get information about one specific system.", "operationId": "System", "responses": { "200": { "description": "Returns a System", "content": { "application/vnd.api+json": { "examples": { "Returns a System": { "value": { "data": { "id": "6979dd8f-b684-47f7-8f78-2fd5f2bf9d4c", "display_name": "muller.example", "groups": [], "culled_timestamp": "2034-12-12T14:44:45.973Z", "stale_timestamp": "2034-11-28T14:44:45.973Z", "stale_warning_timestamp": "2034-12-05T14:44:45.973Z", "updated": "2024-11-28T14:44:45.973Z", "insights_id": null, "tags": [ { "key": "driver", "value": "auxiliary", "namespace": "indexing" }, { "key": "panel", "value": "solid state", "namespace": "hacking" }, { "key": "hard drive", "value": "online", "namespace": "synthesizing" }, { "key": "application", "value": "online", "namespace": "overriding" }, { "key": "feed", "value": "auxiliary", "namespace": "transmitting" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [] } }, "summary": "", "description": "" } }, "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/system" } } } } } } } }, "404": { "description": "Returns with Not Found", "content": { "application/vnd.api+json": { "examples": { "Description of an error when requesting a non-existing System": { "value": { "errors": [ "V2::System not found with ID 3b838870-8634-4294-8e87-686511d98193" ] }, "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": "0107d137-89dd-4c27-b90a-6e99da598af8", "display_name": "paucek.example", "groups": [], "culled_timestamp": "2034-12-12T14:44:46.140Z", "stale_timestamp": "2034-11-28T14:44:46.140Z", "stale_warning_timestamp": "2034-12-05T14:44:46.140Z", "updated": "2024-11-28T14:44:46.140Z", "insights_id": null, "tags": [ { "key": "microchip", "value": "mobile", "namespace": "backing up" }, { "key": "capacitor", "value": "1080p", "namespace": "hacking" }, { "key": "firewall", "value": "solid state", "namespace": "generating" }, { "key": "interface", "value": "cross-platform", "namespace": "backing up" }, { "key": "capacitor", "value": "digital", "namespace": "navigating" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "07bf2f70-e8f6-4e28-8bc9-163b694b4d3b", "display_name": "gibson.example", "groups": [], "culled_timestamp": "2034-12-12T14:44:46.086Z", "stale_timestamp": "2034-11-28T14:44:46.086Z", "stale_warning_timestamp": "2034-12-05T14:44:46.086Z", "updated": "2024-11-28T14:44:46.086Z", "insights_id": null, "tags": [ { "key": "driver", "value": "haptic", "namespace": "bypassing" }, { "key": "alarm", "value": "digital", "namespace": "copying" }, { "key": "panel", "value": "cross-platform", "namespace": "hacking" }, { "key": "circuit", "value": "cross-platform", "namespace": "hacking" }, { "key": "matrix", "value": "wireless", "namespace": "generating" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "12c47d00-78ae-4dc8-a6c4-8ceee17ddb0a", "display_name": "schultz.test", "groups": [], "culled_timestamp": "2034-12-12T14:44:46.037Z", "stale_timestamp": "2034-11-28T14:44:46.037Z", "stale_warning_timestamp": "2034-12-05T14:44:46.037Z", "updated": "2024-11-28T14:44:46.037Z", "insights_id": null, "tags": [ { "key": "alarm", "value": "neural", "namespace": "backing up" }, { "key": "bus", "value": "optical", "namespace": "hacking" }, { "key": "matrix", "value": "cross-platform", "namespace": "backing up" }, { "key": "panel", "value": "1080p", "namespace": "generating" }, { "key": "pixel", "value": "back-end", "namespace": "overriding" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "3b863926-7476-40d7-a52b-31219070c7e8", "display_name": "kozey.example", "groups": [], "culled_timestamp": "2034-12-12T14:44:46.133Z", "stale_timestamp": "2034-11-28T14:44:46.133Z", "stale_warning_timestamp": "2034-12-05T14:44:46.133Z", "updated": "2024-11-28T14:44:46.133Z", "insights_id": null, "tags": [ { "key": "matrix", "value": "redundant", "namespace": "backing up" }, { "key": "feed", "value": "virtual", "namespace": "copying" }, { "key": "application", "value": "auxiliary", "namespace": "connecting" }, { "key": "application", "value": "optical", "namespace": "parsing" }, { "key": "transmitter", "value": "optical", "namespace": "transmitting" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "421fe28e-f8ee-44cf-b24d-be295d351e90", "display_name": "oreilly.example", "groups": [], "culled_timestamp": "2034-12-12T14:44:46.027Z", "stale_timestamp": "2034-11-28T14:44:46.027Z", "stale_warning_timestamp": "2034-12-05T14:44:46.027Z", "updated": "2024-11-28T14:44:46.027Z", "insights_id": null, "tags": [ { "key": "transmitter", "value": "1080p", "namespace": "hacking" }, { "key": "protocol", "value": "primary", "namespace": "hacking" }, { "key": "sensor", "value": "open-source", "namespace": "parsing" }, { "key": "matrix", "value": "neural", "namespace": "programming" }, { "key": "alarm", "value": "online", "namespace": "generating" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "5e2e4fc2-9946-4794-a3e0-8fc93b5be6d9", "display_name": "rowe.test", "groups": [], "culled_timestamp": "2034-12-12T14:44:46.032Z", "stale_timestamp": "2034-11-28T14:44:46.032Z", "stale_warning_timestamp": "2034-12-05T14:44:46.032Z", "updated": "2024-11-28T14:44:46.032Z", "insights_id": null, "tags": [ { "key": "alarm", "value": "virtual", "namespace": "overriding" }, { "key": "transmitter", "value": "back-end", "namespace": "backing up" }, { "key": "alarm", "value": "virtual", "namespace": "programming" }, { "key": "card", "value": "optical", "namespace": "parsing" }, { "key": "pixel", "value": "mobile", "namespace": "hacking" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "61f98e4d-41c4-4517-bbd5-4a71cf3de699", "display_name": "thiel.test", "groups": [], "culled_timestamp": "2034-12-12T14:44:46.123Z", "stale_timestamp": "2034-11-28T14:44:46.123Z", "stale_warning_timestamp": "2034-12-05T14:44:46.123Z", "updated": "2024-11-28T14:44:46.123Z", "insights_id": null, "tags": [ { "key": "microchip", "value": "primary", "namespace": "hacking" }, { "key": "firewall", "value": "digital", "namespace": "compressing" }, { "key": "feed", "value": "virtual", "namespace": "bypassing" }, { "key": "protocol", "value": "redundant", "namespace": "calculating" }, { "key": "driver", "value": "optical", "namespace": "bypassing" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "648b262c-af90-4c43-8048-358a54abd84a", "display_name": "batz.example", "groups": [], "culled_timestamp": "2034-12-12T14:44:46.062Z", "stale_timestamp": "2034-11-28T14:44:46.062Z", "stale_warning_timestamp": "2034-12-05T14:44:46.062Z", "updated": "2024-11-28T14:44:46.062Z", "insights_id": null, "tags": [ { "key": "microchip", "value": "haptic", "namespace": "compressing" }, { "key": "system", "value": "virtual", "namespace": "copying" }, { "key": "bus", "value": "optical", "namespace": "generating" }, { "key": "hard drive", "value": "virtual", "namespace": "overriding" }, { "key": "port", "value": "cross-platform", "namespace": "parsing" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "689f858a-b5c1-47dd-bc9b-51f18ab1f130", "display_name": "grimes-fahey.example", "groups": [], "culled_timestamp": "2034-12-12T14:44:46.097Z", "stale_timestamp": "2034-11-28T14:44:46.097Z", "stale_warning_timestamp": "2034-12-05T14:44:46.097Z", "updated": "2024-11-28T14:44:46.097Z", "insights_id": null, "tags": [ { "key": "panel", "value": "redundant", "namespace": "programming" }, { "key": "card", "value": "virtual", "namespace": "bypassing" }, { "key": "program", "value": "redundant", "namespace": "quantifying" }, { "key": "array", "value": "optical", "namespace": "compressing" }, { "key": "circuit", "value": "digital", "namespace": "navigating" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "70395f63-be94-4b63-a031-127be7047946", "display_name": "rempel.test", "groups": [], "culled_timestamp": "2034-12-12T14:44:46.080Z", "stale_timestamp": "2034-11-28T14:44:46.080Z", "stale_warning_timestamp": "2034-12-05T14:44:46.080Z", "updated": "2024-11-28T14:44:46.081Z", "insights_id": null, "tags": [ { "key": "array", "value": "online", "namespace": "transmitting" }, { "key": "firewall", "value": "open-source", "namespace": "quantifying" }, { "key": "card", "value": "haptic", "namespace": "programming" }, { "key": "alarm", "value": "optical", "namespace": "transmitting" }, { "key": "array", "value": "virtual", "namespace": "generating" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 } ], "meta": { "total": 25, "tags": [], "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/policies/c3d9e5cf-7991-447f-bddd-399b20577544/systems?limit=10&offset=0", "last": "/api/compliance/v2/policies/c3d9e5cf-7991-447f-bddd-399b20577544/systems?limit=10&offset=20", "next": "/api/compliance/v2/policies/c3d9e5cf-7991-447f-bddd-399b20577544/systems?limit=10&offset=10" } }, "summary": "", "description": "" }, "List of Systems sorted by \"os_minor_version:asc\"": { "value": { "data": [ { "id": "03322a6e-fa62-4f2a-b15d-3f55532e61d9", "display_name": "veum.test", "groups": [], "culled_timestamp": "2034-12-12T14:44:46.185Z", "stale_timestamp": "2034-11-28T14:44:46.185Z", "stale_warning_timestamp": "2034-12-05T14:44:46.185Z", "updated": "2024-11-28T14:44:46.185Z", "insights_id": null, "tags": [ { "key": "circuit", "value": "open-source", "namespace": "quantifying" }, { "key": "panel", "value": "back-end", "namespace": "navigating" }, { "key": "pixel", "value": "multi-byte", "namespace": "backing up" }, { "key": "capacitor", "value": "haptic", "namespace": "backing up" }, { "key": "transmitter", "value": "online", "namespace": "backing up" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "0a3abab4-5770-4d00-8b8d-76865e0357f6", "display_name": "daniel.example", "groups": [], "culled_timestamp": "2034-12-12T14:44:46.218Z", "stale_timestamp": "2034-11-28T14:44:46.218Z", "stale_warning_timestamp": "2034-12-05T14:44:46.218Z", "updated": "2024-11-28T14:44:46.218Z", "insights_id": null, "tags": [ { "key": "interface", "value": "open-source", "namespace": "copying" }, { "key": "system", "value": "1080p", "namespace": "transmitting" }, { "key": "system", "value": "virtual", "namespace": "calculating" }, { "key": "sensor", "value": "1080p", "namespace": "generating" }, { "key": "system", "value": "digital", "namespace": "programming" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "0b5ac282-fc62-4941-b156-456af9397b37", "display_name": "davis.test", "groups": [], "culled_timestamp": "2034-12-12T14:44:46.179Z", "stale_timestamp": "2034-11-28T14:44:46.179Z", "stale_warning_timestamp": "2034-12-05T14:44:46.179Z", "updated": "2024-11-28T14:44:46.180Z", "insights_id": null, "tags": [ { "key": "alarm", "value": "1080p", "namespace": "connecting" }, { "key": "protocol", "value": "digital", "namespace": "navigating" }, { "key": "microchip", "value": "1080p", "namespace": "calculating" }, { "key": "panel", "value": "virtual", "namespace": "navigating" }, { "key": "system", "value": "neural", "namespace": "calculating" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "3123ab77-506d-4656-9ed5-c44c0baf968d", "display_name": "treutel-jenkins.example", "groups": [], "culled_timestamp": "2034-12-12T14:44:46.262Z", "stale_timestamp": "2034-11-28T14:44:46.262Z", "stale_warning_timestamp": "2034-12-05T14:44:46.262Z", "updated": "2024-11-28T14:44:46.262Z", "insights_id": null, "tags": [ { "key": "capacitor", "value": "wireless", "namespace": "overriding" }, { "key": "driver", "value": "solid state", "namespace": "compressing" }, { "key": "microchip", "value": "wireless", "namespace": "parsing" }, { "key": "feed", "value": "bluetooth", "namespace": "bypassing" }, { "key": "firewall", "value": "wireless", "namespace": "navigating" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "35008bba-dc02-41c7-a79f-154adf612e15", "display_name": "donnelly.example", "groups": [], "culled_timestamp": "2034-12-12T14:44:46.267Z", "stale_timestamp": "2034-11-28T14:44:46.267Z", "stale_warning_timestamp": "2034-12-05T14:44:46.267Z", "updated": "2024-11-28T14:44:46.267Z", "insights_id": null, "tags": [ { "key": "bandwidth", "value": "neural", "namespace": "indexing" }, { "key": "card", "value": "mobile", "namespace": "synthesizing" }, { "key": "pixel", "value": "open-source", "namespace": "calculating" }, { "key": "application", "value": "mobile", "namespace": "overriding" }, { "key": "bus", "value": "open-source", "namespace": "transmitting" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "3c6ea95c-88ce-46ae-b38a-832f3db0afd1", "display_name": "gusikowski.test", "groups": [], "culled_timestamp": "2034-12-12T14:44:46.213Z", "stale_timestamp": "2034-11-28T14:44:46.213Z", "stale_warning_timestamp": "2034-12-05T14:44:46.213Z", "updated": "2024-11-28T14:44:46.213Z", "insights_id": null, "tags": [ { "key": "transmitter", "value": "primary", "namespace": "programming" }, { "key": "circuit", "value": "redundant", "namespace": "copying" }, { "key": "driver", "value": "digital", "namespace": "backing up" }, { "key": "card", "value": "auxiliary", "namespace": "transmitting" }, { "key": "program", "value": "auxiliary", "namespace": "navigating" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "41c3471a-b47e-4ef8-944d-27aa7313fb70", "display_name": "kautzer.test", "groups": [], "culled_timestamp": "2034-12-12T14:44:46.272Z", "stale_timestamp": "2034-11-28T14:44:46.272Z", "stale_warning_timestamp": "2034-12-05T14:44:46.272Z", "updated": "2024-11-28T14:44:46.272Z", "insights_id": null, "tags": [ { "key": "hard drive", "value": "cross-platform", "namespace": "navigating" }, { "key": "pixel", "value": "optical", "namespace": "overriding" }, { "key": "protocol", "value": "digital", "namespace": "transmitting" }, { "key": "array", "value": "solid state", "namespace": "quantifying" }, { "key": "bandwidth", "value": "solid state", "namespace": "backing up" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "43f28e36-ad6b-4498-a596-93b5c2f1c987", "display_name": "ratke-lowe.example", "groups": [], "culled_timestamp": "2034-12-12T14:44:46.165Z", "stale_timestamp": "2034-11-28T14:44:46.165Z", "stale_warning_timestamp": "2034-12-05T14:44:46.165Z", "updated": "2024-11-28T14:44:46.165Z", "insights_id": null, "tags": [ { "key": "firewall", "value": "haptic", "namespace": "indexing" }, { "key": "alarm", "value": "mobile", "namespace": "synthesizing" }, { "key": "bandwidth", "value": "wireless", "namespace": "synthesizing" }, { "key": "bus", "value": "digital", "namespace": "parsing" }, { "key": "port", "value": "solid state", "namespace": "indexing" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "566e71ef-3ef6-4784-be7a-6d28d6dd5059", "display_name": "stehr.test", "groups": [], "culled_timestamp": "2034-12-12T14:44:46.232Z", "stale_timestamp": "2034-11-28T14:44:46.232Z", "stale_warning_timestamp": "2034-12-05T14:44:46.232Z", "updated": "2024-11-28T14:44:46.232Z", "insights_id": null, "tags": [ { "key": "firewall", "value": "mobile", "namespace": "parsing" }, { "key": "alarm", "value": "bluetooth", "namespace": "generating" }, { "key": "program", "value": "virtual", "namespace": "bypassing" }, { "key": "application", "value": "open-source", "namespace": "programming" }, { "key": "hard drive", "value": "wireless", "namespace": "bypassing" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "5bb8f828-d4a0-41e8-b9bf-7008641a441a", "display_name": "skiles-wolf.example", "groups": [], "culled_timestamp": "2034-12-12T14:44:46.286Z", "stale_timestamp": "2034-11-28T14:44:46.286Z", "stale_warning_timestamp": "2034-12-05T14:44:46.286Z", "updated": "2024-11-28T14:44:46.286Z", "insights_id": null, "tags": [ { "key": "pixel", "value": "haptic", "namespace": "quantifying" }, { "key": "sensor", "value": "virtual", "namespace": "hacking" }, { "key": "microchip", "value": "redundant", "namespace": "navigating" }, { "key": "port", "value": "cross-platform", "namespace": "quantifying" }, { "key": "microchip", "value": "haptic", "namespace": "synthesizing" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 } ], "meta": { "total": 25, "tags": [], "limit": 10, "offset": 0, "sort_by": "os_minor_version" }, "links": { "first": "/api/compliance/v2/policies/120bddec-074c-416d-8032-951e887a1a8b/systems?limit=10&offset=0&sort_by=os_minor_version", "last": "/api/compliance/v2/policies/120bddec-074c-416d-8032-951e887a1a8b/systems?limit=10&offset=20&sort_by=os_minor_version", "next": "/api/compliance/v2/policies/120bddec-074c-416d-8032-951e887a1a8b/systems?limit=10&offset=10&sort_by=os_minor_version" } }, "summary": "", "description": "" }, "List of Systems filtered by \"(os_minor_version=0)\"": { "value": { "data": [ { "id": "1964216d-7255-443f-b0b9-a12b4afa7e52", "display_name": "pfannerstill.test", "groups": [], "culled_timestamp": "2034-12-12T14:44:46.335Z", "stale_timestamp": "2034-11-28T14:44:46.335Z", "stale_warning_timestamp": "2034-12-05T14:44:46.335Z", "updated": "2024-11-28T14:44:46.335Z", "insights_id": null, "tags": [ { "key": "hard drive", "value": "multi-byte", "namespace": "overriding" }, { "key": "bandwidth", "value": "virtual", "namespace": "generating" }, { "key": "pixel", "value": "primary", "namespace": "calculating" }, { "key": "bandwidth", "value": "haptic", "namespace": "calculating" }, { "key": "capacitor", "value": "haptic", "namespace": "quantifying" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "2459efd8-e868-404b-b040-5391618c5b26", "display_name": "tremblay-cartwright.test", "groups": [], "culled_timestamp": "2034-12-12T14:44:46.345Z", "stale_timestamp": "2034-11-28T14:44:46.345Z", "stale_warning_timestamp": "2034-12-05T14:44:46.345Z", "updated": "2024-11-28T14:44:46.345Z", "insights_id": null, "tags": [ { "key": "panel", "value": "redundant", "namespace": "generating" }, { "key": "alarm", "value": "solid state", "namespace": "programming" }, { "key": "system", "value": "primary", "namespace": "copying" }, { "key": "application", "value": "solid state", "namespace": "indexing" }, { "key": "alarm", "value": "bluetooth", "namespace": "transmitting" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "2950c30d-a125-4b93-a112-392c4871daab", "display_name": "sanford.example", "groups": [], "culled_timestamp": "2034-12-12T14:44:46.364Z", "stale_timestamp": "2034-11-28T14:44:46.364Z", "stale_warning_timestamp": "2034-12-05T14:44:46.364Z", "updated": "2024-11-28T14:44:46.364Z", "insights_id": null, "tags": [ { "key": "firewall", "value": "1080p", "namespace": "synthesizing" }, { "key": "matrix", "value": "haptic", "namespace": "quantifying" }, { "key": "interface", "value": "bluetooth", "namespace": "backing up" }, { "key": "bandwidth", "value": "solid state", "namespace": "bypassing" }, { "key": "microchip", "value": "virtual", "namespace": "quantifying" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "3bf38124-2c70-4749-a2ad-9737d8acf297", "display_name": "tremblay.test", "groups": [], "culled_timestamp": "2034-12-12T14:44:46.411Z", "stale_timestamp": "2034-11-28T14:44:46.411Z", "stale_warning_timestamp": "2034-12-05T14:44:46.411Z", "updated": "2024-11-28T14:44:46.411Z", "insights_id": null, "tags": [ { "key": "program", "value": "auxiliary", "namespace": "indexing" }, { "key": "driver", "value": "wireless", "namespace": "connecting" }, { "key": "interface", "value": "redundant", "namespace": "hacking" }, { "key": "system", "value": "open-source", "namespace": "synthesizing" }, { "key": "matrix", "value": "multi-byte", "namespace": "quantifying" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "40ad4f22-2ae8-4bcb-9807-9d518ff64d4c", "display_name": "stiedemann.example", "groups": [], "culled_timestamp": "2034-12-12T14:44:46.380Z", "stale_timestamp": "2034-11-28T14:44:46.380Z", "stale_warning_timestamp": "2034-12-05T14:44:46.380Z", "updated": "2024-11-28T14:44:46.380Z", "insights_id": null, "tags": [ { "key": "bus", "value": "primary", "namespace": "synthesizing" }, { "key": "port", "value": "multi-byte", "namespace": "parsing" }, { "key": "driver", "value": "optical", "namespace": "calculating" }, { "key": "sensor", "value": "auxiliary", "namespace": "quantifying" }, { "key": "panel", "value": "bluetooth", "namespace": "calculating" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "60652702-5766-4bfa-83d4-3dac77208a5e", "display_name": "stroman-hills.example", "groups": [], "culled_timestamp": "2034-12-12T14:44:46.315Z", "stale_timestamp": "2034-11-28T14:44:46.315Z", "stale_warning_timestamp": "2034-12-05T14:44:46.315Z", "updated": "2024-11-28T14:44:46.315Z", "insights_id": null, "tags": [ { "key": "array", "value": "mobile", "namespace": "synthesizing" }, { "key": "capacitor", "value": "neural", "namespace": "copying" }, { "key": "hard drive", "value": "back-end", "namespace": "copying" }, { "key": "interface", "value": "open-source", "namespace": "overriding" }, { "key": "port", "value": "wireless", "namespace": "synthesizing" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "6ad8cb9a-ff0b-4be4-9ca9-cdc20eba5ac4", "display_name": "conn-heaney.test", "groups": [], "culled_timestamp": "2034-12-12T14:44:46.369Z", "stale_timestamp": "2034-11-28T14:44:46.369Z", "stale_warning_timestamp": "2034-12-05T14:44:46.369Z", "updated": "2024-11-28T14:44:46.370Z", "insights_id": null, "tags": [ { "key": "port", "value": "wireless", "namespace": "calculating" }, { "key": "driver", "value": "back-end", "namespace": "quantifying" }, { "key": "hard drive", "value": "cross-platform", "namespace": "backing up" }, { "key": "application", "value": "redundant", "namespace": "generating" }, { "key": "matrix", "value": "back-end", "namespace": "transmitting" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "6d473f26-23f1-4e15-acc7-b27cc23242f1", "display_name": "oconner.example", "groups": [], "culled_timestamp": "2034-12-12T14:44:46.425Z", "stale_timestamp": "2034-11-28T14:44:46.425Z", "stale_warning_timestamp": "2034-12-05T14:44:46.425Z", "updated": "2024-11-28T14:44:46.425Z", "insights_id": null, "tags": [ { "key": "application", "value": "primary", "namespace": "indexing" }, { "key": "alarm", "value": "solid state", "namespace": "compressing" }, { "key": "feed", "value": "auxiliary", "namespace": "parsing" }, { "key": "feed", "value": "primary", "namespace": "synthesizing" }, { "key": "alarm", "value": "solid state", "namespace": "quantifying" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "6e91be91-d24d-48a6-bf6b-6e7d034e3f85", "display_name": "kulas.test", "groups": [], "culled_timestamp": "2034-12-12T14:44:46.359Z", "stale_timestamp": "2034-11-28T14:44:46.359Z", "stale_warning_timestamp": "2034-12-05T14:44:46.359Z", "updated": "2024-11-28T14:44:46.359Z", "insights_id": null, "tags": [ { "key": "program", "value": "online", "namespace": "copying" }, { "key": "hard drive", "value": "neural", "namespace": "hacking" }, { "key": "bus", "value": "cross-platform", "namespace": "compressing" }, { "key": "interface", "value": "haptic", "namespace": "indexing" }, { "key": "program", "value": "digital", "namespace": "transmitting" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "75102df6-46a3-4871-a6d8-43d64bc41de1", "display_name": "weimann.example", "groups": [], "culled_timestamp": "2034-12-12T14:44:46.420Z", "stale_timestamp": "2034-11-28T14:44:46.420Z", "stale_warning_timestamp": "2034-12-05T14:44:46.420Z", "updated": "2024-11-28T14:44:46.420Z", "insights_id": null, "tags": [ { "key": "circuit", "value": "neural", "namespace": "navigating" }, { "key": "circuit", "value": "1080p", "namespace": "indexing" }, { "key": "sensor", "value": "redundant", "namespace": "synthesizing" }, { "key": "bus", "value": "auxiliary", "namespace": "copying" }, { "key": "program", "value": "neural", "namespace": "backing up" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 } ], "meta": { "total": 25, "filter": "(os_minor_version=0)", "tags": [], "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/policies/c3fc7ac1-5ced-483e-ae02-e38b4d8df524/systems?filter=%28os_minor_version%3D0%29&limit=10&offset=0", "last": "/api/compliance/v2/policies/c3fc7ac1-5ced-483e-ae02-e38b4d8df524/systems?filter=%28os_minor_version%3D0%29&limit=10&offset=20", "next": "/api/compliance/v2/policies/c3fc7ac1-5ced-483e-ae02-e38b4d8df524/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": "05d93775-98aa-4f38-9635-16b571e4f7fb", "display_name": "mann.test", "groups": [], "culled_timestamp": "2034-12-12T14:44:46.916Z", "stale_timestamp": "2034-11-28T14:44:46.916Z", "stale_warning_timestamp": "2034-12-05T14:44:46.916Z", "updated": "2024-11-28T14:44:46.916Z", "insights_id": null, "tags": [ { "key": "circuit", "value": "optical", "namespace": "programming" }, { "key": "program", "value": "1080p", "namespace": "overriding" }, { "key": "program", "value": "optical", "namespace": "bypassing" }, { "key": "transmitter", "value": "neural", "namespace": "indexing" }, { "key": "monitor", "value": "bluetooth", "namespace": "connecting" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "086171b1-217a-4b38-804b-d138fa7ade7b", "display_name": "marvin-towne.test", "groups": [], "culled_timestamp": "2034-12-12T14:44:46.915Z", "stale_timestamp": "2034-11-28T14:44:46.915Z", "stale_warning_timestamp": "2034-12-05T14:44:46.915Z", "updated": "2024-11-28T14:44:46.915Z", "insights_id": null, "tags": [ { "key": "card", "value": "multi-byte", "namespace": "quantifying" }, { "key": "monitor", "value": "bluetooth", "namespace": "connecting" }, { "key": "pixel", "value": "primary", "namespace": "hacking" }, { "key": "transmitter", "value": "digital", "namespace": "generating" }, { "key": "pixel", "value": "mobile", "namespace": "overriding" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "0be26af5-6013-4270-ae72-8f2e8428b3d9", "display_name": "muller-aufderhar.test", "groups": [], "culled_timestamp": "2034-12-12T14:44:46.917Z", "stale_timestamp": "2034-11-28T14:44:46.917Z", "stale_warning_timestamp": "2034-12-05T14:44:46.917Z", "updated": "2024-11-28T14:44:46.917Z", "insights_id": null, "tags": [ { "key": "card", "value": "1080p", "namespace": "backing up" }, { "key": "transmitter", "value": "primary", "namespace": "parsing" }, { "key": "capacitor", "value": "virtual", "namespace": "generating" }, { "key": "program", "value": "neural", "namespace": "copying" }, { "key": "monitor", "value": "back-end", "namespace": "connecting" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "0d6da942-e821-466a-b878-a57366675e7b", "display_name": "parker-nikolaus.example", "groups": [], "culled_timestamp": "2034-12-12T14:44:46.928Z", "stale_timestamp": "2034-11-28T14:44:46.928Z", "stale_warning_timestamp": "2034-12-05T14:44:46.928Z", "updated": "2024-11-28T14:44:46.928Z", "insights_id": null, "tags": [ { "key": "pixel", "value": "solid state", "namespace": "programming" }, { "key": "capacitor", "value": "back-end", "namespace": "overriding" }, { "key": "application", "value": "neural", "namespace": "compressing" }, { "key": "array", "value": "auxiliary", "namespace": "calculating" }, { "key": "microchip", "value": "wireless", "namespace": "transmitting" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "1369087f-aaf4-436a-97cb-3298b345d498", "display_name": "little-veum.test", "groups": [], "culled_timestamp": "2034-12-12T14:44:46.930Z", "stale_timestamp": "2034-11-28T14:44:46.930Z", "stale_warning_timestamp": "2034-12-05T14:44:46.930Z", "updated": "2024-11-28T14:44:46.930Z", "insights_id": null, "tags": [ { "key": "port", "value": "mobile", "namespace": "copying" }, { "key": "card", "value": "online", "namespace": "copying" }, { "key": "capacitor", "value": "solid state", "namespace": "connecting" }, { "key": "application", "value": "wireless", "namespace": "hacking" }, { "key": "bandwidth", "value": "mobile", "namespace": "connecting" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "1e4c1acd-70f3-45ad-8aa0-f461be12c7fa", "display_name": "barrows-watsica.example", "groups": [], "culled_timestamp": "2034-12-12T14:44:46.929Z", "stale_timestamp": "2034-11-28T14:44:46.929Z", "stale_warning_timestamp": "2034-12-05T14:44:46.929Z", "updated": "2024-11-28T14:44:46.929Z", "insights_id": null, "tags": [ { "key": "hard drive", "value": "digital", "namespace": "connecting" }, { "key": "transmitter", "value": "multi-byte", "namespace": "transmitting" }, { "key": "sensor", "value": "optical", "namespace": "quantifying" }, { "key": "interface", "value": "solid state", "namespace": "indexing" }, { "key": "card", "value": "neural", "namespace": "synthesizing" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "204d9465-33db-4969-b3e0-97730607376e", "display_name": "reinger.test", "groups": [], "culled_timestamp": "2034-12-12T14:44:46.932Z", "stale_timestamp": "2034-11-28T14:44:46.932Z", "stale_warning_timestamp": "2034-12-05T14:44:46.932Z", "updated": "2024-11-28T14:44:46.932Z", "insights_id": null, "tags": [ { "key": "port", "value": "wireless", "namespace": "overriding" }, { "key": "card", "value": "neural", "namespace": "programming" }, { "key": "application", "value": "online", "namespace": "generating" }, { "key": "array", "value": "haptic", "namespace": "calculating" }, { "key": "interface", "value": "1080p", "namespace": "connecting" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "22692229-8d09-4505-8a55-7a45506ce057", "display_name": "mayer.example", "groups": [], "culled_timestamp": "2034-12-12T14:44:46.922Z", "stale_timestamp": "2034-11-28T14:44:46.922Z", "stale_warning_timestamp": "2034-12-05T14:44:46.922Z", "updated": "2024-11-28T14:44:46.922Z", "insights_id": null, "tags": [ { "key": "firewall", "value": "primary", "namespace": "parsing" }, { "key": "matrix", "value": "open-source", "namespace": "calculating" }, { "key": "application", "value": "back-end", "namespace": "programming" }, { "key": "system", "value": "wireless", "namespace": "calculating" }, { "key": "protocol", "value": "solid state", "namespace": "programming" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "46962de0-4506-473f-b81c-c38d9fbba362", "display_name": "rohan-boyer.test", "groups": [], "culled_timestamp": "2034-12-12T14:44:46.931Z", "stale_timestamp": "2034-11-28T14:44:46.931Z", "stale_warning_timestamp": "2034-12-05T14:44:46.931Z", "updated": "2024-11-28T14:44:46.931Z", "insights_id": null, "tags": [ { "key": "alarm", "value": "wireless", "namespace": "hacking" }, { "key": "bandwidth", "value": "open-source", "namespace": "transmitting" }, { "key": "card", "value": "optical", "namespace": "programming" }, { "key": "bandwidth", "value": "neural", "namespace": "copying" }, { "key": "bandwidth", "value": "virtual", "namespace": "indexing" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 }, { "id": "5e8f4b84-ec6e-414e-839b-6e7af15e8959", "display_name": "senger.example", "groups": [], "culled_timestamp": "2034-12-12T14:44:46.928Z", "stale_timestamp": "2034-11-28T14:44:46.928Z", "stale_warning_timestamp": "2034-12-05T14:44:46.928Z", "updated": "2024-11-28T14:44:46.928Z", "insights_id": null, "tags": [ { "key": "capacitor", "value": "back-end", "namespace": "compressing" }, { "key": "matrix", "value": "open-source", "namespace": "generating" }, { "key": "array", "value": "mobile", "namespace": "programming" }, { "key": "port", "value": "redundant", "namespace": "hacking" }, { "key": "feed", "value": "back-end", "namespace": "generating" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 } ], "meta": { "total": 25, "tags": [], "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/policies/f9caab8f-6c63-4655-a579-4da209841c9f/systems?limit=10&offset=0", "last": "/api/compliance/v2/policies/f9caab8f-6c63-4655-a579-4da209841c9f/systems?limit=10&offset=20", "next": "/api/compliance/v2/policies/f9caab8f-6c63-4655-a579-4da209841c9f/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": [ "ab9a7407-2069-4bbe-a089-5d519ba08f19" ] } } } } } } } } }, "/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": "66827427-158e-49d9-b374-f5e4ca550874", "display_name": "tromp.test", "groups": [], "culled_timestamp": "2034-12-12T14:44:47.153Z", "stale_timestamp": "2034-11-28T14:44:47.153Z", "stale_warning_timestamp": "2034-12-05T14:44:47.153Z", "updated": "2024-11-28T14:44:47.153Z", "insights_id": null, "tags": [ { "key": "pixel", "value": "primary", "namespace": "connecting" }, { "key": "array", "value": "digital", "namespace": "navigating" }, { "key": "interface", "value": "1080p", "namespace": "hacking" }, { "key": "circuit", "value": "primary", "namespace": "backing up" }, { "key": "monitor", "value": "online", "namespace": "navigating" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 } }, "summary": "", "description": "" } }, "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/system" } } } } } } } }, "404": { "description": "Returns with Not Found", "content": { "application/vnd.api+json": { "examples": { "Assigns a System to a Policy": { "value": { "errors": [ "V2::System not found with ID 6a25ae04-64d2-437e-b10f-44ae8aa8ec94" ] }, "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": "a962794c-673f-4e0f-b464-c90470bb209a", "display_name": "gutmann.test", "groups": [], "culled_timestamp": "2034-12-12T14:44:47.212Z", "stale_timestamp": "2034-11-28T14:44:47.212Z", "stale_warning_timestamp": "2034-12-05T14:44:47.212Z", "updated": "2024-11-28T14:44:47.212Z", "insights_id": null, "tags": [ { "key": "card", "value": "online", "namespace": "transmitting" }, { "key": "monitor", "value": "virtual", "namespace": "calculating" }, { "key": "card", "value": "virtual", "namespace": "calculating" }, { "key": "capacitor", "value": "1080p", "namespace": "overriding" }, { "key": "alarm", "value": "haptic", "namespace": "transmitting" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0 } }, "summary": "", "description": "" } }, "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/system" } } } } } } } }, "404": { "description": "Returns with Not Found", "content": { "application/vnd.api+json": { "examples": { "Description of an error when unassigning a non-existing System": { "value": { "errors": [ "V2::System not found with ID 31f4692a-4374-40b6-91e2-251067c15e8e" ] }, "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": "14ec8b8e-4b39-47ea-9914-f7e9845bf37b", "display_name": "beer.test", "groups": [], "culled_timestamp": "2034-12-12T14:44:47.500Z", "stale_timestamp": "2034-11-28T14:44:47.500Z", "stale_warning_timestamp": "2034-12-05T14:44:47.500Z", "updated": "2024-11-28T14:44:47.501Z", "insights_id": null, "tags": [ { "key": "monitor", "value": "primary", "namespace": "bypassing" }, { "key": "program", "value": "open-source", "namespace": "synthesizing" }, { "key": "card", "value": "mobile", "namespace": "synthesizing" }, { "key": "bus", "value": "wireless", "namespace": "copying" }, { "key": "bus", "value": "redundant", "namespace": "copying" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "262beb9a-f95f-4ff0-bd15-56833a513006", "title": "Maiores qui aliquid quia." } ] }, { "id": "2ccfd2b3-16c7-4669-8564-3c6a00542bd9", "display_name": "emmerich.test", "groups": [], "culled_timestamp": "2034-12-12T14:44:47.550Z", "stale_timestamp": "2034-11-28T14:44:47.550Z", "stale_warning_timestamp": "2034-12-05T14:44:47.550Z", "updated": "2024-11-28T14:44:47.550Z", "insights_id": null, "tags": [ { "key": "matrix", "value": "open-source", "namespace": "connecting" }, { "key": "port", "value": "primary", "namespace": "bypassing" }, { "key": "bus", "value": "online", "namespace": "generating" }, { "key": "feed", "value": "open-source", "namespace": "copying" }, { "key": "bus", "value": "optical", "namespace": "synthesizing" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "262beb9a-f95f-4ff0-bd15-56833a513006", "title": "Maiores qui aliquid quia." } ] }, { "id": "2e027579-914c-4759-85dc-16939ab80fb3", "display_name": "christiansen.test", "groups": [], "culled_timestamp": "2034-12-12T14:44:47.431Z", "stale_timestamp": "2034-11-28T14:44:47.431Z", "stale_warning_timestamp": "2034-12-05T14:44:47.431Z", "updated": "2024-11-28T14:44:47.431Z", "insights_id": null, "tags": [ { "key": "firewall", "value": "mobile", "namespace": "transmitting" }, { "key": "card", "value": "neural", "namespace": "bypassing" }, { "key": "port", "value": "virtual", "namespace": "transmitting" }, { "key": "circuit", "value": "primary", "namespace": "programming" }, { "key": "application", "value": "redundant", "namespace": "bypassing" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "262beb9a-f95f-4ff0-bd15-56833a513006", "title": "Maiores qui aliquid quia." } ] }, { "id": "2f500745-88dc-4807-80ec-d0adbda10ab9", "display_name": "nader-ullrich.example", "groups": [], "culled_timestamp": "2034-12-12T14:44:47.510Z", "stale_timestamp": "2034-11-28T14:44:47.510Z", "stale_warning_timestamp": "2034-12-05T14:44:47.510Z", "updated": "2024-11-28T14:44:47.510Z", "insights_id": null, "tags": [ { "key": "transmitter", "value": "open-source", "namespace": "copying" }, { "key": "alarm", "value": "neural", "namespace": "transmitting" }, { "key": "port", "value": "open-source", "namespace": "transmitting" }, { "key": "port", "value": "open-source", "namespace": "calculating" }, { "key": "transmitter", "value": "bluetooth", "namespace": "bypassing" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "262beb9a-f95f-4ff0-bd15-56833a513006", "title": "Maiores qui aliquid quia." } ] }, { "id": "3181cf24-d2d7-4636-8afc-78123cec0d8d", "display_name": "cormier.example", "groups": [], "culled_timestamp": "2034-12-12T14:44:47.480Z", "stale_timestamp": "2034-11-28T14:44:47.480Z", "stale_warning_timestamp": "2034-12-05T14:44:47.480Z", "updated": "2024-11-28T14:44:47.480Z", "insights_id": null, "tags": [ { "key": "driver", "value": "open-source", "namespace": "quantifying" }, { "key": "array", "value": "neural", "namespace": "indexing" }, { "key": "transmitter", "value": "neural", "namespace": "compressing" }, { "key": "system", "value": "back-end", "namespace": "quantifying" }, { "key": "firewall", "value": "auxiliary", "namespace": "indexing" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "262beb9a-f95f-4ff0-bd15-56833a513006", "title": "Maiores qui aliquid quia." } ] }, { "id": "337dc364-2be2-4496-9129-3a062d9b7a6f", "display_name": "adams.example", "groups": [], "culled_timestamp": "2034-12-12T14:44:47.530Z", "stale_timestamp": "2034-11-28T14:44:47.530Z", "stale_warning_timestamp": "2034-12-05T14:44:47.530Z", "updated": "2024-11-28T14:44:47.530Z", "insights_id": null, "tags": [ { "key": "array", "value": "back-end", "namespace": "calculating" }, { "key": "bandwidth", "value": "primary", "namespace": "copying" }, { "key": "transmitter", "value": "back-end", "namespace": "overriding" }, { "key": "driver", "value": "bluetooth", "namespace": "generating" }, { "key": "transmitter", "value": "mobile", "namespace": "navigating" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "262beb9a-f95f-4ff0-bd15-56833a513006", "title": "Maiores qui aliquid quia." } ] }, { "id": "3650f7da-512f-4099-a475-cc0ec972ff1c", "display_name": "pouros.example", "groups": [], "culled_timestamp": "2034-12-12T14:44:47.570Z", "stale_timestamp": "2034-11-28T14:44:47.570Z", "stale_warning_timestamp": "2034-12-05T14:44:47.570Z", "updated": "2024-11-28T14:44:47.570Z", "insights_id": null, "tags": [ { "key": "bus", "value": "haptic", "namespace": "quantifying" }, { "key": "interface", "value": "back-end", "namespace": "copying" }, { "key": "circuit", "value": "wireless", "namespace": "calculating" }, { "key": "bus", "value": "virtual", "namespace": "transmitting" }, { "key": "panel", "value": "neural", "namespace": "synthesizing" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "262beb9a-f95f-4ff0-bd15-56833a513006", "title": "Maiores qui aliquid quia." } ] }, { "id": "372e4451-e0d5-422e-9ca2-47321aea7240", "display_name": "ferry-dare.test", "groups": [], "culled_timestamp": "2034-12-12T14:44:47.448Z", "stale_timestamp": "2034-11-28T14:44:47.448Z", "stale_warning_timestamp": "2034-12-05T14:44:47.448Z", "updated": "2024-11-28T14:44:47.448Z", "insights_id": null, "tags": [ { "key": "firewall", "value": "primary", "namespace": "hacking" }, { "key": "driver", "value": "digital", "namespace": "synthesizing" }, { "key": "bus", "value": "online", "namespace": "calculating" }, { "key": "panel", "value": "neural", "namespace": "indexing" }, { "key": "microchip", "value": "digital", "namespace": "indexing" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "262beb9a-f95f-4ff0-bd15-56833a513006", "title": "Maiores qui aliquid quia." } ] }, { "id": "3ce7a75f-a17d-4080-bdcc-6979c212c294", "display_name": "bauch.example", "groups": [], "culled_timestamp": "2034-12-12T14:44:47.457Z", "stale_timestamp": "2034-11-28T14:44:47.457Z", "stale_warning_timestamp": "2034-12-05T14:44:47.457Z", "updated": "2024-11-28T14:44:47.457Z", "insights_id": null, "tags": [ { "key": "card", "value": "wireless", "namespace": "synthesizing" }, { "key": "alarm", "value": "haptic", "namespace": "parsing" }, { "key": "panel", "value": "solid state", "namespace": "generating" }, { "key": "matrix", "value": "cross-platform", "namespace": "copying" }, { "key": "system", "value": "online", "namespace": "synthesizing" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "262beb9a-f95f-4ff0-bd15-56833a513006", "title": "Maiores qui aliquid quia." } ] }, { "id": "544348a7-f427-4e4a-96ad-c63b9e41d94c", "display_name": "ferry.test", "groups": [], "culled_timestamp": "2034-12-12T14:44:47.515Z", "stale_timestamp": "2034-11-28T14:44:47.515Z", "stale_warning_timestamp": "2034-12-05T14:44:47.515Z", "updated": "2024-11-28T14:44:47.515Z", "insights_id": null, "tags": [ { "key": "bus", "value": "back-end", "namespace": "connecting" }, { "key": "system", "value": "virtual", "namespace": "overriding" }, { "key": "alarm", "value": "bluetooth", "namespace": "overriding" }, { "key": "microchip", "value": "cross-platform", "namespace": "synthesizing" }, { "key": "panel", "value": "wireless", "namespace": "generating" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "262beb9a-f95f-4ff0-bd15-56833a513006", "title": "Maiores qui aliquid quia." } ] } ], "meta": { "total": 25, "tags": [], "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/reports/262beb9a-f95f-4ff0-bd15-56833a513006/systems?limit=10&offset=0", "last": "/api/compliance/v2/reports/262beb9a-f95f-4ff0-bd15-56833a513006/systems?limit=10&offset=20", "next": "/api/compliance/v2/reports/262beb9a-f95f-4ff0-bd15-56833a513006/systems?limit=10&offset=10" } }, "summary": "", "description": "" }, "List of Systems sorted by \"os_minor_version:asc\"": { "value": { "data": [ { "id": "00b648d8-804f-4783-8f1b-b0b87de9c8d8", "display_name": "boehm.test", "groups": [], "culled_timestamp": "2034-12-12T14:44:47.764Z", "stale_timestamp": "2034-11-28T14:44:47.764Z", "stale_warning_timestamp": "2034-12-05T14:44:47.764Z", "updated": "2024-11-28T14:44:47.764Z", "insights_id": null, "tags": [ { "key": "firewall", "value": "multi-byte", "namespace": "compressing" }, { "key": "sensor", "value": "virtual", "namespace": "copying" }, { "key": "array", "value": "auxiliary", "namespace": "calculating" }, { "key": "program", "value": "bluetooth", "namespace": "copying" }, { "key": "alarm", "value": "neural", "namespace": "synthesizing" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "91fc41c4-d911-4821-b7d0-8efd3768007a", "title": "Voluptatem modi ea est." } ] }, { "id": "03fb3ed8-b475-4041-a809-c74ceb7510e1", "display_name": "koepp.example", "groups": [], "culled_timestamp": "2034-12-12T14:44:47.870Z", "stale_timestamp": "2034-11-28T14:44:47.870Z", "stale_warning_timestamp": "2034-12-05T14:44:47.870Z", "updated": "2024-11-28T14:44:47.870Z", "insights_id": null, "tags": [ { "key": "bandwidth", "value": "mobile", "namespace": "copying" }, { "key": "pixel", "value": "auxiliary", "namespace": "calculating" }, { "key": "firewall", "value": "redundant", "namespace": "synthesizing" }, { "key": "array", "value": "digital", "namespace": "overriding" }, { "key": "alarm", "value": "multi-byte", "namespace": "parsing" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "91fc41c4-d911-4821-b7d0-8efd3768007a", "title": "Voluptatem modi ea est." } ] }, { "id": "0618f058-ce77-409e-9246-7f3dbc8ab63a", "display_name": "schmidt.test", "groups": [], "culled_timestamp": "2034-12-12T14:44:47.820Z", "stale_timestamp": "2034-11-28T14:44:47.820Z", "stale_warning_timestamp": "2034-12-05T14:44:47.820Z", "updated": "2024-11-28T14:44:47.820Z", "insights_id": null, "tags": [ { "key": "microchip", "value": "primary", "namespace": "quantifying" }, { "key": "pixel", "value": "solid state", "namespace": "backing up" }, { "key": "application", "value": "optical", "namespace": "indexing" }, { "key": "card", "value": "cross-platform", "namespace": "parsing" }, { "key": "program", "value": "online", "namespace": "copying" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "91fc41c4-d911-4821-b7d0-8efd3768007a", "title": "Voluptatem modi ea est." } ] }, { "id": "0cfa5e3d-a47b-4537-a08a-a663f9889322", "display_name": "strosin.example", "groups": [], "culled_timestamp": "2034-12-12T14:44:47.848Z", "stale_timestamp": "2034-11-28T14:44:47.848Z", "stale_warning_timestamp": "2034-12-05T14:44:47.848Z", "updated": "2024-11-28T14:44:47.848Z", "insights_id": null, "tags": [ { "key": "port", "value": "redundant", "namespace": "indexing" }, { "key": "driver", "value": "haptic", "namespace": "overriding" }, { "key": "firewall", "value": "haptic", "namespace": "hacking" }, { "key": "protocol", "value": "virtual", "namespace": "navigating" }, { "key": "card", "value": "wireless", "namespace": "hacking" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "91fc41c4-d911-4821-b7d0-8efd3768007a", "title": "Voluptatem modi ea est." } ] }, { "id": "0e8235fb-9d00-4638-93d1-6ec58213662c", "display_name": "trantow.test", "groups": [], "culled_timestamp": "2034-12-12T14:44:47.829Z", "stale_timestamp": "2034-11-28T14:44:47.829Z", "stale_warning_timestamp": "2034-12-05T14:44:47.829Z", "updated": "2024-11-28T14:44:47.829Z", "insights_id": null, "tags": [ { "key": "panel", "value": "redundant", "namespace": "generating" }, { "key": "circuit", "value": "mobile", "namespace": "generating" }, { "key": "microchip", "value": "bluetooth", "namespace": "hacking" }, { "key": "circuit", "value": "multi-byte", "namespace": "synthesizing" }, { "key": "alarm", "value": "virtual", "namespace": "connecting" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "91fc41c4-d911-4821-b7d0-8efd3768007a", "title": "Voluptatem modi ea est." } ] }, { "id": "19ea4cf3-d1a9-4e13-a31e-40778e919236", "display_name": "robel.example", "groups": [], "culled_timestamp": "2034-12-12T14:44:47.775Z", "stale_timestamp": "2034-11-28T14:44:47.775Z", "stale_warning_timestamp": "2034-12-05T14:44:47.775Z", "updated": "2024-11-28T14:44:47.775Z", "insights_id": null, "tags": [ { "key": "matrix", "value": "primary", "namespace": "connecting" }, { "key": "bandwidth", "value": "virtual", "namespace": "transmitting" }, { "key": "system", "value": "solid state", "namespace": "indexing" }, { "key": "bus", "value": "haptic", "namespace": "backing up" }, { "key": "protocol", "value": "auxiliary", "namespace": "copying" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "91fc41c4-d911-4821-b7d0-8efd3768007a", "title": "Voluptatem modi ea est." } ] }, { "id": "3b9aa0a1-27a1-4ebf-a4d7-bbc9532280df", "display_name": "mayer.test", "groups": [], "culled_timestamp": "2034-12-12T14:44:47.888Z", "stale_timestamp": "2034-11-28T14:44:47.888Z", "stale_warning_timestamp": "2034-12-05T14:44:47.888Z", "updated": "2024-11-28T14:44:47.888Z", "insights_id": null, "tags": [ { "key": "bus", "value": "1080p", "namespace": "generating" }, { "key": "system", "value": "1080p", "namespace": "programming" }, { "key": "sensor", "value": "back-end", "namespace": "calculating" }, { "key": "monitor", "value": "digital", "namespace": "overriding" }, { "key": "card", "value": "digital", "namespace": "calculating" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "91fc41c4-d911-4821-b7d0-8efd3768007a", "title": "Voluptatem modi ea est." } ] }, { "id": "46b5a598-03db-46ab-a7e8-a8f7f5d9a43d", "display_name": "padberg.test", "groups": [], "culled_timestamp": "2034-12-12T14:44:47.858Z", "stale_timestamp": "2034-11-28T14:44:47.858Z", "stale_warning_timestamp": "2034-12-05T14:44:47.858Z", "updated": "2024-11-28T14:44:47.858Z", "insights_id": null, "tags": [ { "key": "circuit", "value": "bluetooth", "namespace": "navigating" }, { "key": "panel", "value": "wireless", "namespace": "synthesizing" }, { "key": "panel", "value": "optical", "namespace": "indexing" }, { "key": "firewall", "value": "virtual", "namespace": "programming" }, { "key": "array", "value": "open-source", "namespace": "calculating" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "91fc41c4-d911-4821-b7d0-8efd3768007a", "title": "Voluptatem modi ea est." } ] }, { "id": "4b3786c8-9d3a-4cad-a6fe-3dc89434af1f", "display_name": "ondricka.example", "groups": [], "culled_timestamp": "2034-12-12T14:44:47.796Z", "stale_timestamp": "2034-11-28T14:44:47.796Z", "stale_warning_timestamp": "2034-12-05T14:44:47.796Z", "updated": "2024-11-28T14:44:47.796Z", "insights_id": null, "tags": [ { "key": "interface", "value": "neural", "namespace": "calculating" }, { "key": "feed", "value": "haptic", "namespace": "transmitting" }, { "key": "interface", "value": "1080p", "namespace": "synthesizing" }, { "key": "card", "value": "neural", "namespace": "hacking" }, { "key": "transmitter", "value": "digital", "namespace": "backing up" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "91fc41c4-d911-4821-b7d0-8efd3768007a", "title": "Voluptatem modi ea est." } ] }, { "id": "5009bfc5-d6eb-4798-bbc1-758e00439fe1", "display_name": "thiel.example", "groups": [], "culled_timestamp": "2034-12-12T14:44:47.815Z", "stale_timestamp": "2034-11-28T14:44:47.815Z", "stale_warning_timestamp": "2034-12-05T14:44:47.815Z", "updated": "2024-11-28T14:44:47.815Z", "insights_id": null, "tags": [ { "key": "card", "value": "solid state", "namespace": "synthesizing" }, { "key": "matrix", "value": "cross-platform", "namespace": "bypassing" }, { "key": "port", "value": "auxiliary", "namespace": "quantifying" }, { "key": "alarm", "value": "digital", "namespace": "quantifying" }, { "key": "firewall", "value": "mobile", "namespace": "copying" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "91fc41c4-d911-4821-b7d0-8efd3768007a", "title": "Voluptatem modi ea est." } ] } ], "meta": { "total": 25, "tags": [], "limit": 10, "offset": 0, "sort_by": "os_minor_version" }, "links": { "first": "/api/compliance/v2/reports/91fc41c4-d911-4821-b7d0-8efd3768007a/systems?limit=10&offset=0&sort_by=os_minor_version", "last": "/api/compliance/v2/reports/91fc41c4-d911-4821-b7d0-8efd3768007a/systems?limit=10&offset=20&sort_by=os_minor_version", "next": "/api/compliance/v2/reports/91fc41c4-d911-4821-b7d0-8efd3768007a/systems?limit=10&offset=10&sort_by=os_minor_version" } }, "summary": "", "description": "" }, "List of Systems filtered by \"(os_minor_version=0)\"": { "value": { "data": [ { "id": "0d0aca32-aa8c-4501-bcb2-2264f388978d", "display_name": "larson.example", "groups": [], "culled_timestamp": "2034-12-12T14:44:48.204Z", "stale_timestamp": "2034-11-28T14:44:48.204Z", "stale_warning_timestamp": "2034-12-05T14:44:48.204Z", "updated": "2024-11-28T14:44:48.204Z", "insights_id": null, "tags": [ { "key": "feed", "value": "redundant", "namespace": "synthesizing" }, { "key": "card", "value": "wireless", "namespace": "bypassing" }, { "key": "panel", "value": "haptic", "namespace": "synthesizing" }, { "key": "array", "value": "virtual", "namespace": "overriding" }, { "key": "alarm", "value": "optical", "namespace": "bypassing" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "273485e3-6e7c-4b29-b88f-e63e816f685f", "title": "Eaque laboriosam praesentium quo." } ] }, { "id": "368bc0f2-0764-43a0-8cd3-b4657aea31c3", "display_name": "volkman.test", "groups": [], "culled_timestamp": "2034-12-12T14:44:48.210Z", "stale_timestamp": "2034-11-28T14:44:48.210Z", "stale_warning_timestamp": "2034-12-05T14:44:48.210Z", "updated": "2024-11-28T14:44:48.210Z", "insights_id": null, "tags": [ { "key": "port", "value": "optical", "namespace": "hacking" }, { "key": "application", "value": "virtual", "namespace": "synthesizing" }, { "key": "system", "value": "open-source", "namespace": "copying" }, { "key": "transmitter", "value": "wireless", "namespace": "calculating" }, { "key": "array", "value": "primary", "namespace": "synthesizing" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "273485e3-6e7c-4b29-b88f-e63e816f685f", "title": "Eaque laboriosam praesentium quo." } ] }, { "id": "3a7bc429-7ad7-4636-9a7b-fec788f0c9b3", "display_name": "fahey.example", "groups": [], "culled_timestamp": "2034-12-12T14:44:48.234Z", "stale_timestamp": "2034-11-28T14:44:48.234Z", "stale_warning_timestamp": "2034-12-05T14:44:48.234Z", "updated": "2024-11-28T14:44:48.234Z", "insights_id": null, "tags": [ { "key": "feed", "value": "redundant", "namespace": "navigating" }, { "key": "circuit", "value": "auxiliary", "namespace": "calculating" }, { "key": "capacitor", "value": "neural", "namespace": "backing up" }, { "key": "capacitor", "value": "neural", "namespace": "indexing" }, { "key": "application", "value": "haptic", "namespace": "programming" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "273485e3-6e7c-4b29-b88f-e63e816f685f", "title": "Eaque laboriosam praesentium quo." } ] }, { "id": "4404d52b-a80c-4fca-ac7b-e5b17807f9db", "display_name": "kohler.example", "groups": [], "culled_timestamp": "2034-12-12T14:44:48.191Z", "stale_timestamp": "2034-11-28T14:44:48.191Z", "stale_warning_timestamp": "2034-12-05T14:44:48.191Z", "updated": "2024-11-28T14:44:48.191Z", "insights_id": null, "tags": [ { "key": "system", "value": "mobile", "namespace": "synthesizing" }, { "key": "panel", "value": "mobile", "namespace": "synthesizing" }, { "key": "alarm", "value": "neural", "namespace": "parsing" }, { "key": "card", "value": "primary", "namespace": "synthesizing" }, { "key": "bandwidth", "value": "optical", "namespace": "copying" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "273485e3-6e7c-4b29-b88f-e63e816f685f", "title": "Eaque laboriosam praesentium quo." } ] }, { "id": "493dcd85-6d90-4259-b009-7f96ffe01df2", "display_name": "hayes.test", "groups": [], "culled_timestamp": "2034-12-12T14:44:48.196Z", "stale_timestamp": "2034-11-28T14:44:48.196Z", "stale_warning_timestamp": "2034-12-05T14:44:48.196Z", "updated": "2024-11-28T14:44:48.196Z", "insights_id": null, "tags": [ { "key": "hard drive", "value": "virtual", "namespace": "generating" }, { "key": "interface", "value": "back-end", "namespace": "synthesizing" }, { "key": "microchip", "value": "mobile", "namespace": "calculating" }, { "key": "hard drive", "value": "virtual", "namespace": "programming" }, { "key": "protocol", "value": "primary", "namespace": "compressing" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "273485e3-6e7c-4b29-b88f-e63e816f685f", "title": "Eaque laboriosam praesentium quo." } ] }, { "id": "4a2a7c4e-9407-4ba9-9c18-c20b62b4884a", "display_name": "mayert.test", "groups": [], "culled_timestamp": "2034-12-12T14:44:48.214Z", "stale_timestamp": "2034-11-28T14:44:48.214Z", "stale_warning_timestamp": "2034-12-05T14:44:48.214Z", "updated": "2024-11-28T14:44:48.214Z", "insights_id": null, "tags": [ { "key": "matrix", "value": "back-end", "namespace": "compressing" }, { "key": "application", "value": "virtual", "namespace": "backing up" }, { "key": "protocol", "value": "back-end", "namespace": "quantifying" }, { "key": "monitor", "value": "digital", "namespace": "programming" }, { "key": "alarm", "value": "virtual", "namespace": "calculating" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "273485e3-6e7c-4b29-b88f-e63e816f685f", "title": "Eaque laboriosam praesentium quo." } ] }, { "id": "4e812f68-da8f-4717-94cd-73abd26350bf", "display_name": "bednar.test", "groups": [], "culled_timestamp": "2034-12-12T14:44:48.224Z", "stale_timestamp": "2034-11-28T14:44:48.224Z", "stale_warning_timestamp": "2034-12-05T14:44:48.224Z", "updated": "2024-11-28T14:44:48.224Z", "insights_id": null, "tags": [ { "key": "bus", "value": "bluetooth", "namespace": "parsing" }, { "key": "protocol", "value": "wireless", "namespace": "transmitting" }, { "key": "transmitter", "value": "solid state", "namespace": "calculating" }, { "key": "sensor", "value": "1080p", "namespace": "compressing" }, { "key": "protocol", "value": "wireless", "namespace": "overriding" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "273485e3-6e7c-4b29-b88f-e63e816f685f", "title": "Eaque laboriosam praesentium quo." } ] }, { "id": "500e28c4-2ab0-40a6-9e37-e9daaa88e5a4", "display_name": "rohan.example", "groups": [], "culled_timestamp": "2034-12-12T14:44:48.162Z", "stale_timestamp": "2034-11-28T14:44:48.162Z", "stale_warning_timestamp": "2034-12-05T14:44:48.162Z", "updated": "2024-11-28T14:44:48.162Z", "insights_id": null, "tags": [ { "key": "pixel", "value": "virtual", "namespace": "hacking" }, { "key": "firewall", "value": "cross-platform", "namespace": "quantifying" }, { "key": "array", "value": "bluetooth", "namespace": "programming" }, { "key": "circuit", "value": "multi-byte", "namespace": "compressing" }, { "key": "port", "value": "multi-byte", "namespace": "connecting" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "273485e3-6e7c-4b29-b88f-e63e816f685f", "title": "Eaque laboriosam praesentium quo." } ] }, { "id": "541610af-4542-4736-a019-e9f6a396cdad", "display_name": "jast-blanda.test", "groups": [], "culled_timestamp": "2034-12-12T14:44:48.177Z", "stale_timestamp": "2034-11-28T14:44:48.177Z", "stale_warning_timestamp": "2034-12-05T14:44:48.177Z", "updated": "2024-11-28T14:44:48.177Z", "insights_id": null, "tags": [ { "key": "alarm", "value": "neural", "namespace": "navigating" }, { "key": "monitor", "value": "back-end", "namespace": "bypassing" }, { "key": "protocol", "value": "haptic", "namespace": "backing up" }, { "key": "panel", "value": "multi-byte", "namespace": "synthesizing" }, { "key": "monitor", "value": "auxiliary", "namespace": "navigating" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "273485e3-6e7c-4b29-b88f-e63e816f685f", "title": "Eaque laboriosam praesentium quo." } ] }, { "id": "7c267f1c-ddf4-4ecc-b2c5-07f94eed1db0", "display_name": "christiansen.example", "groups": [], "culled_timestamp": "2034-12-12T14:44:48.152Z", "stale_timestamp": "2034-11-28T14:44:48.152Z", "stale_warning_timestamp": "2034-12-05T14:44:48.152Z", "updated": "2024-11-28T14:44:48.152Z", "insights_id": null, "tags": [ { "key": "monitor", "value": "bluetooth", "namespace": "bypassing" }, { "key": "system", "value": "primary", "namespace": "compressing" }, { "key": "capacitor", "value": "1080p", "namespace": "copying" }, { "key": "port", "value": "open-source", "namespace": "compressing" }, { "key": "feed", "value": "1080p", "namespace": "connecting" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "273485e3-6e7c-4b29-b88f-e63e816f685f", "title": "Eaque laboriosam praesentium quo." } ] } ], "meta": { "total": 25, "filter": "(os_minor_version=0)", "tags": [], "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/reports/273485e3-6e7c-4b29-b88f-e63e816f685f/systems?filter=%28os_minor_version%3D0%29&limit=10&offset=0", "last": "/api/compliance/v2/reports/273485e3-6e7c-4b29-b88f-e63e816f685f/systems?filter=%28os_minor_version%3D0%29&limit=10&offset=20", "next": "/api/compliance/v2/reports/273485e3-6e7c-4b29-b88f-e63e816f685f/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": "42a143f7-e38f-4aed-bff7-2855770b4ecb", "display_name": "wolff.example", "groups": [], "culled_timestamp": "2034-12-12T14:44:49.451Z", "stale_timestamp": "2034-11-28T14:44:49.451Z", "stale_warning_timestamp": "2034-12-05T14:44:49.451Z", "updated": "2024-11-28T14:44:49.451Z", "insights_id": null, "tags": [ { "key": "monitor", "value": "neural", "namespace": "parsing" }, { "key": "firewall", "value": "optical", "namespace": "connecting" }, { "key": "transmitter", "value": "haptic", "namespace": "compressing" }, { "key": "bandwidth", "value": "wireless", "namespace": "bypassing" }, { "key": "program", "value": "wireless", "namespace": "calculating" } ], "type": "system", "os_major_version": 8, "os_minor_version": 0, "policies": [ { "id": "293509da-bf18-4db5-9ebe-559244e782ef", "title": "Unde molestiae et eaque." } ] } }, "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 78f3dd5e-1559-4900-bb02-09d73c70416c" ] }, "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": "0070d964-fa4f-4cbe-b7e1-c152659900a2", "profile_id": "e1146add-d22e-4b3b-989b-346d33557f40", "os_minor_version": 1, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "847d732f-7931-492d-abe0-56bcad1a37b5", "security_guide_version": "100.94.47" }, { "id": "01f2d9a9-5e46-451d-a04b-f1df6ace1efa", "profile_id": "b27bf490-8a89-442d-8a12-7cffdaf06d08", "os_minor_version": 24, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "59a3bf9d-ebfd-4de6-bd0a-2406e13918fa", "security_guide_version": "100.95.20" }, { "id": "111bf6e8-3186-497d-909c-0ac44b703fc4", "profile_id": "440e0b7f-6384-4865-b4b7-bbf49b559ad6", "os_minor_version": 6, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "88c4dfc9-41c5-4f30-9add-9691f5ffee1d", "security_guide_version": "100.95.2" }, { "id": "2dc82346-fb4c-4537-8761-43ebd92f1c85", "profile_id": "87488e46-ce7a-4d52-a683-3757329afb05", "os_minor_version": 21, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "3e1c5153-858c-4e2d-a57e-1a07fd3a0877", "security_guide_version": "100.95.17" }, { "id": "35ea604e-e806-4a47-b81b-2c464104c465", "profile_id": "9823d83d-b0c7-4086-8a8c-cc8a247a13cb", "os_minor_version": 16, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "89ec68b5-b7d7-4172-8e88-84061f2de347", "security_guide_version": "100.95.12" }, { "id": "3f0333c3-3ce2-4c98-84ec-a5b890722937", "profile_id": "a2a0dc27-46a8-4589-8495-cceec9eefa87", "os_minor_version": 5, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "992b5fad-47de-4da2-b113-8cd7bb6514af", "security_guide_version": "100.95.1" }, { "id": "58c97c82-6ded-453f-a3f4-cf2bd52a32b7", "profile_id": "8db826d6-1462-4e82-af42-e37be5126d97", "os_minor_version": 7, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "5a9eac9c-31c6-46e2-8f23-f63bd873f7a6", "security_guide_version": "100.95.3" }, { "id": "5bce265b-feed-4813-addc-5cd59980ed84", "profile_id": "2e15c702-82e9-4ca9-add4-5c645e83020d", "os_minor_version": 17, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "14d87b34-66e2-45d1-b4b3-dc07c679e4e0", "security_guide_version": "100.95.13" }, { "id": "63c93652-21be-4130-8fcc-04626ff062d1", "profile_id": "d4e0f3e0-d0c1-43e6-8498-1866015c7066", "os_minor_version": 3, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "52c68113-b7ed-40a3-83f2-57600812e495", "security_guide_version": "100.94.49" }, { "id": "66dd3236-f4e6-4022-a11e-79645be35dc2", "profile_id": "266047a6-1c46-46cd-9e62-9b521f4d9e4d", "os_minor_version": 20, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "e90e6493-d2db-4aff-8a26-197116807269", "security_guide_version": "100.95.16" } ], "meta": { "total": 25, "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/policies/09c811e3-d88b-488f-ad61-f77b62d3ccc7/tailorings?limit=10&offset=0", "last": "/api/compliance/v2/policies/09c811e3-d88b-488f-ad61-f77b62d3ccc7/tailorings?limit=10&offset=20", "next": "/api/compliance/v2/policies/09c811e3-d88b-488f-ad61-f77b62d3ccc7/tailorings?limit=10&offset=10" } }, "summary": "", "description": "" }, "List of Tailorings sorted by \"os_minor_version:asc\"": { "value": { "data": [ { "id": "141add09-f0cf-42bc-9710-53e164bdc606", "profile_id": "77f97495-d5ab-45b3-b060-cc3ae2dfd9cb", "os_minor_version": 0, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "026ef2ab-9c45-4187-bdcc-07ba52d8b212", "security_guide_version": "100.95.21" }, { "id": "18aff3b3-c78b-401c-9037-96dccff2191f", "profile_id": "92f910b4-38a2-4d9f-aead-eeb6f874aa25", "os_minor_version": 1, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "10913670-e457-4977-ae4d-a33544bbdf96", "security_guide_version": "100.95.22" }, { "id": "0a164c53-8da1-43d6-9172-492625e3f3ea", "profile_id": "f520822f-9b7a-412d-bd3d-60a731072d9d", "os_minor_version": 2, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "dcb44a32-62ef-49ea-ac84-9710ce0d3a69", "security_guide_version": "100.95.23" }, { "id": "00d2b438-21e7-4cc5-99ca-7d1ca474115b", "profile_id": "1a730c8d-793f-4819-944f-87ff3c004700", "os_minor_version": 3, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "cd605e32-ddbb-4a81-8f1d-81176dc2ed73", "security_guide_version": "100.95.24" }, { "id": "d78c6599-d568-46e1-bc46-3669a69ad89d", "profile_id": "c28a3f7c-eca5-46e7-a23a-26868cf48f0b", "os_minor_version": 4, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "c4b54d5c-4e0b-4b38-89f6-3ad058db9e0f", "security_guide_version": "100.95.25" }, { "id": "e56f8e96-3f02-4d0e-ade9-869d2d77bfd0", "profile_id": "4fd93d7f-f3c2-4091-9879-fbc876554d0a", "os_minor_version": 5, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "a71a4a35-62dc-4809-99c7-ae41370a25e5", "security_guide_version": "100.95.26" }, { "id": "8a3d46eb-d20b-4413-96c1-2b8915c7ac69", "profile_id": "56d444c6-e68a-4913-802e-1c19d8743fe2", "os_minor_version": 6, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "85951a41-00ef-4b13-b811-ffb5fee16fd3", "security_guide_version": "100.95.27" }, { "id": "0a908eef-6b5b-4bb0-9164-4248b336d4e7", "profile_id": "e5dd7553-f7ac-4ba9-a325-164886827342", "os_minor_version": 7, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "79520e7c-82e2-4150-ae4f-9e6e9a234eff", "security_guide_version": "100.95.28" }, { "id": "d182e2eb-a289-4cd0-beed-0a19daf57bc0", "profile_id": "f19d2431-0828-4727-94f9-e9c2732ebf7a", "os_minor_version": 8, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "198b3dfe-a9e8-42f9-92ce-a111f954a33f", "security_guide_version": "100.95.29" }, { "id": "f94ac5e3-bd2d-44cc-a518-7583b0a25ba6", "profile_id": "504e7a21-3395-42ee-996d-8ba9ea7b4a69", "os_minor_version": 9, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "a6829b7f-bc99-4557-8378-0de5d1b1c8c8", "security_guide_version": "100.95.30" } ], "meta": { "total": 25, "limit": 10, "offset": 0, "sort_by": "os_minor_version" }, "links": { "first": "/api/compliance/v2/policies/008ad7c0-a52b-46b3-b9b5-8ca247d9efb1/tailorings?limit=10&offset=0&sort_by=os_minor_version", "last": "/api/compliance/v2/policies/008ad7c0-a52b-46b3-b9b5-8ca247d9efb1/tailorings?limit=10&offset=20&sort_by=os_minor_version", "next": "/api/compliance/v2/policies/008ad7c0-a52b-46b3-b9b5-8ca247d9efb1/tailorings?limit=10&offset=10&sort_by=os_minor_version" } }, "summary": "", "description": "" }, "List of Tailorings filtered by '(os_minor_version=7)'": { "value": { "data": [ { "id": "07bae846-dde1-424e-be16-b484d0e837c7", "profile_id": "a9364b4d-4538-4b89-899f-88ffa4109776", "os_minor_version": 7, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "f84b7e85-3dbc-4b5f-862e-16a29f217c07", "security_guide_version": "100.96.3" } ], "meta": { "total": 1, "filter": "(os_minor_version=7)", "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/policies/efe5b7bd-1986-4aa9-b8e5-1e119e8d90c6/tailorings?filter=%28os_minor_version%3D7%29&limit=10&offset=0", "last": "/api/compliance/v2/policies/efe5b7bd-1986-4aa9-b8e5-1e119e8d90c6/tailorings?filter=%28os_minor_version%3D7%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": "c1f6baf0-1d15-4482-84cb-39e38a63bf84", "profile_id": "5ae27341-48a5-4d30-bfbd-32c336cf2507", "os_minor_version": 1, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "e8aa3675-09e2-4658-809b-66b67f6b032a", "security_guide_version": "100.97.21" } }, "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": "2272998e-9831-480e-b729-7bcbb329581c", "profile_id": "b6de4fb3-c8af-432d-94f4-ae6f142eca3a", "os_minor_version": 1, "value_overrides": {}, "type": "tailoring", "os_major_version": 7, "security_guide_id": "83c016e1-dd92-41db-a150-5c7591d80286", "security_guide_version": "100.97.22" } }, "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 ffd9cfa2-add8-4a18-8d74-b563c925810d" ] }, "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": "1b7ad8ae-2f88-4595-8e48-9cb0d4130c2a", "profile_id": "c60bb065-9723-483a-aa55-a9a19b10590c", "os_minor_version": 1, "value_overrides": { "affdddd0-b04f-4dce-8807-c930ba3ce9c6": "123" }, "type": "tailoring", "os_major_version": 7, "security_guide_id": "5e63cb93-ed5c-47b9-97e5-3e1e9c209f62", "security_guide_version": "100.97.23" } }, "summary": "", "description": "" } }, "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/tailoring" } } } } } } } } }, "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/tailoring" } } } } } }, "/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": "155ed68c-7292-428a-b828-4edc7ae2b93a", "type": "rule_group", "children": [ { "id": "2641bbc3-b49e-414d-a75d-3f81c18a4f46", "type": "rule" } ] }, { "id": "38f05daa-17c8-4567-9ff3-bc0fb46fc4bc", "type": "rule_group", "children": [ { "id": "1055c724-e5a7-458d-8940-e55510ed0ad7", "type": "rule" } ] }, { "id": "8c392ab2-b534-4135-9988-4736c6e15458", "type": "rule_group", "children": [ { "id": "8e8513a9-0b6e-4ebd-a7e5-105177853517", "type": "rule" } ] }, { "id": "fcc6ed2a-3863-4d26-99ad-8acb8b041c8f", "type": "rule_group", "children": [ { "id": "b6978cf0-0f01-4b72-b4bc-e913df540c33", "type": "rule" } ] }, { "id": "2137903e-c193-4eca-a432-c1b95f06293e", "type": "rule_group", "children": [ { "id": "f1c00296-da83-447e-934b-6865ec4adba7", "type": "rule" } ] }, { "id": "667529fb-3a4e-4c6e-b248-0bf87e019689", "type": "rule_group", "children": [ { "id": "9ae028d0-3103-4546-9977-a0e287faafdf", "type": "rule" } ] }, { "id": "1388bc5c-df36-4a2b-ad2a-55aab1d048ab", "type": "rule_group", "children": [ { "id": "a1403617-4e26-4e8a-a653-dd35b80794c2", "type": "rule" } ] }, { "id": "824f5ea7-eda0-4292-a346-9197fc6f6ef4", "type": "rule_group", "children": [ { "id": "099b1c23-bdc0-4a49-ace0-f1c0fbbe377b", "type": "rule" } ] }, { "id": "3c90595b-25c4-442e-acfa-21401f462e7b", "type": "rule_group", "children": [ { "id": "5f9c2501-9635-40b3-8d6a-761aee2cbd2a", "type": "rule" } ] }, { "id": "014233b4-6ff9-498b-b546-742366b568eb", "type": "rule_group", "children": [ { "id": "8ab1c245-54b2-41b1-bb30-55dff809b085", "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 0770b19a-a44d-49cf-890d-29a66e6cf36a" ] }, "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_b4aa84d27bdd65b2a6980e0017716e56", "title": "Laborum molestiae rerum necessitatibus.", "groups": {}, "rules": {}, "variables": { "foo_value_1e61d78b-ff38-4bc6-8313-e4c8fb381a5c": { "value": "997961" }, "foo_value_e429b140-7577-43ed-9771-7323a23cbb04": { "value": "28854" } } } ] }, "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": "07d4f276-df3d-4eee-91e5-f2fb5afdbd15", "end_time": "2024-11-28T14:43:51.448Z", "failed_rule_count": 0, "supported": true, "score": 64.74321837224612, "type": "test_result", "display_name": "kling.test", "groups": [], "tags": [ { "key": "circuit", "value": "digital", "namespace": "bypassing" }, { "key": "array", "value": "1080p", "namespace": "hacking" }, { "key": "program", "value": "haptic", "namespace": "copying" }, { "key": "feed", "value": "redundant", "namespace": "compressing" }, { "key": "alarm", "value": "online", "namespace": "calculating" } ], "os_major_version": 8, "os_minor_version": 0, "compliant": false, "system_id": "4dc21983-65ab-4e56-91c3-d1eb5eadb101", "security_guide_version": "100.99.45" }, { "id": "117c309f-cca6-479f-b53b-e11901901057", "end_time": "2024-11-28T14:43:51.388Z", "failed_rule_count": 0, "supported": true, "score": 95.58479212926116, "type": "test_result", "display_name": "hettinger.example", "groups": [], "tags": [ { "key": "array", "value": "solid state", "namespace": "overriding" }, { "key": "panel", "value": "neural", "namespace": "backing up" }, { "key": "microchip", "value": "haptic", "namespace": "overriding" }, { "key": "feed", "value": "wireless", "namespace": "navigating" }, { "key": "feed", "value": "digital", "namespace": "parsing" } ], "os_major_version": 8, "os_minor_version": 0, "compliant": true, "system_id": "86190da6-5980-4019-bd54-0f6fda28a3dc", "security_guide_version": "100.99.45" }, { "id": "21da774e-54e0-4583-98e4-c4a5d80ac119", "end_time": "2024-11-28T14:43:51.414Z", "failed_rule_count": 0, "supported": true, "score": 8.969810229212971, "type": "test_result", "display_name": "jacobson-bogan.example", "groups": [], "tags": [ { "key": "firewall", "value": "bluetooth", "namespace": "quantifying" }, { "key": "application", "value": "haptic", "namespace": "synthesizing" }, { "key": "pixel", "value": "wireless", "namespace": "synthesizing" }, { "key": "application", "value": "1080p", "namespace": "compressing" }, { "key": "panel", "value": "virtual", "namespace": "generating" } ], "os_major_version": 8, "os_minor_version": 0, "compliant": false, "system_id": "63ac8f27-e78f-4925-9c68-69bc35c8e32d", "security_guide_version": "100.99.45" }, { "id": "23d3b9db-328c-4f48-b5c2-536a937251b5", "end_time": "2024-11-28T14:43:51.348Z", "failed_rule_count": 0, "supported": true, "score": 50.71910006006622, "type": "test_result", "display_name": "fritsch.example", "groups": [], "tags": [ { "key": "pixel", "value": "open-source", "namespace": "programming" }, { "key": "card", "value": "online", "namespace": "hacking" }, { "key": "monitor", "value": "auxiliary", "namespace": "connecting" }, { "key": "driver", "value": "open-source", "namespace": "transmitting" }, { "key": "firewall", "value": "open-source", "namespace": "navigating" } ], "os_major_version": 8, "os_minor_version": 0, "compliant": false, "system_id": "5ff97a6a-99fd-4d07-819b-68ceab05c3f1", "security_guide_version": "100.99.45" }, { "id": "23e99ce4-d983-4b78-9e50-f924dedd772b", "end_time": "2024-11-28T14:43:51.325Z", "failed_rule_count": 0, "supported": true, "score": 76.54042057594283, "type": "test_result", "display_name": "wolf-wolff.example", "groups": [], "tags": [ { "key": "sensor", "value": "multi-byte", "namespace": "bypassing" }, { "key": "bandwidth", "value": "digital", "namespace": "copying" }, { "key": "program", "value": "neural", "namespace": "quantifying" }, { "key": "bandwidth", "value": "cross-platform", "namespace": "programming" }, { "key": "circuit", "value": "primary", "namespace": "bypassing" } ], "os_major_version": 8, "os_minor_version": 0, "compliant": false, "system_id": "a1696c75-4d1c-4cf4-9350-ccd187e2220e", "security_guide_version": "100.99.45" }, { "id": "43ed94c8-192f-4ec3-a261-7d44900288e8", "end_time": "2024-11-28T14:43:51.312Z", "failed_rule_count": 0, "supported": true, "score": 11.93536251421712, "type": "test_result", "display_name": "waters.test", "groups": [], "tags": [ { "key": "driver", "value": "redundant", "namespace": "copying" }, { "key": "monitor", "value": "open-source", "namespace": "bypassing" }, { "key": "bus", "value": "multi-byte", "namespace": "quantifying" }, { "key": "card", "value": "bluetooth", "namespace": "generating" }, { "key": "card", "value": "cross-platform", "namespace": "compressing" } ], "os_major_version": 8, "os_minor_version": 0, "compliant": false, "system_id": "3735b68d-7fa1-4620-b993-9f9c930d5b3e", "security_guide_version": "100.99.45" }, { "id": "57dacc3d-c576-4001-95b3-327c9d555e4b", "end_time": "2024-11-28T14:43:51.453Z", "failed_rule_count": 0, "supported": true, "score": 27.94674415070214, "type": "test_result", "display_name": "stark.test", "groups": [], "tags": [ { "key": "bandwidth", "value": "neural", "namespace": "parsing" }, { "key": "transmitter", "value": "digital", "namespace": "calculating" }, { "key": "sensor", "value": "1080p", "namespace": "bypassing" }, { "key": "array", "value": "cross-platform", "namespace": "quantifying" }, { "key": "bus", "value": "solid state", "namespace": "hacking" } ], "os_major_version": 8, "os_minor_version": 0, "compliant": false, "system_id": "075e53a5-ce0e-4b72-87bc-7e7e5272b76a", "security_guide_version": "100.99.45" }, { "id": "5a7e6622-86ec-417d-bd9e-4853c1d182e8", "end_time": "2024-11-28T14:43:51.354Z", "failed_rule_count": 0, "supported": true, "score": 87.73526596285234, "type": "test_result", "display_name": "feest-robel.example", "groups": [], "tags": [ { "key": "card", "value": "bluetooth", "namespace": "indexing" }, { "key": "array", "value": "redundant", "namespace": "navigating" }, { "key": "feed", "value": "multi-byte", "namespace": "navigating" }, { "key": "application", "value": "digital", "namespace": "parsing" }, { "key": "pixel", "value": "haptic", "namespace": "copying" } ], "os_major_version": 8, "os_minor_version": 0, "compliant": false, "system_id": "3cd2e780-5e2e-49c1-af2f-6a398806387f", "security_guide_version": "100.99.45" }, { "id": "5b3e2576-89e3-4514-ae4d-8d133a86bb0c", "end_time": "2024-11-28T14:43:51.331Z", "failed_rule_count": 0, "supported": true, "score": 10.06279518572617, "type": "test_result", "display_name": "konopelski.example", "groups": [], "tags": [ { "key": "transmitter", "value": "optical", "namespace": "overriding" }, { "key": "bandwidth", "value": "mobile", "namespace": "programming" }, { "key": "system", "value": "auxiliary", "namespace": "backing up" }, { "key": "sensor", "value": "redundant", "namespace": "calculating" }, { "key": "port", "value": "auxiliary", "namespace": "programming" } ], "os_major_version": 8, "os_minor_version": 0, "compliant": false, "system_id": "79f44c5e-c739-4f3b-ab41-a00ca4a08e8a", "security_guide_version": "100.99.45" }, { "id": "60ddc92f-0725-4f7e-9d49-c41fb2990054", "end_time": "2024-11-28T14:43:51.436Z", "failed_rule_count": 0, "supported": true, "score": 54.51951091159077, "type": "test_result", "display_name": "carter.example", "groups": [], "tags": [ { "key": "system", "value": "cross-platform", "namespace": "hacking" }, { "key": "monitor", "value": "online", "namespace": "overriding" }, { "key": "system", "value": "solid state", "namespace": "copying" }, { "key": "bandwidth", "value": "open-source", "namespace": "backing up" }, { "key": "circuit", "value": "wireless", "namespace": "navigating" } ], "os_major_version": 8, "os_minor_version": 0, "compliant": false, "system_id": "f18e8ab6-39ec-4283-8474-e3e36595cfb1", "security_guide_version": "100.99.45" } ], "meta": { "total": 25, "tags": [], "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/reports/8c6485fc-7f36-4981-a21c-6fa7c914c63a/test_results?limit=10&offset=0", "last": "/api/compliance/v2/reports/8c6485fc-7f36-4981-a21c-6fa7c914c63a/test_results?limit=10&offset=20", "next": "/api/compliance/v2/reports/8c6485fc-7f36-4981-a21c-6fa7c914c63a/test_results?limit=10&offset=10" } }, "summary": "", "description": "" }, "List of Test Results sorted by \"score:asc\"": { "value": { "data": [ { "id": "1c7f1b65-1f19-4043-9404-e1fb834ae15d", "end_time": "2024-11-28T14:43:51.708Z", "failed_rule_count": 0, "supported": true, "score": 2.382693535155089, "type": "test_result", "display_name": "wiegand.example", "groups": [], "tags": [ { "key": "port", "value": "cross-platform", "namespace": "parsing" }, { "key": "pixel", "value": "primary", "namespace": "parsing" }, { "key": "bus", "value": "cross-platform", "namespace": "quantifying" }, { "key": "driver", "value": "neural", "namespace": "generating" }, { "key": "firewall", "value": "1080p", "namespace": "compressing" } ], "os_major_version": 8, "os_minor_version": 0, "compliant": false, "system_id": "00fd5937-5370-40cc-a18d-89df5bb15ef8", "security_guide_version": "100.101.8" }, { "id": "8ea42d12-df22-480a-a003-3f9d50ce17f7", "end_time": "2024-11-28T14:43:51.676Z", "failed_rule_count": 0, "supported": true, "score": 18.51043276331846, "type": "test_result", "display_name": "okuneva-wuckert.test", "groups": [], "tags": [ { "key": "matrix", "value": "cross-platform", "namespace": "parsing" }, { "key": "driver", "value": "wireless", "namespace": "indexing" }, { "key": "monitor", "value": "multi-byte", "namespace": "calculating" }, { "key": "capacitor", "value": "primary", "namespace": "programming" }, { "key": "capacitor", "value": "neural", "namespace": "navigating" } ], "os_major_version": 8, "os_minor_version": 0, "compliant": false, "system_id": "05d15279-b3eb-4418-ae12-12762b0ea6d8", "security_guide_version": "100.101.8" }, { "id": "8ebda2ab-edb7-4df5-ad42-ee13f2b47b3a", "end_time": "2024-11-28T14:43:51.808Z", "failed_rule_count": 0, "supported": true, "score": 20.87209476501004, "type": "test_result", "display_name": "reilly-kozey.example", "groups": [], "tags": [ { "key": "bus", "value": "open-source", "namespace": "quantifying" }, { "key": "alarm", "value": "open-source", "namespace": "compressing" }, { "key": "program", "value": "virtual", "namespace": "compressing" }, { "key": "bus", "value": "1080p", "namespace": "navigating" }, { "key": "interface", "value": "cross-platform", "namespace": "synthesizing" } ], "os_major_version": 8, "os_minor_version": 0, "compliant": false, "system_id": "a6985c0e-5b1b-4acd-bfbb-484eef21c103", "security_guide_version": "100.101.8" }, { "id": "8de36f0b-0134-4617-ad10-541605fad422", "end_time": "2024-11-28T14:43:51.719Z", "failed_rule_count": 0, "supported": true, "score": 21.20423073126508, "type": "test_result", "display_name": "flatley.test", "groups": [], "tags": [ { "key": "firewall", "value": "optical", "namespace": "overriding" }, { "key": "program", "value": "primary", "namespace": "generating" }, { "key": "pixel", "value": "virtual", "namespace": "quantifying" }, { "key": "hard drive", "value": "digital", "namespace": "connecting" }, { "key": "card", "value": "multi-byte", "namespace": "compressing" } ], "os_major_version": 8, "os_minor_version": 0, "compliant": false, "system_id": "d93d71cc-7240-4ccd-b111-373f1f785538", "security_guide_version": "100.101.8" }, { "id": "eb22ac2e-43c9-4ff2-8ead-0ac653ec6449", "end_time": "2024-11-28T14:43:51.697Z", "failed_rule_count": 0, "supported": true, "score": 21.23787097553609, "type": "test_result", "display_name": "aufderhar.example", "groups": [], "tags": [ { "key": "program", "value": "neural", "namespace": "compressing" }, { "key": "hard drive", "value": "virtual", "namespace": "quantifying" }, { "key": "bus", "value": "digital", "namespace": "navigating" }, { "key": "matrix", "value": "redundant", "namespace": "calculating" }, { "key": "interface", "value": "optical", "namespace": "parsing" } ], "os_major_version": 8, "os_minor_version": 0, "compliant": false, "system_id": "e8e05259-da2b-4f9e-85b1-a92b29255947", "security_guide_version": "100.101.8" }, { "id": "d2594e1c-bf2e-4388-84fc-3398112fb86b", "end_time": "2024-11-28T14:43:51.681Z", "failed_rule_count": 0, "supported": true, "score": 24.5579680463506, "type": "test_result", "display_name": "morar.test", "groups": [], "tags": [ { "key": "driver", "value": "bluetooth", "namespace": "indexing" }, { "key": "firewall", "value": "primary", "namespace": "programming" }, { "key": "driver", "value": "neural", "namespace": "hacking" }, { "key": "system", "value": "redundant", "namespace": "synthesizing" }, { "key": "feed", "value": "mobile", "namespace": "synthesizing" } ], "os_major_version": 8, "os_minor_version": 0, "compliant": false, "system_id": "05b7e306-94e3-4ad6-b8c2-299949f92a65", "security_guide_version": "100.101.8" }, { "id": "ed8aedd4-15f8-4dcc-a180-2ee7d009016c", "end_time": "2024-11-28T14:43:51.657Z", "failed_rule_count": 0, "supported": true, "score": 31.95029772959636, "type": "test_result", "display_name": "rolfson.example", "groups": [], "tags": [ { "key": "alarm", "value": "virtual", "namespace": "compressing" }, { "key": "firewall", "value": "haptic", "namespace": "compressing" }, { "key": "sensor", "value": "back-end", "namespace": "calculating" }, { "key": "bandwidth", "value": "neural", "namespace": "overriding" }, { "key": "pixel", "value": "bluetooth", "namespace": "generating" } ], "os_major_version": 8, "os_minor_version": 0, "compliant": false, "system_id": "2ac2e5c6-75a1-42d4-a2ef-6818805aa004", "security_guide_version": "100.101.8" }, { "id": "1e6bdb2f-5482-4092-a289-ff349c8cf27a", "end_time": "2024-11-28T14:43:51.802Z", "failed_rule_count": 0, "supported": true, "score": 38.37081487054051, "type": "test_result", "display_name": "quitzon-lebsack.example", "groups": [], "tags": [ { "key": "firewall", "value": "primary", "namespace": "compressing" }, { "key": "interface", "value": "neural", "namespace": "connecting" }, { "key": "application", "value": "neural", "namespace": "navigating" }, { "key": "driver", "value": "open-source", "namespace": "bypassing" }, { "key": "microchip", "value": "neural", "namespace": "generating" } ], "os_major_version": 8, "os_minor_version": 0, "compliant": false, "system_id": "7eed25bc-4504-4eea-872c-a1a04baeb65c", "security_guide_version": "100.101.8" }, { "id": "106f063b-0430-4275-b1f0-538482d4196b", "end_time": "2024-11-28T14:43:51.702Z", "failed_rule_count": 0, "supported": true, "score": 44.43230616684835, "type": "test_result", "display_name": "swift.test", "groups": [], "tags": [ { "key": "pixel", "value": "1080p", "namespace": "overriding" }, { "key": "bandwidth", "value": "online", "namespace": "backing up" }, { "key": "microchip", "value": "wireless", "namespace": "overriding" }, { "key": "pixel", "value": "mobile", "namespace": "transmitting" }, { "key": "application", "value": "digital", "namespace": "quantifying" } ], "os_major_version": 8, "os_minor_version": 0, "compliant": false, "system_id": "323b5350-f2ef-458c-b2a8-a59643af20b2", "security_guide_version": "100.101.8" }, { "id": "032a1d80-f5ad-43c8-9ce2-367f72f2075a", "end_time": "2024-11-28T14:43:51.670Z", "failed_rule_count": 0, "supported": true, "score": 47.57812626906297, "type": "test_result", "display_name": "orn.test", "groups": [], "tags": [ { "key": "driver", "value": "optical", "namespace": "copying" }, { "key": "protocol", "value": "online", "namespace": "indexing" }, { "key": "pixel", "value": "bluetooth", "namespace": "bypassing" }, { "key": "bandwidth", "value": "back-end", "namespace": "parsing" }, { "key": "panel", "value": "digital", "namespace": "generating" } ], "os_major_version": 8, "os_minor_version": 0, "compliant": false, "system_id": "a2fb116e-1444-4eb7-94a6-068fa394d3af", "security_guide_version": "100.101.8" } ], "meta": { "total": 25, "tags": [], "limit": 10, "offset": 0, "sort_by": "score" }, "links": { "first": "/api/compliance/v2/reports/5351a772-6334-41f9-8d74-d5c311133297/test_results?limit=10&offset=0&sort_by=score", "last": "/api/compliance/v2/reports/5351a772-6334-41f9-8d74-d5c311133297/test_results?limit=10&offset=20&sort_by=score", "next": "/api/compliance/v2/reports/5351a772-6334-41f9-8d74-d5c311133297/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/768c39ba-dcc9-4df0-9c01-28fee0725274/test_results?filter=%28os_minor_version%3D8%29&limit=10&offset=0", "last": "/api/compliance/v2/reports/768c39ba-dcc9-4df0-9c01-28fee0725274/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.107.11" ], "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": "4473df3c-2e9f-4c13-9442-fdc59f590a93", "end_time": "2024-11-28T14:43:53.849Z", "failed_rule_count": 0, "supported": true, "score": 12.01468076429843, "type": "test_result", "display_name": "erdman.test", "groups": [], "tags": [ { "key": "monitor", "value": "solid state", "namespace": "connecting" }, { "key": "transmitter", "value": "back-end", "namespace": "hacking" }, { "key": "array", "value": "virtual", "namespace": "generating" }, { "key": "hard drive", "value": "redundant", "namespace": "synthesizing" }, { "key": "hard drive", "value": "haptic", "namespace": "hacking" } ], "os_major_version": 8, "os_minor_version": 0, "compliant": false, "system_id": "3e6926e0-71ee-47df-bd82-2fa0297bc8d5", "security_guide_version": "100.108.25" } }, "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 610b8193-f23d-4d61-90b0-3b0d59ffc0d6" ] }, "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": "1d56a0a4-caa1-4a28-99da-d5c0208e4cfd", "ref_id": "foo_value_72f5e98a-32cb-48ab-b007-a97e404c4e95", "title": "Omnis fugit aspernatur eaque.", "description": "Neque sapiente non. Non labore fuga. Ex et voluptas.", "value_type": "number", "default_value": "0.589420703645653", "type": "value_definition" }, { "id": "3158bbcf-43f6-49d8-be5a-7fd282924162", "ref_id": "foo_value_6db73f5a-8ccb-4c9d-b082-9a99d8c2a550", "title": "Ipsum veritatis qui est.", "description": "Qui libero distinctio. Quidem distinctio animi. Quo ipsum optio.", "value_type": "number", "default_value": "0.10480660595148761", "type": "value_definition" }, { "id": "362bf500-8e22-498e-867e-f565e3bc7b79", "ref_id": "foo_value_e472e92c-7a52-4a55-9289-653a78183223", "title": "Quam et et reiciendis.", "description": "In rerum id. Laudantium provident est. Non optio est.", "value_type": "number", "default_value": "0.5502292206508375", "type": "value_definition" }, { "id": "3e13f50a-8503-4a08-928a-0a0355c016e4", "ref_id": "foo_value_bc8790ae-5c89-4501-955f-20a1d99d4b79", "title": "Reiciendis impedit ducimus eos.", "description": "Rerum voluptates et. Vero omnis consequatur. Iure at fuga.", "value_type": "number", "default_value": "0.3903416182522993", "type": "value_definition" }, { "id": "45421a83-dd46-426b-a065-19ec889a7deb", "ref_id": "foo_value_55c51f4a-a44b-4101-81c4-4836027671b0", "title": "Natus consequatur laborum molestiae.", "description": "Accusantium ut laboriosam. Quaerat et odio. Et qui ipsam.", "value_type": "number", "default_value": "0.061075273799558905", "type": "value_definition" }, { "id": "4b29f76d-9c91-403b-a01f-68b81dda3a06", "ref_id": "foo_value_30dda532-8b6c-4ed5-9a55-b085d2219554", "title": "Illum numquam et error.", "description": "Voluptates ratione nostrum. Est possimus cumque. Non voluptas ut.", "value_type": "number", "default_value": "0.10856737161472019", "type": "value_definition" }, { "id": "536fa9e8-953d-4548-aa4a-ec6b7b3cc502", "ref_id": "foo_value_d264f0a6-c2d9-4378-b81f-1da0dea63ecc", "title": "Voluptas corrupti et facere.", "description": "Nulla iusto veritatis. Ea sit modi. Qui facere ducimus.", "value_type": "number", "default_value": "0.09911864172750628", "type": "value_definition" }, { "id": "55587d9a-50e2-446a-b6c1-8de492f99d19", "ref_id": "foo_value_208ac5d4-d002-43ec-a7a5-076c43064982", "title": "Quaerat aliquid id dolores.", "description": "Illo animi ipsam. Perferendis modi officiis. Reiciendis ad voluptates.", "value_type": "number", "default_value": "0.37229609800727104", "type": "value_definition" }, { "id": "6300d1ee-3902-4d54-aa58-52e02b7cb7b4", "ref_id": "foo_value_c43060b0-c11a-4495-9dd3-e984ab83db6a", "title": "Non doloremque aperiam est.", "description": "Dolore quia odio. Magnam laborum dolores. Numquam asperiores aperiam.", "value_type": "number", "default_value": "0.20602296657054553", "type": "value_definition" }, { "id": "73d12986-1fff-460f-9c2b-093e4a12eb63", "ref_id": "foo_value_e5603489-7c7e-4409-9473-8f09bffc2bd2", "title": "Quia officia dignissimos neque.", "description": "Repudiandae vitae temporibus. Est vel fugit. Rerum aut aut.", "value_type": "number", "default_value": "0.754290300686453", "type": "value_definition" } ], "meta": { "total": 25, "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/security_guides/69d23e25-f8e4-4d5e-b078-801db7564602/value_definitions?limit=10&offset=0", "last": "/api/compliance/v2/security_guides/69d23e25-f8e4-4d5e-b078-801db7564602/value_definitions?limit=10&offset=20", "next": "/api/compliance/v2/security_guides/69d23e25-f8e4-4d5e-b078-801db7564602/value_definitions?limit=10&offset=10" } }, "summary": "", "description": "" }, "List of Value Definitions sorted by \"title:asc\"": { "value": { "data": [ { "id": "166c9c26-a5df-4014-a1c6-5788f71b77cc", "ref_id": "foo_value_f1913688-715b-4ab2-8de8-af07a72ddb0c", "title": "Aliquid et voluptates atque.", "description": "Et sit facilis. Corrupti qui harum. Impedit magnam consequatur.", "value_type": "number", "default_value": "0.05089852792241878", "type": "value_definition" }, { "id": "97b68a52-1847-4054-b37e-e97c692ed95a", "ref_id": "foo_value_4d2781a2-d540-48a8-851e-a17db17c8103", "title": "Assumenda minus praesentium est.", "description": "Temporibus sapiente repudiandae. Id officia dolorem. Fuga culpa sed.", "value_type": "number", "default_value": "0.945740997200241", "type": "value_definition" }, { "id": "9d220726-9bc5-4f49-83a7-c8382872a7fa", "ref_id": "foo_value_80246b05-921a-4f10-bda8-18fe12d56ea9", "title": "Atque reiciendis sint excepturi.", "description": "Ut corporis soluta. Quos omnis veritatis. Id quidem omnis.", "value_type": "number", "default_value": "0.5622905854278331", "type": "value_definition" }, { "id": "cf81d615-f66e-41b0-9a59-363d26c83a2c", "ref_id": "foo_value_8f40b717-64d7-408e-9dd0-35202f9f0f7e", "title": "Deleniti modi qui a.", "description": "Provident at et. Sunt repellendus harum. Suscipit repellendus voluptatem.", "value_type": "number", "default_value": "0.6472340748827418", "type": "value_definition" }, { "id": "90577cb7-591f-4308-b858-81aa5eb60084", "ref_id": "foo_value_9f3c44a4-eb97-47df-9279-ebf57c913212", "title": "Deserunt qui deleniti eaque.", "description": "Aliquid delectus doloremque. Distinctio enim illo. Nam autem nihil.", "value_type": "number", "default_value": "0.35107395021818744", "type": "value_definition" }, { "id": "3ae5de67-c682-4384-beaf-23ffa1ca6367", "ref_id": "foo_value_4d5aec95-6bec-49eb-af5d-6560d176013f", "title": "Ea voluptas rem ut.", "description": "Ullam rerum veritatis. Vero et aut. Consequatur aspernatur dolorem.", "value_type": "number", "default_value": "0.4282655901567878", "type": "value_definition" }, { "id": "8435151d-ce0b-4350-b338-d31090eb1a85", "ref_id": "foo_value_2e37315e-940e-4cfd-8375-8cf04b597655", "title": "Eos voluptate nulla ut.", "description": "Quos aspernatur quam. Eos voluptas sunt. Iure eius architecto.", "value_type": "number", "default_value": "0.5307343951334518", "type": "value_definition" }, { "id": "80533c01-dcae-4d4d-b91f-c0f072a1a9ba", "ref_id": "foo_value_4564ab32-97ec-4c05-bec8-0ca0434af427", "title": "Esse quos dolorum fugiat.", "description": "Et ut quos. Libero quis voluptatem. Enim velit tempore.", "value_type": "number", "default_value": "0.5326454279941517", "type": "value_definition" }, { "id": "8287cedb-74f7-4c22-8ec0-ec118f871f2f", "ref_id": "foo_value_269ed0b8-765d-4890-88c4-ca5270dedd17", "title": "Est omnis et quis.", "description": "Inventore dolorum eos. Excepturi officia distinctio. Perspiciatis tempora nihil.", "value_type": "number", "default_value": "0.22735720813295468", "type": "value_definition" }, { "id": "a8424070-8eae-47b6-94d6-a628c86e641a", "ref_id": "foo_value_63661654-25af-49ae-9aa7-b71459fab1f3", "title": "Et ipsum animi blanditiis.", "description": "Voluptatibus laborum ratione. Et eos voluptatem. Tempore nam aut.", "value_type": "number", "default_value": "0.12736505520937802", "type": "value_definition" } ], "meta": { "total": 25, "limit": 10, "offset": 0, "sort_by": "title" }, "links": { "first": "/api/compliance/v2/security_guides/44e5669c-3d55-42a0-b567-a5833dd7d0f5/value_definitions?limit=10&offset=0&sort_by=title", "last": "/api/compliance/v2/security_guides/44e5669c-3d55-42a0-b567-a5833dd7d0f5/value_definitions?limit=10&offset=20&sort_by=title", "next": "/api/compliance/v2/security_guides/44e5669c-3d55-42a0-b567-a5833dd7d0f5/value_definitions?limit=10&offset=10&sort_by=title" } }, "summary": "", "description": "" }, "List of Value Definitions filtered by '(title=Earum ut commodi et.)'": { "value": { "data": [ { "id": "0611031d-4892-4c79-aaf5-3287b53cc4f1", "ref_id": "foo_value_d50e660e-2cf4-449f-a8c2-bec0815c55cd", "title": "Earum ut commodi et.", "description": "Odio veritatis ratione. Ducimus officia quisquam. Minus ea facilis.", "value_type": "number", "default_value": "0.16987610007671716", "type": "value_definition" } ], "meta": { "total": 1, "filter": "(title=\"Earum ut commodi et.\")", "limit": 10, "offset": 0 }, "links": { "first": "/api/compliance/v2/security_guides/1368a922-68ab-45aa-a6f4-22a4e9b0f833/value_definitions?filter=%28title%3D%22Earum+ut+commodi+et.%22%29&limit=10&offset=0", "last": "/api/compliance/v2/security_guides/1368a922-68ab-45aa-a6f4-22a4e9b0f833/value_definitions?filter=%28title%3D%22Earum+ut+commodi+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/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": "ee632933-4124-4638-b519-0933e8344d3e", "ref_id": "foo_value_73cab56e-fa64-4035-9b83-2b35215b6a49", "title": "Natus voluptatem ut in.", "description": "Minima sit nobis. Ipsam error repudiandae. Delectus nulla sed.", "value_type": "number", "default_value": "0.2255550691632362", "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 28e974e7-52ee-4fdb-889e-7cbee91708f0" ] }, "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:rhel6|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:rhel6|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" ] }, "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": [ { "dfce8ca4-c36f-4d9e-b2c2-f6cdcc62b30c": "foo", "6bd616ea-20b7-4f0d-af02-f4104f193e44": "123", "7472e746-10e8-481e-a7d6-40e873965314": "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" } } } } } }