v2

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

Compliance details by rule

Get current compliance of a rule of a Rudder server

get/compliance/rules/{ruleId}

Path parameters

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

Id of the target rule

Query parameters

levelinteger
Example:4

Number of depth level of compliance objects to display (1:rules, 2:directives, 3:components, 4:nodes, 5:values, 6:reports)

precisioninteger

Number of digits after comma in compliance percent figures

Response

Success

result'success' | 'error' required

Result of the request

action'getRuleCompliance' required

The id of the action

Example response

{
  "result": "success",
  "data": {
    "rules": [
      {
        "id": "f37f4928-fcb5-4acf-a422-d40f123a9670",
        "compliance": 57.43,
        "complianceDetails": {
          "successAlreadyOK": 48.68,
          "noReport": 36.18,
          "successNotApplicable": 5.92,
          "unexpectedMissingComponent": 2.63,
          "error": 1.32,
          "unexpectedUnknownComponent": 2.63,
          "successRepaired": 2.63
        }
      }
    ]
  }
}