Detection

Lists all detection settings

Request

Definition

GET /api/v1/settings/detection

Header

• Authorization required

  Authentication token with privileges to view the resource.

  Bearer {token}

Response

Status codes

Status code	Message
200	"List of detection settings"
403	"Forbidden"

Corpo

Attributes

• data.settings.broken_access_control.enable_drupal_probing boolean

  If true, it enables the drupal probing module.

• data.settings.broken_access_control.enable_path_traversal boolean

  If true, it enables the path traversal module.

• data.settings.broken_access_control.enable_wordpress_probing boolean

  If true, it enables the wordpress probing module.

• data.settings.id_and_auth_failures.enable_botnet boolean

  If true, it enables the botnet module.

• data.settings.id_and_auth_failures.enable_brute_force boolean

  If true, it enables the brute force module.

• data.settings.id_and_auth_failures.enable_fake_bot boolean

  If true, it enables the fake bot module.

• data.settings.id_and_auth_failures.enable_malicious_scanner boolean,

  If true, it enables the malicious scanner module.

• data.settings.injection.enable_code_injection boolean

  If true, it enables the code injection module.

• data.settings.injection.enable_command_injection boolean

  If true, it enables the command injection module.

• data.settings.injection.enable_cross_site_scripting boolean

  If true, it enables the cross-site scripting module.

• data.settings.injection.enable_jndi_injection boolean

  If true, it enables the jndi injection module.

• data.settings.injection.enable_sql_injection boolean

  If true, it enables the SQL injection module.

• data.settings.injection.enable_xml_external_entity boolean

  If true, it enables the XML external entity module.

Example

{
"data": {
    "settings": {
    "broken_access_control": {
        "enable_drupal_probing": true,
        "enable_path_traversal": true,
        "enable_wordpress_probing": true
    },
    "id_and_auth_failures": {
        "enable_botnet": true,
        "enable_brute_force": true,
        "enable_fake_bot": true,
        "enable_malicious_scanner": true
    },
    "injection": {
        "enable_code_injection": true,
        "enable_command_injection": true,
        "enable_cross_site_scripting": true,
        "enable_jndi_injection": true,
        "enable_sql_injection": true,
        "enable_xml_external_entity": false
    }
    }
},
"message": "List of detection settings",
"status": "ok"
}

Updates detection settings

Request

Definition

PUT /api/v1/settings/detection

Headers

• Authorization required

  Authentication token with privileges to view the resource.

  Bearer {token}

• Content-Type required

  application/json

Request body

{
  "broken_access_control": {},
  "id_and_auth_failures": {},
  "injection": {
    "enable_code_injection": false,
    "enable_sql_injection": false
  }
}

Response

Status codes

Status code	Message
200	"Detection settings updated"
400	"Error updating detection settings"
403	"Forbidden"

Body

{
  "data": {
    "firewall": {
      "description": "new description",
      "name": "fw_test",
      "settings": {
        "enabled_as_fw": true
      },
      "type": "generic_blacklist_feed"
    }
  },
  "message": "Firewall updated",
  "status": "ok"
}