v2

latestOpenAPI 3.1.0CC-BY-SA 2.02026-07-2617789528.6 KB

Rules

Create a rule category

Create a new rule category

put/rules/categories

Request body

parentstring uuid required

The parent category of the rules

idstring uuid

Rule category id, only provide it when needed.

namestring required

Name of the rule category

descriptionstring

Rules category description

Example request

{
  "parent": "b9f6d98a-28bc-4d80-90f7-d2f14269e215",
  "id": "32d013f7-b6d8-46c8-99d3-016307fa66c0",
  "name": "Security policies",
  "description": "Baseline applying CIS guidelines"
}

Response

Rules category information

result'success' | 'error' required

Result of the request

action'CreateRuleCategory' required

The id of the action

Example response

{
  "data": {
    "ruleCategories": [
      {
        "parent": "b9f6d98a-28bc-4d80-90f7-d2f14269e215",
        "id": "32d013f7-b6d8-46c8-99d3-016307fa66c0",
        "name": "Security policies",
        "description": "Baseline applying CIS guidelines"
      }
    ]
  }
}