debian-image-builder-frontend/api/schema/compliance.json
2024-11-26 13:03:55 +01:00

17414 lines
No EOL
725 KiB
JSON

{
"openapi": "3.1.0",
"info": {
"title": "Cloud Services for RHEL Compliance API v2",
"version": "v2",
"description": "UNDER DEVELOPMENT: This version of the API is not fully done and some parts of it might change! 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 (`<key>:asc` or `<key>:desc`).<br><br>If no direction is selected, `<key>: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 <a href=\"https://github.com/wvanbergen/scoped_search/wiki/Query-language\" target=\"_blank\" title=\"github.com/wvanbergen/scoped_search\">scoped_search query language</a>. However, only `=` or `!=` (resp. `<>`) operators are supported.<br><br>Policies are searchable using attributes `title`, `os_major_version`, and `os_minor_version`<br><br>(e.g.: `(field_1=something AND field_2!=\"something else\") OR field_3>40`)",
"schema": {
"type": "string"
}
}
],
"tags": [
"Policies"
],
"description": "Lists Policies",
"operationId": "Policies",
"responses": {
"200": {
"description": "Lists Policies",
"content": {
"application/vnd.api+json": {
"examples": {
"List of Policies": {
"value": {
"data": [
{
"id": "2084643d-c456-4274-a985-e2cd3e10325d",
"title": "Esse voluptatem magnam enim.",
"description": "Vero sequi est. Adipisci eius accusantium. Assumenda voluptatem repellat.",
"business_objective": null,
"compliance_threshold": 48.0,
"total_system_count": 0,
"type": "policy",
"os_major_version": 7,
"profile_title": "Commodi enim aut ea.",
"ref_id": "xccdf_org.ssgproject.content_profile_49090fa3ced93d91ad09c2b543af3821"
},
{
"id": "2895b784-1d7e-4252-beba-d00de5bfa92b",
"title": "Tenetur voluptatem nihil blanditiis.",
"description": "Aliquam perferendis enim. Ipsum quae alias. Voluptas error alias.",
"business_objective": null,
"compliance_threshold": 34.0,
"total_system_count": 0,
"type": "policy",
"os_major_version": 7,
"profile_title": "Iusto magni velit et.",
"ref_id": "xccdf_org.ssgproject.content_profile_8d1ef038a2b37b4e1079b3a708d19edb"
},
{
"id": "331c9db6-260a-463a-b4e7-4b8f0fc59be7",
"title": "Voluptas id aspernatur quia.",
"description": "Vel ea repellat. Dolorem ut consequuntur. Labore magni aut.",
"business_objective": null,
"compliance_threshold": 67.0,
"total_system_count": 0,
"type": "policy",
"os_major_version": 7,
"profile_title": "Incidunt temporibus sunt est.",
"ref_id": "xccdf_org.ssgproject.content_profile_86b7d514d38a186228fba7992ef9ca1a"
},
{
"id": "39ad5051-89e6-4561-a349-c058f19449c4",
"title": "Ipsam quas quo a.",
"description": "Ducimus recusandae aut. Cupiditate eum vel. Totam eum earum.",
"business_objective": null,
"compliance_threshold": 19.0,
"total_system_count": 0,
"type": "policy",
"os_major_version": 7,
"profile_title": "Voluptas magni facilis soluta.",
"ref_id": "xccdf_org.ssgproject.content_profile_204e985df08262bbfff1685d63adf8a6"
},
{
"id": "4922dec9-6143-4592-9fef-97f5db65aa7e",
"title": "Ut molestiae possimus qui.",
"description": "Totam saepe facilis. Aut vel non. Eius est aut.",
"business_objective": null,
"compliance_threshold": 83.0,
"total_system_count": 0,
"type": "policy",
"os_major_version": 7,
"profile_title": "Est alias eum labore.",
"ref_id": "xccdf_org.ssgproject.content_profile_495ee50c1296a24245d22b85e92c7254"
},
{
"id": "52dd1d8c-587f-4a1c-8eeb-12ec199e72f4",
"title": "Iste labore ut sunt.",
"description": "Magnam perferendis sapiente. Nihil nihil sed. Rerum eum dicta.",
"business_objective": null,
"compliance_threshold": 81.0,
"total_system_count": 0,
"type": "policy",
"os_major_version": 7,
"profile_title": "Maiores consectetur molestias rerum.",
"ref_id": "xccdf_org.ssgproject.content_profile_a709362c8073ed23367054fb8984e6a1"
},
{
"id": "59c96dcb-39d1-4ca1-93d7-4f6f65d88c77",
"title": "Officiis explicabo ab tempora.",
"description": "Fugit necessitatibus est. Odit ut aperiam. Enim et rerum.",
"business_objective": null,
"compliance_threshold": 48.0,
"total_system_count": 0,
"type": "policy",
"os_major_version": 7,
"profile_title": "Labore sunt repellat maxime.",
"ref_id": "xccdf_org.ssgproject.content_profile_5dfc0cf99a9285a80501e6030c892aee"
},
{
"id": "66e9584d-3e45-4775-9a4e-33079cf7a679",
"title": "Nesciunt sequi debitis est.",
"description": "Facilis voluptatem quos. Corporis rerum qui. Dolorem vitae molestias.",
"business_objective": null,
"compliance_threshold": 90.0,
"total_system_count": 0,
"type": "policy",
"os_major_version": 7,
"profile_title": "Est repellendus rerum dolor.",
"ref_id": "xccdf_org.ssgproject.content_profile_1a39acfbbdde94cf9a6e351da86360b4"
},
{
"id": "705bb0f5-2d19-4a8e-a9d3-698f54bc9b3e",
"title": "Eos distinctio adipisci accusantium.",
"description": "Quos natus nisi. Illo et sunt. Esse id ducimus.",
"business_objective": null,
"compliance_threshold": 29.0,
"total_system_count": 0,
"type": "policy",
"os_major_version": 7,
"profile_title": "Voluptate accusamus explicabo quidem.",
"ref_id": "xccdf_org.ssgproject.content_profile_aee7d3e093821b29ecf61d5ff2b5d50f"
},
{
"id": "716c0bc9-3f08-4f90-883f-095070f5b6a8",
"title": "Quae molestiae voluptas et.",
"description": "Qui magni quam. Qui natus dolorum. Ipsam quam architecto.",
"business_objective": null,
"compliance_threshold": 38.0,
"total_system_count": 0,
"type": "policy",
"os_major_version": 7,
"profile_title": "Enim molestias dolorem possimus.",
"ref_id": "xccdf_org.ssgproject.content_profile_a87e5ec1e070f20d841a2ff475b9fa28"
}
],
"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": "0216cf98-7a70-4d69-884d-9e957ac8dd23",
"title": "Ab qui facere et.",
"description": "Consequatur dolor aspernatur. Minima animi qui. Veniam vitae est.",
"business_objective": null,
"compliance_threshold": 87.0,
"total_system_count": 0,
"type": "policy",
"os_major_version": 7,
"profile_title": "Alias nihil possimus facilis.",
"ref_id": "xccdf_org.ssgproject.content_profile_3ac3d50a49f0de7f03cd34668026a7f1"
},
{
"id": "08730d58-c0e3-4512-8851-91db229cbe07",
"title": "Soluta nihil harum praesentium.",
"description": "Vel veritatis quo. Quia necessitatibus aut. Modi error ratione.",
"business_objective": null,
"compliance_threshold": 49.0,
"total_system_count": 0,
"type": "policy",
"os_major_version": 7,
"profile_title": "Quam aperiam dignissimos eos.",
"ref_id": "xccdf_org.ssgproject.content_profile_4146d1d830dbba9d448048423505bed9"
},
{
"id": "2173ca8f-5873-495f-a961-f28eb9ce312b",
"title": "Quasi ex sed et.",
"description": "Eius nobis consequuntur. Qui voluptatum perspiciatis. Et quam quia.",
"business_objective": null,
"compliance_threshold": 96.0,
"total_system_count": 0,
"type": "policy",
"os_major_version": 7,
"profile_title": "Labore delectus praesentium a.",
"ref_id": "xccdf_org.ssgproject.content_profile_b860b2e389fd5ba62aecadfeed567b40"
},
{
"id": "26f8f367-6c5c-4ecf-b405-9290612bc090",
"title": "Quia sed beatae provident.",
"description": "Officia quis repellat. Sunt eum hic. Voluptas assumenda et.",
"business_objective": null,
"compliance_threshold": 32.0,
"total_system_count": 0,
"type": "policy",
"os_major_version": 7,
"profile_title": "Tempore nisi et voluptatem.",
"ref_id": "xccdf_org.ssgproject.content_profile_9276333c880b8a8b4b47b9fdfa3e8162"
},
{
"id": "2a3e4b4d-e3df-4398-bfea-6175f9729949",
"title": "Et ut consectetur ut.",
"description": "Dignissimos et expedita. Blanditiis laudantium voluptas. Accusantium iusto esse.",
"business_objective": null,
"compliance_threshold": 13.0,
"total_system_count": 0,
"type": "policy",
"os_major_version": 7,
"profile_title": "Repellat veniam sunt tempora.",
"ref_id": "xccdf_org.ssgproject.content_profile_25b2135ec4881bb048d37d7a69658981"
},
{
"id": "2c0ab18b-e453-4f8c-bc0c-05df0f1f165a",
"title": "Aut quod ea quibusdam.",
"description": "Tempore qui perferendis. Voluptates maiores ab. Totam sint dolorem.",
"business_objective": null,
"compliance_threshold": 7.0,
"total_system_count": 0,
"type": "policy",
"os_major_version": 7,
"profile_title": "Doloribus voluptatibus labore alias.",
"ref_id": "xccdf_org.ssgproject.content_profile_2c0a5f348341ae158ba2e087d12aa24a"
},
{
"id": "35db7ec9-0d4f-45da-9a06-57e1571a64f4",
"title": "Minus nesciunt et pariatur.",
"description": "Nisi voluptatem minus. Commodi est impedit. Voluptatem accusamus sed.",
"business_objective": null,
"compliance_threshold": 68.0,
"total_system_count": 0,
"type": "policy",
"os_major_version": 7,
"profile_title": "Voluptatem magnam aut saepe.",
"ref_id": "xccdf_org.ssgproject.content_profile_3fc5ea6bc620094db74a10da71e73136"
},
{
"id": "3ef1e4ea-a755-46f7-8419-30e6281df112",
"title": "Reiciendis quam necessitatibus eos.",
"description": "Illum totam provident. Atque minima officia. Nobis ut occaecati.",
"business_objective": null,
"compliance_threshold": 93.0,
"total_system_count": 0,
"type": "policy",
"os_major_version": 7,
"profile_title": "Aut voluptatem et dicta.",
"ref_id": "xccdf_org.ssgproject.content_profile_f28ef0cb968f1074609b410d21dd8126"
},
{
"id": "426a4bea-e527-4de8-b885-a8196bef663a",
"title": "Impedit et nemo veritatis.",
"description": "Non hic molestiae. Quis non et. Quis laborum dignissimos.",
"business_objective": null,
"compliance_threshold": 31.0,
"total_system_count": 0,
"type": "policy",
"os_major_version": 7,
"profile_title": "Delectus quam fugit et.",
"ref_id": "xccdf_org.ssgproject.content_profile_effc90e67f81b3ec8c20a991716b4f49"
},
{
"id": "5346fc85-ac53-4deb-a5a5-8bc52bb942e1",
"title": "Occaecati molestiae dolorem accusamus.",
"description": "Accusantium temporibus quisquam. Molestiae asperiores veniam. Enim nemo deleniti.",
"business_objective": null,
"compliance_threshold": 33.0,
"total_system_count": 0,
"type": "policy",
"os_major_version": 7,
"profile_title": "Et omnis qui dolorem.",
"ref_id": "xccdf_org.ssgproject.content_profile_e13babc69b0b70199467116f3c5383fc"
}
],
"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 Policy with the provided attributes",
"operationId": "CreatePolicy",
"responses": {
"201": {
"description": "Creates a Policy",
"content": {
"application/vnd.api+json": {
"examples": {
"Response example": {
"value": {
"data": {
"id": "ab647248-648e-4fed-b74a-9cb084557feb",
"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": "Deleniti dolorum quas natus.",
"ref_id": "xccdf_org.ssgproject.content_profile_91a90c95617377921b7fcf76b6398ad6"
}
},
"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": "Returns a Policy",
"operationId": "Policy",
"responses": {
"200": {
"description": "Returns a Policy",
"content": {
"application/vnd.api+json": {
"examples": {
"Returns a Policy": {
"value": {
"data": {
"id": "6862a580-a0e3-4cb9-abd2-130e41aa9c48",
"title": "Unde ipsum et dignissimos.",
"description": "Impedit consequuntur rerum. Perferendis dolorem molestiae. Esse perferendis illum.",
"business_objective": null,
"compliance_threshold": 90.0,
"total_system_count": 0,
"type": "policy",
"os_major_version": 7,
"profile_title": "Veniam officiis eum enim.",
"ref_id": "xccdf_org.ssgproject.content_profile_0ac4131a9402b1ee1856be1974cacdf1"
}
},
"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 42dc33f3-79d7-4e98-8699-cbc6bc136532"
]
},
"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": "Updates a Policy with the provided attributes",
"operationId": "UpdatePolicy",
"responses": {
"202": {
"description": "Updates a Policy",
"content": {
"application/vnd.api+json": {
"examples": {
"Returns the updated Policy": {
"value": {
"data": {
"id": "fd842bf0-0d9b-4b94-907b-d5b3c8244a47",
"title": "Recusandae omnis debitis qui.",
"description": "Dolorum molestias corporis. Iure est repellendus. Quae harum veritatis.",
"business_objective": null,
"compliance_threshold": 100.0,
"total_system_count": 0,
"type": "policy",
"os_major_version": 7,
"profile_title": "Dolores tempore et voluptatem.",
"ref_id": "xccdf_org.ssgproject.content_profile_d996cd96246120643c6d53d92669cc61"
}
},
"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": "Deletes a Policy",
"operationId": "DeletePolicy",
"responses": {
"202": {
"description": "Deletes a Policy",
"content": {
"application/vnd.api+json": {
"examples": {
"Deletes a Policy": {
"value": {
"data": {
"id": "0ce2eba4-0d3b-477d-9333-683160e0c0b3",
"title": "Veniam illum aut porro.",
"description": "Corporis ipsum molestiae. Adipisci sit rerum. Sunt molestiae officiis.",
"business_objective": null,
"compliance_threshold": 3.0,
"total_system_count": 0,
"type": "policy",
"os_major_version": 7,
"profile_title": "Necessitatibus assumenda illo ut.",
"ref_id": "xccdf_org.ssgproject.content_profile_99306f8c8fe2fa129be25b1f4d6c0032"
}
},
"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 (`<key>:asc` or `<key>:desc`).<br><br>If no direction is selected, `<key>: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 <a href=\"https://github.com/wvanbergen/scoped_search/wiki/Query-language\" target=\"_blank\" title=\"github.com/wvanbergen/scoped_search\">scoped_search query language</a>. However, only `=` or `!=` (resp. `<>`) operators are supported.<br><br>Policies are searchable using attributes `title` and `os_minor_version`<br><br>(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": "Lists Policies under a System",
"operationId": "SystemsPolicies",
"responses": {
"200": {
"description": "Lists Policies",
"content": {
"application/vnd.api+json": {
"examples": {
"List of Policies under a System": {
"value": {
"data": [
{
"id": "0c004a78-1513-4745-83ce-5092a624268e",
"title": "Aperiam sed quia ducimus.",
"description": "Et voluptates quam. Rem veniam ipsum. Sed veniam harum.",
"business_objective": null,
"compliance_threshold": 31.0,
"total_system_count": 1,
"type": "policy",
"os_major_version": 7,
"profile_title": "Laboriosam deserunt magni qui.",
"ref_id": "xccdf_org.ssgproject.content_profile_e9a16c79d2f182c0ba8cc4c09042df4a"
},
{
"id": "0e8263c8-80f3-40c1-941c-34c62650b385",
"title": "Eius nostrum eum nihil.",
"description": "Iusto sed quidem. Et sapiente commodi. Sunt qui accusantium.",
"business_objective": null,
"compliance_threshold": 98.0,
"total_system_count": 1,
"type": "policy",
"os_major_version": 7,
"profile_title": "Sit ipsa iure suscipit.",
"ref_id": "xccdf_org.ssgproject.content_profile_3a189b0fb5e5f69eabe0e1263e9c324f"
},
{
"id": "105a6bcf-d299-4159-ae68-6e5e3d0582ce",
"title": "Consequuntur qui suscipit id.",
"description": "Impedit nesciunt cumque. Eum sunt quia. Ut inventore laboriosam.",
"business_objective": null,
"compliance_threshold": 95.0,
"total_system_count": 1,
"type": "policy",
"os_major_version": 7,
"profile_title": "Nulla ratione optio voluptatem.",
"ref_id": "xccdf_org.ssgproject.content_profile_9b2cfbf53965fde8624ffea3b2d30ac9"
},
{
"id": "16633d69-3659-48c9-a66a-74b42b4fec00",
"title": "Illo qui consequatur non.",
"description": "Dolorum ut et. Sunt alias vitae. Rerum qui eum.",
"business_objective": null,
"compliance_threshold": 53.0,
"total_system_count": 1,
"type": "policy",
"os_major_version": 7,
"profile_title": "Consequatur eaque et nihil.",
"ref_id": "xccdf_org.ssgproject.content_profile_0beafa9764338749ce50d794858170f8"
},
{
"id": "313cf3f1-e97c-4682-8f52-b7e7b3ebe41b",
"title": "Ea doloribus non vel.",
"description": "Ab maxime iure. Labore sed odio. Error non libero.",
"business_objective": null,
"compliance_threshold": 18.0,
"total_system_count": 1,
"type": "policy",
"os_major_version": 7,
"profile_title": "Recusandae voluptate minima minus.",
"ref_id": "xccdf_org.ssgproject.content_profile_24794210566822f04751abe1afc7d0e6"
},
{
"id": "5de28bf8-f8b6-44ea-8d52-d48f3e494009",
"title": "Sequi nemo quae aliquam.",
"description": "Quasi molestiae non. Suscipit ut iste. Occaecati velit ipsam.",
"business_objective": null,
"compliance_threshold": 26.0,
"total_system_count": 1,
"type": "policy",
"os_major_version": 7,
"profile_title": "Enim quo sed odio.",
"ref_id": "xccdf_org.ssgproject.content_profile_ed3eff4cefdf48836adece96b6699e44"
},
{
"id": "62c2302a-0ecd-441b-bc4c-78edd5559c13",
"title": "Dignissimos aperiam natus veniam.",
"description": "Vero sit ut. Commodi rem est. Voluptatem optio provident.",
"business_objective": null,
"compliance_threshold": 7.0,
"total_system_count": 1,
"type": "policy",
"os_major_version": 7,
"profile_title": "Ut ut et eveniet.",
"ref_id": "xccdf_org.ssgproject.content_profile_1d624c5e0c3f66929a691c5c1ed66a62"
},
{
"id": "63573b8b-84c5-4789-b763-5270c345e52f",
"title": "Illo quidem voluptatum est.",
"description": "In tempore repellat. Temporibus accusantium eos. Doloremque itaque placeat.",
"business_objective": null,
"compliance_threshold": 14.0,
"total_system_count": 1,
"type": "policy",
"os_major_version": 7,
"profile_title": "Et illum aut qui.",
"ref_id": "xccdf_org.ssgproject.content_profile_dcfd82851a24cc1a846c73d01b2cf82e"
},
{
"id": "6ba09c66-7ec4-496b-b816-bc2930e371c9",
"title": "Ducimus dolorem deleniti cupiditate.",
"description": "Alias exercitationem non. Nobis deserunt tempora. Et est consequatur.",
"business_objective": null,
"compliance_threshold": 78.0,
"total_system_count": 1,
"type": "policy",
"os_major_version": 7,
"profile_title": "Delectus placeat quibusdam molestiae.",
"ref_id": "xccdf_org.ssgproject.content_profile_53201fa6b42984976e14dcd7b474167c"
},
{
"id": "7af3bca2-d469-4933-800f-977c5281f40f",
"title": "Similique ab quis id.",
"description": "Iure provident maiores. Suscipit perferendis et. Dignissimos doloribus modi.",
"business_objective": null,
"compliance_threshold": 96.0,
"total_system_count": 1,
"type": "policy",
"os_major_version": 7,
"profile_title": "Ad ut provident facilis.",
"ref_id": "xccdf_org.ssgproject.content_profile_6c286484e620a1dd6d2476751bc19a1c"
}
],
"meta": {
"total": 25,
"limit": 10,
"offset": 0
},
"links": {
"first": "/api/compliance/v2/systems/d6c47793-5404-4361-96c9-c6216142bb28/policies?limit=10&offset=0",
"last": "/api/compliance/v2/systems/d6c47793-5404-4361-96c9-c6216142bb28/policies?limit=10&offset=20",
"next": "/api/compliance/v2/systems/d6c47793-5404-4361-96c9-c6216142bb28/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 (`<key>:asc` or `<key>:desc`).<br><br>If no direction is selected, `<key>: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 <a href=\"https://github.com/wvanbergen/scoped_search/wiki/Query-language\" target=\"_blank\" title=\"github.com/wvanbergen/scoped_search\">scoped_search query language</a>. However, only `=` or `!=` (resp. `<>`) operators are supported.<br><br>Profiles are searchable using attributes `title` and `ref_id`<br><br>(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": "Lists Profiles",
"operationId": "Profiles",
"responses": {
"200": {
"description": "Lists Profiles",
"content": {
"application/vnd.api+json": {
"examples": {
"List of Profiles": {
"value": {
"data": [
{
"id": "1689e86a-5d78-4c3b-8a3b-5558b63d8305",
"ref_id": "xccdf_org.ssgproject.content_profile_7c3c0fda748a44d6049ff4cd3a0fafea",
"title": "Accusamus error architecto voluptate.",
"description": "Quasi occaecati et. Sint sed dignissimos. Quia porro nam.",
"value_overrides": {},
"type": "profile"
},
{
"id": "1cfc74b9-36c2-41cb-a9ce-c4320dae3942",
"ref_id": "xccdf_org.ssgproject.content_profile_740687e589c32f0bf2eec497f9024b06",
"title": "Esse natus impedit vel.",
"description": "Dolores odit tempore. Sint laborum suscipit. Nihil est omnis.",
"value_overrides": {},
"type": "profile"
},
{
"id": "21a86e17-41d3-46ec-a8e0-f6de050723a8",
"ref_id": "xccdf_org.ssgproject.content_profile_e9e2ea0023845496e888df4895fcdc3d",
"title": "Asperiores nostrum ad pariatur.",
"description": "Quidem qui quae. Possimus suscipit dolorem. Quidem et omnis.",
"value_overrides": {},
"type": "profile"
},
{
"id": "264dabc6-e395-4b78-ae58-8bdba9bfc2b7",
"ref_id": "xccdf_org.ssgproject.content_profile_30190d4939ee59aade698a9d7c6a736d",
"title": "Et optio et ipsa.",
"description": "Asperiores numquam consectetur. Minus accusamus et. Porro corporis beatae.",
"value_overrides": {},
"type": "profile"
},
{
"id": "2e845d7c-dc5d-4ddf-80ec-c415929cbaca",
"ref_id": "xccdf_org.ssgproject.content_profile_3af52be8f9ef762321277a2709813828",
"title": "Aperiam suscipit tempora animi.",
"description": "Voluptates occaecati nulla. Eveniet ab sunt. Id enim labore.",
"value_overrides": {},
"type": "profile"
},
{
"id": "327c1f3c-fb29-4b9b-b821-884227619b72",
"ref_id": "xccdf_org.ssgproject.content_profile_98cb1c7d334097ae9c931ae4fd4c7020",
"title": "Neque placeat laboriosam et.",
"description": "Enim possimus perspiciatis. Ipsa id fuga. Architecto sed cum.",
"value_overrides": {},
"type": "profile"
},
{
"id": "3ae84d27-5fe1-481a-ac33-952800582aab",
"ref_id": "xccdf_org.ssgproject.content_profile_96acab6f1208e3143633e37f3787d50b",
"title": "Omnis aut aliquid perferendis.",
"description": "Repudiandae omnis rem. Impedit quo quia. Voluptates fugiat asperiores.",
"value_overrides": {},
"type": "profile"
},
{
"id": "3d83b982-a2bc-4893-be78-822146d313a6",
"ref_id": "xccdf_org.ssgproject.content_profile_4058f524d821b29a205d7cb09b4a807c",
"title": "Consequatur voluptates veritatis est.",
"description": "Odio quae iure. Unde numquam molestiae. Perferendis doloribus non.",
"value_overrides": {},
"type": "profile"
},
{
"id": "4ad2296d-015d-4ff7-94a5-64815b4b1793",
"ref_id": "xccdf_org.ssgproject.content_profile_da348adfed174780131526b00d70aa72",
"title": "Aliquid est velit minima.",
"description": "Voluptatum qui est. Velit non commodi. Quia maiores voluptatibus.",
"value_overrides": {},
"type": "profile"
},
{
"id": "4b2da52e-4cec-4f84-93ec-3433c78db9ce",
"ref_id": "xccdf_org.ssgproject.content_profile_10aa2f7ade58a85a57000d22a78c0328",
"title": "Autem similique delectus omnis.",
"description": "Neque sed nihil. Enim quasi vero. Sunt doloremque quibusdam.",
"value_overrides": {},
"type": "profile"
}
],
"meta": {
"total": 25,
"limit": 10,
"offset": 0
},
"links": {
"first": "/api/compliance/v2/security_guides/00704812-d469-4ad7-bd5c-9d86ba096abb/profiles?limit=10&offset=0",
"last": "/api/compliance/v2/security_guides/00704812-d469-4ad7-bd5c-9d86ba096abb/profiles?limit=10&offset=20",
"next": "/api/compliance/v2/security_guides/00704812-d469-4ad7-bd5c-9d86ba096abb/profiles?limit=10&offset=10"
}
},
"summary": "",
"description": ""
},
"List of Profiles sorted by \"title:asc\"": {
"value": {
"data": [
{
"id": "13518a6a-808f-47f1-b9fe-6163ac2005e4",
"ref_id": "xccdf_org.ssgproject.content_profile_75552cccff80ffe7c1a684b3ca9a04fc",
"title": "Ab explicabo delectus velit.",
"description": "Et quia eius. Possimus illo nemo. Odio in aut.",
"value_overrides": {},
"type": "profile"
},
{
"id": "b6a2373a-93ec-4a53-a2c3-2a466e05a8a2",
"ref_id": "xccdf_org.ssgproject.content_profile_278fa50e32dfe7c9a1adc70019ca46a9",
"title": "Ad magni omnis cumque.",
"description": "Commodi nulla soluta. Nulla repellat hic. Eos asperiores minima.",
"value_overrides": {},
"type": "profile"
},
{
"id": "1d2b4fd6-11aa-440d-ad83-d564ca26fcca",
"ref_id": "xccdf_org.ssgproject.content_profile_8143df760bede858e5d3070714d5a09a",
"title": "Assumenda itaque eum ipsum.",
"description": "Sit excepturi qui. Officiis modi voluptas. Accusantium hic odio.",
"value_overrides": {},
"type": "profile"
},
{
"id": "5f5d878c-bb67-4a03-8ad6-14a152bf3595",
"ref_id": "xccdf_org.ssgproject.content_profile_62418773c9bc0b066d51292b2b35b2e7",
"title": "At nihil facere accusantium.",
"description": "Tenetur excepturi corrupti. Enim consequatur sint. Commodi perspiciatis tenetur.",
"value_overrides": {},
"type": "profile"
},
{
"id": "f1c67f29-b0d9-4035-ae24-1fbe113739e4",
"ref_id": "xccdf_org.ssgproject.content_profile_3c284180fb3936b99b4312bb7e1c591e",
"title": "Aut in suscipit accusantium.",
"description": "Et cumque dolorem. Deserunt nam eum. Id nostrum reprehenderit.",
"value_overrides": {},
"type": "profile"
},
{
"id": "d73cc478-e665-4742-be1b-240c3e41e5c9",
"ref_id": "xccdf_org.ssgproject.content_profile_5bb6ec82a82a9b3d5679b463191a8f79",
"title": "Aut officiis velit inventore.",
"description": "Deserunt consectetur quisquam. Iure dolore consequuntur. Ad repellendus eius.",
"value_overrides": {},
"type": "profile"
},
{
"id": "f9b4918d-218c-4b4b-b277-0388b34a9f31",
"ref_id": "xccdf_org.ssgproject.content_profile_9dd426fb806283874fc8d298ed9e21a1",
"title": "Autem est animi reprehenderit.",
"description": "Qui quae explicabo. At consequatur fuga. Beatae itaque voluptatem.",
"value_overrides": {},
"type": "profile"
},
{
"id": "5e4c27ea-8f5a-4e7e-9ec2-781d55c0ecd1",
"ref_id": "xccdf_org.ssgproject.content_profile_a33cfec65e41ee8c84e3c1ee8cf82048",
"title": "Consequatur et excepturi quam.",
"description": "Placeat omnis omnis. Distinctio delectus qui. Debitis placeat aperiam.",
"value_overrides": {},
"type": "profile"
},
{
"id": "ef655721-ea47-4fc4-aee6-5b847b7a8967",
"ref_id": "xccdf_org.ssgproject.content_profile_446645d18ffdccda379824cb0e0ae000",
"title": "Cupiditate praesentium exercitationem error.",
"description": "Repudiandae omnis cum. Debitis quos ducimus. Ex ut est.",
"value_overrides": {},
"type": "profile"
},
{
"id": "a5990ace-93e6-4c17-bf44-a97591c5c2b4",
"ref_id": "xccdf_org.ssgproject.content_profile_b6c7ed5d9e8ced903b745914b8a63f33",
"title": "Deserunt aliquam praesentium sit.",
"description": "Accusantium placeat ut. Nam non voluptate. Quod corrupti rem.",
"value_overrides": {},
"type": "profile"
}
],
"meta": {
"total": 25,
"limit": 10,
"offset": 0,
"sort_by": "title"
},
"links": {
"first": "/api/compliance/v2/security_guides/b7d2c412-6dcc-4ea3-bc77-eb0aff566e96/profiles?limit=10&offset=0&sort_by=title",
"last": "/api/compliance/v2/security_guides/b7d2c412-6dcc-4ea3-bc77-eb0aff566e96/profiles?limit=10&offset=20&sort_by=title",
"next": "/api/compliance/v2/security_guides/b7d2c412-6dcc-4ea3-bc77-eb0aff566e96/profiles?limit=10&offset=10&sort_by=title"
}
},
"summary": "",
"description": ""
},
"List of Profiles filtered by '(title=Labore ea ut architecto.)'": {
"value": {
"data": [
{
"id": "034e5198-8f55-4313-b769-d8bf86324dd7",
"ref_id": "xccdf_org.ssgproject.content_profile_3a46d82bb84592d38bffc830c93dac94",
"title": "Labore ea ut architecto.",
"description": "Voluptates similique deserunt. Explicabo quisquam velit. Qui ex sed.",
"value_overrides": {},
"type": "profile"
}
],
"meta": {
"total": 1,
"filter": "(title=\"Labore ea ut architecto.\")",
"limit": 10,
"offset": 0
},
"links": {
"first": "/api/compliance/v2/security_guides/fdafad0c-6c01-4fd0-8635-20a2d7a12f57/profiles?filter=%28title%3D%22Labore+ea+ut+architecto.%22%29&limit=10&offset=0",
"last": "/api/compliance/v2/security_guides/fdafad0c-6c01-4fd0-8635-20a2d7a12f57/profiles?filter=%28title%3D%22Labore+ea+ut+architecto.%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": "Returns a Profile",
"operationId": "Profile",
"responses": {
"200": {
"description": "Returns a Profile",
"content": {
"application/vnd.api+json": {
"examples": {
"Returns a Profile": {
"value": {
"data": {
"id": "91b0c14e-84da-453d-ba7a-40b58e9280f2",
"ref_id": "xccdf_org.ssgproject.content_profile_744161f1b400de0f5778185cf7596290",
"title": "Asperiores id voluptate tempora.",
"description": "Ut nisi eum. Excepturi optio nemo. Rerum totam odit.",
"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 174aab8b-4fc1-4ff8-ad03-d84658bb8475"
]
},
"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",
"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": "14a0976c-5542-49b6-9b48-38adf2889c24",
"type": "rule_group",
"children": [
{
"id": "9719a223-c9b4-4529-ba7d-269ba0c309b8",
"type": "rule"
}
]
},
{
"id": "7d6bcd4e-fc4d-4a1d-a94d-f205e54b3a15",
"type": "rule_group",
"children": [
{
"id": "5679dd5c-ed00-43b7-ad42-bf00efc2cc56",
"type": "rule"
}
]
},
{
"id": "5ca05ab7-cb88-4fab-b723-2d3b1b4da085",
"type": "rule_group",
"children": [
{
"id": "9372d77c-cb8d-43ae-aca3-7a31dd5cf8cc",
"type": "rule"
}
]
},
{
"id": "d2dccec8-23d2-49b1-8f48-cd0a548be956",
"type": "rule_group",
"children": [
{
"id": "0d2334c0-37b8-416c-974e-de863e2b5af1",
"type": "rule"
}
]
},
{
"id": "ea7e9134-a0bb-49e9-b6e0-2bd0c485a213",
"type": "rule_group",
"children": [
{
"id": "dd79f620-7a33-4719-8614-a1ceb74eee1c",
"type": "rule"
}
]
},
{
"id": "bede0446-fd20-4d0c-b1f7-b8c2559ab3b1",
"type": "rule_group",
"children": [
{
"id": "ca2997e9-9eaf-4aaa-bcd7-de6b3c7ac0c9",
"type": "rule"
}
]
},
{
"id": "1155062e-4722-4ba0-80ab-166ed6e174e5",
"type": "rule_group",
"children": [
{
"id": "12469b9f-942a-4374-acff-7262efa6c5cf",
"type": "rule"
}
]
},
{
"id": "5a42b62c-52b2-4996-8910-ae95a91615ea",
"type": "rule_group",
"children": [
{
"id": "30630013-9f0b-4624-bb48-1d589babe597",
"type": "rule"
}
]
},
{
"id": "833b965d-af00-4a5c-8fcd-ee820722fc17",
"type": "rule_group",
"children": [
{
"id": "d29aadc0-3930-46a6-92ef-0a9f6faf3035",
"type": "rule"
}
]
},
{
"id": "62ddd992-abfd-42db-bd31-e29a8813caca",
"type": "rule_group",
"children": [
{
"id": "b6f649d3-1bdd-4eeb-bde1-5f084a1663d4",
"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 a65c9e41-018d-4d74-ba17-3d2ecc868bf3"
]
},
"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 (`<key>:asc` or `<key>:desc`).<br><br>If no direction is selected, `<key>: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 <a href=\"https://github.com/wvanbergen/scoped_search/wiki/Query-language\" target=\"_blank\" title=\"github.com/wvanbergen/scoped_search\">scoped_search query language</a>. However, only `=` or `!=` (resp. `<>`) operators are supported.<br><br>Reports are searchable using attributes `title`, `os_major_version`, `with_reported_systems`, and `percent_compliant`<br><br>(e.g.: `(field_1=something AND field_2!=\"something else\") OR field_3>40`)",
"schema": {
"type": "string"
}
}
],
"tags": [
"Reports"
],
"description": "Lists Reports",
"operationId": "Reports",
"responses": {
"200": {
"description": "Lists Reports",
"content": {
"application/vnd.api+json": {
"examples": {
"List of Reports": {
"value": {
"data": [
{
"id": "02ca856f-ef38-4c35-aba4-e5ceca1fcba2",
"title": "Veritatis rem maxime quia.",
"description": "Omnis mollitia nemo. Non quibusdam expedita. Enim nobis suscipit.",
"business_objective": "feed",
"compliance_threshold": 90.0,
"type": "report",
"os_major_version": 8,
"profile_title": "Magnam saepe exercitationem sit.",
"ref_id": "xccdf_org.ssgproject.content_profile_661f86aa5bfed8ad3256b685ac3a23a9",
"all_systems_exposed": true,
"percent_compliant": 25,
"assigned_system_count": 4,
"compliant_system_count": 1,
"unsupported_system_count": 2,
"reported_system_count": 4
},
{
"id": "534c3666-5f52-4a71-b02f-97b0ed9baddc",
"title": "Voluptates illo distinctio maiores.",
"description": "Sunt harum qui. Et et iusto. Sit quo doloribus.",
"business_objective": "driver",
"compliance_threshold": 90.0,
"type": "report",
"os_major_version": 8,
"profile_title": "Quaerat et eum reprehenderit.",
"ref_id": "xccdf_org.ssgproject.content_profile_1eb4c5cdc5795a08c59e3f37b66d7e9f",
"all_systems_exposed": true,
"percent_compliant": 25,
"assigned_system_count": 4,
"compliant_system_count": 1,
"unsupported_system_count": 2,
"reported_system_count": 4
},
{
"id": "b7ef0b6a-f617-4b76-8fe6-c16f511ff118",
"title": "Rerum dolores modi et.",
"description": "Ratione nesciunt cumque. Autem exercitationem quia. Quos vitae qui.",
"business_objective": "microchip",
"compliance_threshold": 90.0,
"type": "report",
"os_major_version": 8,
"profile_title": "Enim soluta ut fugiat.",
"ref_id": "xccdf_org.ssgproject.content_profile_5b68343c37a8f743fb2dfa60d47b629a",
"all_systems_exposed": true,
"percent_compliant": 25,
"assigned_system_count": 4,
"compliant_system_count": 1,
"unsupported_system_count": 2,
"reported_system_count": 4
},
{
"id": "bf614031-271d-4ff1-8ca3-bbdf4907d8ad",
"title": "Exercitationem voluptas pariatur doloribus.",
"description": "Sunt eius eos. Ut ut accusantium. Aliquam quia qui.",
"business_objective": "port",
"compliance_threshold": 90.0,
"type": "report",
"os_major_version": 8,
"profile_title": "Minima quis iste quisquam.",
"ref_id": "xccdf_org.ssgproject.content_profile_d4404ae6b9627a64ac1a816970ca056b",
"all_systems_exposed": true,
"percent_compliant": 25,
"assigned_system_count": 4,
"compliant_system_count": 1,
"unsupported_system_count": 2,
"reported_system_count": 4
},
{
"id": "bf6fbc53-7f95-4b0a-ac31-abf228699a79",
"title": "Quo doloremque dolorem quia.",
"description": "Voluptas occaecati eligendi. Quia molestiae iste. Consequatur non rerum.",
"business_objective": "hard drive",
"compliance_threshold": 90.0,
"type": "report",
"os_major_version": 8,
"profile_title": "Necessitatibus rerum non animi.",
"ref_id": "xccdf_org.ssgproject.content_profile_705c44f8278ddc31d2506f88906abebb",
"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": "1b2cbc83-3176-49e9-953c-5b170fd48cfc",
"title": "Consectetur sit molestias eum.",
"description": "Aut vitae neque. Illum maiores libero. Iusto aut quia.",
"business_objective": "program",
"compliance_threshold": 90.0,
"type": "report",
"os_major_version": 8,
"profile_title": "Sunt ut rerum nisi.",
"ref_id": "xccdf_org.ssgproject.content_profile_763e11e5426de71fa1a2d1f03498e334",
"all_systems_exposed": true,
"percent_compliant": 25,
"assigned_system_count": 4,
"compliant_system_count": 1,
"unsupported_system_count": 2,
"reported_system_count": 4
},
{
"id": "28d468aa-8c7e-44fb-9e92-7dffba34e812",
"title": "Velit quo totam ratione.",
"description": "Corrupti cupiditate magni. Sapiente rerum voluptatum. Excepturi et dolores.",
"business_objective": "port",
"compliance_threshold": 90.0,
"type": "report",
"os_major_version": 8,
"profile_title": "Ea blanditiis et inventore.",
"ref_id": "xccdf_org.ssgproject.content_profile_70a902db6ab11aae78dc70d6b748881d",
"all_systems_exposed": true,
"percent_compliant": 25,
"assigned_system_count": 4,
"compliant_system_count": 1,
"unsupported_system_count": 2,
"reported_system_count": 4
},
{
"id": "9702d58e-db15-4bd3-ab40-cfd63b70169e",
"title": "Praesentium amet ipsam reiciendis.",
"description": "Quod quasi eos. Rerum et doloremque. Omnis totam saepe.",
"business_objective": "interface",
"compliance_threshold": 90.0,
"type": "report",
"os_major_version": 8,
"profile_title": "Aut voluptatem quia totam.",
"ref_id": "xccdf_org.ssgproject.content_profile_01f00c165456fd03764c73c3f81c4007",
"all_systems_exposed": true,
"percent_compliant": 25,
"assigned_system_count": 4,
"compliant_system_count": 1,
"unsupported_system_count": 2,
"reported_system_count": 4
},
{
"id": "c61b9d00-2b1d-4b80-aa4b-e789fe0b3c2b",
"title": "Enim quibusdam occaecati temporibus.",
"description": "Et voluptas ut. Ut magni ratione. Sapiente ab ex.",
"business_objective": "transmitter",
"compliance_threshold": 90.0,
"type": "report",
"os_major_version": 8,
"profile_title": "Adipisci fugit dolorum sequi.",
"ref_id": "xccdf_org.ssgproject.content_profile_87480d535047364e6c1897038009b5ea",
"all_systems_exposed": true,
"percent_compliant": 25,
"assigned_system_count": 4,
"compliant_system_count": 1,
"unsupported_system_count": 2,
"reported_system_count": 4
},
{
"id": "eba0be98-29ba-406f-972d-7276b74aa6d1",
"title": "Est omnis unde cum.",
"description": "Error et dicta. Non exercitationem minima. Quisquam provident odit.",
"business_objective": "card",
"compliance_threshold": 90.0,
"type": "report",
"os_major_version": 8,
"profile_title": "Delectus accusantium nam autem.",
"ref_id": "xccdf_org.ssgproject.content_profile_efd4c21b4894a3bb840ffaccde2cbd9f",
"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 <a href=\"https://github.com/wvanbergen/scoped_search/wiki/Query-language\" target=\"_blank\" title=\"github.com/wvanbergen/scoped_search\">scoped_search query language</a>. However, only `=` or `!=` (resp. `<>`) operators are supported.<br><br>Reports are searchable using attributes `title`, `os_major_version`, `with_reported_systems`, and `percent_compliant`<br><br>(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": "Returns a Report",
"operationId": "Report",
"responses": {
"200": {
"description": "Returns a Report",
"content": {
"application/vnd.api+json": {
"examples": {
"Returns a Report": {
"value": {
"data": {
"id": "1d2cadf3-8a22-4e79-abfb-b5380ad01a3a",
"title": "Voluptate non dignissimos dolor.",
"description": "Molestiae et est. Aut ut reprehenderit. Deserunt dolor enim.",
"business_objective": "driver",
"compliance_threshold": 90.0,
"type": "report",
"os_major_version": 9,
"profile_title": "Accusantium laboriosam consectetur dolor.",
"ref_id": "xccdf_org.ssgproject.content_profile_8ee240badcf2f5f4baef1da752ca68f1",
"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 792fb0a0-a640-47fd-994d-a2bfb507b209"
]
},
"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": "Deletes Report's test results",
"operationId": "DeleteReport",
"responses": {
"202": {
"description": "Deletes Report's test results",
"content": {
"application/vnd.api+json": {
"examples": {
"Deletes Report's test results": {
"value": {
"data": {
"id": "23b207a3-459e-4db5-940e-242ab78495a9",
"title": "Corporis suscipit et excepturi.",
"description": "Adipisci enim autem. Incidunt repellat nemo. Voluptatem voluptas dolores.",
"business_objective": "circuit",
"compliance_threshold": 90.0,
"type": "report",
"os_major_version": 9,
"profile_title": "Aliquam nihil deleniti sunt.",
"ref_id": "xccdf_org.ssgproject.content_profile_5f8529e6b4ddb965227f8db49151c29c",
"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 9576bb86-39f0-4ece-b535-94332d8a3d1c"
]
},
"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 (`<key>:asc` or `<key>:desc`).<br><br>If no direction is selected, `<key>: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 <a href=\"https://github.com/wvanbergen/scoped_search/wiki/Query-language\" target=\"_blank\" title=\"github.com/wvanbergen/scoped_search\">scoped_search query language</a>. However, only `=` or `!=` (resp. `<>`) operators are supported.<br><br>Reports are searchable using attributes `title` and `percent_compliant`<br><br>(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": "Lists Reports",
"operationId": "SystemReports",
"responses": {
"200": {
"description": "Lists Reports",
"content": {
"application/vnd.api+json": {
"examples": {
"List of Reports": {
"value": {
"data": [
{
"id": "217e1bd8-349c-4d57-aa80-3beb75887fad",
"title": "Quis nihil molestiae atque.",
"description": "Quae harum assumenda. Neque hic quisquam. Voluptas explicabo repellat.",
"business_objective": "hard drive",
"compliance_threshold": 90.0,
"type": "report",
"os_major_version": 8,
"profile_title": "Rerum quae culpa quam.",
"ref_id": "xccdf_org.ssgproject.content_profile_f2ed71ad709ba7b21afe2115e1d81761",
"all_systems_exposed": false,
"percent_compliant": 0,
"compliant_system_count": 0,
"unsupported_system_count": 0,
"reported_system_count": 0
},
{
"id": "2be7c9af-0062-4277-ba2f-b0ab376da7fe",
"title": "Quia officiis nam maxime.",
"description": "Temporibus reprehenderit cupiditate. Exercitationem qui modi. Sunt illo doloremque.",
"business_objective": "matrix",
"compliance_threshold": 90.0,
"type": "report",
"os_major_version": 8,
"profile_title": "Sed laborum repellat deleniti.",
"ref_id": "xccdf_org.ssgproject.content_profile_d42c2ddaf3c35e6ffbc6b38d0494dc8e",
"all_systems_exposed": false,
"percent_compliant": 0,
"compliant_system_count": 0,
"unsupported_system_count": 0,
"reported_system_count": 0
},
{
"id": "4ff22360-f052-4215-8fcf-ee47656958e4",
"title": "Molestiae autem quasi omnis.",
"description": "Eveniet explicabo in. Voluptatem quaerat magni. Sit aut et.",
"business_objective": "pixel",
"compliance_threshold": 90.0,
"type": "report",
"os_major_version": 8,
"profile_title": "Asperiores placeat illum sit.",
"ref_id": "xccdf_org.ssgproject.content_profile_5cda2bed30d09ef06a5dfe719e3a6257",
"all_systems_exposed": false,
"percent_compliant": 0,
"compliant_system_count": 0,
"unsupported_system_count": 0,
"reported_system_count": 0
},
{
"id": "5dddcea0-fb13-477b-9731-e91a32ff8b11",
"title": "Repudiandae quae et aut.",
"description": "Numquam asperiores delectus. Magnam et nobis. Ipsam et harum.",
"business_objective": "hard drive",
"compliance_threshold": 90.0,
"type": "report",
"os_major_version": 8,
"profile_title": "Animi et culpa illo.",
"ref_id": "xccdf_org.ssgproject.content_profile_bf66a911591f03d9ee8f9dd8defde58d",
"all_systems_exposed": false,
"percent_compliant": 0,
"compliant_system_count": 0,
"unsupported_system_count": 0,
"reported_system_count": 0
},
{
"id": "8e5256f4-0883-4298-97a6-63db56d4b10c",
"title": "Dolores quae ut velit.",
"description": "Expedita iure voluptas. Facilis assumenda nesciunt. Quasi ex doloremque.",
"business_objective": "transmitter",
"compliance_threshold": 90.0,
"type": "report",
"os_major_version": 8,
"profile_title": "Quidem veniam sed amet.",
"ref_id": "xccdf_org.ssgproject.content_profile_caa3179644b32ec3c53d1df7d0db856a",
"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/1c2cd120-e07e-465f-ae87-321e64deb206/reports?limit=10&offset=0",
"last": "/api/compliance/v2/systems/1c2cd120-e07e-465f-ae87-321e64deb206/reports?limit=10&offset=0"
}
},
"summary": "",
"description": ""
},
"List of Reports sorted by \"title:asc\"": {
"value": {
"data": [
{
"id": "60286f52-d0b8-4aec-a02d-aa1247e1ecc6",
"title": "Aperiam ad maxime quasi.",
"description": "Minus non reiciendis. Distinctio eligendi ut. Et quos dicta.",
"business_objective": "hard drive",
"compliance_threshold": 90.0,
"type": "report",
"os_major_version": 8,
"profile_title": "Aut dolorem enim minima.",
"ref_id": "xccdf_org.ssgproject.content_profile_26cb1d2db07e934b04546936eb26b296",
"all_systems_exposed": false,
"percent_compliant": 0,
"compliant_system_count": 0,
"unsupported_system_count": 0,
"reported_system_count": 0
},
{
"id": "c76072ed-b9bf-404b-9cb2-6f48cd82dc77",
"title": "Beatae quidem quos dolores.",
"description": "Sit numquam vel. Voluptatem vel ut. Vel ea aut.",
"business_objective": "interface",
"compliance_threshold": 90.0,
"type": "report",
"os_major_version": 8,
"profile_title": "Quaerat placeat quis eaque.",
"ref_id": "xccdf_org.ssgproject.content_profile_b7373756db6c346871d48aca45b7a3dd",
"all_systems_exposed": false,
"percent_compliant": 0,
"compliant_system_count": 0,
"unsupported_system_count": 0,
"reported_system_count": 0
},
{
"id": "a330acc4-d9e4-4d72-a551-b7ca8cecfa0c",
"title": "Doloribus similique cupiditate sit.",
"description": "Illum aut nihil. Amet commodi aut. Et aspernatur dicta.",
"business_objective": "alarm",
"compliance_threshold": 90.0,
"type": "report",
"os_major_version": 8,
"profile_title": "Eveniet quaerat et occaecati.",
"ref_id": "xccdf_org.ssgproject.content_profile_b22f82648d97ddca5a97f1373a67ba4c",
"all_systems_exposed": false,
"percent_compliant": 0,
"compliant_system_count": 0,
"unsupported_system_count": 0,
"reported_system_count": 0
},
{
"id": "40f83ce5-287e-4c79-8ab1-1d8b668c6a59",
"title": "Et nulla qui nihil.",
"description": "Voluptatum animi ut. Ullam sequi sit. Fugit voluptatum doloribus.",
"business_objective": "monitor",
"compliance_threshold": 90.0,
"type": "report",
"os_major_version": 8,
"profile_title": "Aut aut vitae doloremque.",
"ref_id": "xccdf_org.ssgproject.content_profile_3cd25206e22762bdc3f9af90da79b5a6",
"all_systems_exposed": false,
"percent_compliant": 0,
"compliant_system_count": 0,
"unsupported_system_count": 0,
"reported_system_count": 0
},
{
"id": "a971ea90-9c22-46a1-b6b7-5696a6ece0c0",
"title": "Sit amet adipisci distinctio.",
"description": "Enim voluptatum et. Voluptatem exercitationem qui. Labore omnis quam.",
"business_objective": "capacitor",
"compliance_threshold": 90.0,
"type": "report",
"os_major_version": 8,
"profile_title": "At reiciendis aliquam facilis.",
"ref_id": "xccdf_org.ssgproject.content_profile_c59380f77af0f6ced4fa28abbaeb98aa",
"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/2f76d2aa-5d67-4c71-a54b-2b2b880f291e/reports?limit=10&offset=0&sort_by=title",
"last": "/api/compliance/v2/systems/2f76d2aa-5d67-4c71-a54b-2b2b880f291e/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 (`<key>:asc` or `<key>:desc`).<br><br>If no direction is selected, `<key>: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 <a href=\"https://github.com/wvanbergen/scoped_search/wiki/Query-language\" target=\"_blank\" title=\"github.com/wvanbergen/scoped_search\">scoped_search query language</a>. However, only `=` or `!=` (resp. `<>`) operators are supported.<br><br>Rule Groups are searchable using attributes `title` and `ref_id`<br><br>(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": "Lists Rule Groups",
"operationId": "Rule Groups",
"responses": {
"200": {
"description": "Lists Rule Groups",
"content": {
"application/vnd.api+json": {
"examples": {
"List of Rule Groups": {
"value": {
"data": [
{
"id": "0817616c-5976-4b47-a6f8-2b7054ca7096",
"ref_id": "xccdf_org.ssgproject.content_rule_group_96753cb8646b7ff15a715a6cf14866d0",
"title": "Magnam sunt doloribus consequuntur.",
"rationale": "Aut molestias amet. Eum atque ut. Harum accusantium in.",
"description": "Ut minima deleniti. Magni perspiciatis ex. Perspiciatis aut esse.",
"precedence": null,
"type": "rule_group"
},
{
"id": "0cbb0903-13ec-4da9-8074-ec9318d235b4",
"ref_id": "xccdf_org.ssgproject.content_rule_group_94c8256db3000bde16d47e403a817719",
"title": "Cum deleniti aperiam quibusdam.",
"rationale": "Dignissimos repellendus saepe. Modi ut corporis. Molestiae excepturi dolor.",
"description": "Inventore aut et. Maiores reiciendis quia. Hic dignissimos natus.",
"precedence": null,
"type": "rule_group"
},
{
"id": "25bee955-d89b-4237-b1cc-948e5079ff56",
"ref_id": "xccdf_org.ssgproject.content_rule_group_f185acf741584997c033addba9a804cc",
"title": "Eius sunt error laborum.",
"rationale": "Est earum qui. Ducimus eaque incidunt. Neque sunt rerum.",
"description": "Sunt quia ut. Quisquam illum minus. Aspernatur totam suscipit.",
"precedence": null,
"type": "rule_group"
},
{
"id": "31c392b5-54ed-4a87-af8f-94b84a6269d3",
"ref_id": "xccdf_org.ssgproject.content_rule_group_d80de049c2fb1f3099f2e6941763fded",
"title": "Placeat ducimus dolore atque.",
"rationale": "Nostrum distinctio tempore. Vel ut quia. Expedita error vel.",
"description": "Illum ducimus consequatur. Quisquam autem ea. Deserunt aperiam quasi.",
"precedence": null,
"type": "rule_group"
},
{
"id": "39db96a7-bcb9-4588-ac7f-c55bc527546e",
"ref_id": "xccdf_org.ssgproject.content_rule_group_cc192d7701c2d20ab40c71484ac94c54",
"title": "Quisquam modi quos nihil.",
"rationale": "Autem eum ut. Quasi harum unde. Voluptas ut ipsa.",
"description": "Eos deserunt omnis. Velit autem sit. Earum placeat ipsum.",
"precedence": null,
"type": "rule_group"
},
{
"id": "5119dc5b-d5f3-4637-8098-4747861f69f1",
"ref_id": "xccdf_org.ssgproject.content_rule_group_12ccd0b53acc31332d0fcb57d5d24393",
"title": "Deleniti ipsam deserunt molestias.",
"rationale": "Et in libero. In molestiae quaerat. Et dolor voluptas.",
"description": "Consequatur soluta accusantium. Consequatur earum eos. Corporis dolor a.",
"precedence": null,
"type": "rule_group"
},
{
"id": "572f5c16-dfcb-49d4-b456-075e6d68205b",
"ref_id": "xccdf_org.ssgproject.content_rule_group_e05e663baaab56eeff06fb38eb04fb0b",
"title": "Aperiam ut facilis est.",
"rationale": "Aut optio tempora. Explicabo hic odio. Tempora voluptatem dolores.",
"description": "In est culpa. Reiciendis et delectus. Veritatis saepe et.",
"precedence": null,
"type": "rule_group"
},
{
"id": "5e07623a-a3f2-42f1-95da-0080099b7894",
"ref_id": "xccdf_org.ssgproject.content_rule_group_08f3b1f6fa9ad60221e8800e2d4b7f95",
"title": "Velit et amet et.",
"rationale": "Ad iure et. Magnam odio non. Itaque quia sequi.",
"description": "Veritatis deserunt dignissimos. Assumenda necessitatibus amet. Mollitia non nobis.",
"precedence": null,
"type": "rule_group"
},
{
"id": "6c2c271a-c101-4ebe-9d04-f9eb841895ff",
"ref_id": "xccdf_org.ssgproject.content_rule_group_e25fc44c683e6702f2b05ab536f5c938",
"title": "Id hic quo necessitatibus.",
"rationale": "Ipsam accusantium blanditiis. Minus quis repellendus. Et dolor doloribus.",
"description": "Ea omnis dolorem. Enim officiis et. Illo omnis quis.",
"precedence": null,
"type": "rule_group"
},
{
"id": "8a4cbdcd-abb6-409c-b885-cfcf37ea03b0",
"ref_id": "xccdf_org.ssgproject.content_rule_group_2b3b9833f74c825c173069e54d78e1ed",
"title": "Non vitae et rerum.",
"rationale": "Est vel reprehenderit. Est repellendus explicabo. Quis cum ea.",
"description": "Et doloremque et. Laborum beatae architecto. Corporis ipsa dicta.",
"precedence": null,
"type": "rule_group"
}
],
"meta": {
"total": 25,
"limit": 10,
"offset": 0
},
"links": {
"first": "/api/compliance/v2/security_guides/12181745-5f8c-4a6f-a61c-4e3d05cfd9d4/rule_groups?limit=10&offset=0",
"last": "/api/compliance/v2/security_guides/12181745-5f8c-4a6f-a61c-4e3d05cfd9d4/rule_groups?limit=10&offset=20",
"next": "/api/compliance/v2/security_guides/12181745-5f8c-4a6f-a61c-4e3d05cfd9d4/rule_groups?limit=10&offset=10"
}
},
"summary": "",
"description": ""
},
"List of Rule Groups sorted by \"precedence:asc\"": {
"value": {
"data": [
{
"id": "21bf9693-a88a-46fa-a5d1-adcee3c00e86",
"ref_id": "xccdf_org.ssgproject.content_rule_group_c1786d9f41998ffc3340b0a58fc8bf9f",
"title": "Quia dolore molestiae dignissimos.",
"rationale": "Et esse rerum. Rerum omnis eum. Quisquam et eum.",
"description": "Animi quia eos. Ut esse incidunt. Atque ut magnam.",
"precedence": null,
"type": "rule_group"
},
{
"id": "26c7f9a1-5da8-43af-b587-f6348db61f87",
"ref_id": "xccdf_org.ssgproject.content_rule_group_0803bca0d38b6b0e4533bd74bcd10e0b",
"title": "Animi nostrum aliquam at.",
"rationale": "Magni iure iusto. Sint iusto vitae. Pariatur non nihil.",
"description": "Sed praesentium autem. Non commodi a. Voluptatem harum voluptate.",
"precedence": null,
"type": "rule_group"
},
{
"id": "2887d8d4-aee0-4740-b00a-59a0d5021faa",
"ref_id": "xccdf_org.ssgproject.content_rule_group_2523533a7d40a1df5c8211aa38817550",
"title": "Voluptatem enim praesentium quas.",
"rationale": "Iusto voluptatibus velit. Sequi et quia. Praesentium atque quod.",
"description": "Et quia ipsam. Et nam iure. Laudantium tenetur consequuntur.",
"precedence": null,
"type": "rule_group"
},
{
"id": "29c800a2-6447-4899-ba4d-eb0ab71d7279",
"ref_id": "xccdf_org.ssgproject.content_rule_group_41ff8df45f6fa7fec3ca7d8440a5870d",
"title": "Quia aliquid molestias laboriosam.",
"rationale": "Nemo est nam. Minima fugit magnam. Harum consequatur est.",
"description": "Sed aut qui. Laboriosam facilis necessitatibus. Quam est similique.",
"precedence": null,
"type": "rule_group"
},
{
"id": "5122c234-51cb-45d5-8bb3-6d9f12998f0b",
"ref_id": "xccdf_org.ssgproject.content_rule_group_37b0b9e6896e30014fddee8b5a2f637d",
"title": "Doloremque magnam quia ducimus.",
"rationale": "Consequatur consequatur dolores. Molestiae at totam. Non totam officia.",
"description": "Aut et aut. Laborum praesentium rerum. Reprehenderit et nulla.",
"precedence": null,
"type": "rule_group"
},
{
"id": "691ea158-5c57-449d-89a5-4c0ef86a4861",
"ref_id": "xccdf_org.ssgproject.content_rule_group_ba97c6e5b941854804ea9965d49f0ee9",
"title": "Consequuntur earum incidunt enim.",
"rationale": "In odio dolor. Iusto doloremque beatae. Aut natus rerum.",
"description": "Quia fuga illo. Quaerat tempora maxime. Alias id voluptate.",
"precedence": null,
"type": "rule_group"
},
{
"id": "6c54eebb-9786-49ad-a984-a6535999600c",
"ref_id": "xccdf_org.ssgproject.content_rule_group_c9c6a5c7bdac5c4327ff74f9aef2e4bd",
"title": "Ut illo quam rem.",
"rationale": "Voluptas fugit ipsum. Voluptate repellat et. Quo et inventore.",
"description": "Sed eos exercitationem. Error mollitia facere. Voluptas rerum quam.",
"precedence": null,
"type": "rule_group"
},
{
"id": "772c415c-5771-46cc-b54f-37547a2dfa41",
"ref_id": "xccdf_org.ssgproject.content_rule_group_d54056b890f687fee1ee41727978d504",
"title": "Voluptatem dolor dolores est.",
"rationale": "Totam rerum et. Est soluta laborum. Quaerat et dolores.",
"description": "Odit sunt est. Rem cum aut. Illum incidunt vero.",
"precedence": null,
"type": "rule_group"
},
{
"id": "8de9ef6d-dd07-445a-8da4-940d7ab7317a",
"ref_id": "xccdf_org.ssgproject.content_rule_group_f24a0bae9a1894ccf953e96c9a77665a",
"title": "Est ratione quas qui.",
"rationale": "Veniam error quia. Autem et totam. Aut aut iusto.",
"description": "Quia aliquid est. Iusto laboriosam et. Ratione ut dolores.",
"precedence": null,
"type": "rule_group"
},
{
"id": "97d6ae1f-2619-4640-b7f9-5f43fa9185a7",
"ref_id": "xccdf_org.ssgproject.content_rule_group_38636fbb628d3d4467680a89a9d2d618",
"title": "Dicta enim voluptas mollitia.",
"rationale": "Rerum perferendis modi. Ut tenetur et. Quae placeat sint.",
"description": "Porro voluptatem dolore. Perferendis in quibusdam. Voluptatem est accusantium.",
"precedence": null,
"type": "rule_group"
}
],
"meta": {
"total": 25,
"limit": 10,
"offset": 0,
"sort_by": "precedence"
},
"links": {
"first": "/api/compliance/v2/security_guides/f4a6f02e-1401-4dc1-95d1-8d217d9f4a8d/rule_groups?limit=10&offset=0&sort_by=precedence",
"last": "/api/compliance/v2/security_guides/f4a6f02e-1401-4dc1-95d1-8d217d9f4a8d/rule_groups?limit=10&offset=20&sort_by=precedence",
"next": "/api/compliance/v2/security_guides/f4a6f02e-1401-4dc1-95d1-8d217d9f4a8d/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": "Returns a Rule Group",
"operationId": "RuleGroup",
"responses": {
"200": {
"description": "Returns a Rule Group",
"content": {
"application/vnd.api+json": {
"examples": {
"Returns a Rule Group": {
"value": {
"data": {
"id": "265c5990-1e13-4f18-ad87-a1431e3f718b",
"ref_id": "xccdf_org.ssgproject.content_rule_group_f8a7e5cb30e40963d404477e66081359",
"title": "Libero deserunt tempore repellendus.",
"rationale": "Voluptate ut officiis. Illo possimus doloremque. Non est esse.",
"description": "Dolor labore itaque. Sunt hic vel. Est ut optio.",
"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 29efef50-fc57-4ef0-ada8-3f7d0a3d1a5b"
]
},
"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 (`<key>:asc` or `<key>:desc`).<br><br>If no direction is selected, `<key>: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 <a href=\"https://github.com/wvanbergen/scoped_search/wiki/Query-language\" target=\"_blank\" title=\"github.com/wvanbergen/scoped_search\">scoped_search query language</a>. However, only `=` or `!=` (resp. `<>`) operators are supported.<br><br>Rule Results are searchable using attributes `result`, `title`, `severity`, `remediation_available`, and `rule_group_id`<br><br>(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": "Lists Rule Results under a 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/93e70930-64ff-4bec-9eda-11e7672de875/test_results/469e41b4-a74f-49eb-b7fe-643b928995d0/rule_results?limit=10&offset=0",
"last": "/api/compliance/v2/reports/93e70930-64ff-4bec-9eda-11e7672de875/test_results/469e41b4-a74f-49eb-b7fe-643b928995d0/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/5e29b682-5750-47bd-b9a7-ffeade9f8492/test_results/7d2c1e88-30c3-4f1d-a243-4466575595d8/rule_results?limit=10&offset=0&sort_by=result",
"last": "/api/compliance/v2/reports/5e29b682-5750-47bd-b9a7-ffeade9f8492/test_results/7d2c1e88-30c3-4f1d-a243-4466575595d8/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/9e2b0a19-235e-49e5-b89f-e4bbb7f67ce5/test_results/d5ff10e2-7906-4520-96b7-1b6f83ea4c4c/rule_results?filter=%28title%3Dfoo%29&limit=10&offset=0",
"last": "/api/compliance/v2/reports/9e2b0a19-235e-49e5-b89f-e4bbb7f67ce5/test_results/d5ff10e2-7906-4520-96b7-1b6f83ea4c4c/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 (`<key>:asc` or `<key>:desc`).<br><br>If no direction is selected, `<key>: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 <a href=\"https://github.com/wvanbergen/scoped_search/wiki/Query-language\" target=\"_blank\" title=\"github.com/wvanbergen/scoped_search\">scoped_search query language</a>. However, only `=` or `!=` (resp. `<>`) operators are supported.<br><br>Rules are searchable using attributes `title`, `severity`, `remediation_available`, and `rule_group_id`<br><br>(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": "Lists Rules assigned",
"operationId": "Rules",
"responses": {
"200": {
"description": "Lists Rules",
"content": {
"application/vnd.api+json": {
"examples": {
"List of Rules": {
"value": {
"data": [
{
"id": "1259a356-a9cd-4f45-8a33-46fb0209798d",
"ref_id": "xccdf_org.ssgproject.content_rule_8f663965109ff1415122ef684f70ac81",
"title": "Voluptas similique architecto sit.",
"rationale": "Voluptatibus sint occaecati. Saepe perspiciatis perferendis. Ut voluptas dignissimos.",
"description": "Totam esse sint. Id et nemo. Pariatur omnis ut.",
"severity": "high",
"precedence": 6149,
"identifier": {
"href": "http://runolfsdottir-olson.test/talia",
"label": "Gelmir"
},
"references": [
{
"href": "http://smith-smitham.test/adrian.mckenzie",
"label": "Númendil"
},
{
"href": "http://gerlach-hettinger.test/alberto_okeefe",
"label": "Anson Roper"
},
{
"href": "http://langosh.test/lenard.armstrong",
"label": "Eradan"
},
{
"href": "http://hills.test/angelo",
"label": "Bard"
},
{
"href": "http://huel.example/abe_olson",
"label": "Aglahad"
}
],
"value_checks": null,
"remediation_available": false,
"rule_group_id": "cc54da0f-cf74-47e3-8229-13c1797207f3",
"type": "rule"
},
{
"id": "172b3969-bcfb-4591-8525-ecad878f3d7b",
"ref_id": "xccdf_org.ssgproject.content_rule_1ccf658b711d2c54d5e116a8eaeb1a9d",
"title": "Nobis natus eaque eum.",
"rationale": "Nisi nemo nostrum. Et laborum et. Provident dolores sit.",
"description": "Voluptatum omnis rem. Laboriosam omnis explicabo. Quis pariatur harum.",
"severity": "low",
"precedence": 4729,
"identifier": {
"href": "http://gibson.example/meagan",
"label": "Lindir"
},
"references": [
{
"href": "http://kohler.example/merideth",
"label": "Azog"
},
{
"href": "http://nikolaus-baumbach.test/myrtis",
"label": "Morwen Steelsheen"
},
{
"href": "http://wiegand.example/eusebio",
"label": "Thingol"
},
{
"href": "http://cormier.example/consuela_kulas",
"label": "Eärnur"
},
{
"href": "http://lueilwitz.example/mayme",
"label": "Argonui"
}
],
"value_checks": null,
"remediation_available": false,
"rule_group_id": "53c9276a-d64b-4580-b5cd-0c973ce12939",
"type": "rule"
},
{
"id": "21a83193-a488-4f83-bc69-5e1c74a8f1da",
"ref_id": "xccdf_org.ssgproject.content_rule_46e5f406288e8e99e1ad3ac5e59bb427",
"title": "Esse laborum totam ut.",
"rationale": "Et voluptatem molestiae. Porro aut nihil. Earum nisi similique.",
"description": "Enim qui a. Necessitatibus quas dolorem. Dolor modi laboriosam.",
"severity": "high",
"precedence": 3062,
"identifier": {
"href": "http://ankunding.test/alexis.wuckert",
"label": "Asphodel Brandybuck"
},
"references": [
{
"href": "http://wiza.example/adah_ward",
"label": "Gerda Boffin"
},
{
"href": "http://moore.example/tana",
"label": "Landroval"
},
{
"href": "http://lehner-yundt.example/efrain.schuster",
"label": "Vidugavia"
},
{
"href": "http://bashirian.test/isaias.hintz",
"label": "Largo Baggins"
},
{
"href": "http://bechtelar.test/john.dach",
"label": "Tar-Elendil"
}
],
"value_checks": null,
"remediation_available": false,
"rule_group_id": "97ff9324-a15c-4e54-8260-388c5e184076",
"type": "rule"
},
{
"id": "354e88df-a2e9-40aa-9c28-9e7f86a8d731",
"ref_id": "xccdf_org.ssgproject.content_rule_ab4eea74e6deb296db0085ff08d55c43",
"title": "Et nam laudantium possimus.",
"rationale": "Repudiandae consectetur non. Dolor aut necessitatibus. Consectetur ipsa voluptas.",
"description": "Consequuntur ut rerum. Iste perspiciatis voluptatem. Sunt vel minus.",
"severity": "high",
"precedence": 4154,
"identifier": {
"href": "http://cassin.test/shemeka",
"label": "Brytta"
},
"references": [
{
"href": "http://deckow.example/clair_murray",
"label": "Dori"
},
{
"href": "http://strosin.test/ronald",
"label": "Andreth"
},
{
"href": "http://kihn.test/gennie",
"label": "Mogru"
},
{
"href": "http://herzog.example/perry.gutmann",
"label": "Harry Goatleaf"
},
{
"href": "http://schiller.example/weston",
"label": "Buldar"
}
],
"value_checks": null,
"remediation_available": false,
"rule_group_id": "908ff67a-1593-4a00-a16c-89ff5ad7f7a5",
"type": "rule"
},
{
"id": "48b307c1-eea2-4166-8bc4-61e251105da9",
"ref_id": "xccdf_org.ssgproject.content_rule_d2f097f687e25ab40250313a5cb1b627",
"title": "Unde veritatis rem qui.",
"rationale": "Veniam ipsa ullam. Et voluptatem quam. Quia et dolorum.",
"description": "Nisi velit ut. In recusandae quo. Quidem odit culpa.",
"severity": "low",
"precedence": 9543,
"identifier": {
"href": "http://jacobson.example/laci",
"label": "Eofor"
},
"references": [
{
"href": "http://zboncak.example/yuki",
"label": "Arahad"
},
{
"href": "http://durgan.example/hassan_reilly",
"label": "Calimehtar"
},
{
"href": "http://adams-wilderman.example/shena.waters",
"label": "Hundar"
},
{
"href": "http://heaney.test/kortney",
"label": "Tar-Meneldur"
},
{
"href": "http://fay-roberts.test/nestor.bartell",
"label": "Great Goblin"
}
],
"value_checks": null,
"remediation_available": false,
"rule_group_id": "712bcd54-515b-4b8b-8be9-5dd2c54e18c9",
"type": "rule"
},
{
"id": "4ea5ae92-4dc2-482e-99d1-cd0893a3362e",
"ref_id": "xccdf_org.ssgproject.content_rule_e521577adb6f31960d1f4cded90657ad",
"title": "Voluptas quia ipsum error.",
"rationale": "Atque dolor voluptatem. Qui sunt qui. Fugiat veniam possimus.",
"description": "Quis accusamus laboriosam. Modi et doloribus. Beatae aliquid facilis.",
"severity": "medium",
"precedence": 8529,
"identifier": {
"href": "http://hagenes.example/racquel_oreilly",
"label": "Blanco Bracegirdle"
},
"references": [
{
"href": "http://rogahn.test/marceline.price",
"label": "Minohtar"
},
{
"href": "http://stiedemann.example/sonny",
"label": "Aragost"
},
{
"href": "http://heaney.test/nicky",
"label": "Ingold"
},
{
"href": "http://sporer-nolan.example/vince.okon",
"label": "Khîm"
},
{
"href": "http://schmidt.example/lawerence",
"label": "Gorbadoc Brandybuck"
}
],
"value_checks": null,
"remediation_available": false,
"rule_group_id": "4b1956b2-fed5-405a-b114-2d4baed4e5a0",
"type": "rule"
},
{
"id": "5b7ef834-74ad-467b-87cc-ad0298ab564e",
"ref_id": "xccdf_org.ssgproject.content_rule_043eb8b70179bcd5baa301112bc42ed3",
"title": "Esse dolores ut impedit.",
"rationale": "Facilis illum consequatur. Nostrum iste sit. Fugit saepe omnis.",
"description": "Laborum ducimus sit. Rem autem quia. Soluta ut sit.",
"severity": "medium",
"precedence": 2211,
"identifier": {
"href": "http://yost.test/trenton",
"label": "Landroval"
},
"references": [
{
"href": "http://davis-toy.test/angel.schmidt",
"label": "Sapphira Brockhouse"
},
{
"href": "http://pfannerstill.test/arlette",
"label": "Elladan"
},
{
"href": "http://donnelly.test/floria.nader",
"label": "Belen"
},
{
"href": "http://upton.example/yun",
"label": "Lindir"
},
{
"href": "http://marks-rohan.test/gayle",
"label": "Ceorl"
}
],
"value_checks": null,
"remediation_available": false,
"rule_group_id": "d3466e95-e0bc-4e6a-8ad3-9e0be5b3f65c",
"type": "rule"
},
{
"id": "70582b70-8151-465b-b582-16d0a419b44b",
"ref_id": "xccdf_org.ssgproject.content_rule_90716af296614405f1557891cf49f0af",
"title": "Eos voluptas et enim.",
"rationale": "Voluptatem libero impedit. Qui sunt modi. Quidem rerum fugiat.",
"description": "Sed repudiandae qui. Inventore qui rerum. Laboriosam doloribus odit.",
"severity": "medium",
"precedence": 8821,
"identifier": {
"href": "http://bernhard.test/otha.zboncak",
"label": "Farmer Cotton"
},
"references": [
{
"href": "http://moen.test/jed_ward",
"label": "Amlach"
},
{
"href": "http://gorczany-jacobi.example/shanna.langworth",
"label": "Bell Goodchild"
},
{
"href": "http://carroll.test/sybil.russel",
"label": "Jago Boffin"
},
{
"href": "http://nolan.example/kenny_conroy",
"label": "Adaldrida Bolger"
},
{
"href": "http://bogisich.test/robert.sauer",
"label": "Tar-Míriel"
}
],
"value_checks": null,
"remediation_available": false,
"rule_group_id": "067a9eec-e7ae-4557-802c-9bc196c80ddc",
"type": "rule"
},
{
"id": "712eccc2-48c4-43da-8132-48596b585dce",
"ref_id": "xccdf_org.ssgproject.content_rule_35640cf779924dafb7749a5428f1217a",
"title": "Nostrum excepturi eveniet quam.",
"rationale": "Et nihil ut. Ipsum cumque iure. Tempora veritatis exercitationem.",
"description": "A repudiandae voluptas. Tenetur sunt quae. Id iure quisquam.",
"severity": "low",
"precedence": 951,
"identifier": {
"href": "http://hickle-robel.example/virgilio_nitzsche",
"label": "Erkenbrand"
},
"references": [
{
"href": "http://hackett.test/essie",
"label": "Thorondor"
},
{
"href": "http://ondricka.test/roosevelt_bode",
"label": "Imrazôr"
},
{
"href": "http://dicki-cole.test/tammi.witting",
"label": "Eärendil"
},
{
"href": "http://schneider.test/chas_tillman",
"label": "Nar"
},
{
"href": "http://nolan.example/luther",
"label": "Primrose Gardner"
}
],
"value_checks": null,
"remediation_available": false,
"rule_group_id": "430ae82a-703f-4c4a-8a2b-c739139fc366",
"type": "rule"
},
{
"id": "777ab401-686d-49e7-9b9c-ed42a9c0b925",
"ref_id": "xccdf_org.ssgproject.content_rule_6cbf5f334833f1206d436628de291ca4",
"title": "Velit amet porro et.",
"rationale": "Rerum ut at. Quos harum dicta. Quam est unde.",
"description": "Ut velit officiis. Consequatur aut sed. Vel eaque et.",
"severity": "medium",
"precedence": 8834,
"identifier": {
"href": "http://keeling.example/benito",
"label": "Eärendur"
},
"references": [
{
"href": "http://marvin.example/lionel",
"label": "Quennar"
},
{
"href": "http://batz.example/yong.thompson",
"label": "Huor"
},
{
"href": "http://bednar.example/josiah",
"label": "Nimloth of Doriath"
},
{
"href": "http://ullrich.test/giovanni_farrell",
"label": "Dina Diggle"
},
{
"href": "http://walter-skiles.test/angelic",
"label": "Legolas"
}
],
"value_checks": null,
"remediation_available": false,
"rule_group_id": "5b53f7b8-2b8d-48ec-9725-90637a9461eb",
"type": "rule"
}
],
"meta": {
"total": 25,
"limit": 10,
"offset": 0
},
"links": {
"first": "/api/compliance/v2/security_guides/475f9c55-6d10-4875-96f5-d57f35edc759/rules?limit=10&offset=0",
"last": "/api/compliance/v2/security_guides/475f9c55-6d10-4875-96f5-d57f35edc759/rules?limit=10&offset=20",
"next": "/api/compliance/v2/security_guides/475f9c55-6d10-4875-96f5-d57f35edc759/rules?limit=10&offset=10"
}
},
"summary": "",
"description": ""
},
"List of Rules sorted by \"precedence:asc\"": {
"value": {
"data": [
{
"id": "d1188747-21d2-4514-8e22-ab7832984946",
"ref_id": "xccdf_org.ssgproject.content_rule_1acd70ae37de01b2c8424708d757e010",
"title": "Et tenetur perferendis et.",
"rationale": "Fugit velit enim. Eum ea repellendus. Veritatis in quos.",
"description": "Enim temporibus voluptate. Assumenda rerum commodi. Mollitia autem dicta.",
"severity": "medium",
"precedence": 53,
"identifier": {
"href": "http://bogisich.example/francine.mraz",
"label": "Grim"
},
"references": [
{
"href": "http://lockman-hermiston.example/long_konopelski",
"label": "Ulfang"
},
{
"href": "http://torphy.test/wendi_renner",
"label": "Lily Brown"
},
{
"href": "http://wehner.example/lilliam.greenfelder",
"label": "Tom Bombadil"
},
{
"href": "http://herzog-beatty.test/bob_breitenberg",
"label": "Turambar"
},
{
"href": "http://hegmann.test/chery",
"label": "Bereg"
}
],
"value_checks": null,
"remediation_available": false,
"rule_group_id": "6b28bcbe-0307-4995-8e19-43773f91ab71",
"type": "rule"
},
{
"id": "57eaf085-3368-4b56-b8c1-3be8fe75e5bb",
"ref_id": "xccdf_org.ssgproject.content_rule_4e6278d20f06bdc62c20393d2dae9e08",
"title": "Iusto quidem ut officiis.",
"rationale": "Aspernatur quia doloribus. Tempora cupiditate sunt. Enim tenetur voluptatem.",
"description": "Quibusdam magnam quasi. Est nobis et. Eos aut rerum.",
"severity": "high",
"precedence": 144,
"identifier": {
"href": "http://powlowski.example/blanche_rosenbaum",
"label": "Aldamir"
},
"references": [
{
"href": "http://schamberger.example/adrien",
"label": "Gléowine"
},
{
"href": "http://romaguera.test/racheal",
"label": "Isembard Took"
},
{
"href": "http://stroman.example/tarah",
"label": "Ulfang"
},
{
"href": "http://bednar.test/jamaal.greenfelder",
"label": "Findis"
},
{
"href": "http://konopelski-mann.test/freddie",
"label": "Tar-Vanimeldë"
}
],
"value_checks": null,
"remediation_available": false,
"rule_group_id": "f6fd2540-694a-43af-a9f4-f4c57c16ccc1",
"type": "rule"
},
{
"id": "34f3d32d-0554-41cf-b2b9-ee20f2d97a25",
"ref_id": "xccdf_org.ssgproject.content_rule_be8278661a99640ac829f7b20026f294",
"title": "Voluptatem sunt laborum aliquid.",
"rationale": "Modi sequi molestias. Ratione est inventore. Voluptatibus a quam.",
"description": "Eligendi debitis deleniti. Nobis provident quaerat. Accusantium vitae et.",
"severity": "high",
"precedence": 345,
"identifier": {
"href": "http://kassulke-becker.test/cody.mccullough",
"label": "Wulf"
},
"references": [
{
"href": "http://boyer.example/emerald.waelchi",
"label": "Herugar Bolger"
},
{
"href": "http://altenwerth.example/kari_kris",
"label": "Fortinbras Took"
},
{
"href": "http://casper.example/ward",
"label": "Rufus Burrows"
},
{
"href": "http://auer.example/tia",
"label": "Malantur"
},
{
"href": "http://block-romaguera.example/vince",
"label": "Andróg"
}
],
"value_checks": null,
"remediation_available": false,
"rule_group_id": "3dd3383d-6517-4996-9442-f517f6035588",
"type": "rule"
},
{
"id": "c1c0b8df-f985-4189-b9af-1f888d7303e4",
"ref_id": "xccdf_org.ssgproject.content_rule_658b64922d7944153a7aa715f311ebbb",
"title": "Dolor ipsa dolores et.",
"rationale": "Nobis maiores minus. Dolorem quia non. Ab quas voluptatem.",
"description": "Ratione voluptatibus ut. Possimus voluptatem in. Nihil incidunt doloribus.",
"severity": "medium",
"precedence": 805,
"identifier": {
"href": "http://spencer.example/gino.herzog",
"label": "Aulendil"
},
"references": [
{
"href": "http://rice.test/aldo",
"label": "Elros"
},
{
"href": "http://mertz.example/rene.hermann",
"label": "Nolondil"
},
{
"href": "http://bergstrom.example/sung_lang",
"label": "Nár"
},
{
"href": "http://considine-homenick.example/shad",
"label": "William"
},
{
"href": "http://goyette.test/donna.stoltenberg",
"label": "Faniel"
}
],
"value_checks": null,
"remediation_available": false,
"rule_group_id": "4804880e-995d-42f0-97a9-fbb1d57d31ee",
"type": "rule"
},
{
"id": "2c97d58e-1a57-4d92-9dd9-b0e549c2a51e",
"ref_id": "xccdf_org.ssgproject.content_rule_626530fc9a06e0c3d5f9bbc0b4dda349",
"title": "Facilis aut veniam iure.",
"rationale": "Magni itaque et. Non nesciunt optio. Qui sequi non.",
"description": "Sequi omnis ipsa. Dolorem magnam rerum. Cum eligendi asperiores.",
"severity": "medium",
"precedence": 828,
"identifier": {
"href": "http://douglas.test/jamal.ward",
"label": "Ferdinand Took"
},
"references": [
{
"href": "http://mitchell-hills.example/letisha",
"label": "Mîm"
},
{
"href": "http://wisozk-lowe.test/trudy.champlin",
"label": "Telchar"
},
{
"href": "http://nolan-kshlerin.example/keneth",
"label": "Angelimir"
},
{
"href": "http://lesch.example/robt_sporer",
"label": "Hallatan"
},
{
"href": "http://dare-bosco.test/chantelle_bahringer",
"label": "Amlach"
}
],
"value_checks": null,
"remediation_available": false,
"rule_group_id": "3109547d-ae24-41e7-8fd9-142f9ccb070e",
"type": "rule"
},
{
"id": "edcb1d0b-8db1-493f-8c34-b3002cc138f6",
"ref_id": "xccdf_org.ssgproject.content_rule_f46fbd55d2b07a31445646a3e7347485",
"title": "Maiores magnam fuga laborum.",
"rationale": "Qui quos a. Suscipit distinctio autem. Consequatur nesciunt iusto.",
"description": "Quae sapiente voluptatem. Dolorum molestias mollitia. Eius vero quis.",
"severity": "high",
"precedence": 1016,
"identifier": {
"href": "http://batz.example/oliver.kunde",
"label": "Tata"
},
"references": [
{
"href": "http://sipes.example/alexis",
"label": "Carc"
},
{
"href": "http://heller.example/aurelio.koelpin",
"label": "Anson Roper"
},
{
"href": "http://lehner.example/adan_marquardt",
"label": "Nár"
},
{
"href": "http://jacobs.example/isiah.cole",
"label": "Findis"
},
{
"href": "http://green-powlowski.example/amberly_spinka",
"label": "Silmariën"
}
],
"value_checks": null,
"remediation_available": false,
"rule_group_id": "dcef6d6a-fa2c-43b6-b472-7e734c3a02d4",
"type": "rule"
},
{
"id": "070000bb-8de7-4192-a021-b9751ed83d8b",
"ref_id": "xccdf_org.ssgproject.content_rule_d485f9d056c84e5b2ca9e424a115b3e0",
"title": "Nihil excepturi illo aliquid.",
"rationale": "Ut rerum quia. Totam debitis veritatis. Accusantium est nihil.",
"description": "Minus ea eum. Sapiente eligendi et. Necessitatibus quo dolore.",
"severity": "low",
"precedence": 1265,
"identifier": {
"href": "http://von.example/jerrell",
"label": "Narmacil"
},
"references": [
{
"href": "http://ortiz.example/michal.altenwerth",
"label": "Gandalf"
},
{
"href": "http://carter.test/krissy",
"label": "Rosa Baggins"
},
{
"href": "http://grant.test/burl_erdman",
"label": "Mrs. Bunce"
},
{
"href": "http://okon.test/arlinda.koepp",
"label": "Rufus Burrows"
},
{
"href": "http://windler.test/neil_welch",
"label": "Cemendur"
}
],
"value_checks": null,
"remediation_available": false,
"rule_group_id": "b71ec3d7-7740-4766-b31a-138bd4825b4a",
"type": "rule"
},
{
"id": "96be6a44-e3f0-4465-a55a-94672a649d85",
"ref_id": "xccdf_org.ssgproject.content_rule_499dcfeee0bec7e4af5e3aedab588042",
"title": "Ipsum aut neque culpa.",
"rationale": "Modi quisquam in. Aspernatur voluptatem mollitia. Dolorum voluptatibus quia.",
"description": "Laboriosam exercitationem perspiciatis. Enim ea autem. Reiciendis aspernatur aliquid.",
"severity": "high",
"precedence": 1640,
"identifier": {
"href": "http://robel.test/lily_bernhard",
"label": "Ibun"
},
"references": [
{
"href": "http://fadel-goyette.example/collen",
"label": "Lofar"
},
{
"href": "http://russel.test/tyson_parker",
"label": "Gamil Zirak"
},
{
"href": "http://boyle-crist.example/ardath",
"label": "Meneldor"
},
{
"href": "http://simonis-simonis.example/danae",
"label": "Hathol"
},
{
"href": "http://heller-bauch.example/lina",
"label": "Glaurung"
}
],
"value_checks": null,
"remediation_available": false,
"rule_group_id": "7028d64c-ac07-4833-af5b-8fdb75aa9ace",
"type": "rule"
},
{
"id": "252d32bb-a437-445a-8eff-488c851c08ee",
"ref_id": "xccdf_org.ssgproject.content_rule_e6b10af4b61e5de18decf7862e3da32a",
"title": "Non voluptas omnis iste.",
"rationale": "Enim fuga tenetur. Aperiam voluptatem iure. Rem deserunt sed.",
"description": "Aut quia doloremque. Atque cupiditate amet. Architecto quisquam optio.",
"severity": "medium",
"precedence": 1823,
"identifier": {
"href": "http://corkery-kreiger.test/carmelo",
"label": "Amaranth Brandybuck"
},
"references": [
{
"href": "http://wilderman.test/quinton_kutch",
"label": "Daisy Gardner"
},
{
"href": "http://doyle.test/elijah",
"label": "Gálmód"
},
{
"href": "http://walker-hane.test/talitha",
"label": "Aerin"
},
{
"href": "http://lang.example/kareen.schaden",
"label": "Valandil"
},
{
"href": "http://morar-bradtke.test/merrill",
"label": "Tar-Aldarion"
}
],
"value_checks": null,
"remediation_available": false,
"rule_group_id": "16f0100c-5c14-4036-8ad4-8e902e33c026",
"type": "rule"
},
{
"id": "43a47257-e302-49c4-9579-26005bcce5b9",
"ref_id": "xccdf_org.ssgproject.content_rule_1c5ee35bfbfb4b96c0b8158f4e57a245",
"title": "Quos expedita voluptate cum.",
"rationale": "Et accusamus rerum. Minima dolor qui. Voluptatem ratione tempore.",
"description": "Nisi nulla maiores. Neque non deserunt. Consequatur dolorem esse.",
"severity": "low",
"precedence": 2519,
"identifier": {
"href": "http://nader.example/buster.shanahan",
"label": "Bruno Bracegirdle"
},
"references": [
{
"href": "http://sporer-schoen.test/shelton",
"label": "Lúthien"
},
{
"href": "http://mcclure.test/elma",
"label": "Gárulf"
},
{
"href": "http://crooks.test/jody.bashirian",
"label": "Daisy Baggins"
},
{
"href": "http://predovic.example/junior_schinner",
"label": "Algund"
},
{
"href": "http://russel.test/bertha",
"label": "Mahtan"
}
],
"value_checks": null,
"remediation_available": false,
"rule_group_id": "f1d5acc4-35ed-474a-8fd8-365bd47fb077",
"type": "rule"
}
],
"meta": {
"total": 25,
"limit": 10,
"offset": 0,
"sort_by": "precedence"
},
"links": {
"first": "/api/compliance/v2/security_guides/920a5473-e345-4993-b778-efb88b44d486/rules?limit=10&offset=0&sort_by=precedence",
"last": "/api/compliance/v2/security_guides/920a5473-e345-4993-b778-efb88b44d486/rules?limit=10&offset=20&sort_by=precedence",
"next": "/api/compliance/v2/security_guides/920a5473-e345-4993-b778-efb88b44d486/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": "Returns a Rule",
"operationId": "Rule",
"responses": {
"200": {
"description": "Returns a Rule",
"content": {
"application/vnd.api+json": {
"examples": {
"Returns a Rule": {
"value": {
"data": {
"id": "6b458ae7-21d9-4a38-981c-a745b094df7b",
"ref_id": "xccdf_org.ssgproject.content_rule_3fa17287fd97c7d9003cd13f1acd6b62",
"title": "Illo temporibus quam eius.",
"rationale": "Adipisci perferendis non. Aut repellat ratione. Rerum placeat omnis.",
"description": "Amet numquam harum. Est ducimus nemo. Quaerat tempora aspernatur.",
"severity": "high",
"precedence": 4865,
"identifier": {
"href": "http://erdman.example/juan_marvin",
"label": "Nellas"
},
"references": [
{
"href": "http://murazik.test/blake_schinner",
"label": "Gwaihir"
},
{
"href": "http://murphy.test/jordan",
"label": "Haleth"
},
{
"href": "http://veum.example/gary",
"label": "Turambar"
},
{
"href": "http://ankunding-blanda.test/weston.crooks",
"label": "Sangahyando"
},
{
"href": "http://keeling.example/fermina",
"label": "Sangahyando"
}
],
"value_checks": null,
"remediation_available": false,
"rule_group_id": "766b3e31-4706-4e3f-9719-d4377c55fc23",
"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 e5101581-c501-440c-bf40-7535a0bf220e"
]
},
"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 (`<key>:asc` or `<key>:desc`).<br><br>If no direction is selected, `<key>: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 <a href=\"https://github.com/wvanbergen/scoped_search/wiki/Query-language\" target=\"_blank\" title=\"github.com/wvanbergen/scoped_search\">scoped_search query language</a>. However, only `=` or `!=` (resp. `<>`) operators are supported.<br><br>Rules are searchable using attributes `title`, `severity`, `remediation_available`, and `rule_group_id`<br><br>(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": "Lists Rules assigned to a Profile",
"operationId": "ProfileRules",
"responses": {
"200": {
"description": "Lists Rules assigned to a Profile",
"content": {
"application/vnd.api+json": {
"examples": {
"List of Rules": {
"value": {
"data": [
{
"id": "029de7be-c67d-4308-99f2-9a6644e1919f",
"ref_id": "xccdf_org.ssgproject.content_rule_e364f2c49e6b95b6ef96619ead7453af",
"title": "Aut tenetur occaecati veritatis.",
"rationale": "Pariatur qui porro. Mollitia qui est. Veniam eos et.",
"description": "Maiores excepturi necessitatibus. In qui vitae. Adipisci voluptates inventore.",
"severity": "high",
"precedence": 9206,
"identifier": {
"href": "http://beier.example/monte_sauer",
"label": "Hildigrim Took"
},
"references": [
{
"href": "http://kohler-beatty.test/logan.corwin",
"label": "Hob Hayward"
},
{
"href": "http://gerlach.example/otis",
"label": "Imlach"
},
{
"href": "http://turner.example/napoleon",
"label": "Háma"
},
{
"href": "http://mcglynn.example/fran",
"label": "Belen"
},
{
"href": "http://hahn-wyman.test/jeannette",
"label": "Mauhúr"
}
],
"value_checks": null,
"remediation_available": false,
"rule_group_id": "b858a0eb-3ef1-4434-93fb-01e3d12dd1a6",
"type": "rule",
"remediation_issue_id": null
},
{
"id": "0a0de1ad-8668-4264-bead-95fd0b17368f",
"ref_id": "xccdf_org.ssgproject.content_rule_0c997a00c0336a1f33ffa27b4fa048c7",
"title": "Facere et saepe voluptates.",
"rationale": "Vitae at voluptatem. Voluptas dolore a. Dolor at et.",
"description": "Sed consequatur sapiente. Consequatur ipsa voluptatibus. Beatae architecto accusantium.",
"severity": "high",
"precedence": 9075,
"identifier": {
"href": "http://orn.test/mary_schamberger",
"label": "Nazgûl"
},
"references": [
{
"href": "http://halvorson-thompson.example/neomi_toy",
"label": "Ungoliant"
},
{
"href": "http://hauck-stoltenberg.example/bryon.botsford",
"label": "Goldilocks Gardner"
},
{
"href": "http://willms.example/roman",
"label": "Imin"
},
{
"href": "http://orn-kihn.test/christena",
"label": "Huan"
},
{
"href": "http://greenfelder.example/arturo_reichel",
"label": "Ferdibrand Took"
}
],
"value_checks": null,
"remediation_available": false,
"rule_group_id": "4514f301-4f97-4f80-8bfa-01b3fe4f037f",
"type": "rule",
"remediation_issue_id": null
},
{
"id": "17afb7e8-0158-4d29-9a2c-ce40d9dbc56a",
"ref_id": "xccdf_org.ssgproject.content_rule_17aa2959c46f0d704568d3af439083e8",
"title": "Nihil aut consectetur expedita.",
"rationale": "Aliquid quisquam fugit. Natus et modi. Maiores provident beatae.",
"description": "Sint dolorem aut. Assumenda nihil aut. Odio temporibus maiores.",
"severity": "high",
"precedence": 8167,
"identifier": {
"href": "http://reichel-jacobson.test/romana",
"label": "Arassuil"
},
"references": [
{
"href": "http://stehr.test/patience",
"label": "Fingolfin"
},
{
"href": "http://bernhard.example/long",
"label": "Forthwini"
},
{
"href": "http://gulgowski-beer.test/gerald.turner",
"label": "Olo Proudfoot"
},
{
"href": "http://little.example/earlie.spencer",
"label": "Eöl"
},
{
"href": "http://ruecker.test/angila_funk",
"label": "Ar-Zimrathôn"
}
],
"value_checks": null,
"remediation_available": false,
"rule_group_id": "2f3f1e4c-be46-487b-9858-cf553da60509",
"type": "rule",
"remediation_issue_id": null
},
{
"id": "2582aecb-f0fd-4723-b714-d307c20401db",
"ref_id": "xccdf_org.ssgproject.content_rule_6c114e7c664a2d5fadf99fcbd38f2ad6",
"title": "Velit dolor natus ut.",
"rationale": "Expedita explicabo fuga. Magnam eum non. Perferendis ut iste.",
"description": "Est autem suscipit. Labore nobis et. Illo quasi sit.",
"severity": "high",
"precedence": 3350,
"identifier": {
"href": "http://kuhn-oconnell.example/elton_bauch",
"label": "Ufthak"
},
"references": [
{
"href": "http://klein.example/leanora_schinner",
"label": "Frár"
},
{
"href": "http://cremin.example/terrell",
"label": "Aldor"
},
{
"href": "http://kub-fay.example/leisha.beier",
"label": "Rudigar Bolger"
},
{
"href": "http://flatley-ratke.test/synthia_goyette",
"label": "Harding of the Hill"
},
{
"href": "http://bednar.example/katherine.nikolaus",
"label": "Daddy Twofoot"
}
],
"value_checks": null,
"remediation_available": false,
"rule_group_id": "13c0f551-f89e-4316-97c8-089722f641e9",
"type": "rule",
"remediation_issue_id": null
},
{
"id": "31eb215e-5f42-4bb5-be66-5a4600f82801",
"ref_id": "xccdf_org.ssgproject.content_rule_c5a857962fc8dd6927d5bf96daaf4ecb",
"title": "Ratione nulla vitae optio.",
"rationale": "Ullam quisquam id. Consequuntur voluptate dolore. Sapiente minus voluptatem.",
"description": "Quibusdam quia voluptatem. Dicta ut doloribus. Nesciunt nostrum exercitationem.",
"severity": "high",
"precedence": 5392,
"identifier": {
"href": "http://johnston-wilkinson.test/willene.steuber",
"label": "Zimraphel"
},
"references": [
{
"href": "http://davis-rogahn.example/gisela",
"label": "Angbor"
},
{
"href": "http://welch-paucek.example/wes.roberts",
"label": "Calimehtar"
},
{
"href": "http://heathcote-fadel.test/gaynell",
"label": "Dori"
},
{
"href": "http://beier.test/tarah",
"label": "Pelendur"
},
{
"href": "http://runte-dach.test/elise",
"label": "Ragnir"
}
],
"value_checks": null,
"remediation_available": false,
"rule_group_id": "f670dc22-f936-4782-9a21-c1c85f592de6",
"type": "rule",
"remediation_issue_id": null
},
{
"id": "3de01c44-8d02-47d5-b781-3215ee3ba83e",
"ref_id": "xccdf_org.ssgproject.content_rule_b974557d03fa92bced5feaa1e7770b37",
"title": "Et eum quae ipsam.",
"rationale": "Corrupti est et. Similique ab rerum. Rerum aut asperiores.",
"description": "Laboriosam sint ipsum. Commodi nam dolores. Sit qui delectus.",
"severity": "medium",
"precedence": 280,
"identifier": {
"href": "http://jaskolski.test/louis",
"label": "Atanatar"
},
"references": [
{
"href": "http://kreiger.example/angel",
"label": "Donnamira Took"
},
{
"href": "http://torphy.test/benita_dicki",
"label": "Iorlas"
},
{
"href": "http://rempel-klocko.test/lilly_hagenes",
"label": "Tuor"
},
{
"href": "http://dickens.example/erin",
"label": "Ungoliant"
},
{
"href": "http://cassin.test/franklyn_gleichner",
"label": "Vardamir"
}
],
"value_checks": null,
"remediation_available": false,
"rule_group_id": "b0eb382e-6fdd-4986-bc6c-0bf4d2214714",
"type": "rule",
"remediation_issue_id": null
},
{
"id": "424429aa-f084-41e8-8621-7269df4b2c27",
"ref_id": "xccdf_org.ssgproject.content_rule_65af1fcd46fdb4871d68d0e3a9308483",
"title": "Qui sed sint recusandae.",
"rationale": "Mollitia est expedita. Recusandae et velit. Non saepe eos.",
"description": "Nemo qui debitis. Doloremque similique maiores. Nihil esse inventore.",
"severity": "low",
"precedence": 7003,
"identifier": {
"href": "http://paucek.test/stanley",
"label": "Goldberry"
},
"references": [
{
"href": "http://metz.test/josefa",
"label": "Peregrin Took"
},
{
"href": "http://smitham.example/chadwick",
"label": "Mallor"
},
{
"href": "http://mohr-nienow.test/brian",
"label": "Hirluin"
},
{
"href": "http://mitchell.test/evelin.kub",
"label": "Robin Gardner"
},
{
"href": "http://haag.test/piper",
"label": "Borin"
}
],
"value_checks": null,
"remediation_available": false,
"rule_group_id": "9224e152-447e-428a-978f-a8a7d1dba2b8",
"type": "rule",
"remediation_issue_id": null
},
{
"id": "45078790-d106-49aa-bfb0-67ff3ac71188",
"ref_id": "xccdf_org.ssgproject.content_rule_453bf90786fce0473020e2af01610513",
"title": "Soluta corporis eum deleniti.",
"rationale": "Explicabo perspiciatis ab. Debitis sint quod. Inventore sed quia.",
"description": "Aut illum id. Suscipit vel reprehenderit. Doloremque qui praesentium.",
"severity": "low",
"precedence": 5407,
"identifier": {
"href": "http://bahringer.test/daisey.conn",
"label": "Erien"
},
"references": [
{
"href": "http://schmeler.example/ronnie_hintz",
"label": "Dervorin"
},
{
"href": "http://hodkiewicz.test/ezekiel",
"label": "Îbal"
},
{
"href": "http://rodriguez.example/gary",
"label": "Aranwë"
},
{
"href": "http://boyle.test/alden_dooley",
"label": "Eärwen"
},
{
"href": "http://leuschke-gibson.test/daniela",
"label": "Radbug"
}
],
"value_checks": null,
"remediation_available": false,
"rule_group_id": "1b8b0452-7bbd-41f2-b81e-033a07ab0a5c",
"type": "rule",
"remediation_issue_id": null
},
{
"id": "45819c94-e6e0-4e2a-a1fb-3d2dccd751cb",
"ref_id": "xccdf_org.ssgproject.content_rule_aac2d354fd325e39bbcd772d99a587c5",
"title": "Et qui autem deleniti.",
"rationale": "Exercitationem aut consequuntur. Harum assumenda quia. Voluptatem quia fugit.",
"description": "Sed magnam ut. Praesentium alias eveniet. Voluptate laborum in.",
"severity": "medium",
"precedence": 1238,
"identifier": {
"href": "http://dubuque-reilly.example/wilburn_predovic",
"label": "Finarfin"
},
"references": [
{
"href": "http://schumm.test/howard",
"label": "Durin"
},
{
"href": "http://effertz-strosin.example/stanford.daniel",
"label": "Celebrimbor"
},
{
"href": "http://macgyver-goldner.test/hai.rice",
"label": "Elanor Gardner"
},
{
"href": "http://reichert.example/wayne_langosh",
"label": "Baran"
},
{
"href": "http://moen.test/elane",
"label": "Fingolfin"
}
],
"value_checks": null,
"remediation_available": false,
"rule_group_id": "4f7f241e-1775-4625-a3c3-fa358f8d48b1",
"type": "rule",
"remediation_issue_id": null
},
{
"id": "55aedfdf-e58f-464c-9785-0f8747616d0e",
"ref_id": "xccdf_org.ssgproject.content_rule_9439eb38c7adf67c86e4793e52685694",
"title": "Culpa itaque saepe repellendus.",
"rationale": "Eaque beatae sit. Commodi quos dolor. Adipisci impedit qui.",
"description": "Quia voluptate harum. Sit atque in. Laudantium similique fugiat.",
"severity": "low",
"precedence": 2869,
"identifier": {
"href": "http://roob.example/asley",
"label": "Tal-Elmar"
},
"references": [
{
"href": "http://harvey.test/norma.weissnat",
"label": "Adelard Took"
},
{
"href": "http://nikolaus.example/bridgette_schultz",
"label": "Hildibrand Took"
},
{
"href": "http://leannon.example/roderick.mcdermott",
"label": "Dora Baggins"
},
{
"href": "http://hilpert-kozey.example/shannon",
"label": "Ingwion"
},
{
"href": "http://nikolaus-keeling.test/fernando",
"label": "Roäc"
}
],
"value_checks": null,
"remediation_available": false,
"rule_group_id": "e73b47fe-fe7f-4feb-abde-e8cd22920dc1",
"type": "rule",
"remediation_issue_id": null
}
],
"meta": {
"total": 25,
"limit": 10,
"offset": 0
},
"links": {
"first": "/api/compliance/v2/security_guides/4ef7cfa3-2772-453f-b477-e0b0230a46b3/profiles/b12be9c6-b492-4dec-9838-b20e88dec49f/rules?limit=10&offset=0",
"last": "/api/compliance/v2/security_guides/4ef7cfa3-2772-453f-b477-e0b0230a46b3/profiles/b12be9c6-b492-4dec-9838-b20e88dec49f/rules?limit=10&offset=20",
"next": "/api/compliance/v2/security_guides/4ef7cfa3-2772-453f-b477-e0b0230a46b3/profiles/b12be9c6-b492-4dec-9838-b20e88dec49f/rules?limit=10&offset=10"
}
},
"summary": "",
"description": ""
},
"List of Rules sorted by \"precedence:asc\"": {
"value": {
"data": [
{
"id": "55294b15-ce94-43af-b26f-6d18f37cba0b",
"ref_id": "xccdf_org.ssgproject.content_rule_69721f9c626cbf84d1c3a45223764960",
"title": "Illo facere voluptatem ratione.",
"rationale": "Delectus aut autem. Numquam voluptatem et. Et consequatur at.",
"description": "Doloremque incidunt vel. Necessitatibus illo sint. Sunt iste dolorem.",
"severity": "low",
"precedence": 20,
"identifier": {
"href": "http://okuneva.example/lawanda.boyer",
"label": "Gelmir"
},
"references": [
{
"href": "http://yost.test/caprice_greenholt",
"label": "Meriadoc Brandybuck"
},
{
"href": "http://ziemann.test/richard.welch",
"label": "Bandobras Took"
},
{
"href": "http://baumbach-bergstrom.example/belen",
"label": "Tar-Palantir"
},
{
"href": "http://schmeler.test/tyisha_wilkinson",
"label": "Ulfang"
},
{
"href": "http://blick-hahn.example/tamie",
"label": "Dora Baggins"
}
],
"value_checks": null,
"remediation_available": false,
"rule_group_id": "1fcf7dc5-235b-4122-aee4-56f73aeac573",
"type": "rule",
"remediation_issue_id": null
},
{
"id": "3a1e09e6-c7a6-40ee-8239-01ede2da6f8e",
"ref_id": "xccdf_org.ssgproject.content_rule_5b9b3aa0976fc983919690cc52fe0ffe",
"title": "Laboriosam incidunt in deleniti.",
"rationale": "Perspiciatis quia libero. Ut quidem facilis. Laudantium error veniam.",
"description": "Voluptatibus mollitia nobis. Culpa iste magni. Praesentium sit iste.",
"severity": "high",
"precedence": 149,
"identifier": {
"href": "http://goodwin.example/lakesha.mosciski",
"label": "Gil-galad"
},
"references": [
{
"href": "http://bauch-balistreri.test/dawna.renner",
"label": "Farmer Cotton"
},
{
"href": "http://batz.test/yuonne_willms",
"label": "Ar-Zimrathôn"
},
{
"href": "http://connelly-lakin.example/shamika",
"label": "Tata"
},
{
"href": "http://marvin-farrell.example/natacha",
"label": "Hildigrim Took"
},
{
"href": "http://adams.example/kieth",
"label": "Briffo Boffin"
}
],
"value_checks": null,
"remediation_available": false,
"rule_group_id": "6443421b-681c-4e61-9fce-700cef79f6b4",
"type": "rule",
"remediation_issue_id": null
},
{
"id": "dd6afc72-86fd-4188-9249-21c6d0930652",
"ref_id": "xccdf_org.ssgproject.content_rule_53699c140ef91079ff2194276c24f2a4",
"title": "Quidem excepturi neque aut.",
"rationale": "Quia laboriosam sequi. Eaque sequi fuga. Placeat eaque praesentium.",
"description": "Deserunt ut ut. Neque ducimus corporis. Iste ut et.",
"severity": "high",
"precedence": 620,
"identifier": {
"href": "http://fay-hoeger.example/noel",
"label": "Sapphira Brockhouse"
},
"references": [
{
"href": "http://hartmann-mante.example/vernell",
"label": "Ulfast"
},
{
"href": "http://wisozk-veum.example/carletta_wisozk",
"label": "Girion"
},
{
"href": "http://schroeder.example/tammi_terry",
"label": "Elboron"
},
{
"href": "http://roob.example/trey_sipes",
"label": "Cora Goodbody"
},
{
"href": "http://dietrich.test/max",
"label": "Ar-Zimrathôn"
}
],
"value_checks": null,
"remediation_available": false,
"rule_group_id": "23b1f143-6609-4c41-a5e8-6c928d211181",
"type": "rule",
"remediation_issue_id": null
},
{
"id": "c181fe8c-d38d-4d48-8927-31dad0da9b0c",
"ref_id": "xccdf_org.ssgproject.content_rule_226c8b9cd84d8b605d8fb7073efd773d",
"title": "Autem et quibusdam et.",
"rationale": "Aut tempora ut. Assumenda accusamus voluptas. Hic sunt ut.",
"description": "Qui qui inventore. Vero at consequatur. Rerum ratione ea.",
"severity": "low",
"precedence": 643,
"identifier": {
"href": "http://deckow.example/fernando.klein",
"label": "Bowman Cotton"
},
"references": [
{
"href": "http://marks-heathcote.example/rosenda_dare",
"label": "Shagram"
},
{
"href": "http://dare.example/rod",
"label": "Cora Goodbody"
},
{
"href": "http://jacobs.example/earl_adams",
"label": "Malva Headstrong"
},
{
"href": "http://harber.test/neil",
"label": "Bucca of the Marish"
},
{
"href": "http://renner.test/gregorio.bauch",
"label": "Mrs. Maggot"
}
],
"value_checks": null,
"remediation_available": false,
"rule_group_id": "37e0907e-0077-47c3-bc81-6da402ab2d32",
"type": "rule",
"remediation_issue_id": null
},
{
"id": "1ebab747-d3d8-4662-b04d-c64f5d150880",
"ref_id": "xccdf_org.ssgproject.content_rule_0af3e2cbaaa00c827e9da9bb91e0b91f",
"title": "Vitae ducimus exercitationem in.",
"rationale": "Quia exercitationem enim. Pariatur velit ut. Sit vel qui.",
"description": "Dicta facilis amet. Aliquid explicabo consequatur. Facere omnis illum.",
"severity": "medium",
"precedence": 722,
"identifier": {
"href": "http://mohr.example/frederica",
"label": "Rowan"
},
"references": [
{
"href": "http://langosh.test/kurtis.haley",
"label": "Prisca Baggins"
},
{
"href": "http://hagenes.test/irmgard",
"label": "Brandir"
},
{
"href": "http://roob.example/marva",
"label": "Frár"
},
{
"href": "http://kris-schamberger.example/mitchell.carter",
"label": "Ghân-buri-Ghân"
},
{
"href": "http://cole-kunze.test/broderick_crist",
"label": "Mîm"
}
],
"value_checks": null,
"remediation_available": false,
"rule_group_id": "95f8bc44-8d45-44f6-bd6b-2376e558f470",
"type": "rule",
"remediation_issue_id": null
},
{
"id": "c5e0c4d3-fd2a-4d78-99cc-033fe81384c7",
"ref_id": "xccdf_org.ssgproject.content_rule_521e5caed09978fa4d9c8953e7044fa1",
"title": "Sit saepe nisi harum.",
"rationale": "Architecto dolor aut. Nesciunt sit perspiciatis. Repudiandae ad doloribus.",
"description": "Placeat dolor delectus. Enim soluta quo. Ea asperiores reiciendis.",
"severity": "low",
"precedence": 843,
"identifier": {
"href": "http://lindgren.test/jacinto",
"label": "Primrose Boffin"
},
"references": [
{
"href": "http://marvin-ruecker.test/luke_gleichner",
"label": "Girion"
},
{
"href": "http://franecki.example/elaine.kutch",
"label": "Tar-Atanamir"
},
{
"href": "http://yundt.example/micheal_sawayn",
"label": "Rúmil"
},
{
"href": "http://lehner.example/sanora_vandervort",
"label": "Bolg"
},
{
"href": "http://mayer.example/angelena.kuphal",
"label": "Rudolph Bolger"
}
],
"value_checks": null,
"remediation_available": false,
"rule_group_id": "17ba29c5-659a-40d6-b57d-a94fc4323fdc",
"type": "rule",
"remediation_issue_id": null
},
{
"id": "b15b1846-6fdf-4f1f-a410-112dd3e4c81a",
"ref_id": "xccdf_org.ssgproject.content_rule_df9ac6b603c9c001f4d340b7ded77ee9",
"title": "Velit sequi recusandae labore.",
"rationale": "Officiis et esse. Odit corrupti sed. Quam aliquid saepe.",
"description": "In ut sequi. Ullam nobis consectetur. Voluptas quo quisquam.",
"severity": "low",
"precedence": 1084,
"identifier": {
"href": "http://heller.example/louvenia.okon",
"label": "Radhruin"
},
"references": [
{
"href": "http://thiel.example/marlon_gorczany",
"label": "Thráin"
},
{
"href": "http://schaden-parisian.example/michiko",
"label": "Ponto Baggins"
},
{
"href": "http://heaney.test/reed.johnson",
"label": "Ted Sandyman"
},
{
"href": "http://feest.test/hipolito",
"label": "Bell Goodchild"
},
{
"href": "http://corkery.test/cole",
"label": "Avranc"
}
],
"value_checks": null,
"remediation_available": false,
"rule_group_id": "54b2703c-9125-405a-a323-c39048526c7c",
"type": "rule",
"remediation_issue_id": null
},
{
"id": "bfa66237-08ae-47c9-81c4-b8b396ff2fd9",
"ref_id": "xccdf_org.ssgproject.content_rule_85e98cbcfde650fc1296b296fb5576c7",
"title": "Nulla unde minima ut.",
"rationale": "Iure optio quia. Necessitatibus minus voluptatem. Quae quas aut.",
"description": "Sed libero iusto. Commodi tempora ducimus. A impedit omnis.",
"severity": "medium",
"precedence": 1255,
"identifier": {
"href": "http://dibbert-leffler.example/basilia.marks",
"label": "Saradoc Brandybuck"
},
"references": [
{
"href": "http://douglas.example/gina.hilpert",
"label": "Arahad"
},
{
"href": "http://stehr-pagac.example/elmer",
"label": "Uldor"
},
{
"href": "http://kunze.example/tiffany",
"label": "Doderic Brandybuck"
},
{
"href": "http://rodriguez-medhurst.example/wendell",
"label": "Tar-Minastir"
},
{
"href": "http://harvey.example/serafina",
"label": "Fastolph Bolger"
}
],
"value_checks": null,
"remediation_available": false,
"rule_group_id": "0940e72f-f412-4e0a-9133-b5bea9b1646d",
"type": "rule",
"remediation_issue_id": null
},
{
"id": "05c1f552-82c6-49f0-bd0b-b8d60c9f54d9",
"ref_id": "xccdf_org.ssgproject.content_rule_6690ce34d4ab7ab4987a4132e5f1496e",
"title": "Quisquam eaque consequuntur sit.",
"rationale": "Commodi et dignissimos. Consequuntur et quia. Exercitationem debitis sed.",
"description": "Dignissimos cumque adipisci. Explicabo suscipit dicta. Perferendis ratione vitae.",
"severity": "low",
"precedence": 1503,
"identifier": {
"href": "http://jacobson.test/darrin",
"label": "Almáriel"
},
"references": [
{
"href": "http://auer.test/filomena",
"label": "Malva Headstrong"
},
{
"href": "http://osinski.example/angeline",
"label": "Mablung"
},
{
"href": "http://volkman.example/lawerence.strosin",
"label": "Milo Burrows"
},
{
"href": "http://crooks.example/latesha",
"label": "Thráin"
},
{
"href": "http://collins.test/carleen.will",
"label": "Lindissë"
}
],
"value_checks": null,
"remediation_available": false,
"rule_group_id": "dafc6399-b30c-4b81-bc54-b224e9c42297",
"type": "rule",
"remediation_issue_id": null
},
{
"id": "ecf509f5-653d-4a68-b35d-e19f8795b197",
"ref_id": "xccdf_org.ssgproject.content_rule_260e864078e7e637039d8125011d7188",
"title": "Ea et voluptatem alias.",
"rationale": "Officia modi corrupti. Rerum id in. Rerum velit odio.",
"description": "Esse dolores voluptas. Sed sit aut. Recusandae velit alias.",
"severity": "high",
"precedence": 2136,
"identifier": {
"href": "http://weber.example/karan",
"label": "Gruffo Boffin"
},
"references": [
{
"href": "http://cartwright.example/bethanie.price",
"label": "Elrohir"
},
{
"href": "http://predovic.test/jesus.boehm",
"label": "Cotman"
},
{
"href": "http://stanton-kertzmann.example/wanda",
"label": "Robin Gardner"
},
{
"href": "http://dare.example/marcelo_casper",
"label": "Hazad"
},
{
"href": "http://tromp.test/dallas_runolfsdottir",
"label": "Telumehtar Umbardacil"
}
],
"value_checks": null,
"remediation_available": false,
"rule_group_id": "eb9c966f-da59-4ffe-b716-ca81e6b96e17",
"type": "rule",
"remediation_issue_id": null
}
],
"meta": {
"total": 25,
"limit": 10,
"offset": 0,
"sort_by": "precedence"
},
"links": {
"first": "/api/compliance/v2/security_guides/78890ab7-3f30-45af-a278-e90d56ec0860/profiles/09539e62-a04b-4ac1-aea8-878e2d6b54e0/rules?limit=10&offset=0&sort_by=precedence",
"last": "/api/compliance/v2/security_guides/78890ab7-3f30-45af-a278-e90d56ec0860/profiles/09539e62-a04b-4ac1-aea8-878e2d6b54e0/rules?limit=10&offset=20&sort_by=precedence",
"next": "/api/compliance/v2/security_guides/78890ab7-3f30-45af-a278-e90d56ec0860/profiles/09539e62-a04b-4ac1-aea8-878e2d6b54e0/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": "Returns a Rule assigned to a 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": "ba5d8f28-18b2-4122-a7bd-b0c17ceb4508",
"ref_id": "xccdf_org.ssgproject.content_rule_5629c1aa057bf382fd59bfd6d996ae31",
"title": "Rerum quos totam soluta.",
"rationale": "Non illum eos. Iure enim sed. Dolorum molestiae dignissimos.",
"description": "Dignissimos voluptate non. Unde aut veritatis. Quo ratione molestiae.",
"severity": "high",
"precedence": 9822,
"identifier": {
"href": "http://will-bayer.test/roderick_moore",
"label": "Cotman"
},
"references": [
{
"href": "http://ritchie.example/cathrine_schuster",
"label": "Tar-Atanamir"
},
{
"href": "http://mraz-mosciski.test/hank.block",
"label": "Frumgar"
},
{
"href": "http://keeling-stark.example/suzanna",
"label": "Borlas"
},
{
"href": "http://boyle.example/dayna.marks",
"label": "Pengolodh"
},
{
"href": "http://larson-roberts.test/haywood_braun",
"label": "Angbor"
}
],
"value_checks": null,
"remediation_available": false,
"rule_group_id": "5fd10ace-dfac-4fb0-b27f-af1a23cf5f36",
"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 8e794357-ecf8-4527-8b62-b41dc6c6f7e0"
]
},
"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 (`<key>:asc` or `<key>:desc`).<br><br>If no direction is selected, `<key>: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 <a href=\"https://github.com/wvanbergen/scoped_search/wiki/Query-language\" target=\"_blank\" title=\"github.com/wvanbergen/scoped_search\">scoped_search query language</a>. However, only `=` or `!=` (resp. `<>`) operators are supported.<br><br>Rules are searchable using attributes `title`, `severity`, `remediation_available`, and `rule_group_id`<br><br>(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": "Lists Rules assigned to a Tailoring",
"operationId": "TailoringRules",
"responses": {
"200": {
"description": "Lists Rules assigned to a Tailoring",
"content": {
"application/vnd.api+json": {
"examples": {
"List of Rules": {
"value": {
"data": [
{
"id": "143eade4-6f9a-49e7-a604-d3fa86df32a3",
"ref_id": "xccdf_org.ssgproject.content_rule_8fc534d63d129946a5cffa42fae3fe9b",
"title": "Totam aut sequi consectetur.",
"rationale": "Commodi fugit dicta. Non eum corporis. Ducimus ab aut.",
"description": "Beatae veritatis aspernatur. Est quas ullam. Amet voluptatem unde.",
"severity": "low",
"precedence": 4623,
"identifier": {
"href": "http://schaefer.example/tuan",
"label": "Lonely Troll"
},
"references": [
{
"href": "http://gorczany.test/gonzalo",
"label": "King of the Dead"
},
{
"href": "http://considine.example/terrence_skiles",
"label": "Othrondir"
},
{
"href": "http://osinski.example/glady.kling",
"label": "Primrose Gardner"
},
{
"href": "http://hirthe-dach.example/judson",
"label": "Eorl"
},
{
"href": "http://mclaughlin.example/rosendo_schneider",
"label": "Elendur"
}
],
"value_checks": null,
"remediation_available": false,
"rule_group_id": "2e06fc13-6288-4576-a9bd-e56f83dead72",
"type": "rule"
}
],
"meta": {
"total": 1,
"limit": 10,
"offset": 0
},
"links": {
"first": "/api/compliance/v2/policies/d24665cf-b6bc-4875-a91a-2cda34dceb05/tailorings/b1953d29-edb0-485a-a2ba-d6e1e2faade4/rules?limit=10&offset=0",
"last": "/api/compliance/v2/policies/d24665cf-b6bc-4875-a91a-2cda34dceb05/tailorings/b1953d29-edb0-485a-a2ba-d6e1e2faade4/rules?limit=10&offset=0"
}
},
"summary": "",
"description": ""
},
"List of Rules sorted by \"precedence:asc\"": {
"value": {
"data": [
{
"id": "f5043149-0c0f-405d-a0e6-ca97553a8dc6",
"ref_id": "xccdf_org.ssgproject.content_rule_9bbc66cbd0f02accbca0bd6cdd867c2b",
"title": "Sed ratione ab ducimus.",
"rationale": "Iusto dolore enim. Deserunt laborum saepe. Est quam distinctio.",
"description": "Doloribus eum eveniet. Voluptatibus corporis fuga. Est libero delectus.",
"severity": "high",
"precedence": 298,
"identifier": {
"href": "http://okon-jenkins.example/santiago_hoeger",
"label": "Tar-Telperiën"
},
"references": [
{
"href": "http://daugherty.example/ernie",
"label": "Galador"
},
{
"href": "http://conn.test/karine_fadel",
"label": "Ulrad"
},
{
"href": "http://stanton.example/keli",
"label": "Mablung"
},
{
"href": "http://ondricka.example/zachariah",
"label": "Pervinca Took"
},
{
"href": "http://murray.test/stephen",
"label": "Fíriel Fairbairn"
}
],
"value_checks": null,
"remediation_available": false,
"rule_group_id": "e3c69a41-9b59-4ca9-b693-7f38cbecc264",
"type": "rule"
}
],
"meta": {
"total": 1,
"limit": 10,
"offset": 0,
"sort_by": "precedence"
},
"links": {
"first": "/api/compliance/v2/policies/2c91e82a-b971-406a-a2ad-35b89c657bb5/tailorings/0ff5968e-6249-4255-b55a-3b56efca2bb0/rules?limit=10&offset=0&sort_by=precedence",
"last": "/api/compliance/v2/policies/2c91e82a-b971-406a-a2ad-35b89c657bb5/tailorings/0ff5968e-6249-4255-b55a-3b56efca2bb0/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": "2d46076d-8445-4be2-9a0d-0f8573fecd4c",
"ref_id": "xccdf_org.ssgproject.content_rule_f61ac5262f6f43b0d67a5d3197c4a34f",
"title": "Ea a voluptas debitis.",
"rationale": "Sint distinctio ea. Sint animi suscipit. Laboriosam odio est.",
"description": "Sapiente eius qui. Possimus qui nulla. Et cum nam.",
"severity": "high",
"precedence": 8134,
"identifier": {
"href": "http://cronin.example/perla.schowalter",
"label": "Gethron"
},
"references": [
{
"href": "http://dickens.example/barry.schmitt",
"label": "Frodo Baggins"
},
{
"href": "http://wisozk.example/cesar",
"label": "Amrothos"
},
{
"href": "http://zulauf.test/terence_veum",
"label": "Thráin"
},
{
"href": "http://schmidt.test/trey",
"label": "Angelica Baggins"
},
{
"href": "http://legros-ondricka.test/tomika",
"label": "Rorimac Brandybuck"
}
],
"value_checks": null,
"remediation_available": false,
"rule_group_id": "75525cab-837f-43aa-aa74-7087663ddefc",
"type": "rule"
},
{
"id": "3372ed46-2728-4d43-b0cd-ceb55b3cdf5b",
"ref_id": "xccdf_org.ssgproject.content_rule_234bfd88c3fb04864713b5a0fade5658",
"title": "Voluptatem natus velit delectus.",
"rationale": "Veritatis quod iure. Ipsum eius pariatur. Reprehenderit eos incidunt.",
"description": "Sed velit nemo. Repudiandae veniam occaecati. Et nulla dolores.",
"severity": "high",
"precedence": 9657,
"identifier": {
"href": "http://cremin.test/ester",
"label": "Eärnil"
},
"references": [
{
"href": "http://waters.test/erminia",
"label": "Gildis"
},
{
"href": "http://rogahn-berge.test/jerry",
"label": "Samwise Gamgee"
},
{
"href": "http://carter.example/leigha",
"label": "Carl Cotton"
},
{
"href": "http://padberg.example/chong",
"label": "Eärnur"
},
{
"href": "http://crist.test/chad.adams",
"label": "Oromendil"
}
],
"value_checks": null,
"remediation_available": false,
"rule_group_id": "6f43b653-b682-48f2-8565-7f13491d1703",
"type": "rule"
},
{
"id": "34412d38-bd32-400d-afe4-f73f15466b66",
"ref_id": "xccdf_org.ssgproject.content_rule_e8fba67ad7ca3933889ddcc89dd6f46f",
"title": "Ex maxime ut qui.",
"rationale": "Assumenda quam voluptatum. Voluptatem numquam ad. Iusto alias dolor.",
"description": "Expedita dolore nulla. In quaerat at. Laborum accusantium esse.",
"severity": "low",
"precedence": 3919,
"identifier": {
"href": "http://larson-breitenberg.example/cassondra",
"label": "Araglas"
},
"references": [
{
"href": "http://von-klocko.example/damion",
"label": "Dervorin"
},
{
"href": "http://lang.example/luther",
"label": "Boron"
},
{
"href": "http://rau-weissnat.test/galen",
"label": "Amethyst Hornblower"
},
{
"href": "http://ebert-hermiston.test/marianela.ohara",
"label": "Hannar"
},
{
"href": "http://ryan.test/simon",
"label": "Boar of Everholt"
}
],
"value_checks": null,
"remediation_available": false,
"rule_group_id": "4ed777e2-61db-4336-a602-144173cf1ae3",
"type": "rule"
},
{
"id": "38da44c4-113d-4117-aeae-ce12719165d0",
"ref_id": "xccdf_org.ssgproject.content_rule_35d4f836754bc93e9646b7366c90cab2",
"title": "Delectus nihil vel consequatur.",
"rationale": "Recusandae atque ipsum. Et est fugit. Delectus non et.",
"description": "Dolorem nihil et. Voluptate eius accusamus. Blanditiis sint et.",
"severity": "high",
"precedence": 2015,
"identifier": {
"href": "http://parisian.example/laurine.crona",
"label": "Mrs. Maggot"
},
"references": [
{
"href": "http://hintz.test/carroll",
"label": "Amroth"
},
{
"href": "http://stanton.example/marin",
"label": "Haldir"
},
{
"href": "http://gibson.example/gino_turcotte",
"label": "Argon"
},
{
"href": "http://damore.example/demarcus_price",
"label": "Tar-Calmacil"
},
{
"href": "http://jenkins-renner.example/ashli",
"label": "Halfred Gamgee"
}
],
"value_checks": null,
"remediation_available": false,
"rule_group_id": "1424f846-fba1-4df9-9d3e-2570f646b2a5",
"type": "rule"
},
{
"id": "3d3cd3b9-9629-466b-9808-2a080dffa2a1",
"ref_id": "xccdf_org.ssgproject.content_rule_b57caae0ec7176954200f4b33eace58d",
"title": "Facilis quia aliquid sapiente.",
"rationale": "Molestias vitae illo. Id qui sed. Nesciunt tempore repellat.",
"description": "Itaque cupiditate eos. Enim temporibus nisi. Ut eius voluptas.",
"severity": "high",
"precedence": 4679,
"identifier": {
"href": "http://beahan-schmitt.example/desire",
"label": "Adalbert Bolger"
},
"references": [
{
"href": "http://purdy.example/kathrine",
"label": "Mungo Baggins"
},
{
"href": "http://rogahn-lemke.example/jocelyn.rosenbaum",
"label": "Elmo"
},
{
"href": "http://weissnat-huels.example/sherill",
"label": "Gildor"
},
{
"href": "http://bruen.test/jean",
"label": "Isembold Took"
},
{
"href": "http://kovacek-ruecker.example/thurman.ward",
"label": "Nora Bolger"
}
],
"value_checks": null,
"remediation_available": false,
"rule_group_id": "4fe434b6-2b35-4624-8205-5b780b20bbf2",
"type": "rule"
},
{
"id": "4c588db7-a9ec-46b1-bc39-1900e86a9215",
"ref_id": "xccdf_org.ssgproject.content_rule_5795b5e2a481140fded50b1b7707ac87",
"title": "Vitae illo laborum doloribus.",
"rationale": "Omnis quia est. Praesentium ullam et. Ab consequatur fugiat.",
"description": "Necessitatibus atque provident. Officiis voluptas omnis. Odit aperiam necessitatibus.",
"severity": "high",
"precedence": 7453,
"identifier": {
"href": "http://little.example/randal",
"label": "Borlad"
},
"references": [
{
"href": "http://stokes-rogahn.example/chassidy",
"label": "Aegnor"
},
{
"href": "http://pfannerstill.test/shanae_bernier",
"label": "Ivriniel"
},
{
"href": "http://smith.example/alphonse",
"label": "Shelob"
},
{
"href": "http://larkin.example/cliff",
"label": "Narvi"
},
{
"href": "http://jerde-swaniawski.example/justin",
"label": "Eärendil"
}
],
"value_checks": null,
"remediation_available": false,
"rule_group_id": "328c8085-5b81-4aac-a2b7-2258d860644e",
"type": "rule"
},
{
"id": "5e38c35d-a8df-4042-ae1c-983ef5fe9786",
"ref_id": "xccdf_org.ssgproject.content_rule_f0da5e2d126a0a84a723d3da2f3bdbe3",
"title": "Ex harum voluptas aliquam.",
"rationale": "Esse voluptatem nemo. Totam ut dolor. Dolor et sint.",
"description": "Ratione fugit dolor. Ipsam adipisci id. Sunt aut odit.",
"severity": "low",
"precedence": 6531,
"identifier": {
"href": "http://johnston.test/demetrius.kovacek",
"label": "Tar-Vanimeldë"
},
"references": [
{
"href": "http://altenwerth.test/lexie.damore",
"label": "Girion"
},
{
"href": "http://keeling.example/russell_kuhic",
"label": "Malva Headstrong"
},
{
"href": "http://doyle-lebsack.example/lyndon",
"label": "Tar-Meneldur"
},
{
"href": "http://zulauf.test/libby",
"label": "Marhwini"
},
{
"href": "http://volkman.test/carl",
"label": "Írildë"
}
],
"value_checks": null,
"remediation_available": false,
"rule_group_id": "41a36bcb-61ec-4b20-8781-7dd9b8704387",
"type": "rule"
},
{
"id": "6d92383b-d057-429a-85cc-e18d35decaf7",
"ref_id": "xccdf_org.ssgproject.content_rule_060e28162c3ed044641674a0442e424a",
"title": "Nulla aut animi quam.",
"rationale": "Quidem et et. Et dolorem facilis. Explicabo dignissimos beatae.",
"description": "Similique rerum molestias. Quia consequatur accusantium. Incidunt ut consectetur.",
"severity": "medium",
"precedence": 5753,
"identifier": {
"href": "http://koss-mosciski.example/prudence",
"label": "Tar-Calmacil"
},
"references": [
{
"href": "http://streich-barton.test/hedwig",
"label": "Lindórië"
},
{
"href": "http://fahey-pacocha.example/mathew",
"label": "Forthwini"
},
{
"href": "http://wisozk.example/sidney.jacobi",
"label": "Galdor of the Havens"
},
{
"href": "http://lebsack.test/donte",
"label": "Aegnor"
},
{
"href": "http://lemke-cummerata.test/man",
"label": "Tar-Ancalimë"
}
],
"value_checks": null,
"remediation_available": false,
"rule_group_id": "e58455cb-75f5-432c-8a4c-b12784765e4e",
"type": "rule"
},
{
"id": "6daa1d28-209d-4b93-a562-0bfafa52cdd8",
"ref_id": "xccdf_org.ssgproject.content_rule_f0c519ceba7e87533dd7246846ed80f2",
"title": "Qui voluptate necessitatibus non.",
"rationale": "Quam tempora natus. Similique qui harum. Qui quam vero.",
"description": "Eligendi quisquam dolorum. At cum nihil. Consectetur doloribus sequi.",
"severity": "low",
"precedence": 4394,
"identifier": {
"href": "http://rogahn.example/robbin_mckenzie",
"label": "Finarfin"
},
"references": [
{
"href": "http://pfeffer-ondricka.example/nathaniel.reilly",
"label": "Glóin"
},
{
"href": "http://mccullough.test/elva.hansen",
"label": "Balbo Baggins"
},
{
"href": "http://okeefe.test/harland",
"label": "Elladan"
},
{
"href": "http://senger.test/karie.lesch",
"label": "Othrondir"
},
{
"href": "http://schamberger.example/kraig.wiegand",
"label": "Watcher in the Water"
}
],
"value_checks": null,
"remediation_available": false,
"rule_group_id": "2da20f78-b139-4c4d-8173-d69b10fbdfcd",
"type": "rule"
},
{
"id": "78014cfe-e1df-443d-9bb2-da8a22864c3b",
"ref_id": "xccdf_org.ssgproject.content_rule_20b27d65874607e7472bd51f99e99a1b",
"title": "Consequatur rerum sequi voluptatibus.",
"rationale": "Qui aut impedit. Dolorem et commodi. Sit reprehenderit tenetur.",
"description": "Praesentium iure dolorum. Aliquid et suscipit. Esse in nihil.",
"severity": "high",
"precedence": 7887,
"identifier": {
"href": "http://dietrich.test/socorro_lockman",
"label": "Bowman Cotton"
},
"references": [
{
"href": "http://lebsack.example/porsche",
"label": "Melilot Brandybuck"
},
{
"href": "http://hoeger-gerlach.test/ollie",
"label": "Soronto"
},
{
"href": "http://fisher.test/cristobal",
"label": "Estella Bolger"
},
{
"href": "http://bogisich.example/rozella_renner",
"label": "Narmacil"
},
{
"href": "http://ebert-pacocha.test/arlie",
"label": "Larnach"
}
],
"value_checks": null,
"remediation_available": false,
"rule_group_id": "53c1ffe8-845a-40ec-954a-c138ea943e45",
"type": "rule"
}
],
"meta": {
"total": 25,
"limit": 10,
"offset": 0
},
"links": {
"first": "/api/compliance/v2/policies/e3d21cb2-ae71-49f0-8760-8f601a082583/tailorings/256a220f-bb14-46d0-80c3-3fd057e2d1cf/rules?limit=10&offset=0",
"last": "/api/compliance/v2/policies/e3d21cb2-ae71-49f0-8760-8f601a082583/tailorings/256a220f-bb14-46d0-80c3-3fd057e2d1cf/rules?limit=10&offset=20",
"next": "/api/compliance/v2/policies/e3d21cb2-ae71-49f0-8760-8f601a082583/tailorings/256a220f-bb14-46d0-80c3-3fd057e2d1cf/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": "Assigns a Rule to a 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": "9bfed476-3f9d-4e7e-8fe1-5ea599dc08df",
"ref_id": "xccdf_org.ssgproject.content_rule_230841e25c6b13b02566bf1c0d965337",
"title": "Suscipit quam in quae.",
"rationale": "Vero et fugiat. Vel nemo libero. Nobis autem a.",
"description": "Sed est similique. Impedit quos consectetur. Laboriosam et expedita.",
"severity": "medium",
"precedence": 3595,
"identifier": {
"href": "http://schoen.test/marcelina_jakubowski",
"label": "Ar-Sakalthôr"
},
"references": [
{
"href": "http://kreiger.test/jeffry_white",
"label": "Elboron"
},
{
"href": "http://stanton.test/jule.mante",
"label": "Morwë"
},
{
"href": "http://mante.example/courtney",
"label": "Legolas"
},
{
"href": "http://brakus-lehner.test/brittni",
"label": "Tarannon Falastur"
},
{
"href": "http://rempel-daugherty.example/nydia",
"label": "Radbug"
}
],
"value_checks": null,
"remediation_available": false,
"rule_group_id": "c142ba5b-14cc-411c-a194-fd29f21eaae6",
"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 b6e060eb-9d2c-4881-acaa-7a46c2e186cc"
]
},
"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": "Unassigns a Rule from a 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": "d5578d85-d31b-4cda-8576-a247c7b87cb1",
"ref_id": "xccdf_org.ssgproject.content_rule_81083c523c0259b0f1a4001b414ccec0",
"title": "Autem doloremque veritatis corporis.",
"rationale": "Minima quibusdam accusamus. Ut maiores corrupti. Omnis voluptatem atque.",
"description": "Omnis minus explicabo. Qui autem et. Et blanditiis sint.",
"severity": "low",
"precedence": 7674,
"identifier": {
"href": "http://hermann.test/teofila",
"label": "Helm"
},
"references": [
{
"href": "http://ebert.example/antoine",
"label": "Frumgar"
},
{
"href": "http://prosacco.example/ida",
"label": "Belen"
},
{
"href": "http://bergstrom-hoppe.test/chester",
"label": "Saradas Brandybuck"
},
{
"href": "http://braun.test/tammara.hegmann",
"label": "Wulf"
},
{
"href": "http://skiles.example/venita.moen",
"label": "Lindir"
}
],
"value_checks": null,
"remediation_available": false,
"rule_group_id": "60ad3dd4-6079-4a40-bbc9-6457db060595",
"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 e3f19d21-3941-4863-bdd0-e378af184d69"
]
},
"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 (`<key>:asc` or `<key>:desc`).<br><br>If no direction is selected, `<key>: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 <a href=\"https://github.com/wvanbergen/scoped_search/wiki/Query-language\" target=\"_blank\" title=\"github.com/wvanbergen/scoped_search\">scoped_search query language</a>. However, only `=` or `!=` (resp. `<>`) operators are supported.<br><br>Security Guides are searchable using attributes `title`, `version`, `ref_id`, `os_major_version`, `profile_ref_id`, and `supported_profile`<br><br>(e.g.: `(field_1=something AND field_2!=\"something else\") OR field_3>40`)",
"schema": {
"type": "string"
}
}
],
"tags": [
"Content"
],
"description": "Lists Security Guides",
"operationId": "SecurityGuides",
"responses": {
"200": {
"description": "Lists Security Guides",
"content": {
"application/vnd.api+json": {
"examples": {
"List of Security Guides": {
"value": {
"data": [
{
"id": "1f36243b-a7c8-4799-8241-2cd45f53d44d",
"ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7",
"title": "Quos quam est fuga.",
"version": "100.82.36",
"description": "Et ad dignissimos. In hic et. Est dolorem et.",
"os_major_version": 7,
"type": "security_guide"
},
{
"id": "277087b6-5cb0-420d-9476-0d093dc03fde",
"ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7",
"title": "Dignissimos et vero laudantium.",
"version": "100.82.43",
"description": "Aut sit rem. Optio ut minima. Quibusdam rerum facilis.",
"os_major_version": 7,
"type": "security_guide"
},
{
"id": "2a67608f-cc17-4ec4-91c7-3e43231fedf9",
"ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7",
"title": "Facere ut laboriosam voluptates.",
"version": "100.83.7",
"description": "Adipisci tempore incidunt. Non magni impedit. Explicabo qui praesentium.",
"os_major_version": 7,
"type": "security_guide"
},
{
"id": "2acd42f5-57e5-4e58-83fe-f45d83a54f1c",
"ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7",
"title": "Molestias quis autem nisi.",
"version": "100.82.44",
"description": "Dolor voluptatum quis. Voluptatem culpa voluptas. Omnis et perspiciatis.",
"os_major_version": 7,
"type": "security_guide"
},
{
"id": "2c1afb67-f8db-4e1f-9650-313d64799525",
"ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7",
"title": "Ullam exercitationem praesentium atque.",
"version": "100.82.39",
"description": "Et consequuntur doloribus. Dolor inventore et. Quibusdam maiores quis.",
"os_major_version": 7,
"type": "security_guide"
},
{
"id": "31cbe5a6-fbcd-4158-bf51-b45e945bfa35",
"ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7",
"title": "Et dolorem quia id.",
"version": "100.82.49",
"description": "Et vitae consequatur. Vero ipsum unde. Cum eos harum.",
"os_major_version": 7,
"type": "security_guide"
},
{
"id": "36f43103-08fc-4da1-9f8c-250bdbc78a7c",
"ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7",
"title": "Sed minima temporibus ut.",
"version": "100.82.38",
"description": "Ipsa laborum sapiente. Voluptatum tempora odit. Aspernatur omnis omnis.",
"os_major_version": 7,
"type": "security_guide"
},
{
"id": "37fbc483-1987-43c9-b54c-005d638e665a",
"ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7",
"title": "A dicta voluptatem architecto.",
"version": "100.82.34",
"description": "Perspiciatis pariatur consequatur. Dicta assumenda culpa. Officiis officia animi.",
"os_major_version": 7,
"type": "security_guide"
},
{
"id": "39d34175-1cec-421c-b169-0814db72491f",
"ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7",
"title": "Eligendi eaque dolore non.",
"version": "100.83.2",
"description": "Totam qui quas. Quaerat eligendi aspernatur. Et repudiandae quisquam.",
"os_major_version": 7,
"type": "security_guide"
},
{
"id": "3e9254d2-892c-4d85-84d0-8f5790e8bc64",
"ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7",
"title": "Similique voluptatibus aspernatur est.",
"version": "100.82.33",
"description": "Ut vel velit. Totam illo qui. Exercitationem dolor qui.",
"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": "0ef211e4-6fcf-4293-b70e-8b001aed753f",
"ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7",
"title": "Praesentium sed debitis quae.",
"version": "100.83.12",
"description": "Et et perspiciatis. Exercitationem rerum velit. Vitae molestiae iusto.",
"os_major_version": 7,
"type": "security_guide"
},
{
"id": "13d12202-1e22-44fe-8e26-a16229b4184b",
"ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7",
"title": "Perspiciatis qui cumque et.",
"version": "100.83.10",
"description": "Rem non ducimus. Et commodi ullam. Cumque et labore.",
"os_major_version": 7,
"type": "security_guide"
},
{
"id": "16ee9f0b-d454-436f-af05-d32694b9a30d",
"ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7",
"title": "Rem libero omnis molestias.",
"version": "100.83.21",
"description": "Perspiciatis tempora aut. Distinctio et est. Voluptate alias aut.",
"os_major_version": 7,
"type": "security_guide"
},
{
"id": "1874fe00-fcb5-4ec1-85a1-a5201569f4d4",
"ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7",
"title": "Incidunt adipisci accusamus aperiam.",
"version": "100.83.14",
"description": "Dignissimos eligendi magni. Omnis eum optio. Et saepe nesciunt.",
"os_major_version": 7,
"type": "security_guide"
},
{
"id": "28c4c716-1539-48fb-a2d7-ed24f0b74501",
"ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7",
"title": "A recusandae molestias beatae.",
"version": "100.83.31",
"description": "Quis neque et. Temporibus et ea. Dolor odio consequatur.",
"os_major_version": 7,
"type": "security_guide"
},
{
"id": "366f8eb2-72ee-44e4-b310-f1176ad3b17b",
"ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7",
"title": "Aliquid voluptates voluptatibus enim.",
"version": "100.83.30",
"description": "Voluptas iusto voluptatem. Dolores est distinctio. Nemo tenetur officia.",
"os_major_version": 7,
"type": "security_guide"
},
{
"id": "37611189-e6b5-4993-a280-57343dca5759",
"ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7",
"title": "Exercitationem illum dicta voluptatem.",
"version": "100.83.29",
"description": "Dolores veritatis aut. Voluptatem voluptatem magni. Qui qui eligendi.",
"os_major_version": 7,
"type": "security_guide"
},
{
"id": "3777629a-d727-477c-b625-371ddae4a4f6",
"ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7",
"title": "Et quo similique et.",
"version": "100.83.11",
"description": "Quia praesentium quas. Ea quis in. Perspiciatis quod possimus.",
"os_major_version": 7,
"type": "security_guide"
},
{
"id": "3a1f6776-b18f-4b1b-a473-e18c7a484d0b",
"ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7",
"title": "Excepturi consectetur quos nam.",
"version": "100.83.16",
"description": "Ea magni molestiae. Ut delectus sed. Dolores ut blanditiis.",
"os_major_version": 7,
"type": "security_guide"
},
{
"id": "3b5cc151-f641-4cc4-bcc2-596d18c18dd6",
"ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7",
"title": "Laborum eligendi commodi vitae.",
"version": "100.83.18",
"description": "Dolor voluptatem alias. Quia maxime corrupti. Consequatur assumenda praesentium.",
"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 <a href=\"https://github.com/wvanbergen/scoped_search/wiki/Query-language\" target=\"_blank\" title=\"github.com/wvanbergen/scoped_search\">scoped_search query language</a>. However, only `=` or `!=` (resp. `<>`) operators are supported.<br><br>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`<br><br>(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": "Returns a Security Guide",
"operationId": "SecurityGuide",
"responses": {
"200": {
"description": "Returns a Security Guide",
"content": {
"application/vnd.api+json": {
"examples": {
"Returns a Security Guide": {
"value": {
"data": {
"id": "0499129e-02c6-4a06-8d72-2da09e43f65e",
"ref_id": "xccdf_org.ssgproject.content_benchmark_RHEL-7",
"title": "Est dolores deserunt id.",
"version": "100.85.33",
"description": "Et impedit qui. Consequatur voluptatem autem. Quia necessitatibus odio.",
"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 0503d80d-b781-4b8e-9266-5189dd76865c"
]
},
"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 the Rule Tree of a Security Guide",
"operationId": "SecurityGuideRuleTree",
"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": "66a80e86-5a30-4b06-acb5-03a1cd57f970",
"type": "rule_group",
"children": [
{
"id": "7061bc06-604d-4165-8041-594d014b17d3",
"type": "rule"
}
]
},
{
"id": "251193c6-4f5e-4364-ab70-17d60955d4fb",
"type": "rule_group",
"children": [
{
"id": "022dd922-e8e4-4558-80ed-3a4c2d315b05",
"type": "rule"
}
]
},
{
"id": "875dee30-029f-4768-ba53-939ca359a9e9",
"type": "rule_group",
"children": [
{
"id": "a39b6a9c-a86e-4938-b8e5-3599323bc452",
"type": "rule"
}
]
},
{
"id": "6ba5be1b-1c53-4ae1-8d03-e5a8cb37a5dc",
"type": "rule_group",
"children": [
{
"id": "b7d36521-d867-415a-95a1-0af184a82a97",
"type": "rule"
}
]
},
{
"id": "38dd3198-170f-491f-912b-c3dbbf14be4d",
"type": "rule_group",
"children": [
{
"id": "150cafbc-b864-4370-877a-6ace94be22c2",
"type": "rule"
}
]
},
{
"id": "d72c33ce-5954-4c41-b4d6-3434ffdf909d",
"type": "rule_group",
"children": [
{
"id": "bff1b757-fbb6-430e-8ba6-343f13d5530a",
"type": "rule"
}
]
},
{
"id": "841b5559-3759-4418-83c6-ac1e8416dd53",
"type": "rule_group",
"children": [
{
"id": "596e82e3-a161-47d3-a5e0-a8d2ee6b523f",
"type": "rule"
}
]
},
{
"id": "022fe488-31e6-4bf0-969e-9e7abc6a6467",
"type": "rule_group",
"children": [
{
"id": "ec13b753-5212-412e-9657-23795f4b1f86",
"type": "rule"
}
]
},
{
"id": "668c1dc7-f7fe-4dce-b3d8-d74ee3a2ca46",
"type": "rule_group",
"children": [
{
"id": "0f1ead19-7bff-4afb-8e1c-53d73f317265",
"type": "rule"
}
]
},
{
"id": "04d628b1-2cf3-4141-93d0-78cbe634eea5",
"type": "rule_group",
"children": [
{
"id": "5153e2d7-ac31-40a3-85d0-dafc33880598",
"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 26caf84f-768e-4bc3-a16a-40a0a202793e"
]
},
"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 (`<key>:asc` or `<key>:desc`).<br><br>If no direction is selected, `<key>: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 <a href=\"https://github.com/wvanbergen/scoped_search/wiki/Query-language\" target=\"_blank\" title=\"github.com/wvanbergen/scoped_search\">scoped_search query language</a>. However, only `=` or `!=` (resp. `<>`) operators are supported.<br><br>Supported Profiles are searchable using attributes `os_major_version`, `title`, and `ref_id`<br><br>(e.g.: `(field_1=something AND field_2!=\"something else\") OR field_3>40`)",
"schema": {
"type": "string"
}
}
],
"tags": [
"Content"
],
"description": "Lists Supported Profiles",
"operationId": "SupportedProfiles",
"responses": {
"200": {
"description": "Lists Supported Profiles",
"content": {
"application/vnd.api+json": {
"examples": {
"List of Supported Profiles": {
"value": {
"data": [
{
"id": "7d4d3f9b-903a-4894-827f-24d967cc2c02",
"title": "Illo fuga eum incidunt.",
"description": "Sunt fugiat rerum. Voluptas non nam. Quaerat vitae enim.",
"ref_id": "xccdf_org.ssgproject.content_profile_90d4ee4ab93c208dcccd66ecaf4b4234",
"security_guide_id": "cbe119cb-9fa8-4f9b-bee2-2f018ed1d95b",
"security_guide_version": "100.86.7",
"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": "27b778c7-1177-40ee-b7b2-2b258520fa7b",
"title": "Qui ipsum aperiam tenetur.",
"description": "Itaque id dolores. Rerum deleniti id. Molestiae unde deleniti.",
"ref_id": "xccdf_org.ssgproject.content_profile_9755bd3282b74e42127cdddba1a4b751",
"security_guide_id": "bfad56e5-0e32-4066-983c-118508f079a7",
"security_guide_version": "100.86.8",
"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.<br>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 (`<key>:asc` or `<key>:desc`).<br><br>If no direction is selected, `<key>: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 <a href=\"https://github.com/wvanbergen/scoped_search/wiki/Query-language\" target=\"_blank\" title=\"github.com/wvanbergen/scoped_search\">scoped_search query language</a>. However, only `=` or `!=` (resp. `<>`) operators are supported.<br><br>Systems are searchable using attributes `display_name`, `os_version`, `os_major_version`, `os_minor_version`, `assigned_or_scanned`, `group_name`, `policies`, and `profile_ref_id`<br><br>(e.g.: `(field_1=something AND field_2!=\"something else\") OR field_3>40`)",
"schema": {
"type": "string"
}
}
],
"tags": [
"Systems"
],
"description": "Lists Systems",
"operationId": "Systems",
"responses": {
"200": {
"description": "Lists Systems",
"content": {
"application/vnd.api+json": {
"examples": {
"List of Systems": {
"value": {
"data": [
{
"id": "3176845b-221b-40e5-bd01-656c5f137804",
"display_name": "walter.example",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:16.671Z",
"stale_timestamp": "2034-11-14T12:12:16.671Z",
"stale_warning_timestamp": "2034-11-21T12:12:16.671Z",
"updated": "2024-11-14T12:12:16.671Z",
"insights_id": null,
"tags": [
{
"key": "application",
"value": "neural",
"namespace": "generating"
},
{
"key": "capacitor",
"value": "solid state",
"namespace": "bypassing"
},
{
"key": "monitor",
"value": "mobile",
"namespace": "quantifying"
},
{
"key": "bandwidth",
"value": "primary",
"namespace": "indexing"
},
{
"key": "hard drive",
"value": "solid state",
"namespace": "programming"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0,
"policies": []
},
{
"id": "4b78f7fb-21c2-4141-9de4-d579781ae217",
"display_name": "hoeger.test",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:16.663Z",
"stale_timestamp": "2034-11-14T12:12:16.663Z",
"stale_warning_timestamp": "2034-11-21T12:12:16.663Z",
"updated": "2024-11-14T12:12:16.663Z",
"insights_id": null,
"tags": [
{
"key": "microchip",
"value": "neural",
"namespace": "indexing"
},
{
"key": "panel",
"value": "virtual",
"namespace": "parsing"
},
{
"key": "interface",
"value": "open-source",
"namespace": "parsing"
},
{
"key": "bandwidth",
"value": "1080p",
"namespace": "calculating"
},
{
"key": "pixel",
"value": "wireless",
"namespace": "quantifying"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0,
"policies": []
},
{
"id": "5cbfce9a-969e-4eb1-860a-11357f3a29ca",
"display_name": "christiansen.example",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:16.670Z",
"stale_timestamp": "2034-11-14T12:12:16.670Z",
"stale_warning_timestamp": "2034-11-21T12:12:16.670Z",
"updated": "2024-11-14T12:12:16.670Z",
"insights_id": null,
"tags": [
{
"key": "microchip",
"value": "online",
"namespace": "transmitting"
},
{
"key": "card",
"value": "optical",
"namespace": "parsing"
},
{
"key": "card",
"value": "mobile",
"namespace": "indexing"
},
{
"key": "matrix",
"value": "back-end",
"namespace": "synthesizing"
},
{
"key": "alarm",
"value": "cross-platform",
"namespace": "generating"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0,
"policies": []
},
{
"id": "5d6199d2-498b-4585-ac8d-098f898c61a1",
"display_name": "emmerich.example",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:16.662Z",
"stale_timestamp": "2034-11-14T12:12:16.662Z",
"stale_warning_timestamp": "2034-11-21T12:12:16.662Z",
"updated": "2024-11-14T12:12:16.662Z",
"insights_id": null,
"tags": [
{
"key": "firewall",
"value": "online",
"namespace": "copying"
},
{
"key": "firewall",
"value": "haptic",
"namespace": "programming"
},
{
"key": "capacitor",
"value": "multi-byte",
"namespace": "programming"
},
{
"key": "application",
"value": "primary",
"namespace": "navigating"
},
{
"key": "bandwidth",
"value": "solid state",
"namespace": "copying"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0,
"policies": []
},
{
"id": "713c7613-abfd-41a7-85dc-984e641dbc1e",
"display_name": "crist-mckenzie.example",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:16.664Z",
"stale_timestamp": "2034-11-14T12:12:16.664Z",
"stale_warning_timestamp": "2034-11-21T12:12:16.664Z",
"updated": "2024-11-14T12:12:16.664Z",
"insights_id": null,
"tags": [
{
"key": "monitor",
"value": "primary",
"namespace": "calculating"
},
{
"key": "capacitor",
"value": "bluetooth",
"namespace": "navigating"
},
{
"key": "port",
"value": "digital",
"namespace": "compressing"
},
{
"key": "transmitter",
"value": "cross-platform",
"namespace": "compressing"
},
{
"key": "feed",
"value": "auxiliary",
"namespace": "generating"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0,
"policies": []
},
{
"id": "78b27c7f-2c73-44e0-adfc-95c3832f5c88",
"display_name": "renner.example",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:16.666Z",
"stale_timestamp": "2034-11-14T12:12:16.666Z",
"stale_warning_timestamp": "2034-11-21T12:12:16.666Z",
"updated": "2024-11-14T12:12:16.666Z",
"insights_id": null,
"tags": [
{
"key": "microchip",
"value": "cross-platform",
"namespace": "backing up"
},
{
"key": "bus",
"value": "1080p",
"namespace": "backing up"
},
{
"key": "port",
"value": "haptic",
"namespace": "bypassing"
},
{
"key": "card",
"value": "auxiliary",
"namespace": "programming"
},
{
"key": "panel",
"value": "neural",
"namespace": "quantifying"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0,
"policies": []
},
{
"id": "7edd6a72-7415-4a04-9997-9044f6f6f595",
"display_name": "leuschke.example",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:16.673Z",
"stale_timestamp": "2034-11-14T12:12:16.673Z",
"stale_warning_timestamp": "2034-11-21T12:12:16.673Z",
"updated": "2024-11-14T12:12:16.673Z",
"insights_id": null,
"tags": [
{
"key": "protocol",
"value": "haptic",
"namespace": "parsing"
},
{
"key": "array",
"value": "cross-platform",
"namespace": "calculating"
},
{
"key": "array",
"value": "redundant",
"namespace": "compressing"
},
{
"key": "circuit",
"value": "bluetooth",
"namespace": "hacking"
},
{
"key": "system",
"value": "cross-platform",
"namespace": "copying"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0,
"policies": []
},
{
"id": "86c8d994-f041-4e57-b90c-66832b5c368b",
"display_name": "cormier.example",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:16.669Z",
"stale_timestamp": "2034-11-14T12:12:16.669Z",
"stale_warning_timestamp": "2034-11-21T12:12:16.669Z",
"updated": "2024-11-14T12:12:16.669Z",
"insights_id": null,
"tags": [
{
"key": "hard drive",
"value": "mobile",
"namespace": "transmitting"
},
{
"key": "panel",
"value": "wireless",
"namespace": "bypassing"
},
{
"key": "bus",
"value": "auxiliary",
"namespace": "programming"
},
{
"key": "protocol",
"value": "neural",
"namespace": "copying"
},
{
"key": "pixel",
"value": "wireless",
"namespace": "navigating"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0,
"policies": []
},
{
"id": "87207173-b477-46df-8a6d-7b5f76d4e717",
"display_name": "douglas.example",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:16.680Z",
"stale_timestamp": "2034-11-14T12:12:16.680Z",
"stale_warning_timestamp": "2034-11-21T12:12:16.680Z",
"updated": "2024-11-14T12:12:16.680Z",
"insights_id": null,
"tags": [
{
"key": "protocol",
"value": "digital",
"namespace": "hacking"
},
{
"key": "monitor",
"value": "solid state",
"namespace": "connecting"
},
{
"key": "circuit",
"value": "redundant",
"namespace": "parsing"
},
{
"key": "firewall",
"value": "neural",
"namespace": "programming"
},
{
"key": "microchip",
"value": "digital",
"namespace": "hacking"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0,
"policies": []
},
{
"id": "90ce8a84-a2ff-47c6-8ed0-83c80ac34bb3",
"display_name": "wisoky.test",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:16.677Z",
"stale_timestamp": "2034-11-14T12:12:16.677Z",
"stale_warning_timestamp": "2034-11-21T12:12:16.677Z",
"updated": "2024-11-14T12:12:16.677Z",
"insights_id": null,
"tags": [
{
"key": "sensor",
"value": "bluetooth",
"namespace": "connecting"
},
{
"key": "firewall",
"value": "solid state",
"namespace": "backing up"
},
{
"key": "pixel",
"value": "auxiliary",
"namespace": "compressing"
},
{
"key": "sensor",
"value": "redundant",
"namespace": "calculating"
},
{
"key": "port",
"value": "mobile",
"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": "151f9b01-59f9-487c-98a7-a6d122ce58bf",
"display_name": "terry.example",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:16.725Z",
"stale_timestamp": "2034-11-14T12:12:16.725Z",
"stale_warning_timestamp": "2034-11-21T12:12:16.725Z",
"updated": "2024-11-14T12:12:16.725Z",
"insights_id": null,
"tags": [
{
"key": "panel",
"value": "cross-platform",
"namespace": "compressing"
},
{
"key": "alarm",
"value": "multi-byte",
"namespace": "overriding"
},
{
"key": "interface",
"value": "primary",
"namespace": "hacking"
},
{
"key": "microchip",
"value": "optical",
"namespace": "navigating"
},
{
"key": "monitor",
"value": "cross-platform",
"namespace": "overriding"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0,
"policies": []
},
{
"id": "1571019a-9da0-4116-ab9b-25df117f721a",
"display_name": "champlin.example",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:16.727Z",
"stale_timestamp": "2034-11-14T12:12:16.727Z",
"stale_warning_timestamp": "2034-11-21T12:12:16.727Z",
"updated": "2024-11-14T12:12:16.727Z",
"insights_id": null,
"tags": [
{
"key": "panel",
"value": "1080p",
"namespace": "indexing"
},
{
"key": "panel",
"value": "wireless",
"namespace": "connecting"
},
{
"key": "capacitor",
"value": "open-source",
"namespace": "indexing"
},
{
"key": "matrix",
"value": "virtual",
"namespace": "transmitting"
},
{
"key": "pixel",
"value": "primary",
"namespace": "quantifying"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0,
"policies": []
},
{
"id": "18931741-6e9a-4e0c-9e30-6e803d22befe",
"display_name": "dibbert.test",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:16.715Z",
"stale_timestamp": "2034-11-14T12:12:16.715Z",
"stale_warning_timestamp": "2034-11-21T12:12:16.715Z",
"updated": "2024-11-14T12:12:16.715Z",
"insights_id": null,
"tags": [
{
"key": "port",
"value": "virtual",
"namespace": "transmitting"
},
{
"key": "card",
"value": "mobile",
"namespace": "copying"
},
{
"key": "interface",
"value": "multi-byte",
"namespace": "programming"
},
{
"key": "feed",
"value": "redundant",
"namespace": "overriding"
},
{
"key": "interface",
"value": "multi-byte",
"namespace": "quantifying"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0,
"policies": []
},
{
"id": "1bc6b2ce-17dd-4446-833a-ca2e7b0d27dd",
"display_name": "bernier.example",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:16.738Z",
"stale_timestamp": "2034-11-14T12:12:16.738Z",
"stale_warning_timestamp": "2034-11-21T12:12:16.738Z",
"updated": "2024-11-14T12:12:16.738Z",
"insights_id": null,
"tags": [
{
"key": "transmitter",
"value": "mobile",
"namespace": "compressing"
},
{
"key": "feed",
"value": "back-end",
"namespace": "generating"
},
{
"key": "port",
"value": "bluetooth",
"namespace": "transmitting"
},
{
"key": "system",
"value": "open-source",
"namespace": "synthesizing"
},
{
"key": "system",
"value": "multi-byte",
"namespace": "parsing"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0,
"policies": []
},
{
"id": "240b7be3-2d69-4f7e-86b2-f378f85ac8d9",
"display_name": "mclaughlin.example",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:16.734Z",
"stale_timestamp": "2034-11-14T12:12:16.734Z",
"stale_warning_timestamp": "2034-11-21T12:12:16.734Z",
"updated": "2024-11-14T12:12:16.734Z",
"insights_id": null,
"tags": [
{
"key": "application",
"value": "mobile",
"namespace": "generating"
},
{
"key": "firewall",
"value": "multi-byte",
"namespace": "synthesizing"
},
{
"key": "bandwidth",
"value": "optical",
"namespace": "compressing"
},
{
"key": "port",
"value": "optical",
"namespace": "navigating"
},
{
"key": "microchip",
"value": "back-end",
"namespace": "hacking"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0,
"policies": []
},
{
"id": "2a56d52b-0808-4fe0-81df-1775ba8c3b8f",
"display_name": "marvin.example",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:16.720Z",
"stale_timestamp": "2034-11-14T12:12:16.720Z",
"stale_warning_timestamp": "2034-11-21T12:12:16.720Z",
"updated": "2024-11-14T12:12:16.720Z",
"insights_id": null,
"tags": [
{
"key": "panel",
"value": "multi-byte",
"namespace": "quantifying"
},
{
"key": "port",
"value": "mobile",
"namespace": "compressing"
},
{
"key": "bandwidth",
"value": "bluetooth",
"namespace": "indexing"
},
{
"key": "system",
"value": "optical",
"namespace": "overriding"
},
{
"key": "firewall",
"value": "neural",
"namespace": "connecting"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0,
"policies": []
},
{
"id": "430aa75d-9003-4c99-97c4-928ac140f012",
"display_name": "oberbrunner-greenholt.example",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:16.729Z",
"stale_timestamp": "2034-11-14T12:12:16.729Z",
"stale_warning_timestamp": "2034-11-21T12:12:16.729Z",
"updated": "2024-11-14T12:12:16.729Z",
"insights_id": null,
"tags": [
{
"key": "hard drive",
"value": "mobile",
"namespace": "bypassing"
},
{
"key": "program",
"value": "optical",
"namespace": "synthesizing"
},
{
"key": "pixel",
"value": "haptic",
"namespace": "connecting"
},
{
"key": "interface",
"value": "primary",
"namespace": "backing up"
},
{
"key": "interface",
"value": "cross-platform",
"namespace": "overriding"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0,
"policies": []
},
{
"id": "4c338e9f-ff95-4937-a9c7-6e06dcc4b1b9",
"display_name": "dicki.example",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:16.719Z",
"stale_timestamp": "2034-11-14T12:12:16.719Z",
"stale_warning_timestamp": "2034-11-21T12:12:16.719Z",
"updated": "2024-11-14T12:12:16.719Z",
"insights_id": null,
"tags": [
{
"key": "array",
"value": "multi-byte",
"namespace": "parsing"
},
{
"key": "microchip",
"value": "virtual",
"namespace": "quantifying"
},
{
"key": "pixel",
"value": "digital",
"namespace": "connecting"
},
{
"key": "panel",
"value": "virtual",
"namespace": "compressing"
},
{
"key": "driver",
"value": "solid state",
"namespace": "transmitting"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0,
"policies": []
},
{
"id": "4c47ac95-2f8e-46fc-a149-1085fb4ee0f8",
"display_name": "hills.example",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:16.728Z",
"stale_timestamp": "2034-11-14T12:12:16.728Z",
"stale_warning_timestamp": "2034-11-21T12:12:16.728Z",
"updated": "2024-11-14T12:12:16.728Z",
"insights_id": null,
"tags": [
{
"key": "alarm",
"value": "back-end",
"namespace": "bypassing"
},
{
"key": "capacitor",
"value": "1080p",
"namespace": "quantifying"
},
{
"key": "sensor",
"value": "virtual",
"namespace": "programming"
},
{
"key": "monitor",
"value": "solid state",
"namespace": "parsing"
},
{
"key": "pixel",
"value": "haptic",
"namespace": "transmitting"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0,
"policies": []
},
{
"id": "5231c038-2801-4d5c-9db7-4e12a7d3b95b",
"display_name": "runolfsdottir.test",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:16.733Z",
"stale_timestamp": "2034-11-14T12:12:16.733Z",
"stale_warning_timestamp": "2034-11-21T12:12:16.733Z",
"updated": "2024-11-14T12:12:16.733Z",
"insights_id": null,
"tags": [
{
"key": "application",
"value": "wireless",
"namespace": "overriding"
},
{
"key": "application",
"value": "primary",
"namespace": "overriding"
},
{
"key": "card",
"value": "wireless",
"namespace": "generating"
},
{
"key": "microchip",
"value": "digital",
"namespace": "overriding"
},
{
"key": "panel",
"value": "haptic",
"namespace": "backing up"
}
],
"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": "1d5d992f-c5da-498e-aaee-d27853bc7bb7",
"display_name": "wintheiser.test",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:16.771Z",
"stale_timestamp": "2034-11-14T12:12:16.771Z",
"stale_warning_timestamp": "2034-11-21T12:12:16.771Z",
"updated": "2024-11-14T12:12:16.771Z",
"insights_id": null,
"tags": [
{
"key": "bus",
"value": "primary",
"namespace": "indexing"
},
{
"key": "circuit",
"value": "back-end",
"namespace": "transmitting"
},
{
"key": "firewall",
"value": "optical",
"namespace": "parsing"
},
{
"key": "matrix",
"value": "1080p",
"namespace": "connecting"
},
{
"key": "pixel",
"value": "primary",
"namespace": "compressing"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0,
"policies": []
},
{
"id": "2a8a832f-0159-4be5-ab44-7c6bbca62e9e",
"display_name": "kassulke-mraz.example",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:16.788Z",
"stale_timestamp": "2034-11-14T12:12:16.788Z",
"stale_warning_timestamp": "2034-11-21T12:12:16.788Z",
"updated": "2024-11-14T12:12:16.788Z",
"insights_id": null,
"tags": [
{
"key": "system",
"value": "online",
"namespace": "copying"
},
{
"key": "panel",
"value": "primary",
"namespace": "transmitting"
},
{
"key": "array",
"value": "solid state",
"namespace": "generating"
},
{
"key": "circuit",
"value": "online",
"namespace": "programming"
},
{
"key": "transmitter",
"value": "haptic",
"namespace": "quantifying"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0,
"policies": []
},
{
"id": "312390b6-5802-414b-b5e2-2429c4ac16ec",
"display_name": "reilly.example",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:16.769Z",
"stale_timestamp": "2034-11-14T12:12:16.769Z",
"stale_warning_timestamp": "2034-11-21T12:12:16.769Z",
"updated": "2024-11-14T12:12:16.769Z",
"insights_id": null,
"tags": [
{
"key": "card",
"value": "multi-byte",
"namespace": "compressing"
},
{
"key": "hard drive",
"value": "cross-platform",
"namespace": "copying"
},
{
"key": "array",
"value": "redundant",
"namespace": "overriding"
},
{
"key": "card",
"value": "solid state",
"namespace": "connecting"
},
{
"key": "array",
"value": "wireless",
"namespace": "calculating"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0,
"policies": []
},
{
"id": "3ae5ef27-a590-4fa4-8a5c-bfaf54269a2d",
"display_name": "weber-waelchi.test",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:16.770Z",
"stale_timestamp": "2034-11-14T12:12:16.770Z",
"stale_warning_timestamp": "2034-11-21T12:12:16.770Z",
"updated": "2024-11-14T12:12:16.770Z",
"insights_id": null,
"tags": [
{
"key": "microchip",
"value": "open-source",
"namespace": "bypassing"
},
{
"key": "microchip",
"value": "optical",
"namespace": "indexing"
},
{
"key": "program",
"value": "solid state",
"namespace": "compressing"
},
{
"key": "firewall",
"value": "online",
"namespace": "navigating"
},
{
"key": "system",
"value": "digital",
"namespace": "overriding"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0,
"policies": []
},
{
"id": "3f70e9c1-7a52-45d6-93a8-dd08b19a093e",
"display_name": "howe.example",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:16.783Z",
"stale_timestamp": "2034-11-14T12:12:16.783Z",
"stale_warning_timestamp": "2034-11-21T12:12:16.783Z",
"updated": "2024-11-14T12:12:16.783Z",
"insights_id": null,
"tags": [
{
"key": "sensor",
"value": "virtual",
"namespace": "connecting"
},
{
"key": "capacitor",
"value": "neural",
"namespace": "parsing"
},
{
"key": "bandwidth",
"value": "digital",
"namespace": "parsing"
},
{
"key": "matrix",
"value": "wireless",
"namespace": "indexing"
},
{
"key": "application",
"value": "primary",
"namespace": "quantifying"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0,
"policies": []
},
{
"id": "4593a9e6-0883-48e3-863b-f96a5877808a",
"display_name": "treutel-tremblay.example",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:16.768Z",
"stale_timestamp": "2034-11-14T12:12:16.768Z",
"stale_warning_timestamp": "2034-11-21T12:12:16.768Z",
"updated": "2024-11-14T12:12:16.768Z",
"insights_id": null,
"tags": [
{
"key": "bandwidth",
"value": "haptic",
"namespace": "bypassing"
},
{
"key": "matrix",
"value": "optical",
"namespace": "transmitting"
},
{
"key": "port",
"value": "optical",
"namespace": "navigating"
},
{
"key": "monitor",
"value": "1080p",
"namespace": "quantifying"
},
{
"key": "circuit",
"value": "back-end",
"namespace": "connecting"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0,
"policies": []
},
{
"id": "4680c2d9-58a7-4d01-80db-cbf827ea24f8",
"display_name": "hermiston.test",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:16.787Z",
"stale_timestamp": "2034-11-14T12:12:16.787Z",
"stale_warning_timestamp": "2034-11-21T12:12:16.787Z",
"updated": "2024-11-14T12:12:16.787Z",
"insights_id": null,
"tags": [
{
"key": "matrix",
"value": "haptic",
"namespace": "connecting"
},
{
"key": "panel",
"value": "digital",
"namespace": "connecting"
},
{
"key": "bandwidth",
"value": "primary",
"namespace": "indexing"
},
{
"key": "application",
"value": "solid state",
"namespace": "quantifying"
},
{
"key": "interface",
"value": "optical",
"namespace": "generating"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0,
"policies": []
},
{
"id": "4b910fd5-5cff-42ce-a844-cc83fe40c5a5",
"display_name": "schultz.example",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:16.784Z",
"stale_timestamp": "2034-11-14T12:12:16.784Z",
"stale_warning_timestamp": "2034-11-21T12:12:16.784Z",
"updated": "2024-11-14T12:12:16.784Z",
"insights_id": null,
"tags": [
{
"key": "bandwidth",
"value": "cross-platform",
"namespace": "copying"
},
{
"key": "firewall",
"value": "open-source",
"namespace": "backing up"
},
{
"key": "panel",
"value": "multi-byte",
"namespace": "hacking"
},
{
"key": "pixel",
"value": "open-source",
"namespace": "transmitting"
},
{
"key": "sensor",
"value": "mobile",
"namespace": "connecting"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0,
"policies": []
},
{
"id": "638a6c28-e464-4e4f-8272-2bd5117bc4e5",
"display_name": "dubuque-anderson.test",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:16.765Z",
"stale_timestamp": "2034-11-14T12:12:16.765Z",
"stale_warning_timestamp": "2034-11-21T12:12:16.765Z",
"updated": "2024-11-14T12:12:16.765Z",
"insights_id": null,
"tags": [
{
"key": "transmitter",
"value": "digital",
"namespace": "bypassing"
},
{
"key": "application",
"value": "online",
"namespace": "backing up"
},
{
"key": "sensor",
"value": "online",
"namespace": "bypassing"
},
{
"key": "microchip",
"value": "redundant",
"namespace": "transmitting"
},
{
"key": "application",
"value": "virtual",
"namespace": "connecting"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0,
"policies": []
},
{
"id": "67f16bca-8ff7-43a2-b242-d64ccb763d89",
"display_name": "bechtelar.test",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:16.772Z",
"stale_timestamp": "2034-11-14T12:12:16.772Z",
"stale_warning_timestamp": "2034-11-21T12:12:16.772Z",
"updated": "2024-11-14T12:12:16.772Z",
"insights_id": null,
"tags": [
{
"key": "alarm",
"value": "optical",
"namespace": "overriding"
},
{
"key": "circuit",
"value": "open-source",
"namespace": "quantifying"
},
{
"key": "hard drive",
"value": "auxiliary",
"namespace": "quantifying"
},
{
"key": "firewall",
"value": "wireless",
"namespace": "synthesizing"
},
{
"key": "capacitor",
"value": "mobile",
"namespace": "calculating"
}
],
"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 <a href=\"https://github.com/wvanbergen/scoped_search/wiki/Query-language\" target=\"_blank\" title=\"github.com/wvanbergen/scoped_search\">scoped_search query language</a>. However, only `=` or `!=` (resp. `<>`) operators are supported.<br><br>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`<br><br>(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": "Returns a System",
"operationId": "System",
"responses": {
"200": {
"description": "Returns a System",
"content": {
"application/vnd.api+json": {
"examples": {
"Returns a System": {
"value": {
"data": {
"id": "f09c0e90-066e-481a-822e-387c5a669f21",
"display_name": "larson-grady.test",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:16.945Z",
"stale_timestamp": "2034-11-14T12:12:16.945Z",
"stale_warning_timestamp": "2034-11-21T12:12:16.945Z",
"updated": "2024-11-14T12:12:16.945Z",
"insights_id": null,
"tags": [
{
"key": "pixel",
"value": "digital",
"namespace": "backing up"
},
{
"key": "application",
"value": "solid state",
"namespace": "navigating"
},
{
"key": "application",
"value": "open-source",
"namespace": "programming"
},
{
"key": "hard drive",
"value": "multi-byte",
"namespace": "transmitting"
},
{
"key": "firewall",
"value": "optical",
"namespace": "parsing"
}
],
"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 88a626c1-6876-4688-b9d7-d847ffd6e526"
]
},
"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.<br>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 (`<key>:asc` or `<key>:desc`).<br><br>If no direction is selected, `<key>: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 <a href=\"https://github.com/wvanbergen/scoped_search/wiki/Query-language\" target=\"_blank\" title=\"github.com/wvanbergen/scoped_search\">scoped_search query language</a>. However, only `=` or `!=` (resp. `<>`) operators are supported.<br><br>Systems are searchable using attributes `display_name`, `os_version`, `os_minor_version`, and `group_name`<br><br>(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": "Lists Systems assigned to a Policy",
"operationId": "PolicySystems",
"responses": {
"200": {
"description": "Lists Systems assigned to a Policy",
"content": {
"application/vnd.api+json": {
"examples": {
"List of Systems": {
"value": {
"data": [
{
"id": "148faa27-8097-49da-b7ba-407e012596e6",
"display_name": "hilll.example",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:17.164Z",
"stale_timestamp": "2034-11-14T12:12:17.164Z",
"stale_warning_timestamp": "2034-11-21T12:12:17.164Z",
"updated": "2024-11-14T12:12:17.164Z",
"insights_id": null,
"tags": [
{
"key": "feed",
"value": "auxiliary",
"namespace": "programming"
},
{
"key": "firewall",
"value": "digital",
"namespace": "indexing"
},
{
"key": "port",
"value": "online",
"namespace": "indexing"
},
{
"key": "feed",
"value": "haptic",
"namespace": "overriding"
},
{
"key": "interface",
"value": "digital",
"namespace": "synthesizing"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0
},
{
"id": "18545cdf-9c04-4bd4-bf42-663172ff77c4",
"display_name": "kautzer.example",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:17.102Z",
"stale_timestamp": "2034-11-14T12:12:17.102Z",
"stale_warning_timestamp": "2034-11-21T12:12:17.102Z",
"updated": "2024-11-14T12:12:17.102Z",
"insights_id": null,
"tags": [
{
"key": "system",
"value": "primary",
"namespace": "overriding"
},
{
"key": "interface",
"value": "open-source",
"namespace": "parsing"
},
{
"key": "pixel",
"value": "redundant",
"namespace": "transmitting"
},
{
"key": "feed",
"value": "redundant",
"namespace": "transmitting"
},
{
"key": "firewall",
"value": "digital",
"namespace": "programming"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0
},
{
"id": "1fd351e5-271d-4e23-8eed-c87f977082d8",
"display_name": "robel.example",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:17.120Z",
"stale_timestamp": "2034-11-14T12:12:17.120Z",
"stale_warning_timestamp": "2034-11-21T12:12:17.120Z",
"updated": "2024-11-14T12:12:17.120Z",
"insights_id": null,
"tags": [
{
"key": "hard drive",
"value": "neural",
"namespace": "navigating"
},
{
"key": "array",
"value": "primary",
"namespace": "generating"
},
{
"key": "array",
"value": "back-end",
"namespace": "hacking"
},
{
"key": "firewall",
"value": "1080p",
"namespace": "generating"
},
{
"key": "hard drive",
"value": "auxiliary",
"namespace": "parsing"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0
},
{
"id": "2fba5f67-b9c4-4e5f-a963-16f80b2f28c2",
"display_name": "ward-predovic.example",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:17.111Z",
"stale_timestamp": "2034-11-14T12:12:17.111Z",
"stale_warning_timestamp": "2034-11-21T12:12:17.111Z",
"updated": "2024-11-14T12:12:17.111Z",
"insights_id": null,
"tags": [
{
"key": "port",
"value": "haptic",
"namespace": "navigating"
},
{
"key": "capacitor",
"value": "open-source",
"namespace": "indexing"
},
{
"key": "pixel",
"value": "online",
"namespace": "compressing"
},
{
"key": "firewall",
"value": "1080p",
"namespace": "backing up"
},
{
"key": "system",
"value": "optical",
"namespace": "calculating"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0
},
{
"id": "32fd6960-8b0b-4e30-8727-a55303286cb5",
"display_name": "heaney.example",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:17.084Z",
"stale_timestamp": "2034-11-14T12:12:17.084Z",
"stale_warning_timestamp": "2034-11-21T12:12:17.084Z",
"updated": "2024-11-14T12:12:17.084Z",
"insights_id": null,
"tags": [
{
"key": "driver",
"value": "1080p",
"namespace": "programming"
},
{
"key": "system",
"value": "digital",
"namespace": "compressing"
},
{
"key": "microchip",
"value": "open-source",
"namespace": "indexing"
},
{
"key": "panel",
"value": "cross-platform",
"namespace": "compressing"
},
{
"key": "transmitter",
"value": "cross-platform",
"namespace": "overriding"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0
},
{
"id": "33107e76-cf69-4841-ad39-6188447f7568",
"display_name": "auer.example",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:17.078Z",
"stale_timestamp": "2034-11-14T12:12:17.078Z",
"stale_warning_timestamp": "2034-11-21T12:12:17.078Z",
"updated": "2024-11-14T12:12:17.078Z",
"insights_id": null,
"tags": [
{
"key": "program",
"value": "back-end",
"namespace": "connecting"
},
{
"key": "monitor",
"value": "auxiliary",
"namespace": "backing up"
},
{
"key": "capacitor",
"value": "online",
"namespace": "parsing"
},
{
"key": "card",
"value": "virtual",
"namespace": "parsing"
},
{
"key": "transmitter",
"value": "primary",
"namespace": "overriding"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0
},
{
"id": "34f373f9-030a-49c1-b608-84c462fc5d7b",
"display_name": "hickle-connelly.example",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:17.133Z",
"stale_timestamp": "2034-11-14T12:12:17.133Z",
"stale_warning_timestamp": "2034-11-21T12:12:17.133Z",
"updated": "2024-11-14T12:12:17.133Z",
"insights_id": null,
"tags": [
{
"key": "card",
"value": "online",
"namespace": "calculating"
},
{
"key": "microchip",
"value": "mobile",
"namespace": "parsing"
},
{
"key": "transmitter",
"value": "primary",
"namespace": "compressing"
},
{
"key": "interface",
"value": "virtual",
"namespace": "parsing"
},
{
"key": "firewall",
"value": "optical",
"namespace": "overriding"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0
},
{
"id": "442be36a-1fa1-4de7-8b4f-7f9c556d7f14",
"display_name": "graham.test",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:17.089Z",
"stale_timestamp": "2034-11-14T12:12:17.089Z",
"stale_warning_timestamp": "2034-11-21T12:12:17.089Z",
"updated": "2024-11-14T12:12:17.089Z",
"insights_id": null,
"tags": [
{
"key": "system",
"value": "open-source",
"namespace": "backing up"
},
{
"key": "microchip",
"value": "neural",
"namespace": "navigating"
},
{
"key": "hard drive",
"value": "multi-byte",
"namespace": "overriding"
},
{
"key": "microchip",
"value": "wireless",
"namespace": "compressing"
},
{
"key": "capacitor",
"value": "haptic",
"namespace": "calculating"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0
},
{
"id": "46fc5af9-df78-470a-aee9-63cae785e668",
"display_name": "spinka.example",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:17.033Z",
"stale_timestamp": "2034-11-14T12:12:17.033Z",
"stale_warning_timestamp": "2034-11-21T12:12:17.033Z",
"updated": "2024-11-14T12:12:17.033Z",
"insights_id": null,
"tags": [
{
"key": "program",
"value": "digital",
"namespace": "generating"
},
{
"key": "matrix",
"value": "solid state",
"namespace": "programming"
},
{
"key": "circuit",
"value": "primary",
"namespace": "calculating"
},
{
"key": "bandwidth",
"value": "primary",
"namespace": "quantifying"
},
{
"key": "panel",
"value": "mobile",
"namespace": "backing up"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0
},
{
"id": "55e5c951-2e0c-400e-8369-74125353d88a",
"display_name": "kuphal.test",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:17.098Z",
"stale_timestamp": "2034-11-14T12:12:17.098Z",
"stale_warning_timestamp": "2034-11-21T12:12:17.098Z",
"updated": "2024-11-14T12:12:17.098Z",
"insights_id": null,
"tags": [
{
"key": "pixel",
"value": "cross-platform",
"namespace": "indexing"
},
{
"key": "panel",
"value": "bluetooth",
"namespace": "generating"
},
{
"key": "protocol",
"value": "virtual",
"namespace": "programming"
},
{
"key": "program",
"value": "virtual",
"namespace": "overriding"
},
{
"key": "alarm",
"value": "wireless",
"namespace": "overriding"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0
}
],
"meta": {
"total": 25,
"tags": [],
"limit": 10,
"offset": 0
},
"links": {
"first": "/api/compliance/v2/policies/d747dd75-1d91-48b7-89ca-d958f237b437/systems?limit=10&offset=0",
"last": "/api/compliance/v2/policies/d747dd75-1d91-48b7-89ca-d958f237b437/systems?limit=10&offset=20",
"next": "/api/compliance/v2/policies/d747dd75-1d91-48b7-89ca-d958f237b437/systems?limit=10&offset=10"
}
},
"summary": "",
"description": ""
},
"List of Systems sorted by \"os_minor_version:asc\"": {
"value": {
"data": [
{
"id": "079bb8c8-3c2e-4e4c-bdee-d7aae8d99a41",
"display_name": "skiles.test",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:17.276Z",
"stale_timestamp": "2034-11-14T12:12:17.276Z",
"stale_warning_timestamp": "2034-11-21T12:12:17.276Z",
"updated": "2024-11-14T12:12:17.276Z",
"insights_id": null,
"tags": [
{
"key": "monitor",
"value": "mobile",
"namespace": "navigating"
},
{
"key": "transmitter",
"value": "virtual",
"namespace": "navigating"
},
{
"key": "firewall",
"value": "1080p",
"namespace": "synthesizing"
},
{
"key": "application",
"value": "auxiliary",
"namespace": "copying"
},
{
"key": "matrix",
"value": "optical",
"namespace": "calculating"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0
},
{
"id": "0ca57bc9-efa8-46d6-b867-2c8c458f126e",
"display_name": "leffler-kertzmann.test",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:17.311Z",
"stale_timestamp": "2034-11-14T12:12:17.311Z",
"stale_warning_timestamp": "2034-11-21T12:12:17.311Z",
"updated": "2024-11-14T12:12:17.311Z",
"insights_id": null,
"tags": [
{
"key": "matrix",
"value": "auxiliary",
"namespace": "programming"
},
{
"key": "pixel",
"value": "optical",
"namespace": "calculating"
},
{
"key": "feed",
"value": "wireless",
"namespace": "generating"
},
{
"key": "feed",
"value": "solid state",
"namespace": "calculating"
},
{
"key": "monitor",
"value": "open-source",
"namespace": "parsing"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0
},
{
"id": "14185ad1-0deb-4a67-804a-5776316c97a3",
"display_name": "cartwright-dickinson.test",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:17.266Z",
"stale_timestamp": "2034-11-14T12:12:17.266Z",
"stale_warning_timestamp": "2034-11-21T12:12:17.266Z",
"updated": "2024-11-14T12:12:17.266Z",
"insights_id": null,
"tags": [
{
"key": "monitor",
"value": "open-source",
"namespace": "hacking"
},
{
"key": "driver",
"value": "cross-platform",
"namespace": "calculating"
},
{
"key": "bus",
"value": "primary",
"namespace": "navigating"
},
{
"key": "port",
"value": "open-source",
"namespace": "overriding"
},
{
"key": "capacitor",
"value": "online",
"namespace": "bypassing"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0
},
{
"id": "24262c39-0a88-46b4-afd8-6a49d3e87d73",
"display_name": "leffler.test",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:17.229Z",
"stale_timestamp": "2034-11-14T12:12:17.229Z",
"stale_warning_timestamp": "2034-11-21T12:12:17.229Z",
"updated": "2024-11-14T12:12:17.229Z",
"insights_id": null,
"tags": [
{
"key": "driver",
"value": "mobile",
"namespace": "transmitting"
},
{
"key": "microchip",
"value": "wireless",
"namespace": "indexing"
},
{
"key": "transmitter",
"value": "1080p",
"namespace": "overriding"
},
{
"key": "port",
"value": "auxiliary",
"namespace": "indexing"
},
{
"key": "transmitter",
"value": "auxiliary",
"namespace": "copying"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0
},
{
"id": "34678d0b-c3b5-46f5-9fcb-c4333039077c",
"display_name": "moore-hills.example",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:17.302Z",
"stale_timestamp": "2034-11-14T12:12:17.302Z",
"stale_warning_timestamp": "2034-11-21T12:12:17.302Z",
"updated": "2024-11-14T12:12:17.302Z",
"insights_id": null,
"tags": [
{
"key": "circuit",
"value": "virtual",
"namespace": "generating"
},
{
"key": "capacitor",
"value": "haptic",
"namespace": "parsing"
},
{
"key": "sensor",
"value": "back-end",
"namespace": "transmitting"
},
{
"key": "card",
"value": "multi-byte",
"namespace": "navigating"
},
{
"key": "application",
"value": "wireless",
"namespace": "bypassing"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0
},
{
"id": "393d928c-e755-4d6f-851f-02b19e32fc47",
"display_name": "marquardt.example",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:17.247Z",
"stale_timestamp": "2034-11-14T12:12:17.247Z",
"stale_warning_timestamp": "2034-11-21T12:12:17.247Z",
"updated": "2024-11-14T12:12:17.247Z",
"insights_id": null,
"tags": [
{
"key": "feed",
"value": "optical",
"namespace": "bypassing"
},
{
"key": "matrix",
"value": "haptic",
"namespace": "overriding"
},
{
"key": "panel",
"value": "auxiliary",
"namespace": "backing up"
},
{
"key": "card",
"value": "primary",
"namespace": "connecting"
},
{
"key": "driver",
"value": "redundant",
"namespace": "navigating"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0
},
{
"id": "5311e484-f47d-47ec-8478-d6401715a9a5",
"display_name": "mraz.example",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:17.243Z",
"stale_timestamp": "2034-11-14T12:12:17.243Z",
"stale_warning_timestamp": "2034-11-21T12:12:17.243Z",
"updated": "2024-11-14T12:12:17.243Z",
"insights_id": null,
"tags": [
{
"key": "circuit",
"value": "open-source",
"namespace": "programming"
},
{
"key": "transmitter",
"value": "solid state",
"namespace": "parsing"
},
{
"key": "capacitor",
"value": "online",
"namespace": "copying"
},
{
"key": "circuit",
"value": "wireless",
"namespace": "programming"
},
{
"key": "application",
"value": "mobile",
"namespace": "backing up"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0
},
{
"id": "533009bd-af6a-4e03-9503-02c71f8e7cb7",
"display_name": "jaskolski.test",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:17.197Z",
"stale_timestamp": "2034-11-14T12:12:17.197Z",
"stale_warning_timestamp": "2034-11-21T12:12:17.197Z",
"updated": "2024-11-14T12:12:17.197Z",
"insights_id": null,
"tags": [
{
"key": "application",
"value": "optical",
"namespace": "programming"
},
{
"key": "card",
"value": "bluetooth",
"namespace": "bypassing"
},
{
"key": "alarm",
"value": "1080p",
"namespace": "compressing"
},
{
"key": "driver",
"value": "wireless",
"namespace": "calculating"
},
{
"key": "bandwidth",
"value": "mobile",
"namespace": "programming"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0
},
{
"id": "60d01227-6159-4b5b-8441-8be7c6e78be5",
"display_name": "waelchi.test",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:17.225Z",
"stale_timestamp": "2034-11-14T12:12:17.225Z",
"stale_warning_timestamp": "2034-11-21T12:12:17.225Z",
"updated": "2024-11-14T12:12:17.225Z",
"insights_id": null,
"tags": [
{
"key": "microchip",
"value": "virtual",
"namespace": "bypassing"
},
{
"key": "pixel",
"value": "1080p",
"namespace": "overriding"
},
{
"key": "feed",
"value": "digital",
"namespace": "quantifying"
},
{
"key": "panel",
"value": "1080p",
"namespace": "transmitting"
},
{
"key": "feed",
"value": "open-source",
"namespace": "indexing"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0
},
{
"id": "6a1bcdf4-20a9-4031-85cf-2fe0ecf24568",
"display_name": "schaden-pagac.test",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:17.270Z",
"stale_timestamp": "2034-11-14T12:12:17.270Z",
"stale_warning_timestamp": "2034-11-21T12:12:17.270Z",
"updated": "2024-11-14T12:12:17.270Z",
"insights_id": null,
"tags": [
{
"key": "protocol",
"value": "digital",
"namespace": "parsing"
},
{
"key": "feed",
"value": "online",
"namespace": "calculating"
},
{
"key": "array",
"value": "redundant",
"namespace": "indexing"
},
{
"key": "pixel",
"value": "open-source",
"namespace": "overriding"
},
{
"key": "alarm",
"value": "digital",
"namespace": "quantifying"
}
],
"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/720e75ed-5790-40b8-9ddb-7f5973e6723e/systems?limit=10&offset=0&sort_by=os_minor_version",
"last": "/api/compliance/v2/policies/720e75ed-5790-40b8-9ddb-7f5973e6723e/systems?limit=10&offset=20&sort_by=os_minor_version",
"next": "/api/compliance/v2/policies/720e75ed-5790-40b8-9ddb-7f5973e6723e/systems?limit=10&offset=10&sort_by=os_minor_version"
}
},
"summary": "",
"description": ""
},
"List of Systems filtered by \"(os_minor_version=0)\"": {
"value": {
"data": [
{
"id": "007fc59a-4499-4109-8466-9aefdf19e35f",
"display_name": "christiansen.example",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:17.418Z",
"stale_timestamp": "2034-11-14T12:12:17.418Z",
"stale_warning_timestamp": "2034-11-21T12:12:17.418Z",
"updated": "2024-11-14T12:12:17.418Z",
"insights_id": null,
"tags": [
{
"key": "interface",
"value": "cross-platform",
"namespace": "parsing"
},
{
"key": "matrix",
"value": "primary",
"namespace": "navigating"
},
{
"key": "feed",
"value": "back-end",
"namespace": "generating"
},
{
"key": "protocol",
"value": "bluetooth",
"namespace": "hacking"
},
{
"key": "microchip",
"value": "solid state",
"namespace": "indexing"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0
},
{
"id": "067c9c35-5662-4211-baa7-3f20d0a1fef5",
"display_name": "runte.example",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:17.409Z",
"stale_timestamp": "2034-11-14T12:12:17.409Z",
"stale_warning_timestamp": "2034-11-21T12:12:17.409Z",
"updated": "2024-11-14T12:12:17.409Z",
"insights_id": null,
"tags": [
{
"key": "hard drive",
"value": "auxiliary",
"namespace": "compressing"
},
{
"key": "circuit",
"value": "back-end",
"namespace": "compressing"
},
{
"key": "hard drive",
"value": "auxiliary",
"namespace": "quantifying"
},
{
"key": "system",
"value": "wireless",
"namespace": "navigating"
},
{
"key": "bandwidth",
"value": "1080p",
"namespace": "overriding"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0
},
{
"id": "09ff46d8-61c3-4b4d-8126-69a0babb8fdb",
"display_name": "fritsch-kirlin.test",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:17.435Z",
"stale_timestamp": "2034-11-14T12:12:17.435Z",
"stale_warning_timestamp": "2034-11-21T12:12:17.435Z",
"updated": "2024-11-14T12:12:17.435Z",
"insights_id": null,
"tags": [
{
"key": "firewall",
"value": "solid state",
"namespace": "calculating"
},
{
"key": "application",
"value": "online",
"namespace": "synthesizing"
},
{
"key": "protocol",
"value": "primary",
"namespace": "connecting"
},
{
"key": "driver",
"value": "primary",
"namespace": "indexing"
},
{
"key": "capacitor",
"value": "online",
"namespace": "programming"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0
},
{
"id": "1808c6a1-4c11-4b8a-8f19-b036d8cbb1dc",
"display_name": "huels.example",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:17.377Z",
"stale_timestamp": "2034-11-14T12:12:17.377Z",
"stale_warning_timestamp": "2034-11-21T12:12:17.377Z",
"updated": "2024-11-14T12:12:17.377Z",
"insights_id": null,
"tags": [
{
"key": "bandwidth",
"value": "online",
"namespace": "generating"
},
{
"key": "interface",
"value": "auxiliary",
"namespace": "generating"
},
{
"key": "sensor",
"value": "back-end",
"namespace": "synthesizing"
},
{
"key": "interface",
"value": "redundant",
"namespace": "compressing"
},
{
"key": "port",
"value": "optical",
"namespace": "generating"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0
},
{
"id": "1c816fe6-a96e-4128-a8b3-dc69ec2cdc21",
"display_name": "schaefer-crist.test",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:17.422Z",
"stale_timestamp": "2034-11-14T12:12:17.422Z",
"stale_warning_timestamp": "2034-11-21T12:12:17.422Z",
"updated": "2024-11-14T12:12:17.422Z",
"insights_id": null,
"tags": [
{
"key": "card",
"value": "bluetooth",
"namespace": "overriding"
},
{
"key": "firewall",
"value": "cross-platform",
"namespace": "programming"
},
{
"key": "port",
"value": "neural",
"namespace": "programming"
},
{
"key": "firewall",
"value": "redundant",
"namespace": "indexing"
},
{
"key": "application",
"value": "bluetooth",
"namespace": "backing up"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0
},
{
"id": "1dc90305-b673-4991-90c3-8d44258b3439",
"display_name": "hirthe.test",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:17.451Z",
"stale_timestamp": "2034-11-14T12:12:17.451Z",
"stale_warning_timestamp": "2034-11-21T12:12:17.451Z",
"updated": "2024-11-14T12:12:17.451Z",
"insights_id": null,
"tags": [
{
"key": "hard drive",
"value": "haptic",
"namespace": "bypassing"
},
{
"key": "microchip",
"value": "digital",
"namespace": "connecting"
},
{
"key": "matrix",
"value": "bluetooth",
"namespace": "compressing"
},
{
"key": "alarm",
"value": "solid state",
"namespace": "synthesizing"
},
{
"key": "panel",
"value": "back-end",
"namespace": "connecting"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0
},
{
"id": "29244ad2-263f-4eaf-9940-5b4a1a14c945",
"display_name": "little-hegmann.test",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:17.386Z",
"stale_timestamp": "2034-11-14T12:12:17.386Z",
"stale_warning_timestamp": "2034-11-21T12:12:17.386Z",
"updated": "2024-11-14T12:12:17.386Z",
"insights_id": null,
"tags": [
{
"key": "pixel",
"value": "neural",
"namespace": "programming"
},
{
"key": "pixel",
"value": "neural",
"namespace": "calculating"
},
{
"key": "matrix",
"value": "bluetooth",
"namespace": "synthesizing"
},
{
"key": "program",
"value": "haptic",
"namespace": "compressing"
},
{
"key": "feed",
"value": "online",
"namespace": "backing up"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0
},
{
"id": "2b5aae4f-1b0f-4c1d-a1a9-4546e086df0b",
"display_name": "brakus.example",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:17.359Z",
"stale_timestamp": "2034-11-14T12:12:17.359Z",
"stale_warning_timestamp": "2034-11-21T12:12:17.359Z",
"updated": "2024-11-14T12:12:17.359Z",
"insights_id": null,
"tags": [
{
"key": "bandwidth",
"value": "redundant",
"namespace": "bypassing"
},
{
"key": "protocol",
"value": "1080p",
"namespace": "compressing"
},
{
"key": "panel",
"value": "primary",
"namespace": "programming"
},
{
"key": "array",
"value": "haptic",
"namespace": "synthesizing"
},
{
"key": "driver",
"value": "optical",
"namespace": "generating"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0
},
{
"id": "2d543a1c-a362-495b-8a2c-85d31a3f6bd4",
"display_name": "zieme-trantow.test",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:17.439Z",
"stale_timestamp": "2034-11-14T12:12:17.439Z",
"stale_warning_timestamp": "2034-11-21T12:12:17.439Z",
"updated": "2024-11-14T12:12:17.439Z",
"insights_id": null,
"tags": [
{
"key": "circuit",
"value": "multi-byte",
"namespace": "copying"
},
{
"key": "protocol",
"value": "open-source",
"namespace": "synthesizing"
},
{
"key": "card",
"value": "mobile",
"namespace": "synthesizing"
},
{
"key": "bus",
"value": "cross-platform",
"namespace": "overriding"
},
{
"key": "panel",
"value": "bluetooth",
"namespace": "copying"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0
},
{
"id": "457b10fa-1649-4ec8-a7ff-9d1904fc4981",
"display_name": "ruecker.test",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:17.446Z",
"stale_timestamp": "2034-11-14T12:12:17.446Z",
"stale_warning_timestamp": "2034-11-21T12:12:17.446Z",
"updated": "2024-11-14T12:12:17.446Z",
"insights_id": null,
"tags": [
{
"key": "system",
"value": "back-end",
"namespace": "calculating"
},
{
"key": "matrix",
"value": "open-source",
"namespace": "connecting"
},
{
"key": "matrix",
"value": "haptic",
"namespace": "compressing"
},
{
"key": "microchip",
"value": "cross-platform",
"namespace": "synthesizing"
},
{
"key": "transmitter",
"value": "cross-platform",
"namespace": "compressing"
}
],
"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/c1b81970-9513-40e5-9122-239c230cc1de/systems?filter=%28os_minor_version%3D0%29&limit=10&offset=0",
"last": "/api/compliance/v2/policies/c1b81970-9513-40e5-9122-239c230cc1de/systems?filter=%28os_minor_version%3D0%29&limit=10&offset=20",
"next": "/api/compliance/v2/policies/c1b81970-9513-40e5-9122-239c230cc1de/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": "02730877-191e-4ce0-8816-29583872a2f7",
"display_name": "rau.test",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:17.910Z",
"stale_timestamp": "2034-11-14T12:12:17.910Z",
"stale_warning_timestamp": "2034-11-21T12:12:17.910Z",
"updated": "2024-11-14T12:12:17.910Z",
"insights_id": null,
"tags": [
{
"key": "sensor",
"value": "1080p",
"namespace": "synthesizing"
},
{
"key": "alarm",
"value": "cross-platform",
"namespace": "hacking"
},
{
"key": "pixel",
"value": "primary",
"namespace": "programming"
},
{
"key": "interface",
"value": "primary",
"namespace": "bypassing"
},
{
"key": "alarm",
"value": "neural",
"namespace": "overriding"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0
},
{
"id": "0447640d-95ce-4aa4-b979-a062b0c18b8d",
"display_name": "hodkiewicz.example",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:17.920Z",
"stale_timestamp": "2034-11-14T12:12:17.920Z",
"stale_warning_timestamp": "2034-11-21T12:12:17.920Z",
"updated": "2024-11-14T12:12:17.920Z",
"insights_id": null,
"tags": [
{
"key": "pixel",
"value": "solid state",
"namespace": "programming"
},
{
"key": "system",
"value": "mobile",
"namespace": "quantifying"
},
{
"key": "alarm",
"value": "back-end",
"namespace": "overriding"
},
{
"key": "system",
"value": "auxiliary",
"namespace": "hacking"
},
{
"key": "interface",
"value": "redundant",
"namespace": "overriding"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0
},
{
"id": "0e9f3fb2-5c5b-45f6-8b4b-274955fee4dc",
"display_name": "fahey.example",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:17.921Z",
"stale_timestamp": "2034-11-14T12:12:17.921Z",
"stale_warning_timestamp": "2034-11-21T12:12:17.921Z",
"updated": "2024-11-14T12:12:17.921Z",
"insights_id": null,
"tags": [
{
"key": "application",
"value": "optical",
"namespace": "calculating"
},
{
"key": "matrix",
"value": "digital",
"namespace": "synthesizing"
},
{
"key": "microchip",
"value": "digital",
"namespace": "compressing"
},
{
"key": "sensor",
"value": "haptic",
"namespace": "copying"
},
{
"key": "program",
"value": "cross-platform",
"namespace": "indexing"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0
},
{
"id": "13acbdda-0e5c-4712-9d72-7093d7bada53",
"display_name": "bailey.test",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:17.914Z",
"stale_timestamp": "2034-11-14T12:12:17.914Z",
"stale_warning_timestamp": "2034-11-21T12:12:17.914Z",
"updated": "2024-11-14T12:12:17.914Z",
"insights_id": null,
"tags": [
{
"key": "matrix",
"value": "open-source",
"namespace": "parsing"
},
{
"key": "microchip",
"value": "back-end",
"namespace": "synthesizing"
},
{
"key": "circuit",
"value": "primary",
"namespace": "calculating"
},
{
"key": "firewall",
"value": "neural",
"namespace": "synthesizing"
},
{
"key": "firewall",
"value": "auxiliary",
"namespace": "programming"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0
},
{
"id": "1a7371a7-1749-4a86-b125-464966ef1087",
"display_name": "oconner.example",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:17.911Z",
"stale_timestamp": "2034-11-14T12:12:17.911Z",
"stale_warning_timestamp": "2034-11-21T12:12:17.911Z",
"updated": "2024-11-14T12:12:17.911Z",
"insights_id": null,
"tags": [
{
"key": "pixel",
"value": "auxiliary",
"namespace": "indexing"
},
{
"key": "bandwidth",
"value": "auxiliary",
"namespace": "navigating"
},
{
"key": "capacitor",
"value": "bluetooth",
"namespace": "transmitting"
},
{
"key": "port",
"value": "bluetooth",
"namespace": "parsing"
},
{
"key": "monitor",
"value": "redundant",
"namespace": "bypassing"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0
},
{
"id": "466fbe9e-1cf5-40c8-ad15-c5cb17b6e697",
"display_name": "harris.example",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:17.900Z",
"stale_timestamp": "2034-11-14T12:12:17.900Z",
"stale_warning_timestamp": "2034-11-21T12:12:17.900Z",
"updated": "2024-11-14T12:12:17.900Z",
"insights_id": null,
"tags": [
{
"key": "alarm",
"value": "primary",
"namespace": "programming"
},
{
"key": "protocol",
"value": "bluetooth",
"namespace": "quantifying"
},
{
"key": "alarm",
"value": "back-end",
"namespace": "indexing"
},
{
"key": "matrix",
"value": "multi-byte",
"namespace": "bypassing"
},
{
"key": "transmitter",
"value": "bluetooth",
"namespace": "bypassing"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0
},
{
"id": "496ace30-950b-48a5-b874-37be77c71fb7",
"display_name": "erdman.example",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:17.904Z",
"stale_timestamp": "2034-11-14T12:12:17.904Z",
"stale_warning_timestamp": "2034-11-21T12:12:17.904Z",
"updated": "2024-11-14T12:12:17.904Z",
"insights_id": null,
"tags": [
{
"key": "bus",
"value": "mobile",
"namespace": "backing up"
},
{
"key": "monitor",
"value": "mobile",
"namespace": "quantifying"
},
{
"key": "array",
"value": "open-source",
"namespace": "bypassing"
},
{
"key": "port",
"value": "optical",
"namespace": "quantifying"
},
{
"key": "matrix",
"value": "cross-platform",
"namespace": "indexing"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0
},
{
"id": "77cefe07-0a4f-47c6-95f8-4388196f972d",
"display_name": "ryan-mccullough.example",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:17.908Z",
"stale_timestamp": "2034-11-14T12:12:17.908Z",
"stale_warning_timestamp": "2034-11-21T12:12:17.908Z",
"updated": "2024-11-14T12:12:17.908Z",
"insights_id": null,
"tags": [
{
"key": "capacitor",
"value": "1080p",
"namespace": "transmitting"
},
{
"key": "transmitter",
"value": "digital",
"namespace": "backing up"
},
{
"key": "system",
"value": "multi-byte",
"namespace": "compressing"
},
{
"key": "sensor",
"value": "auxiliary",
"namespace": "programming"
},
{
"key": "sensor",
"value": "online",
"namespace": "hacking"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0
},
{
"id": "86bcf00f-68f5-4e28-80f8-cbd7c16f9b8f",
"display_name": "reilly-bergstrom.example",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:17.902Z",
"stale_timestamp": "2034-11-14T12:12:17.902Z",
"stale_warning_timestamp": "2034-11-21T12:12:17.902Z",
"updated": "2024-11-14T12:12:17.902Z",
"insights_id": null,
"tags": [
{
"key": "microchip",
"value": "open-source",
"namespace": "bypassing"
},
{
"key": "protocol",
"value": "optical",
"namespace": "overriding"
},
{
"key": "protocol",
"value": "virtual",
"namespace": "calculating"
},
{
"key": "pixel",
"value": "mobile",
"namespace": "parsing"
},
{
"key": "microchip",
"value": "multi-byte",
"namespace": "copying"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0
},
{
"id": "88af878c-f19a-4705-af87-228b696c9255",
"display_name": "casper.test",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:17.918Z",
"stale_timestamp": "2034-11-14T12:12:17.918Z",
"stale_warning_timestamp": "2034-11-21T12:12:17.918Z",
"updated": "2024-11-14T12:12:17.918Z",
"insights_id": null,
"tags": [
{
"key": "driver",
"value": "neural",
"namespace": "hacking"
},
{
"key": "pixel",
"value": "auxiliary",
"namespace": "backing up"
},
{
"key": "array",
"value": "open-source",
"namespace": "backing up"
},
{
"key": "transmitter",
"value": "back-end",
"namespace": "parsing"
},
{
"key": "driver",
"value": "open-source",
"namespace": "compressing"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0
}
],
"meta": {
"total": 25,
"tags": [],
"limit": 10,
"offset": 0
},
"links": {
"first": "/api/compliance/v2/policies/660705fb-806b-48cc-a175-7e8a966ef8cd/systems?limit=10&offset=0",
"last": "/api/compliance/v2/policies/660705fb-806b-48cc-a175-7e8a966ef8cd/systems?limit=10&offset=20",
"next": "/api/compliance/v2/policies/660705fb-806b-48cc-a175-7e8a966ef8cd/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": [
"e86cfd1e-7ec8-41ce-a3d7-28ca5ad39cb0"
]
}
}
}
}
}
}
}
}
},
"/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 <a href=\"https://github.com/wvanbergen/scoped_search/wiki/Query-language\" target=\"_blank\" title=\"github.com/wvanbergen/scoped_search\">scoped_search query language</a>. However, only `=` or `!=` (resp. `<>`) operators are supported.<br><br>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`<br><br>(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": "Assigns a System to a 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": "4819bc38-ad2a-4c8f-a4ef-311b7c3c80d8",
"display_name": "kohler.test",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:18.105Z",
"stale_timestamp": "2034-11-14T12:12:18.105Z",
"stale_warning_timestamp": "2034-11-21T12:12:18.105Z",
"updated": "2024-11-14T12:12:18.106Z",
"insights_id": null,
"tags": [
{
"key": "capacitor",
"value": "primary",
"namespace": "programming"
},
{
"key": "system",
"value": "auxiliary",
"namespace": "quantifying"
},
{
"key": "monitor",
"value": "haptic",
"namespace": "indexing"
},
{
"key": "application",
"value": "optical",
"namespace": "transmitting"
},
{
"key": "circuit",
"value": "open-source",
"namespace": "bypassing"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0
}
},
"summary": "",
"description": ""
}
},
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"schema": {
"$ref": "#/components/schemas/system"
}
}
}
}
}
}
}
},
"404": {
"description": "Returns with Not Found",
"content": {
"application/vnd.api+json": {
"examples": {
"Assigns a System to a Policy": {
"value": {
"errors": [
"V2::System not found with ID 9886180b-b90e-4e69-bd42-0c7a981b8a53"
]
},
"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": "Unassigns a System from a 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": "77505349-e8c0-4fca-a931-f52c29605a80",
"display_name": "kuvalis.example",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:18.168Z",
"stale_timestamp": "2034-11-14T12:12:18.168Z",
"stale_warning_timestamp": "2034-11-21T12:12:18.168Z",
"updated": "2024-11-14T12:12:18.168Z",
"insights_id": null,
"tags": [
{
"key": "microchip",
"value": "multi-byte",
"namespace": "generating"
},
{
"key": "microchip",
"value": "mobile",
"namespace": "backing up"
},
{
"key": "feed",
"value": "virtual",
"namespace": "calculating"
},
{
"key": "protocol",
"value": "mobile",
"namespace": "synthesizing"
},
{
"key": "microchip",
"value": "back-end",
"namespace": "bypassing"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0
}
},
"summary": "",
"description": ""
}
},
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"schema": {
"$ref": "#/components/schemas/system"
}
}
}
}
}
}
}
},
"404": {
"description": "Returns with Not Found",
"content": {
"application/vnd.api+json": {
"examples": {
"Description of an error when unassigning a non-existing System": {
"value": {
"errors": [
"V2::System not found with ID 0d7d182f-bc41-421c-bdce-fa0d44e274c0"
]
},
"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.<br>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 (`<key>:asc` or `<key>:desc`).<br><br>If no direction is selected, `<key>: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 <a href=\"https://github.com/wvanbergen/scoped_search/wiki/Query-language\" target=\"_blank\" title=\"github.com/wvanbergen/scoped_search\">scoped_search query language</a>. However, only `=` or `!=` (resp. `<>`) operators are supported.<br><br>Systems are searchable using attributes `display_name`, `os_version`, `os_minor_version`, `never_reported`, and `group_name`<br><br>(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": "Lists Systems assigned to a Report",
"operationId": "ReportSystems",
"responses": {
"200": {
"description": "Lists Systems assigned to a Report",
"content": {
"application/vnd.api+json": {
"examples": {
"List of Systems": {
"value": {
"data": [
{
"id": "01da74b9-c63e-4aa1-8903-15bd4017a20a",
"display_name": "homenick.test",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:18.428Z",
"stale_timestamp": "2034-11-14T12:12:18.428Z",
"stale_warning_timestamp": "2034-11-21T12:12:18.428Z",
"updated": "2024-11-14T12:12:18.428Z",
"insights_id": null,
"tags": [
{
"key": "panel",
"value": "optical",
"namespace": "connecting"
},
{
"key": "card",
"value": "auxiliary",
"namespace": "connecting"
},
{
"key": "microchip",
"value": "primary",
"namespace": "navigating"
},
{
"key": "bus",
"value": "multi-byte",
"namespace": "copying"
},
{
"key": "feed",
"value": "primary",
"namespace": "synthesizing"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0,
"policies": [
{
"id": "46cfcf5a-4a9a-4049-9b3a-99810c2eeaad",
"title": "Cupiditate veritatis voluptatem quasi."
}
]
},
{
"id": "2c946902-b643-4f1b-802e-80bd76781df0",
"display_name": "feeney.example",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:18.480Z",
"stale_timestamp": "2034-11-14T12:12:18.480Z",
"stale_warning_timestamp": "2034-11-21T12:12:18.480Z",
"updated": "2024-11-14T12:12:18.480Z",
"insights_id": null,
"tags": [
{
"key": "matrix",
"value": "cross-platform",
"namespace": "bypassing"
},
{
"key": "circuit",
"value": "cross-platform",
"namespace": "generating"
},
{
"key": "hard drive",
"value": "online",
"namespace": "calculating"
},
{
"key": "circuit",
"value": "digital",
"namespace": "compressing"
},
{
"key": "card",
"value": "open-source",
"namespace": "overriding"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0,
"policies": [
{
"id": "46cfcf5a-4a9a-4049-9b3a-99810c2eeaad",
"title": "Cupiditate veritatis voluptatem quasi."
}
]
},
{
"id": "349b67e6-0c7c-42a4-a6cf-22c24d5bf34d",
"display_name": "schimmel.test",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:18.485Z",
"stale_timestamp": "2034-11-14T12:12:18.485Z",
"stale_warning_timestamp": "2034-11-21T12:12:18.485Z",
"updated": "2024-11-14T12:12:18.485Z",
"insights_id": null,
"tags": [
{
"key": "microchip",
"value": "1080p",
"namespace": "synthesizing"
},
{
"key": "circuit",
"value": "primary",
"namespace": "quantifying"
},
{
"key": "port",
"value": "open-source",
"namespace": "compressing"
},
{
"key": "capacitor",
"value": "mobile",
"namespace": "copying"
},
{
"key": "firewall",
"value": "neural",
"namespace": "compressing"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0,
"policies": [
{
"id": "46cfcf5a-4a9a-4049-9b3a-99810c2eeaad",
"title": "Cupiditate veritatis voluptatem quasi."
}
]
},
{
"id": "34c11e6c-e0cf-4ba0-b9e4-4c188730cc78",
"display_name": "crooks.test",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:18.448Z",
"stale_timestamp": "2034-11-14T12:12:18.448Z",
"stale_warning_timestamp": "2034-11-21T12:12:18.448Z",
"updated": "2024-11-14T12:12:18.448Z",
"insights_id": null,
"tags": [
{
"key": "firewall",
"value": "online",
"namespace": "hacking"
},
{
"key": "panel",
"value": "solid state",
"namespace": "overriding"
},
{
"key": "card",
"value": "virtual",
"namespace": "generating"
},
{
"key": "sensor",
"value": "1080p",
"namespace": "connecting"
},
{
"key": "driver",
"value": "bluetooth",
"namespace": "navigating"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0,
"policies": [
{
"id": "46cfcf5a-4a9a-4049-9b3a-99810c2eeaad",
"title": "Cupiditate veritatis voluptatem quasi."
}
]
},
{
"id": "44b525cf-312d-4bc0-9de8-ea4dbb13a434",
"display_name": "lynch-lowe.test",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:18.457Z",
"stale_timestamp": "2034-11-14T12:12:18.457Z",
"stale_warning_timestamp": "2034-11-21T12:12:18.457Z",
"updated": "2024-11-14T12:12:18.457Z",
"insights_id": null,
"tags": [
{
"key": "protocol",
"value": "optical",
"namespace": "bypassing"
},
{
"key": "sensor",
"value": "back-end",
"namespace": "compressing"
},
{
"key": "sensor",
"value": "optical",
"namespace": "compressing"
},
{
"key": "array",
"value": "solid state",
"namespace": "indexing"
},
{
"key": "capacitor",
"value": "online",
"namespace": "connecting"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0,
"policies": [
{
"id": "46cfcf5a-4a9a-4049-9b3a-99810c2eeaad",
"title": "Cupiditate veritatis voluptatem quasi."
}
]
},
{
"id": "45829dd0-ba4c-46eb-acf7-e2174f943362",
"display_name": "quitzon.test",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:18.498Z",
"stale_timestamp": "2034-11-14T12:12:18.498Z",
"stale_warning_timestamp": "2034-11-21T12:12:18.498Z",
"updated": "2024-11-14T12:12:18.498Z",
"insights_id": null,
"tags": [
{
"key": "card",
"value": "online",
"namespace": "transmitting"
},
{
"key": "panel",
"value": "online",
"namespace": "synthesizing"
},
{
"key": "transmitter",
"value": "neural",
"namespace": "navigating"
},
{
"key": "hard drive",
"value": "haptic",
"namespace": "connecting"
},
{
"key": "system",
"value": "1080p",
"namespace": "calculating"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0,
"policies": [
{
"id": "46cfcf5a-4a9a-4049-9b3a-99810c2eeaad",
"title": "Cupiditate veritatis voluptatem quasi."
}
]
},
{
"id": "473b2b9c-ad0c-477b-9e23-a39377ae0962",
"display_name": "hamill.test",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:18.453Z",
"stale_timestamp": "2034-11-14T12:12:18.453Z",
"stale_warning_timestamp": "2034-11-21T12:12:18.453Z",
"updated": "2024-11-14T12:12:18.453Z",
"insights_id": null,
"tags": [
{
"key": "bandwidth",
"value": "wireless",
"namespace": "synthesizing"
},
{
"key": "sensor",
"value": "redundant",
"namespace": "overriding"
},
{
"key": "pixel",
"value": "bluetooth",
"namespace": "indexing"
},
{
"key": "array",
"value": "primary",
"namespace": "connecting"
},
{
"key": "sensor",
"value": "bluetooth",
"namespace": "parsing"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0,
"policies": [
{
"id": "46cfcf5a-4a9a-4049-9b3a-99810c2eeaad",
"title": "Cupiditate veritatis voluptatem quasi."
}
]
},
{
"id": "515d761e-dfe2-43c7-a349-e35a5243fa49",
"display_name": "littel-nolan.test",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:18.517Z",
"stale_timestamp": "2034-11-14T12:12:18.517Z",
"stale_warning_timestamp": "2034-11-21T12:12:18.517Z",
"updated": "2024-11-14T12:12:18.517Z",
"insights_id": null,
"tags": [
{
"key": "bandwidth",
"value": "redundant",
"namespace": "calculating"
},
{
"key": "array",
"value": "primary",
"namespace": "hacking"
},
{
"key": "sensor",
"value": "mobile",
"namespace": "transmitting"
},
{
"key": "application",
"value": "haptic",
"namespace": "programming"
},
{
"key": "protocol",
"value": "open-source",
"namespace": "programming"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0,
"policies": [
{
"id": "46cfcf5a-4a9a-4049-9b3a-99810c2eeaad",
"title": "Cupiditate veritatis voluptatem quasi."
}
]
},
{
"id": "5288c9c2-7dde-44f7-a807-42f95054a51b",
"display_name": "feil.example",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:18.432Z",
"stale_timestamp": "2034-11-14T12:12:18.432Z",
"stale_warning_timestamp": "2034-11-21T12:12:18.432Z",
"updated": "2024-11-14T12:12:18.432Z",
"insights_id": null,
"tags": [
{
"key": "driver",
"value": "neural",
"namespace": "navigating"
},
{
"key": "application",
"value": "multi-byte",
"namespace": "overriding"
},
{
"key": "array",
"value": "bluetooth",
"namespace": "programming"
},
{
"key": "panel",
"value": "optical",
"namespace": "backing up"
},
{
"key": "pixel",
"value": "1080p",
"namespace": "parsing"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0,
"policies": [
{
"id": "46cfcf5a-4a9a-4049-9b3a-99810c2eeaad",
"title": "Cupiditate veritatis voluptatem quasi."
}
]
},
{
"id": "77d4d842-9f31-4811-b68b-062607e3362a",
"display_name": "lang.test",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:18.502Z",
"stale_timestamp": "2034-11-14T12:12:18.502Z",
"stale_warning_timestamp": "2034-11-21T12:12:18.502Z",
"updated": "2024-11-14T12:12:18.502Z",
"insights_id": null,
"tags": [
{
"key": "transmitter",
"value": "mobile",
"namespace": "hacking"
},
{
"key": "program",
"value": "cross-platform",
"namespace": "connecting"
},
{
"key": "microchip",
"value": "optical",
"namespace": "bypassing"
},
{
"key": "pixel",
"value": "wireless",
"namespace": "calculating"
},
{
"key": "transmitter",
"value": "haptic",
"namespace": "indexing"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0,
"policies": [
{
"id": "46cfcf5a-4a9a-4049-9b3a-99810c2eeaad",
"title": "Cupiditate veritatis voluptatem quasi."
}
]
}
],
"meta": {
"total": 25,
"tags": [],
"limit": 10,
"offset": 0
},
"links": {
"first": "/api/compliance/v2/reports/46cfcf5a-4a9a-4049-9b3a-99810c2eeaad/systems?limit=10&offset=0",
"last": "/api/compliance/v2/reports/46cfcf5a-4a9a-4049-9b3a-99810c2eeaad/systems?limit=10&offset=20",
"next": "/api/compliance/v2/reports/46cfcf5a-4a9a-4049-9b3a-99810c2eeaad/systems?limit=10&offset=10"
}
},
"summary": "",
"description": ""
},
"List of Systems sorted by \"os_minor_version:asc\"": {
"value": {
"data": [
{
"id": "07006905-6191-49fc-9e5c-9c86367eb92c",
"display_name": "lehner-bernhard.example",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:18.902Z",
"stale_timestamp": "2034-11-14T12:12:18.902Z",
"stale_warning_timestamp": "2034-11-21T12:12:18.902Z",
"updated": "2024-11-14T12:12:18.902Z",
"insights_id": null,
"tags": [
{
"key": "pixel",
"value": "redundant",
"namespace": "programming"
},
{
"key": "transmitter",
"value": "back-end",
"namespace": "compressing"
},
{
"key": "feed",
"value": "neural",
"namespace": "copying"
},
{
"key": "pixel",
"value": "bluetooth",
"namespace": "connecting"
},
{
"key": "capacitor",
"value": "redundant",
"namespace": "backing up"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0,
"policies": [
{
"id": "03f87dec-2804-4e1f-bbd9-6101573e2cee",
"title": "Cum minus et et."
}
]
},
{
"id": "07c81bdd-5092-47eb-962c-4a154a8acaa7",
"display_name": "terry-parisian.test",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:18.803Z",
"stale_timestamp": "2034-11-14T12:12:18.803Z",
"stale_warning_timestamp": "2034-11-21T12:12:18.803Z",
"updated": "2024-11-14T12:12:18.803Z",
"insights_id": null,
"tags": [
{
"key": "bandwidth",
"value": "solid state",
"namespace": "backing up"
},
{
"key": "sensor",
"value": "virtual",
"namespace": "bypassing"
},
{
"key": "bus",
"value": "1080p",
"namespace": "generating"
},
{
"key": "feed",
"value": "online",
"namespace": "backing up"
},
{
"key": "alarm",
"value": "auxiliary",
"namespace": "compressing"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0,
"policies": [
{
"id": "03f87dec-2804-4e1f-bbd9-6101573e2cee",
"title": "Cum minus et et."
}
]
},
{
"id": "0f659b4b-97a5-4ee4-adf6-f71bbb8cb808",
"display_name": "kuhlman-beatty.test",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:18.770Z",
"stale_timestamp": "2034-11-14T12:12:18.770Z",
"stale_warning_timestamp": "2034-11-21T12:12:18.770Z",
"updated": "2024-11-14T12:12:18.770Z",
"insights_id": null,
"tags": [
{
"key": "capacitor",
"value": "mobile",
"namespace": "programming"
},
{
"key": "pixel",
"value": "bluetooth",
"namespace": "navigating"
},
{
"key": "matrix",
"value": "multi-byte",
"namespace": "hacking"
},
{
"key": "panel",
"value": "open-source",
"namespace": "navigating"
},
{
"key": "bandwidth",
"value": "auxiliary",
"namespace": "copying"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0,
"policies": [
{
"id": "03f87dec-2804-4e1f-bbd9-6101573e2cee",
"title": "Cum minus et et."
}
]
},
{
"id": "17683605-7604-403d-8261-020f01eee67b",
"display_name": "sporer.example",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:18.897Z",
"stale_timestamp": "2034-11-14T12:12:18.897Z",
"stale_warning_timestamp": "2034-11-21T12:12:18.897Z",
"updated": "2024-11-14T12:12:18.897Z",
"insights_id": null,
"tags": [
{
"key": "interface",
"value": "bluetooth",
"namespace": "quantifying"
},
{
"key": "driver",
"value": "auxiliary",
"namespace": "programming"
},
{
"key": "application",
"value": "redundant",
"namespace": "hacking"
},
{
"key": "capacitor",
"value": "primary",
"namespace": "indexing"
},
{
"key": "hard drive",
"value": "back-end",
"namespace": "copying"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0,
"policies": [
{
"id": "03f87dec-2804-4e1f-bbd9-6101573e2cee",
"title": "Cum minus et et."
}
]
},
{
"id": "1d8bf7a3-b24e-4bcd-b509-35cc42bd52a9",
"display_name": "reilly.test",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:18.838Z",
"stale_timestamp": "2034-11-14T12:12:18.838Z",
"stale_warning_timestamp": "2034-11-21T12:12:18.838Z",
"updated": "2024-11-14T12:12:18.838Z",
"insights_id": null,
"tags": [
{
"key": "pixel",
"value": "multi-byte",
"namespace": "compressing"
},
{
"key": "monitor",
"value": "mobile",
"namespace": "compressing"
},
{
"key": "transmitter",
"value": "1080p",
"namespace": "calculating"
},
{
"key": "panel",
"value": "redundant",
"namespace": "connecting"
},
{
"key": "hard drive",
"value": "online",
"namespace": "compressing"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0,
"policies": [
{
"id": "03f87dec-2804-4e1f-bbd9-6101573e2cee",
"title": "Cum minus et et."
}
]
},
{
"id": "30203aea-7566-40d4-a474-f6f62fafd866",
"display_name": "medhurst-paucek.example",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:18.883Z",
"stale_timestamp": "2034-11-14T12:12:18.883Z",
"stale_warning_timestamp": "2034-11-21T12:12:18.883Z",
"updated": "2024-11-14T12:12:18.883Z",
"insights_id": null,
"tags": [
{
"key": "transmitter",
"value": "back-end",
"namespace": "hacking"
},
{
"key": "panel",
"value": "haptic",
"namespace": "calculating"
},
{
"key": "bus",
"value": "optical",
"namespace": "overriding"
},
{
"key": "hard drive",
"value": "solid state",
"namespace": "copying"
},
{
"key": "port",
"value": "neural",
"namespace": "overriding"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0,
"policies": [
{
"id": "03f87dec-2804-4e1f-bbd9-6101573e2cee",
"title": "Cum minus et et."
}
]
},
{
"id": "3352df28-21bb-4e0e-abd2-1512e5593f65",
"display_name": "damore-johns.test",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:18.874Z",
"stale_timestamp": "2034-11-14T12:12:18.874Z",
"stale_warning_timestamp": "2034-11-21T12:12:18.874Z",
"updated": "2024-11-14T12:12:18.874Z",
"insights_id": null,
"tags": [
{
"key": "bus",
"value": "virtual",
"namespace": "transmitting"
},
{
"key": "pixel",
"value": "online",
"namespace": "generating"
},
{
"key": "interface",
"value": "open-source",
"namespace": "navigating"
},
{
"key": "alarm",
"value": "1080p",
"namespace": "navigating"
},
{
"key": "pixel",
"value": "bluetooth",
"namespace": "parsing"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0,
"policies": [
{
"id": "03f87dec-2804-4e1f-bbd9-6101573e2cee",
"title": "Cum minus et et."
}
]
},
{
"id": "3c2b367c-e425-489e-a468-b4e8626762b1",
"display_name": "wisozk.test",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:18.742Z",
"stale_timestamp": "2034-11-14T12:12:18.742Z",
"stale_warning_timestamp": "2034-11-21T12:12:18.742Z",
"updated": "2024-11-14T12:12:18.742Z",
"insights_id": null,
"tags": [
{
"key": "pixel",
"value": "solid state",
"namespace": "compressing"
},
{
"key": "matrix",
"value": "bluetooth",
"namespace": "quantifying"
},
{
"key": "microchip",
"value": "redundant",
"namespace": "generating"
},
{
"key": "bandwidth",
"value": "mobile",
"namespace": "navigating"
},
{
"key": "monitor",
"value": "optical",
"namespace": "bypassing"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0,
"policies": [
{
"id": "03f87dec-2804-4e1f-bbd9-6101573e2cee",
"title": "Cum minus et et."
}
]
},
{
"id": "3ca61730-3e9b-4374-bcef-b1a38eb6ac40",
"display_name": "walsh.example",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:18.761Z",
"stale_timestamp": "2034-11-14T12:12:18.761Z",
"stale_warning_timestamp": "2034-11-21T12:12:18.761Z",
"updated": "2024-11-14T12:12:18.761Z",
"insights_id": null,
"tags": [
{
"key": "capacitor",
"value": "multi-byte",
"namespace": "programming"
},
{
"key": "protocol",
"value": "cross-platform",
"namespace": "overriding"
},
{
"key": "port",
"value": "cross-platform",
"namespace": "navigating"
},
{
"key": "system",
"value": "online",
"namespace": "backing up"
},
{
"key": "sensor",
"value": "back-end",
"namespace": "transmitting"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0,
"policies": [
{
"id": "03f87dec-2804-4e1f-bbd9-6101573e2cee",
"title": "Cum minus et et."
}
]
},
{
"id": "3f32c2a0-1c2e-4777-94b1-daeb75f295e1",
"display_name": "roberts.test",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:18.724Z",
"stale_timestamp": "2034-11-14T12:12:18.724Z",
"stale_warning_timestamp": "2034-11-21T12:12:18.724Z",
"updated": "2024-11-14T12:12:18.724Z",
"insights_id": null,
"tags": [
{
"key": "transmitter",
"value": "auxiliary",
"namespace": "hacking"
},
{
"key": "array",
"value": "optical",
"namespace": "indexing"
},
{
"key": "card",
"value": "back-end",
"namespace": "parsing"
},
{
"key": "panel",
"value": "mobile",
"namespace": "generating"
},
{
"key": "port",
"value": "redundant",
"namespace": "connecting"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0,
"policies": [
{
"id": "03f87dec-2804-4e1f-bbd9-6101573e2cee",
"title": "Cum minus et et."
}
]
}
],
"meta": {
"total": 25,
"tags": [],
"limit": 10,
"offset": 0,
"sort_by": "os_minor_version"
},
"links": {
"first": "/api/compliance/v2/reports/03f87dec-2804-4e1f-bbd9-6101573e2cee/systems?limit=10&offset=0&sort_by=os_minor_version",
"last": "/api/compliance/v2/reports/03f87dec-2804-4e1f-bbd9-6101573e2cee/systems?limit=10&offset=20&sort_by=os_minor_version",
"next": "/api/compliance/v2/reports/03f87dec-2804-4e1f-bbd9-6101573e2cee/systems?limit=10&offset=10&sort_by=os_minor_version"
}
},
"summary": "",
"description": ""
},
"List of Systems filtered by \"(os_minor_version=0)\"": {
"value": {
"data": [
{
"id": "0578e565-b727-42cf-bf68-8a4d7d5c1fa7",
"display_name": "legros-turcotte.example",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:19.137Z",
"stale_timestamp": "2034-11-14T12:12:19.137Z",
"stale_warning_timestamp": "2034-11-21T12:12:19.137Z",
"updated": "2024-11-14T12:12:19.137Z",
"insights_id": null,
"tags": [
{
"key": "microchip",
"value": "haptic",
"namespace": "backing up"
},
{
"key": "protocol",
"value": "virtual",
"namespace": "programming"
},
{
"key": "port",
"value": "solid state",
"namespace": "backing up"
},
{
"key": "system",
"value": "bluetooth",
"namespace": "parsing"
},
{
"key": "sensor",
"value": "optical",
"namespace": "parsing"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0,
"policies": [
{
"id": "7061f267-cff8-45e2-a2b3-d3e7cf716b6b",
"title": "Ullam est quas voluptatibus."
}
]
},
{
"id": "1e4f2f36-30d1-4c2d-8196-300e405ad9f9",
"display_name": "feil.test",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:19.166Z",
"stale_timestamp": "2034-11-14T12:12:19.166Z",
"stale_warning_timestamp": "2034-11-21T12:12:19.166Z",
"updated": "2024-11-14T12:12:19.166Z",
"insights_id": null,
"tags": [
{
"key": "monitor",
"value": "virtual",
"namespace": "overriding"
},
{
"key": "pixel",
"value": "mobile",
"namespace": "programming"
},
{
"key": "circuit",
"value": "auxiliary",
"namespace": "quantifying"
},
{
"key": "firewall",
"value": "solid state",
"namespace": "overriding"
},
{
"key": "bus",
"value": "open-source",
"namespace": "connecting"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0,
"policies": [
{
"id": "7061f267-cff8-45e2-a2b3-d3e7cf716b6b",
"title": "Ullam est quas voluptatibus."
}
]
},
{
"id": "2ee8080b-2552-4ce4-96c2-225d0df60535",
"display_name": "spencer-heidenreich.example",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:19.209Z",
"stale_timestamp": "2034-11-14T12:12:19.209Z",
"stale_warning_timestamp": "2034-11-21T12:12:19.209Z",
"updated": "2024-11-14T12:12:19.209Z",
"insights_id": null,
"tags": [
{
"key": "hard drive",
"value": "neural",
"namespace": "generating"
},
{
"key": "circuit",
"value": "solid state",
"namespace": "compressing"
},
{
"key": "protocol",
"value": "solid state",
"namespace": "generating"
},
{
"key": "matrix",
"value": "open-source",
"namespace": "programming"
},
{
"key": "microchip",
"value": "redundant",
"namespace": "bypassing"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0,
"policies": [
{
"id": "7061f267-cff8-45e2-a2b3-d3e7cf716b6b",
"title": "Ullam est quas voluptatibus."
}
]
},
{
"id": "378066ab-4eb3-4f90-bac4-30da504acbc3",
"display_name": "lubowitz-fisher.example",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:19.155Z",
"stale_timestamp": "2034-11-14T12:12:19.155Z",
"stale_warning_timestamp": "2034-11-21T12:12:19.155Z",
"updated": "2024-11-14T12:12:19.155Z",
"insights_id": null,
"tags": [
{
"key": "hard drive",
"value": "solid state",
"namespace": "navigating"
},
{
"key": "circuit",
"value": "redundant",
"namespace": "parsing"
},
{
"key": "matrix",
"value": "multi-byte",
"namespace": "generating"
},
{
"key": "circuit",
"value": "neural",
"namespace": "parsing"
},
{
"key": "hard drive",
"value": "haptic",
"namespace": "indexing"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0,
"policies": [
{
"id": "7061f267-cff8-45e2-a2b3-d3e7cf716b6b",
"title": "Ullam est quas voluptatibus."
}
]
},
{
"id": "59b9219c-bb1f-48b7-8543-7d76f23d8801",
"display_name": "dickens.test",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:19.117Z",
"stale_timestamp": "2034-11-14T12:12:19.117Z",
"stale_warning_timestamp": "2034-11-21T12:12:19.117Z",
"updated": "2024-11-14T12:12:19.117Z",
"insights_id": null,
"tags": [
{
"key": "sensor",
"value": "primary",
"namespace": "hacking"
},
{
"key": "transmitter",
"value": "redundant",
"namespace": "parsing"
},
{
"key": "matrix",
"value": "mobile",
"namespace": "navigating"
},
{
"key": "card",
"value": "bluetooth",
"namespace": "copying"
},
{
"key": "microchip",
"value": "cross-platform",
"namespace": "bypassing"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0,
"policies": [
{
"id": "7061f267-cff8-45e2-a2b3-d3e7cf716b6b",
"title": "Ullam est quas voluptatibus."
}
]
},
{
"id": "5e85b61a-0a54-4cac-9617-b6799c3cbeb8",
"display_name": "fay.test",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:19.176Z",
"stale_timestamp": "2034-11-14T12:12:19.176Z",
"stale_warning_timestamp": "2034-11-21T12:12:19.176Z",
"updated": "2024-11-14T12:12:19.176Z",
"insights_id": null,
"tags": [
{
"key": "bandwidth",
"value": "digital",
"namespace": "transmitting"
},
{
"key": "program",
"value": "cross-platform",
"namespace": "indexing"
},
{
"key": "monitor",
"value": "auxiliary",
"namespace": "bypassing"
},
{
"key": "program",
"value": "virtual",
"namespace": "generating"
},
{
"key": "panel",
"value": "1080p",
"namespace": "synthesizing"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0,
"policies": [
{
"id": "7061f267-cff8-45e2-a2b3-d3e7cf716b6b",
"title": "Ullam est quas voluptatibus."
}
]
},
{
"id": "6e4801a0-a293-4523-bb6a-7876181fa6ac",
"display_name": "goyette.example",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:19.111Z",
"stale_timestamp": "2034-11-14T12:12:19.111Z",
"stale_warning_timestamp": "2034-11-21T12:12:19.111Z",
"updated": "2024-11-14T12:12:19.111Z",
"insights_id": null,
"tags": [
{
"key": "panel",
"value": "optical",
"namespace": "hacking"
},
{
"key": "transmitter",
"value": "virtual",
"namespace": "overriding"
},
{
"key": "array",
"value": "auxiliary",
"namespace": "bypassing"
},
{
"key": "microchip",
"value": "back-end",
"namespace": "generating"
},
{
"key": "sensor",
"value": "open-source",
"namespace": "bypassing"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0,
"policies": [
{
"id": "7061f267-cff8-45e2-a2b3-d3e7cf716b6b",
"title": "Ullam est quas voluptatibus."
}
]
},
{
"id": "70b4ccc3-3e2e-45bc-a817-e067cb01a4ec",
"display_name": "flatley.test",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:19.123Z",
"stale_timestamp": "2034-11-14T12:12:19.123Z",
"stale_warning_timestamp": "2034-11-21T12:12:19.123Z",
"updated": "2024-11-14T12:12:19.123Z",
"insights_id": null,
"tags": [
{
"key": "port",
"value": "1080p",
"namespace": "transmitting"
},
{
"key": "array",
"value": "primary",
"namespace": "copying"
},
{
"key": "panel",
"value": "digital",
"namespace": "copying"
},
{
"key": "sensor",
"value": "open-source",
"namespace": "programming"
},
{
"key": "program",
"value": "open-source",
"namespace": "calculating"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0,
"policies": [
{
"id": "7061f267-cff8-45e2-a2b3-d3e7cf716b6b",
"title": "Ullam est quas voluptatibus."
}
]
},
{
"id": "77f76316-2a97-4fa0-b2a2-227eef4257e3",
"display_name": "zemlak.test",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:19.200Z",
"stale_timestamp": "2034-11-14T12:12:19.200Z",
"stale_warning_timestamp": "2034-11-21T12:12:19.200Z",
"updated": "2024-11-14T12:12:19.200Z",
"insights_id": null,
"tags": [
{
"key": "circuit",
"value": "1080p",
"namespace": "calculating"
},
{
"key": "circuit",
"value": "cross-platform",
"namespace": "programming"
},
{
"key": "interface",
"value": "auxiliary",
"namespace": "compressing"
},
{
"key": "matrix",
"value": "haptic",
"namespace": "overriding"
},
{
"key": "bus",
"value": "back-end",
"namespace": "parsing"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0,
"policies": [
{
"id": "7061f267-cff8-45e2-a2b3-d3e7cf716b6b",
"title": "Ullam est quas voluptatibus."
}
]
},
{
"id": "7baa35d0-9d09-4fbc-9ff0-f69b2ae89d35",
"display_name": "runte.example",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:19.101Z",
"stale_timestamp": "2034-11-14T12:12:19.101Z",
"stale_warning_timestamp": "2034-11-21T12:12:19.101Z",
"updated": "2024-11-14T12:12:19.101Z",
"insights_id": null,
"tags": [
{
"key": "interface",
"value": "multi-byte",
"namespace": "generating"
},
{
"key": "matrix",
"value": "solid state",
"namespace": "synthesizing"
},
{
"key": "feed",
"value": "mobile",
"namespace": "overriding"
},
{
"key": "panel",
"value": "mobile",
"namespace": "copying"
},
{
"key": "bandwidth",
"value": "redundant",
"namespace": "compressing"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0,
"policies": [
{
"id": "7061f267-cff8-45e2-a2b3-d3e7cf716b6b",
"title": "Ullam est quas voluptatibus."
}
]
}
],
"meta": {
"total": 25,
"filter": "(os_minor_version=0)",
"tags": [],
"limit": 10,
"offset": 0
},
"links": {
"first": "/api/compliance/v2/reports/7061f267-cff8-45e2-a2b3-d3e7cf716b6b/systems?filter=%28os_minor_version%3D0%29&limit=10&offset=0",
"last": "/api/compliance/v2/reports/7061f267-cff8-45e2-a2b3-d3e7cf716b6b/systems?filter=%28os_minor_version%3D0%29&limit=10&offset=20",
"next": "/api/compliance/v2/reports/7061f267-cff8-45e2-a2b3-d3e7cf716b6b/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 <a href=\"https://github.com/wvanbergen/scoped_search/wiki/Query-language\" target=\"_blank\" title=\"github.com/wvanbergen/scoped_search\">scoped_search query language</a>. However, only `=` or `!=` (resp. `<>`) operators are supported.<br><br>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`<br><br>(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": "Returns a System under a 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": "2016e398-a531-4aa2-a0bf-2fb584b3c46a",
"display_name": "vonrueden.example",
"groups": [],
"culled_timestamp": "2034-11-28T12:12:20.435Z",
"stale_timestamp": "2034-11-14T12:12:20.435Z",
"stale_warning_timestamp": "2034-11-21T12:12:20.435Z",
"updated": "2024-11-14T12:12:20.435Z",
"insights_id": null,
"tags": [
{
"key": "interface",
"value": "neural",
"namespace": "overriding"
},
{
"key": "circuit",
"value": "auxiliary",
"namespace": "parsing"
},
{
"key": "monitor",
"value": "cross-platform",
"namespace": "backing up"
},
{
"key": "program",
"value": "1080p",
"namespace": "transmitting"
},
{
"key": "application",
"value": "primary",
"namespace": "navigating"
}
],
"type": "system",
"os_major_version": 8,
"os_minor_version": 0,
"policies": [
{
"id": "b20e903a-d4cb-490a-b256-af8333d3e68f",
"title": "Ad qui sed sunt."
}
]
}
},
"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 98fa8844-c368-4a73-b94f-7062c0a5ee39"
]
},
"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 (`<key>:asc` or `<key>:desc`).<br><br>If no direction is selected, `<key>: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 <a href=\"https://github.com/wvanbergen/scoped_search/wiki/Query-language\" target=\"_blank\" title=\"github.com/wvanbergen/scoped_search\">scoped_search query language</a>. However, only `=` or `!=` (resp. `<>`) operators are supported.<br><br>Tailorings are searchable using attributes `os_minor_version`<br><br>(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": "Lists Tailorings",
"operationId": "Tailorings",
"responses": {
"200": {
"description": "Lists Tailorings",
"content": {
"application/vnd.api+json": {
"examples": {
"List of Tailorings": {
"value": {
"data": [
{
"id": "017218fa-d895-40b3-8329-dfbddca8eb73",
"profile_id": "1298b97a-91f0-4367-9c46-038f4cc632d7",
"os_minor_version": 6,
"value_overrides": {},
"type": "tailoring",
"os_major_version": 7,
"security_guide_id": "99c834c8-65c7-4268-832e-2732c73aa469",
"security_guide_version": "100.96.39"
},
{
"id": "01fb5803-2799-4afe-b660-811afcbbb883",
"profile_id": "a11697a6-4fc7-4780-b49a-db1ac8140990",
"os_minor_version": 23,
"value_overrides": {},
"type": "tailoring",
"os_major_version": 7,
"security_guide_id": "58adc797-d0e3-428f-9377-4a518b729942",
"security_guide_version": "100.97.6"
},
{
"id": "03860750-850c-49e5-8f6d-75c4e8696740",
"profile_id": "6d8e7267-d1c6-47a2-8b93-5743a2bb9098",
"os_minor_version": 8,
"value_overrides": {},
"type": "tailoring",
"os_major_version": 7,
"security_guide_id": "b64b00ab-f09e-498c-84eb-39524c5f4549",
"security_guide_version": "100.96.41"
},
{
"id": "24f31a2e-2b97-4175-a42d-62add283dc42",
"profile_id": "f10c17bb-4b56-4f6b-a830-3f1f66ad0e2a",
"os_minor_version": 24,
"value_overrides": {},
"type": "tailoring",
"os_major_version": 7,
"security_guide_id": "0473c8af-9509-44ed-a906-4f55db667c74",
"security_guide_version": "100.97.7"
},
{
"id": "2ef0149d-4752-4f4f-8800-2334c9933c01",
"profile_id": "a60f9749-adc7-4c2e-8a90-dd4555b4f8b7",
"os_minor_version": 20,
"value_overrides": {},
"type": "tailoring",
"os_major_version": 7,
"security_guide_id": "4da7d3b7-89e9-4d69-8861-e8d5ab87e0f9",
"security_guide_version": "100.97.3"
},
{
"id": "5d392a68-4016-4054-aad0-b7e4db65caf1",
"profile_id": "8f30fbdd-9311-454f-a707-11a759cacf6c",
"os_minor_version": 4,
"value_overrides": {},
"type": "tailoring",
"os_major_version": 7,
"security_guide_id": "a790b84d-068d-4619-83db-52e69a4a77ee",
"security_guide_version": "100.96.37"
},
{
"id": "641842ac-69b0-4f68-bde1-0e83c830ed9f",
"profile_id": "be6b155a-e89b-45e1-8fa1-2caede8858ee",
"os_minor_version": 12,
"value_overrides": {},
"type": "tailoring",
"os_major_version": 7,
"security_guide_id": "4e462b29-cc0c-4007-95e0-dfa57bd5be2d",
"security_guide_version": "100.96.45"
},
{
"id": "6e560df1-972f-4d48-949d-985c8319e5eb",
"profile_id": "78801fe3-9833-45cd-ac60-c94f80a3ecd3",
"os_minor_version": 21,
"value_overrides": {},
"type": "tailoring",
"os_major_version": 7,
"security_guide_id": "26e6a22b-2d52-4837-9109-3a14cf625177",
"security_guide_version": "100.97.4"
},
{
"id": "7153ef50-aaca-40f2-acd9-50703fd6f118",
"profile_id": "81ac7d16-fcec-4fc8-b8d3-1891d3ab2b1b",
"os_minor_version": 13,
"value_overrides": {},
"type": "tailoring",
"os_major_version": 7,
"security_guide_id": "3a256c26-5e51-4fb2-a397-d5d1051aa9af",
"security_guide_version": "100.96.46"
},
{
"id": "71582a03-aabd-4eae-87ef-899b8bf20bb7",
"profile_id": "c6821719-28da-4c23-b5c6-d9640213ac24",
"os_minor_version": 2,
"value_overrides": {},
"type": "tailoring",
"os_major_version": 7,
"security_guide_id": "8453c6be-562c-42c7-a39d-6f7e7ded3500",
"security_guide_version": "100.96.35"
}
],
"meta": {
"total": 25,
"limit": 10,
"offset": 0
},
"links": {
"first": "/api/compliance/v2/policies/def3c0d9-cff6-4ec2-bfb4-d76d7a2e7ec6/tailorings?limit=10&offset=0",
"last": "/api/compliance/v2/policies/def3c0d9-cff6-4ec2-bfb4-d76d7a2e7ec6/tailorings?limit=10&offset=20",
"next": "/api/compliance/v2/policies/def3c0d9-cff6-4ec2-bfb4-d76d7a2e7ec6/tailorings?limit=10&offset=10"
}
},
"summary": "",
"description": ""
},
"List of Tailorings sorted by \"os_minor_version:asc\"": {
"value": {
"data": [
{
"id": "c5248f8f-c20d-4bb0-b5a8-7baa036c37ed",
"profile_id": "600e600c-9d31-42e6-81b5-2ab1c91f728f",
"os_minor_version": 0,
"value_overrides": {},
"type": "tailoring",
"os_major_version": 7,
"security_guide_id": "fb88a50f-91c0-4e1c-96d6-c86c4f031b6c",
"security_guide_version": "100.97.8"
},
{
"id": "d2824ada-e333-47fa-bd25-58e545038963",
"profile_id": "c5dfa7bb-70fa-42ce-849e-81679f1e4be2",
"os_minor_version": 1,
"value_overrides": {},
"type": "tailoring",
"os_major_version": 7,
"security_guide_id": "0c143e18-d008-4f9d-a95e-7097a12143bb",
"security_guide_version": "100.97.9"
},
{
"id": "b8276519-2191-4074-9bc3-7a8904f02c2d",
"profile_id": "470ee156-5a72-4135-809e-34a808e7692b",
"os_minor_version": 2,
"value_overrides": {},
"type": "tailoring",
"os_major_version": 7,
"security_guide_id": "dbf84579-0ce3-4fd0-baa5-8d063757364a",
"security_guide_version": "100.97.10"
},
{
"id": "7d094131-2571-4016-81cf-d8ccf5ff835a",
"profile_id": "787ea0f0-0962-4b16-ac2c-db5c07c5fddc",
"os_minor_version": 3,
"value_overrides": {},
"type": "tailoring",
"os_major_version": 7,
"security_guide_id": "accfaa35-a1f4-4fc0-9925-f34344b255ae",
"security_guide_version": "100.97.11"
},
{
"id": "f8e75944-23c4-445a-82c7-2ae8db133600",
"profile_id": "d55cab9a-504f-4c9b-a3dd-4cbe9b951e20",
"os_minor_version": 4,
"value_overrides": {},
"type": "tailoring",
"os_major_version": 7,
"security_guide_id": "1643192a-d84d-46b2-ba32-9824a8465163",
"security_guide_version": "100.97.12"
},
{
"id": "e549eac4-3bdd-4740-a62e-760456a3d408",
"profile_id": "722e247c-817d-4191-a53d-788c6ec6ea94",
"os_minor_version": 5,
"value_overrides": {},
"type": "tailoring",
"os_major_version": 7,
"security_guide_id": "3a70e13e-3814-45b6-af67-5a7c484014ac",
"security_guide_version": "100.97.13"
},
{
"id": "1765a63a-d61b-4217-a2e1-5f96c516a1f7",
"profile_id": "6c1d35df-2c98-471c-9296-0536395e7bfc",
"os_minor_version": 6,
"value_overrides": {},
"type": "tailoring",
"os_major_version": 7,
"security_guide_id": "32a2ea90-225b-4f68-b1b7-1e24939c07bd",
"security_guide_version": "100.97.14"
},
{
"id": "f006c6d1-84eb-421d-abcd-cf6d0fd84249",
"profile_id": "9d464962-f99d-4605-b028-234df26761d8",
"os_minor_version": 7,
"value_overrides": {},
"type": "tailoring",
"os_major_version": 7,
"security_guide_id": "0b9ebb02-52c2-4029-be0e-55fce094f062",
"security_guide_version": "100.97.15"
},
{
"id": "a3626185-432a-4bd5-b37f-48637a47da17",
"profile_id": "908ccd80-772a-4fe3-ba1f-91873afeed9c",
"os_minor_version": 8,
"value_overrides": {},
"type": "tailoring",
"os_major_version": 7,
"security_guide_id": "9e1319f0-28cc-40e8-9668-75fa09c9d145",
"security_guide_version": "100.97.16"
},
{
"id": "c2dafe91-647e-458a-bb8a-51f91a991a4b",
"profile_id": "317cbc1a-05bd-421b-b1b5-dcd937d10016",
"os_minor_version": 9,
"value_overrides": {},
"type": "tailoring",
"os_major_version": 7,
"security_guide_id": "aa98f9c6-0fd4-4b3a-bacf-708038845f63",
"security_guide_version": "100.97.17"
}
],
"meta": {
"total": 25,
"limit": 10,
"offset": 0,
"sort_by": "os_minor_version"
},
"links": {
"first": "/api/compliance/v2/policies/a334f66e-668e-4637-8406-ef351ed6bf94/tailorings?limit=10&offset=0&sort_by=os_minor_version",
"last": "/api/compliance/v2/policies/a334f66e-668e-4637-8406-ef351ed6bf94/tailorings?limit=10&offset=20&sort_by=os_minor_version",
"next": "/api/compliance/v2/policies/a334f66e-668e-4637-8406-ef351ed6bf94/tailorings?limit=10&offset=10&sort_by=os_minor_version"
}
},
"summary": "",
"description": ""
},
"List of Tailorings filtered by '(os_minor_version=23)'": {
"value": {
"data": [
{
"id": "142816cd-bb3a-4d0b-b6b4-48182ac446c6",
"profile_id": "0528a1c5-b0b7-4008-8e7e-c85142fc3f5a",
"os_minor_version": 23,
"value_overrides": {},
"type": "tailoring",
"os_major_version": 7,
"security_guide_id": "b45815f6-4d35-492e-9351-92d7878a358a",
"security_guide_version": "100.98.6"
}
],
"meta": {
"total": 1,
"filter": "(os_minor_version=23)",
"limit": 10,
"offset": 0
},
"links": {
"first": "/api/compliance/v2/policies/a2c04bb1-aae2-4bd5-963e-425350c4381e/tailorings?filter=%28os_minor_version%3D23%29&limit=10&offset=0",
"last": "/api/compliance/v2/policies/a2c04bb1-aae2-4bd5-963e-425350c4381e/tailorings?filter=%28os_minor_version%3D23%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",
"responses": {
"201": {
"description": "Creates a Tailoring",
"content": {
"application/vnd.api+json": {
"examples": {
"Response example": {
"value": {
"data": {
"id": "a5d88fa7-0644-4622-8088-dc882866e33f",
"profile_id": "ce79966d-72b5-4caa-ac0d-7fd5fed9d4f8",
"os_minor_version": 1,
"value_overrides": {},
"type": "tailoring",
"os_major_version": 7,
"security_guide_id": "caf5dabe-810e-40b0-a580-20b427fc0015",
"security_guide_version": "100.99.8"
}
},
"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": "Returns a Tailoring",
"operationId": "Tailoring",
"responses": {
"200": {
"description": "Returns a Tailoring",
"content": {
"application/vnd.api+json": {
"examples": {
"Returns a Tailoring": {
"value": {
"data": {
"id": "466fdc4b-fd64-44eb-a5f4-63a19842a1f1",
"profile_id": "b7819284-73e6-4749-aad4-fb732592ce8e",
"os_minor_version": 1,
"value_overrides": {},
"type": "tailoring",
"os_major_version": 7,
"security_guide_id": "7f7b7205-8165-4ede-839d-0827c1bb073d",
"security_guide_version": "100.99.9"
}
},
"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 25e7c0bb-8a96-47ca-bacd-fd6096da0281"
]
},
"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": "Updates a Tailoring with the provided value_overrides",
"operationId": "UpdateTailoring",
"responses": {
"202": {
"description": "Updates a Tailoring",
"content": {
"application/vnd.api+json": {
"examples": {
"Returns the updated Tailoring": {
"value": {
"data": {
"id": "9a83b88d-f9aa-4c1b-b1c0-3fe1d3dff83b",
"profile_id": "502656ce-77eb-499e-91d8-8a41f4ed5ccc",
"os_minor_version": 1,
"value_overrides": {
"43423f44-68bf-4151-bdd5-e0769ffcef6b": "123"
},
"type": "tailoring",
"os_major_version": 7,
"security_guide_id": "a0eb03b0-543f-472b-8af3-be0bc76aeb35",
"security_guide_version": "100.99.10"
}
},
"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 the Rule Tree of a Tailoring",
"operationId": "TailoringRuleTree",
"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": "408b231f-d476-45da-95a9-991746aa58bf",
"type": "rule_group",
"children": [
{
"id": "1e71c2f9-03e3-4fde-8713-7458393da8eb",
"type": "rule"
}
]
},
{
"id": "3f0f286f-2347-4ab6-b3ae-1e9ee0e4f699",
"type": "rule_group",
"children": [
{
"id": "cf072a23-40d1-4178-9f4d-4cd110062e81",
"type": "rule"
}
]
},
{
"id": "c80afd10-6eaf-4bc5-8630-c04c89b159ff",
"type": "rule_group",
"children": [
{
"id": "3f4ea1ce-9cf6-4144-8458-639a0fe9bc80",
"type": "rule"
}
]
},
{
"id": "0cab704d-beef-4182-b282-52a70660c35f",
"type": "rule_group",
"children": [
{
"id": "3e557c38-e98d-415a-9e98-85927140a9e6",
"type": "rule"
}
]
},
{
"id": "6d5931b7-55f3-4f6b-8a23-266e83993f87",
"type": "rule_group",
"children": [
{
"id": "532b1ba7-4cbc-4304-b1d6-1ac85ba55d91",
"type": "rule"
}
]
},
{
"id": "f4be9eb4-3f07-4b61-aaa6-efd03a520b13",
"type": "rule_group",
"children": [
{
"id": "3116408d-f26d-45a4-bc14-2921a58134e0",
"type": "rule"
}
]
},
{
"id": "9e5c485b-adf1-4b78-a3d2-eb339c992555",
"type": "rule_group",
"children": [
{
"id": "dcac6001-94c8-4577-9898-555356645237",
"type": "rule"
}
]
},
{
"id": "78f29873-263c-486d-b016-fb6634240d04",
"type": "rule_group",
"children": [
{
"id": "3d495a4c-0550-4630-be3d-70b635bac60a",
"type": "rule"
}
]
},
{
"id": "5d723e5a-a898-445c-a481-62fbb987ef48",
"type": "rule_group",
"children": [
{
"id": "e69209f5-e143-4b0e-b98c-daa334666e74",
"type": "rule"
}
]
},
{
"id": "f2e23f4b-e03e-41fb-be61-5eb7732a305b",
"type": "rule_group",
"children": [
{
"id": "8617b7e7-f022-4f87-b2f7-73301829bb2d",
"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 ecf3edcc-80b2-4889-b0c6-52cdf68f71fd"
]
},
"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": "Returns a Tailoring File",
"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_7c77240c8a3e6302586d8f87e46f17c1",
"title": "Eius tempore dignissimos explicabo.",
"groups": {},
"rules": {},
"variables": {
"foo_value_253f58ce-de29-40dc-95ae-877ef0d83b96": {
"value": "531970"
},
"foo_value_807cf1a3-150f-4bf0-aae0-8d8c6ff5e572": {
"value": "530019"
}
}
}
]
},
"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.<br>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 (`<key>:asc` or `<key>:desc`).<br><br>If no direction is selected, `<key>: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 <a href=\"https://github.com/wvanbergen/scoped_search/wiki/Query-language\" target=\"_blank\" title=\"github.com/wvanbergen/scoped_search\">scoped_search query language</a>. However, only `=` or `!=` (resp. `<>`) operators are supported.<br><br>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`<br><br>(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": "Lists Test Results under a 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": "0c95d9f4-63aa-4e08-8fdb-33cfc5468f0f",
"end_time": "2024-11-14T12:11:22.340Z",
"failed_rule_count": 0,
"supported": true,
"score": 12.9133372308315,
"type": "test_result",
"display_name": "kris.test",
"groups": [],
"tags": [
{
"key": "protocol",
"value": "online",
"namespace": "backing up"
},
{
"key": "card",
"value": "open-source",
"namespace": "calculating"
},
{
"key": "card",
"value": "primary",
"namespace": "quantifying"
},
{
"key": "system",
"value": "mobile",
"namespace": "backing up"
},
{
"key": "interface",
"value": "primary",
"namespace": "indexing"
}
],
"os_major_version": 8,
"os_minor_version": 0,
"compliant": false,
"system_id": "c793642f-9347-48cf-934c-26a6a74dfe93",
"security_guide_version": "100.101.31"
},
{
"id": "14af3f41-38ee-4661-85c1-5434a87df3ca",
"end_time": "2024-11-14T12:11:22.322Z",
"failed_rule_count": 0,
"supported": true,
"score": 70.74461592383477,
"type": "test_result",
"display_name": "waelchi.test",
"groups": [],
"tags": [
{
"key": "bus",
"value": "back-end",
"namespace": "bypassing"
},
{
"key": "sensor",
"value": "virtual",
"namespace": "calculating"
},
{
"key": "application",
"value": "mobile",
"namespace": "compressing"
},
{
"key": "application",
"value": "back-end",
"namespace": "quantifying"
},
{
"key": "port",
"value": "open-source",
"namespace": "hacking"
}
],
"os_major_version": 8,
"os_minor_version": 0,
"compliant": false,
"system_id": "ebaa02ca-d14f-4b98-821c-7aa88f35b2b0",
"security_guide_version": "100.101.31"
},
{
"id": "1f15765c-c430-41eb-9d90-b002c61f3358",
"end_time": "2024-11-14T12:11:22.308Z",
"failed_rule_count": 0,
"supported": true,
"score": 50.82618716631207,
"type": "test_result",
"display_name": "price.example",
"groups": [],
"tags": [
{
"key": "bus",
"value": "back-end",
"namespace": "connecting"
},
{
"key": "program",
"value": "multi-byte",
"namespace": "compressing"
},
{
"key": "matrix",
"value": "back-end",
"namespace": "copying"
},
{
"key": "card",
"value": "back-end",
"namespace": "overriding"
},
{
"key": "monitor",
"value": "auxiliary",
"namespace": "backing up"
}
],
"os_major_version": 8,
"os_minor_version": 0,
"compliant": false,
"system_id": "ac90e75d-edef-49fd-a639-b67881bb27a8",
"security_guide_version": "100.101.31"
},
{
"id": "208eb43b-77c6-4668-86ab-6babf4a0990e",
"end_time": "2024-11-14T12:11:22.385Z",
"failed_rule_count": 0,
"supported": true,
"score": 67.40866902110365,
"type": "test_result",
"display_name": "brakus.test",
"groups": [],
"tags": [
{
"key": "card",
"value": "auxiliary",
"namespace": "quantifying"
},
{
"key": "monitor",
"value": "wireless",
"namespace": "programming"
},
{
"key": "panel",
"value": "multi-byte",
"namespace": "transmitting"
},
{
"key": "driver",
"value": "virtual",
"namespace": "compressing"
},
{
"key": "application",
"value": "bluetooth",
"namespace": "compressing"
}
],
"os_major_version": 8,
"os_minor_version": 0,
"compliant": false,
"system_id": "e048341b-b291-4ab5-9d80-25672f6001b3",
"security_guide_version": "100.101.31"
},
{
"id": "2524e3bb-ed3c-4f88-8cb8-9ac0887873dc",
"end_time": "2024-11-14T12:11:22.351Z",
"failed_rule_count": 0,
"supported": true,
"score": 8.950532411403566,
"type": "test_result",
"display_name": "cremin-hayes.test",
"groups": [],
"tags": [
{
"key": "array",
"value": "primary",
"namespace": "bypassing"
},
{
"key": "feed",
"value": "virtual",
"namespace": "parsing"
},
{
"key": "feed",
"value": "bluetooth",
"namespace": "synthesizing"
},
{
"key": "firewall",
"value": "back-end",
"namespace": "backing up"
},
{
"key": "transmitter",
"value": "multi-byte",
"namespace": "hacking"
}
],
"os_major_version": 8,
"os_minor_version": 0,
"compliant": false,
"system_id": "84d53640-e46c-48c1-8be3-bfec5e864e58",
"security_guide_version": "100.101.31"
},
{
"id": "298509bc-9ac7-4a04-93d9-08fc52846c1a",
"end_time": "2024-11-14T12:11:22.269Z",
"failed_rule_count": 0,
"supported": true,
"score": 29.02026610741167,
"type": "test_result",
"display_name": "bogisich.test",
"groups": [],
"tags": [
{
"key": "protocol",
"value": "redundant",
"namespace": "parsing"
},
{
"key": "firewall",
"value": "bluetooth",
"namespace": "copying"
},
{
"key": "matrix",
"value": "back-end",
"namespace": "programming"
},
{
"key": "bus",
"value": "bluetooth",
"namespace": "connecting"
},
{
"key": "hard drive",
"value": "wireless",
"namespace": "synthesizing"
}
],
"os_major_version": 8,
"os_minor_version": 0,
"compliant": false,
"system_id": "acdb0b65-b1fe-4f61-9172-cd43a70c031e",
"security_guide_version": "100.101.31"
},
{
"id": "2ef06a23-53dd-4fdf-812f-6f02479db5b5",
"end_time": "2024-11-14T12:11:22.303Z",
"failed_rule_count": 0,
"supported": true,
"score": 26.73628702891804,
"type": "test_result",
"display_name": "kohler.example",
"groups": [],
"tags": [
{
"key": "feed",
"value": "virtual",
"namespace": "generating"
},
{
"key": "program",
"value": "wireless",
"namespace": "backing up"
},
{
"key": "bandwidth",
"value": "back-end",
"namespace": "backing up"
},
{
"key": "matrix",
"value": "digital",
"namespace": "programming"
},
{
"key": "program",
"value": "mobile",
"namespace": "bypassing"
}
],
"os_major_version": 8,
"os_minor_version": 0,
"compliant": false,
"system_id": "97d7b35c-8819-4fc7-80da-4e962b093975",
"security_guide_version": "100.101.31"
},
{
"id": "45796db9-098d-4e90-a3b4-c44a9383afb0",
"end_time": "2024-11-14T12:11:22.316Z",
"failed_rule_count": 0,
"supported": true,
"score": 60.20046351478584,
"type": "test_result",
"display_name": "thompson-ohara.test",
"groups": [],
"tags": [
{
"key": "interface",
"value": "primary",
"namespace": "parsing"
},
{
"key": "hard drive",
"value": "solid state",
"namespace": "programming"
},
{
"key": "pixel",
"value": "online",
"namespace": "compressing"
},
{
"key": "pixel",
"value": "wireless",
"namespace": "generating"
},
{
"key": "microchip",
"value": "multi-byte",
"namespace": "backing up"
}
],
"os_major_version": 8,
"os_minor_version": 0,
"compliant": false,
"system_id": "37b08573-c02b-4d77-95a2-d323c163cad7",
"security_guide_version": "100.101.31"
},
{
"id": "4606b7fa-bc4d-44c9-b951-050d04cecf1e",
"end_time": "2024-11-14T12:11:22.258Z",
"failed_rule_count": 0,
"supported": true,
"score": 3.016392543304624,
"type": "test_result",
"display_name": "fritsch.example",
"groups": [],
"tags": [
{
"key": "sensor",
"value": "online",
"namespace": "navigating"
},
{
"key": "sensor",
"value": "open-source",
"namespace": "transmitting"
},
{
"key": "alarm",
"value": "online",
"namespace": "compressing"
},
{
"key": "microchip",
"value": "mobile",
"namespace": "hacking"
},
{
"key": "circuit",
"value": "redundant",
"namespace": "backing up"
}
],
"os_major_version": 8,
"os_minor_version": 0,
"compliant": false,
"system_id": "e5e480d0-4783-4210-ab8a-8a4b523f6784",
"security_guide_version": "100.101.31"
},
{
"id": "55707c45-84e5-4d46-a8e4-fec2e189e974",
"end_time": "2024-11-14T12:11:22.362Z",
"failed_rule_count": 0,
"supported": true,
"score": 68.08139419780311,
"type": "test_result",
"display_name": "spinka.test",
"groups": [],
"tags": [
{
"key": "capacitor",
"value": "neural",
"namespace": "synthesizing"
},
{
"key": "driver",
"value": "bluetooth",
"namespace": "indexing"
},
{
"key": "hard drive",
"value": "optical",
"namespace": "parsing"
},
{
"key": "array",
"value": "virtual",
"namespace": "generating"
},
{
"key": "protocol",
"value": "haptic",
"namespace": "synthesizing"
}
],
"os_major_version": 8,
"os_minor_version": 0,
"compliant": false,
"system_id": "d0a32995-3ef0-4b03-a36a-8c2868a8ad44",
"security_guide_version": "100.101.31"
}
],
"meta": {
"total": 25,
"tags": [],
"limit": 10,
"offset": 0
},
"links": {
"first": "/api/compliance/v2/reports/00ac295c-c768-46b2-a112-4dbe0b313ba3/test_results?limit=10&offset=0",
"last": "/api/compliance/v2/reports/00ac295c-c768-46b2-a112-4dbe0b313ba3/test_results?limit=10&offset=20",
"next": "/api/compliance/v2/reports/00ac295c-c768-46b2-a112-4dbe0b313ba3/test_results?limit=10&offset=10"
}
},
"summary": "",
"description": ""
},
"List of Test Results sorted by \"score:asc\"": {
"value": {
"data": [
{
"id": "3029f2d8-cdaa-4d66-9af3-1741a99c81ee",
"end_time": "2024-11-14T12:11:22.772Z",
"failed_rule_count": 0,
"supported": true,
"score": 1.540058734495675,
"type": "test_result",
"display_name": "sauer.example",
"groups": [],
"tags": [
{
"key": "sensor",
"value": "online",
"namespace": "bypassing"
},
{
"key": "card",
"value": "redundant",
"namespace": "connecting"
},
{
"key": "array",
"value": "1080p",
"namespace": "connecting"
},
{
"key": "program",
"value": "digital",
"namespace": "calculating"
},
{
"key": "firewall",
"value": "haptic",
"namespace": "programming"
}
],
"os_major_version": 8,
"os_minor_version": 0,
"compliant": false,
"system_id": "ac959250-65c3-47ab-a8b6-2cdfe21abf02",
"security_guide_version": "100.102.41"
},
{
"id": "7f80afcd-7ef8-4c59-9562-17c5117ca827",
"end_time": "2024-11-14T12:11:22.798Z",
"failed_rule_count": 0,
"supported": true,
"score": 5.972276671378762,
"type": "test_result",
"display_name": "abshire-bednar.test",
"groups": [],
"tags": [
{
"key": "driver",
"value": "digital",
"namespace": "synthesizing"
},
{
"key": "application",
"value": "neural",
"namespace": "synthesizing"
},
{
"key": "monitor",
"value": "redundant",
"namespace": "generating"
},
{
"key": "monitor",
"value": "cross-platform",
"namespace": "quantifying"
},
{
"key": "hard drive",
"value": "solid state",
"namespace": "navigating"
}
],
"os_major_version": 8,
"os_minor_version": 0,
"compliant": false,
"system_id": "b6936296-a57c-4f4c-82be-e16a37422dd6",
"security_guide_version": "100.102.41"
},
{
"id": "d4a4ab09-98e1-4ec9-8fa8-a3c6d211d66c",
"end_time": "2024-11-14T12:11:22.754Z",
"failed_rule_count": 0,
"supported": true,
"score": 7.020926051189457,
"type": "test_result",
"display_name": "greenfelder-bernier.example",
"groups": [],
"tags": [
{
"key": "protocol",
"value": "redundant",
"namespace": "programming"
},
{
"key": "circuit",
"value": "online",
"namespace": "navigating"
},
{
"key": "hard drive",
"value": "redundant",
"namespace": "transmitting"
},
{
"key": "pixel",
"value": "back-end",
"namespace": "transmitting"
},
{
"key": "matrix",
"value": "primary",
"namespace": "synthesizing"
}
],
"os_major_version": 8,
"os_minor_version": 0,
"compliant": false,
"system_id": "0eb7dd05-38c1-4fd6-b5a3-7d50d148201a",
"security_guide_version": "100.102.41"
},
{
"id": "e26c07ab-45d5-4c52-9716-d328c6bacb83",
"end_time": "2024-11-14T12:11:22.766Z",
"failed_rule_count": 0,
"supported": true,
"score": 9.348092977041544,
"type": "test_result",
"display_name": "kassulke-dooley.test",
"groups": [],
"tags": [
{
"key": "matrix",
"value": "multi-byte",
"namespace": "hacking"
},
{
"key": "bus",
"value": "online",
"namespace": "parsing"
},
{
"key": "array",
"value": "solid state",
"namespace": "copying"
},
{
"key": "monitor",
"value": "haptic",
"namespace": "hacking"
},
{
"key": "sensor",
"value": "1080p",
"namespace": "synthesizing"
}
],
"os_major_version": 8,
"os_minor_version": 0,
"compliant": false,
"system_id": "2834ab5a-acf3-4480-a710-f74aa8b8d17b",
"security_guide_version": "100.102.41"
},
{
"id": "56883183-f575-42ec-9c05-a2479a1e83d0",
"end_time": "2024-11-14T12:11:22.622Z",
"failed_rule_count": 0,
"supported": true,
"score": 12.08279348774866,
"type": "test_result",
"display_name": "kutch.example",
"groups": [],
"tags": [
{
"key": "driver",
"value": "cross-platform",
"namespace": "transmitting"
},
{
"key": "bandwidth",
"value": "bluetooth",
"namespace": "parsing"
},
{
"key": "port",
"value": "optical",
"namespace": "synthesizing"
},
{
"key": "panel",
"value": "open-source",
"namespace": "backing up"
},
{
"key": "alarm",
"value": "redundant",
"namespace": "copying"
}
],
"os_major_version": 8,
"os_minor_version": 0,
"compliant": false,
"system_id": "e6a505e3-94e9-4502-9efd-7bfd6bd86510",
"security_guide_version": "100.102.41"
},
{
"id": "abbb2a02-8130-4a90-8c77-073b5e3f3a06",
"end_time": "2024-11-14T12:11:22.702Z",
"failed_rule_count": 0,
"supported": true,
"score": 27.2755784567125,
"type": "test_result",
"display_name": "ullrich.test",
"groups": [],
"tags": [
{
"key": "firewall",
"value": "wireless",
"namespace": "navigating"
},
{
"key": "transmitter",
"value": "mobile",
"namespace": "bypassing"
},
{
"key": "application",
"value": "primary",
"namespace": "generating"
},
{
"key": "feed",
"value": "bluetooth",
"namespace": "indexing"
},
{
"key": "hard drive",
"value": "online",
"namespace": "hacking"
}
],
"os_major_version": 8,
"os_minor_version": 0,
"compliant": false,
"system_id": "d61efc09-34f8-4b56-98ac-908ddb553659",
"security_guide_version": "100.102.41"
},
{
"id": "1d61af86-4507-49e5-8c1b-360ae3a07eae",
"end_time": "2024-11-14T12:11:22.657Z",
"failed_rule_count": 0,
"supported": true,
"score": 27.58047727361587,
"type": "test_result",
"display_name": "mcdermott-thompson.test",
"groups": [],
"tags": [
{
"key": "feed",
"value": "online",
"namespace": "transmitting"
},
{
"key": "panel",
"value": "bluetooth",
"namespace": "bypassing"
},
{
"key": "transmitter",
"value": "back-end",
"namespace": "overriding"
},
{
"key": "matrix",
"value": "redundant",
"namespace": "copying"
},
{
"key": "feed",
"value": "virtual",
"namespace": "indexing"
}
],
"os_major_version": 8,
"os_minor_version": 0,
"compliant": false,
"system_id": "b1b889e2-69c2-4986-9dd4-0d1da251cf50",
"security_guide_version": "100.102.41"
},
{
"id": "5086816c-e9a4-4429-a445-a1c47407d7a3",
"end_time": "2024-11-14T12:11:22.626Z",
"failed_rule_count": 0,
"supported": true,
"score": 32.43491081461354,
"type": "test_result",
"display_name": "kulas.test",
"groups": [],
"tags": [
{
"key": "protocol",
"value": "neural",
"namespace": "hacking"
},
{
"key": "firewall",
"value": "mobile",
"namespace": "navigating"
},
{
"key": "capacitor",
"value": "primary",
"namespace": "programming"
},
{
"key": "monitor",
"value": "solid state",
"namespace": "backing up"
},
{
"key": "feed",
"value": "optical",
"namespace": "navigating"
}
],
"os_major_version": 8,
"os_minor_version": 0,
"compliant": false,
"system_id": "d9900d3b-e6be-4b13-bc84-c2c3d66c5fc9",
"security_guide_version": "100.102.41"
},
{
"id": "2fe248a5-a859-4468-a5c4-71cb5d8d7b61",
"end_time": "2024-11-14T12:11:22.792Z",
"failed_rule_count": 0,
"supported": true,
"score": 33.82463620559125,
"type": "test_result",
"display_name": "kling.test",
"groups": [],
"tags": [
{
"key": "microchip",
"value": "haptic",
"namespace": "calculating"
},
{
"key": "hard drive",
"value": "primary",
"namespace": "generating"
},
{
"key": "firewall",
"value": "solid state",
"namespace": "quantifying"
},
{
"key": "array",
"value": "primary",
"namespace": "parsing"
},
{
"key": "port",
"value": "online",
"namespace": "synthesizing"
}
],
"os_major_version": 8,
"os_minor_version": 0,
"compliant": false,
"system_id": "142450ae-8d51-4b1f-b201-5154f8ca0988",
"security_guide_version": "100.102.41"
},
{
"id": "c024ae23-846b-4a50-9b64-f07cbc0615d6",
"end_time": "2024-11-14T12:11:22.785Z",
"failed_rule_count": 0,
"supported": true,
"score": 34.77100911240797,
"type": "test_result",
"display_name": "barton-wolff.test",
"groups": [],
"tags": [
{
"key": "transmitter",
"value": "wireless",
"namespace": "generating"
},
{
"key": "application",
"value": "redundant",
"namespace": "connecting"
},
{
"key": "application",
"value": "haptic",
"namespace": "indexing"
},
{
"key": "transmitter",
"value": "mobile",
"namespace": "programming"
},
{
"key": "interface",
"value": "primary",
"namespace": "compressing"
}
],
"os_major_version": 8,
"os_minor_version": 0,
"compliant": false,
"system_id": "c65b1f98-3a54-4ebc-9fde-a00dc636bd75",
"security_guide_version": "100.102.41"
}
],
"meta": {
"total": 25,
"tags": [],
"limit": 10,
"offset": 0,
"sort_by": "score"
},
"links": {
"first": "/api/compliance/v2/reports/888d741c-1bb0-4e60-be20-85909d38e898/test_results?limit=10&offset=0&sort_by=score",
"last": "/api/compliance/v2/reports/888d741c-1bb0-4e60-be20-85909d38e898/test_results?limit=10&offset=20&sort_by=score",
"next": "/api/compliance/v2/reports/888d741c-1bb0-4e60-be20-85909d38e898/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/141a598b-4a5f-403f-8246-5ff408b4f816/test_results?filter=%28os_minor_version%3D8%29&limit=10&offset=0",
"last": "/api/compliance/v2/reports/141a598b-4a5f-403f-8246-5ff408b4f816/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 <a href=\"https://github.com/wvanbergen/scoped_search/wiki/Query-language\" target=\"_blank\" title=\"github.com/wvanbergen/scoped_search\">scoped_search query language</a>. However, only `=` or `!=` (resp. `<>`) operators are supported.<br><br>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`<br><br>(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.109.1"
],
"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": "Returns a Test Result under a 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": "67a893e9-1be0-4396-8296-5a24ab82e1a8",
"end_time": "2024-11-14T12:11:24.680Z",
"failed_rule_count": 0,
"supported": true,
"score": 9.975277134915117,
"type": "test_result",
"display_name": "johnston.test",
"groups": [],
"tags": [
{
"key": "circuit",
"value": "haptic",
"namespace": "calculating"
},
{
"key": "capacitor",
"value": "wireless",
"namespace": "indexing"
},
{
"key": "pixel",
"value": "multi-byte",
"namespace": "bypassing"
},
{
"key": "alarm",
"value": "bluetooth",
"namespace": "generating"
},
{
"key": "bandwidth",
"value": "mobile",
"namespace": "indexing"
}
],
"os_major_version": 8,
"os_minor_version": 0,
"compliant": false,
"system_id": "3ba6ef8d-c8d3-438b-9c27-210677e98c95",
"security_guide_version": "100.110.17"
}
},
"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 48725bdb-ca58-4268-98a1-b1aad845ce2e"
]
},
"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 (`<key>:asc` or `<key>:desc`).<br><br>If no direction is selected, `<key>: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 <a href=\"https://github.com/wvanbergen/scoped_search/wiki/Query-language\" target=\"_blank\" title=\"github.com/wvanbergen/scoped_search\">scoped_search query language</a>. However, only `=` or `!=` (resp. `<>`) operators are supported.<br><br>Value Definitions are searchable using attributes `title` and `ref_id`<br><br>(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": "Lists Value Definitions",
"operationId": "ValueDefinitions",
"responses": {
"200": {
"description": "Lists Value Definitions",
"content": {
"application/vnd.api+json": {
"examples": {
"List of Value Definitions": {
"value": {
"data": [
{
"id": "01a89cae-9470-4776-836d-f462e7842b3d",
"ref_id": "foo_value_6b9cfca4-4f0a-447f-8da2-d351fadb2f24",
"title": "Sint cupiditate est voluptatum.",
"description": "Aut corporis doloremque. Similique iste nobis. Expedita cumque sunt.",
"value_type": "number",
"default_value": "0.46183725289148514",
"type": "value_definition"
},
{
"id": "083874eb-1976-4358-b7dc-0bc176b4be78",
"ref_id": "foo_value_6af08995-7ff1-49c1-a181-d606f702d447",
"title": "Quidem eveniet aut labore.",
"description": "Dolorem ipsa cumque. Quis a et. Itaque quaerat commodi.",
"value_type": "number",
"default_value": "0.4731278274625662",
"type": "value_definition"
},
{
"id": "19e82c01-a77e-4ea6-8e99-b1ecd852ac84",
"ref_id": "foo_value_8e28106b-dfbb-4b44-bdf7-171a960ab53b",
"title": "Impedit eius deleniti possimus.",
"description": "Optio laudantium excepturi. Sed praesentium excepturi. Iusto nulla at.",
"value_type": "number",
"default_value": "0.0360667747414134",
"type": "value_definition"
},
{
"id": "1ea823c3-a47d-4ba8-ae43-ced61053c375",
"ref_id": "foo_value_92d6bc7e-92c1-4232-b697-704e9400d4b3",
"title": "Quia modi in voluptatem.",
"description": "Beatae excepturi est. Minus veritatis omnis. Recusandae facere molestiae.",
"value_type": "number",
"default_value": "0.8393024464198549",
"type": "value_definition"
},
{
"id": "1ff32509-c221-4ef0-a849-6405782065ef",
"ref_id": "foo_value_fd849742-9e90-4caf-85ef-2a629316d0c6",
"title": "Distinctio molestias qui quis.",
"description": "Ipsum repudiandae et. Earum ea ipsa. Voluptas perspiciatis adipisci.",
"value_type": "number",
"default_value": "0.20653753436453526",
"type": "value_definition"
},
{
"id": "210ad8ad-9fc5-4ded-9a3c-bcdf7e93d775",
"ref_id": "foo_value_a097e9de-fe40-4150-8119-f77bbc191142",
"title": "Modi ipsam iste reiciendis.",
"description": "Minima est officiis. Dignissimos maxime aliquam. Sapiente quis sed.",
"value_type": "number",
"default_value": "0.49041127569466003",
"type": "value_definition"
},
{
"id": "272c7461-a258-459e-b236-c65b121ef2b3",
"ref_id": "foo_value_2af420e2-0c33-4785-af76-9f9a8f5df4be",
"title": "Sunt commodi placeat sed.",
"description": "Dignissimos dolorem debitis. Optio nesciunt ea. Aut consequatur ipsam.",
"value_type": "number",
"default_value": "0.22538016464817057",
"type": "value_definition"
},
{
"id": "2838626a-9f66-4505-815e-635cb87d84d9",
"ref_id": "foo_value_9e079396-76a6-4358-9d02-19bde2f052e9",
"title": "Est sint quidem et.",
"description": "Quia sit sunt. Et hic commodi. Nisi perferendis perspiciatis.",
"value_type": "number",
"default_value": "0.6394214040047392",
"type": "value_definition"
},
{
"id": "2ebdfe25-d925-48d8-b81d-a146a38e884d",
"ref_id": "foo_value_fa2cfcbf-30b6-4488-ac12-c69a2b7ddde0",
"title": "Et qui enim enim.",
"description": "Dicta perspiciatis iure. Blanditiis sint in. Quam accusantium expedita.",
"value_type": "number",
"default_value": "0.13035805981086968",
"type": "value_definition"
},
{
"id": "44117a63-4e4f-40e6-bcec-2d2d15256a53",
"ref_id": "foo_value_3006b2fa-5ca5-4f0d-a406-47eb8363f612",
"title": "Et eligendi ut itaque.",
"description": "Odio officia rerum. Necessitatibus porro voluptatem. Possimus unde laborum.",
"value_type": "number",
"default_value": "0.14766503638699824",
"type": "value_definition"
}
],
"meta": {
"total": 25,
"limit": 10,
"offset": 0
},
"links": {
"first": "/api/compliance/v2/security_guides/ed414818-7091-4f39-ab50-dc999e5a396d/value_definitions?limit=10&offset=0",
"last": "/api/compliance/v2/security_guides/ed414818-7091-4f39-ab50-dc999e5a396d/value_definitions?limit=10&offset=20",
"next": "/api/compliance/v2/security_guides/ed414818-7091-4f39-ab50-dc999e5a396d/value_definitions?limit=10&offset=10"
}
},
"summary": "",
"description": ""
},
"List of Value Definitions sorted by \"title:asc\"": {
"value": {
"data": [
{
"id": "76948a47-4b27-4bdf-9509-ed4f2d9df374",
"ref_id": "foo_value_6113af1f-ea99-46f3-81f6-4ec2e845f8e4",
"title": "Atque sunt corporis aut.",
"description": "Voluptatem soluta sit. Ipsam sint repudiandae. Aut quidem eos.",
"value_type": "number",
"default_value": "0.9356452690118262",
"type": "value_definition"
},
{
"id": "77b003c1-37f0-4b55-9de6-f0302dd135e0",
"ref_id": "foo_value_6acd65db-594f-4c5b-938f-ad2d1d04ead9",
"title": "Consequatur nisi nemo repellat.",
"description": "Blanditiis quae qui. Tempore voluptatibus dignissimos. Et porro fuga.",
"value_type": "number",
"default_value": "0.4756454997509203",
"type": "value_definition"
},
{
"id": "1430dae5-f413-4c6f-b2cc-6f38af248355",
"ref_id": "foo_value_31708cb8-dea0-40a2-9d17-d30492126867",
"title": "Eum atque facere culpa.",
"description": "Explicabo et aut. Praesentium vitae adipisci. Reprehenderit sint praesentium.",
"value_type": "number",
"default_value": "0.3506275660085497",
"type": "value_definition"
},
{
"id": "487dbbb0-ea54-4c5f-a6cc-a3b9520c397f",
"ref_id": "foo_value_5771a42f-8b96-4056-8ed4-e65318bce831",
"title": "Eum unde repellendus quo.",
"description": "Et neque quaerat. Veniam saepe eaque. Est debitis voluptas.",
"value_type": "number",
"default_value": "0.9734886232778274",
"type": "value_definition"
},
{
"id": "4d02a3eb-6b5e-41b9-bb01-480c30d64323",
"ref_id": "foo_value_177b69e9-9091-4e3b-b214-467a00362888",
"title": "Fuga hic quisquam distinctio.",
"description": "Et voluptatem id. Saepe commodi vero. Repellendus aut est.",
"value_type": "number",
"default_value": "0.5357189259065366",
"type": "value_definition"
},
{
"id": "60280d69-8078-4c4b-8386-d4ab0fa9a040",
"ref_id": "foo_value_4d53ae94-c43b-4589-a3e7-8c449bc337e9",
"title": "In illo amet fugiat.",
"description": "Fugit porro amet. Perspiciatis ipsa facilis. Natus sapiente repudiandae.",
"value_type": "number",
"default_value": "0.4038867303700415",
"type": "value_definition"
},
{
"id": "a3e8e29b-4dd2-496a-896e-e97eed0a5353",
"ref_id": "foo_value_753fc2a3-5c7b-43fe-9372-376163a35540",
"title": "Ipsum non possimus odit.",
"description": "Labore magni voluptatum. Qui dolore voluptas. Incidunt quasi vero.",
"value_type": "number",
"default_value": "0.4827035039362456",
"type": "value_definition"
},
{
"id": "d084dea5-5143-4e60-bf5e-c21a82f2238b",
"ref_id": "foo_value_1a76e466-f057-4b06-8edc-b015de836e5b",
"title": "Modi non quod sunt.",
"description": "Eos magnam eligendi. Ut nostrum tempore. Facere placeat commodi.",
"value_type": "number",
"default_value": "0.3719251356108413",
"type": "value_definition"
},
{
"id": "a11ab96b-ad08-48ce-b1bc-b8c57fb115e0",
"ref_id": "foo_value_d67c3099-423b-491e-a4ca-55a71e19508f",
"title": "Non rem consequatur natus.",
"description": "Omnis cum laboriosam. Tempore soluta ratione. Sed soluta ex.",
"value_type": "number",
"default_value": "0.2592610387958234",
"type": "value_definition"
},
{
"id": "ed3f63aa-f157-44f3-87f4-c1f695f477f3",
"ref_id": "foo_value_923c74ea-6dc2-4492-b5a2-e95e52b0ecca",
"title": "Omnis itaque dolore eius.",
"description": "Molestiae fugiat dignissimos. Et ipsa reiciendis. Qui enim sed.",
"value_type": "number",
"default_value": "0.10662876184039705",
"type": "value_definition"
}
],
"meta": {
"total": 25,
"limit": 10,
"offset": 0,
"sort_by": "title"
},
"links": {
"first": "/api/compliance/v2/security_guides/7ed00f2d-dea0-4f5d-9fff-0deebb23a7a3/value_definitions?limit=10&offset=0&sort_by=title",
"last": "/api/compliance/v2/security_guides/7ed00f2d-dea0-4f5d-9fff-0deebb23a7a3/value_definitions?limit=10&offset=20&sort_by=title",
"next": "/api/compliance/v2/security_guides/7ed00f2d-dea0-4f5d-9fff-0deebb23a7a3/value_definitions?limit=10&offset=10&sort_by=title"
}
},
"summary": "",
"description": ""
},
"List of Value Definitions filtered by '(title=Iusto cumque libero quo.)'": {
"value": {
"data": [
{
"id": "05b8eb61-4b64-4fc1-8d70-7dee55991aed",
"ref_id": "foo_value_a6302f38-d3e5-4d7d-9ec5-97a2c104c4c5",
"title": "Iusto cumque libero quo.",
"description": "Qui ad qui. Quos aliquam fugiat. Iure molestiae veritatis.",
"value_type": "number",
"default_value": "0.2201059934462225",
"type": "value_definition"
}
],
"meta": {
"total": 1,
"filter": "(title=\"Iusto cumque libero quo.\")",
"limit": 10,
"offset": 0
},
"links": {
"first": "/api/compliance/v2/security_guides/54e19bcd-a676-4a07-8175-fb33fe35de72/value_definitions?filter=%28title%3D%22Iusto+cumque+libero+quo.%22%29&limit=10&offset=0",
"last": "/api/compliance/v2/security_guides/54e19bcd-a676-4a07-8175-fb33fe35de72/value_definitions?filter=%28title%3D%22Iusto+cumque+libero+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/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": "Returns a Value Definition",
"operationId": "ValueDefinition",
"responses": {
"200": {
"description": "Returns a Value Definition",
"content": {
"application/vnd.api+json": {
"examples": {
"Returns a Value Definition": {
"value": {
"data": {
"id": "32c0321d-e8e0-4c39-96e7-a72dcea75461",
"ref_id": "foo_value_cfc94288-0bb1-440a-8a88-cb23394e3c6d",
"title": "Autem quia quis pariatur.",
"description": "Iste rem dolor. Est exercitationem consectetur. Atque quam non.",
"value_type": "number",
"default_value": "0.9034230648585917",
"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 964889f7-a9fb-43eb-9256-801883fe2cd7"
]
},
"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": [
{
"7b734516-23f7-4886-b78c-d1b25b2f7c28": "foo",
"f12a57b6-f867-46af-a9eb-0e6960f49e3a": "123",
"7c4fe1eb-a348-44df-91a8-3e0db27fe7e7": "false"
}
]
}
}
},
"tailoring_create": {
"type": "object",
"properties": {
"os_minor_version": {
"type": "number",
"examples": [
1
],
"required": true,
"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 failed 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"
}
}
}
}
}
}