Custom rules

Gets custom rules

get/1.1/protection/custom-rules

Request

  • Base URL
    https://customer-api.datadome.co
  • URL
    https://customer-api.datadome.co/1.1/protection/custom-rules
  • Auth
    API key in header x-api-key

Query parameters

withoutTrafficboolean

Get custom rules without their traffic

Response

Gets the defined custom rules, hits attribute is the number of requests who matched the rule from the last 24 hours.

statusinteger
errorsstring[]
messagestring

Example response

{
  "data": {
    "custom_rules": [
      {
        "policy_options": {
          "time_box": {
            "authorized_hours_of_the_week": [
              9,
              10,
              11,
              12,
              13,
              14,
              15,
              16,
              17
            ],
            "response_outside_time_box": "block"
          },
          "rate_limit": {
            "applies_to": "ip",
            "threshold": 100,
            "time_frame": "1h",
            "response_after_threshold": "block"
          }
        }
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.