Rulesets

get_ruleset

dome9.dome9.Dome9.get_ruleset(self, rulesetId=None, name=None)

Get a specific Compliance ruleset

Parameters:

• rulesetId (str) – Locate ruleset by id
• name (str) – Locate ruleset by name

Returns:

Compliance ruleset.

Return type:

dict

Response object:

{
    "rules": [
        {
            "name": "string",
            "severity": "Low",
            "logic": "string",
            "description": "string",
            "remediation": "string",
            "complianceTag": "string",
            "domain": "string",
            "priority": "string",
            "controlTitle": "string",
            "ruleId": "string",
            "logicHash": "string",
            "isDefault": true
        }
    ],
    "accountId": 0,
    "createdTime": "2019-09-26T10:55:03Z",
    "updatedTime": "2019-09-26T10:55:03Z",
    "id": 0,
    "name": "string",
    "description": "string",
    "isTemplate": true,
    "hideInCompliance": true,
    "minFeatureTier": "Trial",
    "section": 0,
    "tooltipText": "string",
    "showBundle": true,
    "systemBundle": true,
    "cloudVendor": "aws",
    "version": 0,
    "language": "string",
    "rulesCount": 0
}

---

list_rulesets

dome9.dome9.Dome9.list_rulesets(self)

List Compliance Rulesets

Returns:List of Compliance rulesets. Return type:list

Response object:

{
    "rules": [
        {
            "name": "string",
            "severity": "Low",
            "logic": "string",
            "description": "string",
            "remediation": "string",
            "complianceTag": "string",
            "domain": "string",
            "priority": "string",
            "controlTitle": "string",
            "ruleId": "string",
            "logicHash": "string",
            "isDefault": true
        }
    ],
    "accountId": 0,
    "createdTime": "2019-09-26T10:55:03Z",
    "updatedTime": "2019-09-26T10:55:03Z",
    "id": 0,
    "name": "string",
    "description": "string",
    "isTemplate": true,
    "hideInCompliance": true,
    "minFeatureTier": "Trial",
    "section": 0,
    "tooltipText": "string",
    "showBundle": true,
    "systemBundle": true,
    "cloudVendor": "aws",
    "version": 0,
    "language": "string",
    "rulesCount": 0
}

---

create_ruleset

dome9.dome9.Dome9.create_ruleset(self, ruleset)

Create a Compliance ruleset

Parameters:ruleset (dict) – Ruleset object. Returns:Compliance ruleset. Return type:dict

Response object:

{
    "rules": [
        {
            "name": "string",
            "severity": "Low",
            "logic": "string",
            "description": "string",
            "remediation": "string",
            "complianceTag": "string",
            "domain": "string",
            "priority": "string",
            "controlTitle": "string",
            "ruleId": "string",
            "logicHash": "string",
            "isDefault": true
        }
    ],
    "accountId": 0,
    "createdTime": "2019-09-26T10:55:03Z",
    "updatedTime": "2019-09-26T10:55:03Z",
    "id": 0,
    "name": "string",
    "description": "string",
    "isTemplate": true,
    "hideInCompliance": true,
    "minFeatureTier": "Trial",
    "section": 0,
    "tooltipText": "string",
    "showBundle": true,
    "systemBundle": true,
    "cloudVendor": "aws",
    "version": 0,
    "language": "string",
    "rulesCount": 0
}

---

update_ruleset

dome9.dome9.Dome9.update_ruleset(self, ruleset)

Update a Compliance ruleset

Parameters:ruleset (dict) – Ruleset object. Returns:Compliance ruleset. Return type:dict

Response object:

{
    "rules": [
        {
            "name": "string",
            "severity": "Low",
            "logic": "string",
            "description": "string",
            "remediation": "string",
            "complianceTag": "string",
            "domain": "string",
            "priority": "string",
            "controlTitle": "string",
            "ruleId": "string",
            "logicHash": "string",
            "isDefault": true
        }
    ],
    "accountId": 0,
    "createdTime": "2019-09-26T10:55:03Z",
    "updatedTime": "2019-09-26T10:55:03Z",
    "id": 0,
    "name": "string",
    "description": "string",
    "isTemplate": true,
    "hideInCompliance": true,
    "minFeatureTier": "Trial",
    "section": 0,
    "tooltipText": "string",
    "showBundle": true,
    "systemBundle": true,
    "cloudVendor": "aws",
    "version": 0,
    "language": "string",
    "rulesCount": 0
}

---

delete_ruleset

dome9.dome9.Dome9.delete_ruleset(self, rulesetId)

Delete a Compliance ruleset

Parameters:rulesetId (str) – ID of the ruleset Returns:Deletion status Return type:bool