v2

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

Compliance details by directive

Get current compliance of a directive of a Rudder server

get/compliance/directives/{directiveId}

Path parameters

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

Id of the directive

Query parameters

format'csv' | 'json'

format of export

Response

Success

OR
string binary required

Example response

{
  "result": "success",
  "data": {
    "directiveCompliance": {
      "id": "9a1773c9-0889-40b6-be89-f6504443ac1b",
      "name": "test directive",
      "compliance": 83.34,
      "complianceDetails": {
        "successAlreadyOK": 66.68,
        "noReport": 7.45,
        "successNotApplicable": 16.66,
        "unexpectedMissingComponent": 2.63,
        "error": 1.32,
        "unexpectedUnknownComponent": 2.63,
        "successRepaired": 2.63
      },
      "rules": {
        "id": "32377fd7-02fd-43d0-aab7-28460a91347b",
        "name": "Global configuration for all nodes",
        "compliance": 83.34,
        "complianceDetails": {
          "successAlreadyOK": 100
        },
        "components": [
          {
            "name": "MOTD Configuration",
            "compliance": 83.34,
            "complianceDetails": {
              "successAlreadyOK": 100
            },
            "nodes": {
              "id": "1c0957c1-9101-464e-b4cf-8983a5293a07",
              "name": "server.rudder.local",
              "compliance": 83.34,
              "complianceDetails": {
                "successAlreadyOK": 100
              },
              "values": [
                {
                  "value": "None",
                  "reports": [
                    {
                      "status": "successAlreadyOK",
                      "message": "The MOTD file was correct"
                    }
                  ]
                }
              ]
            }
          }
        ]
      },
      "nodes": {
        "id": "b6ded8e2-2709-4986-973d-8e5522d20718",
        "name": "agent1.rudder.local",
        "compliance": 83.34,
        "complianceDetails": {
          "successAlreadyOK": 100
        },
        "rules": {
          "id": "835c068d-f01e-44c0-a0f4-7a436d46ad35",
          "name": "Test users",
          "compliance": 100,
          "complianceDetails": {
            "successAlreadyOK": 66.67,
            "successNotApplicable": 33.33
          },
          "components": [
            {
              "name": "test directive",
              "compliance": 100,
              "complianceDetails": {
                "successAlreadyOK": 66.67,
                "successNotApplicable": 33.33
              },
              "values": [
                {
                  "value": "tutu",
                  "reports": [
                    {
                      "status": "successAlreadyOK",
                      "message": "The user tutu ( Without any defined full name ) is already present on the system"
                    }
                  ]
                }
              ]
            }
          ]
        }
      }
    }
  }
}