v2

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

Get a rule details

Get the details of a rule

get/rules/{ruleId}

Path parameters

ruleIdstring uuid required
Example:9a1773c9-0889-40b6-be89-f6504443ac1b

Id of the target rule

Response

Rules information

result'success' | 'error' required

Result of the request

action'ruleDetails' required

The id of the action

Example response

{
  "data": {
    "rules": [
      {
        "id": "0c1713ae-cb9d-4f7b-abda-ca38c5d643ea",
        "displayName": "Security policy",
        "shortDescription": "Baseline applying CIS guidelines",
        "longDescription": "This rules should be applied to all Linux nodes required basic hardening",
        "directives": [
          "ff3bf651-3fce-49bc-8bf3-85132fa9b875"
        ],
        "targets": [
          {
            "include": {
              "or": [
                "special:all"
              ]
            },
            "exclude": {
              "or": [
                "policyServer:root",
                "group:cd377524-808b-4b42-8724-6ef308efeac7"
              ]
            }
          }
        ],
        "enabled": true,
        "tags": [
          {
            "customer": "MyCompany"
          }
        ],
        "policyMode": "mixed",
        "status": {
          "value": "Partially applied",
          "details": "Directive 'test parameter name' disabled"
        }
      }
    ]
  }
}