Rulesets

Resource url/s

  • https://api.koodous.com/user_rulesets
  • https://api.koodous.com/user_rulesets/:id

Object details

  • id Ruleset ID
  • active Ruleset is active or not.
  • created_on The date when ruleset was created on koodous.
  • detections Total APK detections for this ruleset.
  • modified_on The date when comment was modified.
  • name Ruleset's name.
  • privacy Ruleset's privacy (public or private).
  • rules The ruleset content.
  • send_notifications The ruleset will notify detections or not.
  • social The ruleset is inside the Koodous detection system.

Resource information

Response formats JSON
Requires authentication Yes
Requests per minute 60

Parameters

  • :sha256 sha256 lookup (Required)
  • ?page Specify page of current results
  • ?page_size A value of users votes

Examples:

  • https://api.koodous.com/user_rulesets
  • https://api.koodous.com/user_rulesets?page=1&page_size=10&active=True&privacy=public&ordering=-modified_on

Example request

https://api.koodous.com/user_rulesets?page=1&page_size=10&active=True&privacy=public&ordering=-modified_on

Example result

{
    "count": 1,
    "next": null,
    "previous": null,
    "results": [
        {
            "id": 497,
            "created_on": 1431685981,
            "modified_on": 1431685981,
            "name": "New Ruleset",
            "rules": "rule silent_banker : banker\n{\n\tmeta:\n\t\tdescription = \"This is just an example\"\n\t\tthread_level = 3\n\t\tin_the_wild = true\n\n\tstrings:\n\t\t$a = {6A 40 68 00 30 00 00 6A 14 8D 91}\n\t\t$b = {8D 4D B0 2B C1 83 C0 27 99 6A 4E 59 F7 F9}\n\t\t$c = \"UVODFRYSIHLNWPEJXQZAKCBGMT\"\n\n\tcondition:\n\t\t$a or $b or $c\n}",
            "active": false,
            "privacy": "public",
            "social": false,
            "deleted": false,
            "send_notifications": true,
            "detections": 0,
            "parent": null
        }
    ]
}

Ruleset creation

Remote Address:koodous.com
Request URL:https://api.koodous.com/user_rulesets
Request Method:POST
Status Code:201 CREATED

Payload example:

{"active":true, name: "New Ruleset", rules: ""rule silent_banker : banker\n{\n\tmeta:\n\t\tdescription = \"This is just an example\"\n\t\tthread_level = 3\n\t\tin_the_wild = true\n\n\tstrings:\n\t\t$a = {6A 40 68 00 30 00 00 6A 14 8D 91}\n\t\t$b = {8D 4D B0 2B C1 83 C0 27 99 6A 4E 59 F7 F9}\n\t\t$c = \"UVODFRYSIHLNWPEJXQZAKCBGMT\"\n\n\tcondition:\n\t\t$a or $b or $c\n}"}

Ruleset Update

Remote Address:koodous.com
Request URL:https://api.koodous.com/user_rulesets/:id
Request Method:PATCH
Status Code:200 OK

Payload example:

{"active":true, name: "New Ruleset", rules: ""rule silent_banker : banker\n{\n\tmeta:\n\t\tdescription = \"This is just an example\"\n\t\tthread_level = 3\n\t\tin_the_wild = true\n\n\tstrings:\n\t\t$a = {6A 40 68 00 30 00 00 6A 14 8D 91}\n\t\t$b = {8D 4D B0 2B C1 83 C0 27 99 6A 4E 59 F7 F9}\n\t\t$c = \"UVODFRYSIHLNWPEJXQZAKCBGMT\"\n\n\tcondition:\n\t\t$a or $b or $c\n}"}

Ruleset deletion

Remote Address:koodous.com
Request URL:https://api.koodous.com/user_rulesets/:id
Request Method:DELETE
Status Code:204 NO CONTENT